galacean / effects-runtime

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

feat: add sub composition track #411

Closed wumaolinmaoan closed 4 months ago

wumaolinmaoan commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates to the effects-core package introduce significant enhancements and refactoring across multiple files. Key changes include the addition of new methods for handling reusable components, the introduction of sub-composition tracks and playables, and the removal or modification of obsolete methods and interfaces. These updates aim to streamline the handling of compositions and tracks, improve the modularity of the code, and enhance the overall functionality of the package.

Changes

File(s) Summary of Changes
.../comp-vfx-item.ts Removed masterTracks, added setReusable, getReusable, and new binding methods.
.../fallback/migration.ts Enhanced convertTimelineAsset to handle ItemType.composition with new sub-composition and track structures.
.../plugins/cal/calculate-item.ts Removed CalculateItemOptions interface, integrated properties directly into ObjectBindingTrack class.
.../plugins/index.ts Added exports for sub-composition-track and sub-composition-playable-asset.
.../plugins/sprite/sprite-item.ts Removed CalculateItemOptions import, modified SpriteItemOptions type.
.../timeline/playables/sub-composition-clip-playable.ts Introduced SubCompositionClipPlayable class with processFrame method.
.../timeline/playables/sub-composition-playable-asset.ts Introduced SubCompositionPlayableAsset class with createPlayable method.
.../timeline/track.ts Refactored initializeBinding to resolveBinding, removed createTrackMixer method.
.../timeline/tracks/activation-track.ts Removed initializeBinding method.
.../timeline/tracks/sub-composition-track.ts Introduced SubCompositionTrack class with resolveBinding method.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant CompositionComponent
    participant SubCompositionTrack
    participant SubCompositionClipPlayable
    participant PlayableGraph

    User->>CompositionComponent: Call setReusable(true)
    CompositionComponent->>SubCompositionTrack: Initialize track bindings
    SubCompositionTrack->>SubCompositionClipPlayable: Create playable
    SubCompositionClipPlayable->>PlayableGraph: Add to graph
    PlayableGraph->>CompositionComponent: Update time
    CompositionComponent->>User: Return updated state

Poem

In the realm of code so bright,
New methods bring the light,
Tracks and playables now align,
Composition flows just fine.
A rabbit hops with glee,
For changes set us free,
To build with harmony. 🐇✨


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 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. 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.