galacean / effects-runtime

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

chore: 增加渲染等级示例并移除 composition 上的 renderLevel #419

Closed yiiqii closed 4 months ago

yiiqii commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent changes across multiple files primarily focus on refining the handling of rendering levels within the effects-core and related packages. Key modifications include the removal of the renderLevel property from the Composition class, updates to type declarations to use specific enums, and enhancements to the type safety and conditional checks within various classes. Additionally, a new demo page for hierarchical rendering has been introduced.

Changes

Files/Paths Change Summary
packages/effects-core/src/composition.ts Removed the renderLevel property and adjusted destructuring assignments.
packages/effects/src/player.ts Updated condition to check opts.renderLevel instead of composition.renderLevel.
.../sub-composition-clip-playable.ts Added a check for boundObject existence before setting its time property.
packages/effects-core/src/asset-manager.ts Updated SceneType declaration to include SceneRenderLevel instead of string.
.../composition-source-manager.ts Changed type of renderLevel to SceneRenderLevel.
.../pass-render-level.ts Updated to use SceneRenderLevel and spec.RenderLevel instead of strings.
.../calculate-vfx-item.ts Enhanced type safety by checking the type of bound objects before certain operations.
.../particle/particle-system.ts Changed renderLevel property's type from string to spec.RenderLevel.
.../particle/particle-vfx-item.ts Refactored variable names and conditions for better clarity and type safety.
.../sprite/sprite-item.ts Updated usage of VFXItem to a direct import and adjusted property access.
.../activation-mixer-playable.ts Refactored logic related to bindingItem and boundObject for better transformation validity handling.
packages/effects-core/src/scene.ts Changed renderLevel property in Scene interface to use SceneRenderLevel.
packages/effects-core/src/utils/index.ts Added a new type PickEnum for picking keys from an enum type.
plugin-packages/alipay-downgrade/src/utils.ts Updated import and return types to use SceneRenderLevel.
web-packages/demo/html/render-level.html Introduced a new HTML file for a demo page on hierarchical rendering.
web-packages/demo/index.html Added a new list item linking to the render-level.html demo page.
web-packages/demo/src/render-level.ts Added functionality for rendering scenes with different levels of detail using a player component.

Poem

In the code where levels blend and play,
We’ve made some changes to clear the way.
Render levels now precise and neat,
Ensuring scenes are quite the treat.
With demos new and checks refined,
Our code’s more robust, well-defined.
🎨✨


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.