galacean / effects-runtime

It can load and render cool animation effects
https://galacean.antgroup.com/effects/
MIT License
324 stars 8 forks source link

perf: opt playable create #375

Closed wumaolinmaoan closed 4 months ago

wumaolinmaoan commented 4 months ago

Summary by CodeRabbit

Release Notes

These updates enhance the overall functionality and performance of the animation and effects systems, providing a more robust and flexible framework for end-users.

coderabbitai[bot] commented 4 months ago

Walkthrough

The updates primarily enhance the effects-core package by upgrading dependencies, refining class constructors, and improving method signatures to incorporate the PlayableGraph component. Key changes involve removing TypeScript error suppression comments, refining the handling of animations, and adding new methods and properties to improve the functionality of playables and their graphs. Additionally, similar updates are applied to several plugins to ensure compatibility with the new PlayableGraph structure.

Changes

Files/Paths Change Summary
packages/effects-core/package.json Updated dependency @galacean/effects-specification from 2.0.0-alpha.12 to 2.0.0-alpha.14.
.../src/comp-vfx-item.ts Added import for PlayableGraph and modified visibility and initialization of several properties.
.../src/engine.ts Removed //@ts-expect-error comments related to jsonScene.animations.
.../src/fallback/migration.ts Added animations array to jsonScene and removed unnecessary ts-expect-error comments.
.../src/plugins/cal/animation-playable.ts Constructor of AnimationPlayable now accepts a PlayableGraph parameter.
.../src/plugins/cal/calculate-vfx-item.ts Added import for PlayableGraph and modified createPlayable methods to accept PlayableGraph parameter.
.../src/plugins/cal/playable-graph.ts Added addPlayable method, introduced new properties, and enhanced several methods in PlayableGraph and Playable classes.
.../src/plugins/cal/timeline-asset.ts Modified createPlayable method to accept PlayableGraph parameter and updated method implementations accordingly.
.../src/plugins/cal/track.ts Modified method signatures and implementations to include PlayableGraph parameter.
.../src/plugins/particle/particle-vfx-item.ts Added import for PlayableGraph and modified createPlayable method to accept PlayableGraph parameter.
.../src/plugins/sprite/sprite-item.ts Modified createPlayable method in SpriteColorPlayableAsset to accept PlayableGraph parameter.
plugin-packages/model/src/gltf/loader-ecs.ts Added animations array to the object being returned in LoaderECSImpl class.
plugin-packages/model/src/plugin/model-item.ts Added //@ts-expect-error comment before calling clipObj.fromData(clipData) in ModelAnimationComponent class.

In code's embrace, the graphs now play, With animations bright as day. Errors cleared, the paths refined, New methods, properties aligned. From sprites to particles, all in sync, A symphony of changes, in code's ink. The rabbit hops, with joy it sings, For in this update, magic springs.


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 .` - `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 as 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 full the 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.