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

gltf iridescence #2424

Closed hhhhkrx closed 2 weeks ago

hhhhkrx commented 2 weeks ago

Please check if the PR fulfills these requirements

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

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes in this pull request introduce enhancements to the PBRMaterial class for managing iridescence effects, including new properties and methods for iridescence settings. Additionally, the IKHRMaterialsClearcoat interface is modified to make its properties optional, while a new interface IKHRMaterialsIridescence is added. A new class for handling iridescence in GLTF materials is introduced, along with updates to the shader node handling for improved property serialization.

Changes

File Path Change Summary
packages/core/src/material/PBRMaterial.ts Added new properties and getters/setters for iridescence effects; updated constructor for defaults.
packages/loader/src/gltf/extensions/GLTFExtensionSchema.ts Changed properties of IKHRMaterialsClearcoat to optional; added new interface IKHRMaterialsIridescence. Updated GLTFExtensionSchema type.
packages/loader/src/gltf/extensions/KHR_materials_iridescence.ts Introduced KHR_materials_iridescence class for handling iridescence properties in GLTF materials.
packages/loader/src/gltf/extensions/index.ts Added import for KHR_materials_iridescence.
packages/shader-lab/src/ast-node/AstNode.ts Modified FnVariableAstNode for improved property list handling and serialization.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PBRMaterial
    participant GLTFExtensionParser
    participant KHR_materials_iridescence

    User->>PBRMaterial: Set iridescence properties
    PBRMaterial->>PBRMaterial: Update shader data
    PBRMaterial->>GLTFExtensionParser: Parse iridescence properties
    GLTFExtensionParser->>KHR_materials_iridescence: Handle iridescence properties
    KHR_materials_iridescence->>PBRMaterial: Set properties

🐰 "In the world of shaders, bright and bold,
New iridescence properties, a sight to behold!
With textures and factors, they dance and play,
Enhancing our materials in a magical way.
Hooray for the changes, let colors ignite,
A shimmering future, oh what a 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 , 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](http://discord.gg/coderabbit) 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 weeks ago

Codecov Report

Attention: Patch coverage is 44.75138% with 100 lines in your changes missing coverage. Please review.

Project coverage is 66.73%. Comparing base (35f10e2) to head (0be9f2a). Report is 5 commits behind head on dev/1.4.

Files with missing lines Patch % Lines
packages/core/src/material/PBRMaterial.ts 43.80% 68 Missing :warning:
...r/src/gltf/extensions/KHR_materials_iridescence.ts 27.50% 29 Missing :warning:
...ges/core/src/RenderPipeline/BasicRenderPipeline.ts 25.00% 3 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev/1.4 #2424 +/- ## =========================================== - Coverage 67.22% 66.73% -0.50% =========================================== Files 895 896 +1 Lines 92094 92260 +166 Branches 7309 7312 +3 =========================================== - Hits 61912 61566 -346 - Misses 29937 30449 +512 Partials 245 245 ``` | [Flag](https://app.codecov.io/gh/galacean/engine/pull/2424/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/2424/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=galacean) | `66.73% <44.75%> (-0.50%)` | :arrow_down: | 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.