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: integrate imgui for runtime debugging #437

Closed wumaolinmaoan closed 1 month ago

wumaolinmaoan commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes introduce significant enhancements and new functionalities across various modules. Key updates involve the addition of classes for managing projects, previews, and assets, alongside improvements to GUI components and the particle system. This release also includes refined shader sources and better configuration management for the imgui-demo package, ensuring a robust development environment.

Changes

File(s) Change Summary
src/panels/preview.ts, src/panels/project.ts Added Preview and Project classes with methods for preview display and project management.
src/core/asset-data-base.ts Introduced AssetDatabase class for asset management and added related methods.
src/panels/editor.ts Enhanced Editor class with new properties and methods for GUI rendering and management.
src/fallback/migration.ts Removed startColor from the convertTimelineAsset function.
src/plugins/particle/particle-system.ts Introduced an onAttached method in ParticleSystem for initialization logic.
src/serialization-helper.ts Changed deserializeProperty to asynchronous deserializePropertyAsync.
src/vfx-item.ts Modified endBehavior property type in the VFXItem class.
src/gltf/json-converter.ts Added error suppression for sceneJSON.textures initialization.
src/runtime/shader-libs/standard-shader-source.ts Standardized GLSL file naming conventions.
package.json Updated with new scripts and dependencies for Vite and various plugins.
src/imgui/index.ts Exported ImGui and ImGui_Impl components.
tsconfig.json Updated to extend tsconfig.base.json and include necessary directories.
vite.config.js Added configuration settings for Vite.
src/core/selection.ts Added Selection class for managing active object selection.
src/ge.ts Introduced GalaceanEffects class for rendering effects management.
src/panels/composition-window.ts Added CompositionWindow class for composition management.
src/panels/sequencer.ts Introduced Sequencer class for editing tracks and clips within compositions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Preview
    participant Project
    participant AssetDatabase

    User->>Preview: showWindow()
    Preview->>AssetDatabase: createPreviewPlayer()
    Preview->>User: Render Preview

    User->>Project: showWindow()
    Project->>AssetDatabase: handleDroppedFiles(files)
    AssetDatabase->>Project: File data processed

    User->>Sequencer: showWindow()
    Sequencer->>GalaceanEffects: drawTrack()
    Sequencer->>User: Display tracks and clips

Poem

In the land of code, where features grow,
New windows and previews for all to show.
Assets managed with care, projects in tow,
With particle systems in a synchronized flow.
From configs to shaders, the changes glow,
A rabbit’s joy, in every line and row. πŸ’»βœ¨πŸ‡


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.