search

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 imgui inspector #567

Closed wumaolinmaoan closed 1 month ago

wumaolinmaoan commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes enhance type safety and streamline component management across various modules. Key updates include redefining class hierarchies to utilize a more generalized Behaviour class, implementing decorators for managing editors and inspectors, and adjusting rendering properties in WebGL components. These modifications refine interactions within the graphical user interface, promote modularity, and ensure a more maintainable codebase.

Changes

Files Change Summary
packages/effects-core/src/vfx-item.ts Changed endBehavior type to default to spec.EndBehavior.forward, enhancing type safety.
web-packages/imgui-demo/src/core/decorators.ts Introduced decorators for managing editor windows and object inspectors, including duplicate registration checks.
packages/effects-core/src/comp-vfx-item.ts, packages/effects-core/src/components/post-process-volume.ts, plugin-packages/model/src/plugin/model-item.ts, plugin-packages/model/src/plugin/model-plugin.ts, plugin-packages/model/src/plugin/model-tree-item.ts, plugin-packages/orientation-transformer/src/orientation-component.ts, plugin-packages/stats/src/stats-component.ts Classes modified to extend Behaviour instead of ItemBehaviour, reflecting a shift in hierarchy across multiple files.
packages/effects-core/src/components/component.ts Removed methods from Behaviour, altered access levels in ItemBehaviour, and reorganized lifecycle methods.
web-packages/demo/src/gui/inspector-gui.ts Updated imports to replace ItemBehaviour with Behaviour, adjusting type checks accordingly.
packages/effects-webgl/src/gl-material-state.ts Changed frontFace property from glContext.CW to glContext.CCW, altering the polygon winding order.
web-packages/test/unit/src/effects-webgl/gl-material.spec.ts Updated tests to align material.frontFace expectations with the new winding order configuration.
packages/effects-core/package.json Updated @galacean/effects-specification dependency version from "2.0.0-alpha.23" to "2.0.0-beta.0".

Sequence Diagram(s)

sequenceDiagram
    participant A as User
    participant B as Inspector
    participant C as UIManager
    participant D as ObjectInspector

    A->>B: Open Inspector
    B->>C: Request active object info
    C->>D: Fetch object properties
    D-->>C: Return object properties
    C-->>B: Return properties to Inspector
    B-->>A: Display properties

🐰 In the meadow where code does bloom,
Changes frolic, dispelling gloom.
New inspectors peek, and editors cheer,
Tidying up, making pathways clear!
With every click, a feature takes flight,
In the garden of code, everything's bright! 🌼✨

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