search

galacean / engine

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

doc: opt animator doc #2432

Open luzhuang opened 2 weeks ago

luzhuang commented 2 weeks 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 2 weeks ago

Walkthrough

The pull request introduces significant updates to the animation documentation in Chinese, including new files and revisions for clarity and consistency. Key changes include the addition of a JSON object in the _meta.json file, the introduction of new tutorial documents for animation blending, control by input, and sprite animations, as well as extensive terminology updates across existing documentation to ensure uniformity in the translation of animation-related terms.

Changes

File Path Change Summary
docs/zh/animation/_meta.json Added new JSON object: {"examples": {"title": "指南和示例"}}
docs/zh/animation/animator.mdx Replaced "Animator" with "动画控制组件" and "AnimatorController" with "动画控制器" throughout. Updated sections for consistency.
docs/zh/animation/animatorController.mdx Added "简介" section and reformatted text for clarity. Introduced subsections detailing main components.
docs/zh/animation/clip-for-artist.md Expanded Unity section with detailed steps for creating and exporting animation clips.
docs/zh/animation/clip.mdx Enhanced clarity and consistency in terminology related to the animation system.
docs/zh/animation/examples/blending.mdx New document for multi-layer animation blending with step-by-step instructions.
docs/zh/animation/examples/controlAnimationByInput.mdx New tutorial on controlling animations via user input with detailed setup instructions.
docs/zh/animation/examples/crossFade.mdx New document outlining animation transitions with practical examples.
docs/zh/animation/examples/playAnimation.mdx New guide for playing animations in models, including detailed import and playback instructions.
docs/zh/animation/examples/reuseAnimation.mdx New document for reusing animations from one model on another with comprehensive steps.
docs/zh/animation/examples/sprite-sheet.mdx New guide for implementing 2D frame animations with detailed instructions and visuals.
docs/zh/animation/layer.mdx Updated terminology and expanded properties section for clarity.
docs/zh/animation/state-machine.mdx Updated terminology and improved descriptions of animation states and transitions.
docs/zh/animation/system.md Minor terminology update for "Animator" and reorganization of document order.
docs/zh/animation/sprite-sheet.md Deleted file containing outdated documentation on sprite animations.

Suggested labels

enhancement

Suggested reviewers

🐇 In the land of hops and bounds,
New guides and terms abound,
Animations dance with glee,
Clarity for all to see!
With layers and blends so bright,
Our docs now shine with light! ✨

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 0d8394a08b3c8db59fb0cada6521f725c764c6a3 and 2766a6c4e71193c9ff1cc74de000ede63893a8f0.
📒 Files selected for processing (2) * `docs/zh/animation/examples/material-animation.mdx` (1 hunks) * `docs/zh/animation/examples/sprite-sheet.mdx` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2) * docs/zh/animation/examples/material-animation.mdx * docs/zh/animation/examples/sprite-sheet.mdx

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 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 70.78%. Comparing base (2b89197) to head (2766a6c). Report is 12 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2432 +/- ## ========================================== + Coverage 69.41% 70.78% +1.37% ========================================== Files 524 524 Lines 27480 27487 +7 Branches 4111 4111 ========================================== + Hits 19075 19457 +382 + Misses 6900 6477 -423 - Partials 1505 1553 +48 ``` | [Flag](https://app.codecov.io/gh/galacean/engine/pull/2432/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/2432/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | `70.78% <ø> (+1.37%)` | :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.

🚨 Try these New Features: