galacean / engine

A typescript interactive engine, support 2D, 3D, animation, physics, built on WebGL and glTF.
https://www.galacean.com/engine
MIT License
4.3k stars 307 forks source link

Fix `Animator` the check of some transitions are missed #2392

Closed luzhuang closed 1 month ago

luzhuang commented 1 month ago

Please check if the PR fulfills these requirements

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@luzhuang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 54 seconds before requesting another review.

⌛ How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
🚦 How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
📥 Commits Files that changed from the base of the PR and between e4b4c2a7c53900d2ae845a3b5f1ade4976351e2a and ad15b18966019b26df7469648f5a2a848cebc045.

Walkthrough

The changes in this pull request enhance the Animator class and its related components within the animation system. Key modifications include the introduction of new internal methods for calculating animation clip timings in the AnimatorState class, updates to transition logic in Animator and AnimatorStateTransitionCollection, and improvements to the test suite for the Animator class. These changes refine the handling of animation states and transitions, ensuring more robust and clear functionality.

Changes

File Path Change Summary
packages/core/src/animation/Animator.ts - Adjusted transition logic to use a new transitionCollection parameter.
- Added _deactivateTriggeredParameters method for managing triggered parameters.
- Renamed isForwards to isForward in multiple methods.
packages/core/src/animation/AnimatorState.ts - Added two new internal methods: _getClipActualStartTime and _getClipActualEndTime for calculating clip timing.
- Modified clearTransitions to clear transition collection directly.
- Updated return types for clipStartTime and clipEndTime.
packages/core/src/animation/AnimatorStateTransitionCollection.ts - Made _transitions publicly accessible as transitions.
- Introduced new properties: noExitTimeCount, needReset, and currentTransitionIndex.
- Refactored add, remove, and clear methods for new transition management logic.
- Added several new methods for transition checks.
tests/src/core/Animator.test.ts - Enhanced test suite with new tests for animator functionality, including parameter handling and transition behavior.
- Added cleanup in afterEach for better state management between tests.
packages/core/src/animation/internal/AnimatorStatePlayData.ts - Renamed isForwards property to isForward and updated related methods.
- Removed initialization of currentTransitionIndex and added a reset for _needReset.
packages/core/src/animation/internal/AnimatorLayerData.ts - Removed anyTransitionIndex property, simplifying the class structure.
packages/core/src/animation/AnimatorStateMachine.ts - Updated accessors for entryTransitions and anyStateTransitions to return the transitions property instead of the _transitions property.

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

🐇 In the world of animation, we leap and bound,
With fixed times in place, our transitions are sound.
No more variable woes, just smooth, steady flow,
Animator's magic, watch our movements glow!
Hops and skips, in perfect sync,
With each little change, we make the world blink! ✨


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://coderabbit.ai/docs) 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 92.42424% with 15 lines in your changes missing coverage. Please review.

Project coverage is 66.66%. Comparing base (a7b36ad) to head (ad15b18). Report is 1 commits behind head on dev/1.4.

Files with missing lines Patch % Lines
...src/animation/AnimatorStateTransitionCollection.ts 78.57% 9 Missing :warning:
packages/core/src/animation/Animator.ts 97.56% 3 Missing :warning:
...ackages/core/src/animation/AnimatorStateMachine.ts 0.00% 2 Missing :warning:
packages/core/src/animation/AnimatorState.ts 94.44% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev/1.4 #2392 +/- ## =========================================== - Coverage 67.08% 66.66% -0.42% =========================================== Files 895 895 Lines 92064 92090 +26 Branches 7257 7272 +15 =========================================== - Hits 61761 61392 -369 - Misses 30058 30453 +395 Partials 245 245 ``` | [Flag](https://app.codecov.io/gh/galacean/engine/pull/2392/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/2392/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | `66.66% <92.42%> (-0.42%)` | :arrow_down: | 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.