Fix `Transform` world scale dirty error

cptbtptpbcptdtptp commented 1 month ago

import { Script, WebGLEngine } from "@galacean/engine";

main();

/**
 * Init demo.
 */
async function main() {
  // Create engine
  const engine = await WebGLEngine.create({ canvas: "canvas" });

  const rootEntity = engine.sceneManager.activeScene.createRootEntity();
  rootEntity.transform.setScale(1, 2, 3);

  const entityRight = rootEntity.createChild();
  entityRight.transform.setScale(4, 5, 6);
  entityRight.transform.setRotation(40, 0, 0);

  const entityWrong = rootEntity.createChild();
  entityWrong.transform.setScale(4, 5, 6);
  entityWrong.transform.setRotation(40, 0, 0);

  rootEntity.addComponent(
    class extends Script {
      private _rotX = 0;
      onUpdate(deltaTime: number): void {
        const rox = this._rotX++;
        entityRight.transform.setRotation(rox, 0, 0);
        entityWrong.transform.setRotation(rox, 0, 0);
        console.log(
          "lossyScale wrong",
          JSON.stringify(entityWrong.transform.lossyWorldScale)
        );
        // @ts-ignore
        entityRight.transform._dirtyFlag |= TransformModifyFlags.WorldScale;
        console.log(
          "lossyScale right",
          JSON.stringify(entityRight.transform.lossyWorldScale)
        );
      }
    }
  );

  engine.run();
}

export enum TransformModifyFlags {
  WorldScale = 0x20,
}

Summary by CodeRabbit

New Features
- Enhanced transformation logic for improved handling of world transformations, including new properties for tracking uniform scaling at both world and local levels.
- Introduced new flags for more granular control over transformation updates.
Bug Fixes
- Adjusted methods to ensure cohesive updates for position, rotation, and scale, with new checks for uniform scaling.
Tests
- Added a new test case for verifying world scale functionality within the transformation suite.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes involve modifications to the Transform class in packages/core/src/Transform.ts, focusing on transformation flags and uniform scaling. New boolean properties _worldUniformScaling and _localUniformScaling have been introduced, along with updates to several methods to enhance the management of scaling states. Additionally, a new test case titled "World Scale" has been introduced in tests/src/core/Transform.test.ts to validate the scaling functionality, while existing tests remain unchanged.

Changes

File Path	Change Summary
packages/core/src/Transform.ts	- Reordered import statements. - Added properties: `_worldUniformScaling`, `_localUniformScaling`. - Updated methods `_updateWorldScaleFlag` and `_updateWorldPositionAndRotationFlag` to accept a flags parameter. - Added getter method `_getWorldUniformScaling`. - Updated `TransformModifyFlags` enum with new flags for uniform scaling.
tests/src/core/Transform.test.ts	- Added new test case: `it("World Scale", () => {...})` for testing world scaling functionality.

Suggested labels

script

Poem

In the garden of code, where transformations play,
Flags dance and twirl, in a streamlined ballet.
With each little change, our logic grows bright,
Scaling new heights, in the soft coding light.
Hop along, dear friends, let’s celebrate this day! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 69.11765% with 21 lines in your changes missing coverage. Please review.

Project coverage is 70.76%. Comparing base (e8e8090) to head (6c2ea9a). Report is 41 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/core/src/Transform.ts	69.11%	18 Missing and 3 partials :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #2408 +/- ## ========================================== + Coverage 69.48% 70.76% +1.28% ========================================== Files 522 526 +4 Lines 27356 27531 +175 Branches 4096 4123 +27 ========================================== + Hits 19009 19483 +474 + Misses 6847 6492 -355 - Partials 1500 1556 +56 ``` | [Flag](https://app.codecov.io/gh/galacean/engine/pull/2408/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/galacean/engine/pull/2408/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | `70.76% <69.11%> (+1.28%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

galacean / engine