search

galacean / engine

A typescript interactive engine, support 2D, 3D, animation, physics, built on WebGL and glTF.
https://www.galacean.com/engine
MIT License
4.29k stars 307 forks source link

Refactor: extract some methods of the 2D renderers from the Engine #2391

Closed eyworldwide closed 2 months ago

eyworldwide commented 2 months ago

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Extract some methods of the 2D renderers from the Engine. The code of Engine should be clean!

Just like this._textDefaultFont is implemented through Font.createFromOS, it would be more reasonable for _spriteDefaultMaterial to be implemented through the static method of its renderer class.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several static methods for creating materials in the SpriteMask, SpriteRenderer, and TextRenderer classes. These methods configure materials for sprite masking, sprite rendering, and text rendering, respectively. The Engine class has been updated to utilize these new methods, centralizing material creation and removing its previous material-related methods. Additionally, changes were made to the MaskManager, RenderQueue, and other components to enhance stencil state management and rendering processes.

Changes

Files Change Summary
packages/core/src/2d/sprite/SpriteMask.ts Added static method _createSpriteMaskMaterial to create a material for sprite masking.
packages/core/src/2d/sprite/SpriteRenderer.ts Added static method _createSpriteMaterial to create a material for rendering sprites with blending.
packages/core/src/2d/text/TextRenderer.ts Added static method _createTextMaterial to create a material specifically for rendering text.
packages/core/src/Engine.ts Updated imports and refactored to use new static methods for material creation; removed old material methods.
packages/core/src/RenderPipeline/MaskManager.ts Renamed properties for encapsulation, added methods for drawing and clearing masks, and updated logic for mask management.
packages/core/src/RenderPipeline/RenderQueue.ts Introduced new static properties and methods for handling stencil states and mask interactions.
packages/core/src/enums/SpriteMaskLayer.ts Added new enum value Nothing to represent a "None mask layer."
packages/core/src/index.ts Exported SpriteMaskLayer enum from the ./enums/SpriteMaskLayer module.
packages/core/src/shader/state/RenderState.ts Updated constructor to include an optional customStencilStates parameter.
packages/core/src/shader/state/StencilState.ts Enhanced _apply and _platformApply methods to accept custom states for more flexible stencil management.

Possibly related PRs

Suggested labels

enhancement, medium priority, animation

Suggested reviewers

Poem

🐰 In a world of sprites and text so bright,
New materials crafted, a coder's delight!
With shaders and states, they dance and play,
In the realm of rendering, they lead the way.
Hooray for the changes, let the pixels gleam,
A hop and a skip, we’re living the dream! 🌟

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?

:heart: 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)
:placard: 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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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.
codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 54.07407% with 62 lines in your changes missing coverage. Please review.

Please upload report for BASE (dev/1.4@afb7423). Learn more about missing BASE report.

Files with missing lines Patch % Lines
packages/core/src/RenderPipeline/MaskManager.ts 33.33% 28 Missing :warning:
packages/core/src/shader/state/StencilState.ts 19.04% 17 Missing :warning:
packages/core/src/RenderPipeline/RenderQueue.ts 44.82% 16 Missing :warning:
packages/core/src/2d/sprite/SpriteRenderer.ts 93.33% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev/1.4 #2391 +/- ## ========================================== Coverage ? 74.97% ========================================== Files ? 524 Lines ? 27424 Branches ? 4132 ========================================== Hits ? 20560 Misses ? 6829 Partials ? 35 ``` | [Flag](https://app.codecov.io/gh/galacean/engine/pull/2391/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | Coverage Ξ” | | |---|---|---| | [unittests](https://app.codecov.io/gh/galacean/engine/pull/2391/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | `74.97% <54.07%> (?)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

eyworldwide commented 2 months ago

see: https://github.com/singlecoder/engine/pull/15