AnimatorStateTransition support fixedDuration

[luzhuang]

Please check if the PR fulfills these requirements

• The commit message follows our guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

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

• New Features

  • Introduced fixed duration transitions for animations, allowing for more precise control.
  • Added methods for playing animations with fixed time offsets.
  • Enhanced transition logic for cross-fades with fixed durations.

• Bug Fixes

  • Improved handling of transition durations to support both fixed and normalized timings.

• Tests

  • Added new test cases to validate fixed duration transitions and animator behavior during playback and cross-fading.

[coderabbitai]

Walkthrough

The changes enhance the animation system by improving the management of animation playback and transitions in the Animator class. Key modifications include the introduction of private methods for handling both normalized and fixed time offsets in the play and crossFade methods. The AnimatorStateTransition class has been updated to streamline property initialization and introduce a new property for fixed duration transitions. Overall, these changes aim to improve code clarity and maintainability while expanding the functionality of the animation system.

Changes

Files	Change Summary
packages/core/src/animation/Animator.ts	Refactored play and crossFade methods; added _play and _crossFade private methods; introduced crossFadeInFixedDuration method for fixed duration transitions.
packages/core/src/animation/AnimatorStateTransition.ts	Streamlined property initialization and added isFixedDuration property; introduced _getFixedDuration method for calculating effective duration based on the new property.
tests/src/core/Animator.test.ts	Added tests for cross fade in fixed time and fixedDuration to validate new animator functionalities and ensure correct behavior during transitions.

Possibly related PRs

• Add hasExitTime and fix error when set state startTime and transition duration is 0 #2359: This PR modifies the Animator class and the AnimatorStateTransition class, both of which are directly related to the changes made in the main PR regarding animation transitions and state management.
• Support trigger type AnimatorControllerParameter #2374: This PR introduces enhancements to the Animator class, specifically in managing animation triggers, which may interact with the transition logic improved in the main PR.

🐇 In the meadow where animations play,
New features hop in a joyful ballet.
Cross-fades now dance with fixed duration,
Triggers and states in sweet celebration.
With tests to ensure each leap is true,
Our Animator's magic shines bright and new! 🌟

Tip

OpenAI O1 model for chat

• We have deployed OpenAI's latest O1 model for chat.
• OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
• Please share any feedback with us in the discussions post.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2f6708c and 7183a07.

Files selected for processing (3)

• packages/core/src/animation/Animator.ts (9 hunks)
• packages/core/src/animation/AnimatorStateTransition.ts (2 hunks)
• tests/src/core/Animator.test.ts (2 hunks)

Files skipped from review as they are similar to previous changes (3)

• packages/core/src/animation/Animator.ts
• packages/core/src/animation/AnimatorStateTransition.ts
• tests/src/core/Animator.test.ts

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.