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 post process #524

Closed wumaolinmaoan closed 2 months ago

wumaolinmaoan commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes enhance the structure and maintainability of the codebase by refining the management of post-processing volumes and editor functionalities. Key updates simplify property handling, introduce new editor interfaces, and improve modularity through organized exports and the removal of redundant code. This comprehensive refactoring sets a solid foundation for future development and feature expansion.

Changes

Files Change Summary
.../post-process-volume.ts Simplified the PostProcessVolume class by consolidating globalVolume properties and removing the update method for better maintainability.
.../composition.ts Updated globalVolume type from PostProcessVolumeData to PostProcessVolume, aligning with the new design.
.../render/render-frame.ts Changed globalVolume type from Partial<PostProcessVolumeData> to PostProcessVolume, ensuring consistency across the interface and class.
.../shader/post-processing/color-grading.frag.glsl Minor formatting changes to comments, improving readability without impacting functionality.
.../shader/post-processing/threshold.frag.glsl Variable mainColor renamed to mainTex, with additional multiplication using the alpha channel to enhance texture rendering.
.../gl-material.ts Removed conditional assignments for blending and depth properties, simplifying the GLMaterial class initialization.
.../core/asset-data-base.ts Commented out a line related to guid, maintaining logic for processing assets but removing unused functionality.
.../core/decorators.ts Completely removed editorWindow decorator and related store, simplifying the code and removing extraneous functionality.
.../core/ui-manager.ts Renamed static property from panels to editorWindows, altering initialization and retrieval logic for editor window instances.
.../custom-editors/index.ts Introduced a new file to re-export post-process-volume-editor, streamlining imports.
.../custom-editors/post-process-volume-editor.ts Defined PostProcessVolumeEditor class for custom editor interface, currently with no GUI rendering implementation.
.../ge.ts Added PostProcessVolume to composition.rootItem during scene loading, enhancing rendering capabilities.
.../main.ts Imported new ./custom-editors module, extending application functionality.
.../panels/composition.ts Renamed CompositionWindow to Composition for clarity, updating instantiation methods accordingly.
.../panels/editor-window.ts Enhanced EditorWindow class and added editorWindowStore, improving class registration functionality.
.../panels/editor.ts Refactored Editor class by removing inheritance from EditorWindow, introducing a flexible editorStore for component registration.
.../panels/index.ts Reorganized exports, changing composition-window to composition and repositioning other exports for clarity.
.../panels/main-editor.ts Defined MainEditor class for managing visual effects in a scene, utilizing ImGui for various panels.
.../panels/preview.ts Modified imports to streamline the usage of decorators within the file.
.../panels/project.ts Enhanced file handling in handleDroppedFiles with a switch statement and added a new refresh method for better structure.
.../panels/sequencer.ts Adjusted imports similarly to preview.ts, consolidating dependencies.
.../widgets/widget.ts Introduced Widget class with an empty draw method, laying groundwork for future UI component development.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EditorUI
    participant PostProcessVolume
    participant SceneManager

    User->>EditorUI: Open Editor
    EditorUI->>PostProcessVolume: Configure Effects
    PostProcessVolume->>SceneManager: Update Scene with Post-Processing
    SceneManager-->>User: Render Updated Scene

🐇 In fields of code, so bright and clear,
A rabbit hops with joyful cheer.
With editor changes, oh what a sight,
Post-processing shines, the future looks bright!
So let us code, with all our might,
For every change, brings new delight!


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.