galacean / effects-runtime

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

feat: 增加合成和 Spine 元素接口 #432

Closed RGCHN closed 2 months ago

RGCHN commented 2 months ago
  1. 增加 Spine 动画播放接口 setAnimationListLoopEnd
  2. 增加 Composition 上交互响应属性

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The recent updates introduce a new interactive property to the Composition class, enabling control over click and drag interactions within compositions. Additionally, changes in error handling, import reorganization, and enhancements to animation handling in SpineVFXItem are included. Various updates to data structures, method parameters and improved logic also occurred, impacting how interactions and animations are managed across different components.

Changes

File Path Summary of Changes
packages/effects-core/src/composition.ts Added an interactive property to Composition with supporting logic changes, introduced CompItemClickedData, and updated CompositionProps and the hitTest method.
packages/.../event-system.ts Reordered imports and added error handling in getTouchEventValue method.
packages/.../interact-vfx-item.ts Reordered imports, added conditional checks for interactive, and reorganized types.
packages/.../click-handler.ts Made hitPositions a mandatory field within the Region type.
plugin-packages/spine/src/spine-vfx-item.ts Introduced methods for enhanced animation control and error handling, including setAnimationListLoopEnd and getAnimationState.
packages/effects/src/player.ts Updated ItemClickedData interface structure and adjusted handleItemClicked method.
web-packages/demo/src/single.ts Modified scene loading logic to introduce a new variable assignment for the loaded scene.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Player
    participant Composition
    participant SpineVFXItem

    User->>Player: Invoke loadScene()
    Player->>Composition: Load and initialize components
    Composition-->>Player: Components ready

    User->>Composition: Click event
    Composition->>Composition: Check interactive property
    alt is interactive
        Composition->>Player: Handle click interaction
    end

    User->>SpineVFXItem: Set Animation List Loop End
    SpineVFXItem->>SpineVFXItem: Verify Skeleton and animationList
    alt Valid conditions
        SpineVFXItem->>SpineVFXItem: Set animations with loop end
    else Invalid conditions
        SpineVFXItem->>User: Return error message
    end

Poem

In the realm of code so grand, Compositions now take a stand. Interactive clicks abound, Errors deftly handled round. Animations loop with grace, Each component in its place. With every change, our software grows, Like a rabbit hopping, code overflows. 🐇


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.