Support trigger type `AnimatorControllerParameter` #2374

luzhuang · 2024-09-11T07:42:43Z

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
- Enhanced animation state management with new methods: activateTriggerParameter and deactivateTriggerParameter.
- Improved parameter management in the animator controller with the addition of clearParameters functionality and refined parameter handling.
- Updated condition management in animator state transitions for better usability.
Bug Fixes
- Simplified transition timing calculations for better animator behavior during state transitions.
Tests
- Added new test cases for setTriggerParameter to validate animator transitions and parameter handling.
- Adjusted test cases to reflect changes in parameter order for improved clarity.

… is 0

…to feat/animatorTransition

…rigger

coderabbitai · 2024-09-11T07:42:54Z

Warning

Rate limit exceeded

@luzhuang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 37 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 for further information.

Commits

Files that changed from the base of the PR and between a91acf6 and 5fe1685.

Walkthrough

This pull request enhances the animation system by improving the management of animation trigger parameters within the Animator class. Key updates include the introduction of methods for activating and deactivating trigger parameters, a new private property to track active triggers, and refined internal logic for managing animation states. Additionally, the AnimatorController class has been updated to better handle parameter management, including a method for clearing parameters. Corresponding tests have been added to validate these functionalities, ensuring proper behavior during state transitions.

Changes

File	Change Summary
`packages/core/src/animation/Animator.ts`	Added private property `_tempTriggeredParametersName`, added `activateTriggerParameter` and `deactivateTriggerParameter` methods, and introduced `_resetTriggerParameters` method.
`packages/core/src/animation/AnimatorController.ts`	Refactored `addParameter` method to include `isTrigger` parameter and added `clearParameters` method.
`packages/core/src/animation/AnimatorStateTransition.ts`	Modified `addCondition` method's parameter structure for improved clarity and flexibility.
`packages/loader/src/AnimatorControllerLoader.ts`	Enhanced parameter addition logic to distinguish between regular and trigger parameters.
`tests/src/core/Animator.test.ts`	Updated parameter order in `addCondition` calls and added new test case `setTriggerParameter`.

Possibly related PRs

Add hasExitTime and fix error when set state startTime and transition duration is 0 #2359: The changes in the Animator class involve enhancements to state transitions, aligning with the main PR's focus on improving animation trigger parameters and state management.

Poem

🐰 In the meadow where the bunnies play,
New triggers hop in a joyful sway.
With every leap, animations sing,
A dance of joy that changes bring.
So let us celebrate with a happy cheer,
For the Animator's magic is finally here! 🎉

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

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.

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cadfe28 and e65a3d8.

Files selected for processing (2)

packages/core/src/animation/Animator.ts (7 hunks)
tests/src/core/Animator.test.ts (1 hunks)

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

tests/src/core/Animator.test.ts

Additional comments not posted (4)

packages/core/src/animation/Animator.ts (4)

62-63: LGTM!

The new private property _tempTriggerParametersName is properly declared and annotated.

259-270: LGTM!

The new setTrigger method is properly implemented with necessary checks and side effects. The JSDoc comments are also present.

272-282: LGTM!

The new resetTrigger method is properly implemented with necessary checks. The JSDoc comments are also present.

1549-1553: LGTM!

The new private method _resetTriggerParameters is properly implemented to reset temporary trigger parameters. Its usage in the update method is also correct.

packages/core/src/animation/Animator.ts

GuoLei1990 · 2024-09-12T11:56:51Z

packages/core/src/animation/AnimatorController.ts


+  /**
+   * Clear parameters.
+   */


Opt comments

packages/core/src/animation/AnimatorStateTransition.ts

luzhuang added 11 commits August 16, 2024 10:45

fix: animation error when set state startTime and transition duration…

0a2b927

… is 0

test: add ut

3f8e950

feat: opt comment

58f4e03

feat: add hasExitTime, fixedDuration, setTrigger

4bff236

feat: opt code

c4ba1e3

Merge commit refs/pull/2337/head of github.com:oasis-engine/engine in…

9e9d6da

…to feat/animatorTransition

feat: opt code

5a4243b

test: add ut

2618b14

feat: opt code

0dce44f

feat: update animatorController loader

bcca797

Merge branch dev/1.4 of github.com:oasis-engine/engine into feat/setT…

cadfe28

…rigger

luzhuang added the Animation Built-in animation system related functions label Sep 11, 2024

luzhuang requested a review from GuoLei1990 September 11, 2024 07:42

luzhuang assigned GuoLei1990 Sep 11, 2024

coderabbitai bot reviewed Sep 11, 2024

View reviewed changes

packages/core/src/animation/Animator.ts Outdated Show resolved Hide resolved

refactor: opt code

b2bdeed

luzhuang force-pushed the feat/setTrigger branch from e65a3d8 to b2bdeed Compare September 11, 2024 07:56

refactor: opt code

53aa081

GuoLei1990 added the enhancement New feature or request label Sep 12, 2024

GuoLei1990 added this to the 1.4 milestone Sep 12, 2024

GuoLei1990 reviewed Sep 12, 2024

View reviewed changes

packages/core/src/animation/Animator.ts Outdated Show resolved Hide resolved

luzhuang added 2 commits September 12, 2024 18:12

refactor: opt code

a1572ee

refactor: opt code

96afdef

GuoLei1990 reviewed Sep 12, 2024

View reviewed changes

packages/core/src/animation/Animator.ts Outdated Show resolved Hide resolved

GuoLei1990 reviewed Sep 12, 2024

View reviewed changes

packages/core/src/animation/Animator.ts Outdated Show resolved Hide resolved

packages/core/src/animation/Animator.ts Outdated Show resolved Hide resolved

luzhuang added 4 commits September 12, 2024 18:39

refactor: opt code

161cf71

refactor: opt code

1609bc2

refactor: opt code

8f57a08

refactor: opt code

75a74e7

luzhuang added 3 commits September 12, 2024 19:17

refactor: opt code

f576796

refactor: opt code

ce34b21

refactor: opt code

33c0775

GuoLei1990 reviewed Sep 12, 2024

View reviewed changes

packages/core/src/animation/Animator.ts Show resolved Hide resolved

GuoLei1990 reviewed Sep 12, 2024

View reviewed changes

packages/core/src/animation/Animator.ts Outdated Show resolved Hide resolved

refactor: opt code

a91acf6

GuoLei1990 reviewed Sep 12, 2024

View reviewed changes

packages/core/src/animation/Animator.ts Outdated Show resolved Hide resolved

GuoLei1990 reviewed Sep 12, 2024

View reviewed changes

packages/core/src/animation/AnimatorController.ts

/**

* Clear parameters.

*/

Copy link

Member

GuoLei1990 Sep 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opt comments

GuoLei1990 reviewed Sep 12, 2024

View reviewed changes

packages/core/src/animation/AnimatorStateTransition.ts Outdated Show resolved Hide resolved

luzhuang added 2 commits September 12, 2024 20:05

refactor: opt code

b7f4305

refactor: opt code

5fe1685

GuoLei1990 changed the title ~~AnimatorControllerParameter add trigger type~~ Support trigger type AnimatorControllerParameter Sep 12, 2024

GuoLei1990 merged commit ac4a3d2 into galacean:dev/1.4 Sep 12, 2024

coderabbitai bot mentioned this pull request Sep 13, 2024

AnimatorStateTransition support fixedDuration #2377

Merged

3 tasks

coderabbitai bot mentioned this pull request Sep 20, 2024

Fix animate property is not effect when reference changed #2383

Closed

3 tasks

coderabbitai bot mentioned this pull request Nov 12, 2024

doc: opt animator doc #2432

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Support trigger type `AnimatorControllerParameter` #2374

Support trigger type `AnimatorControllerParameter` #2374

Uh oh!

luzhuang commented Sep 11, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 11, 2024 •

edited

Loading

Rate limit exceeded

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GuoLei1990 Sep 12, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Support trigger type AnimatorControllerParameter #2374

Support trigger type AnimatorControllerParameter #2374

Uh oh!

Conversation

luzhuang commented Sep 11, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

Uh oh!

coderabbitai bot commented Sep 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Possibly related PRs

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GuoLei1990 Sep 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Support trigger type `AnimatorControllerParameter` #2374

Support trigger type `AnimatorControllerParameter` #2374

luzhuang commented Sep 11, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 11, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)