Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix Iridescence name #2489

Merged
merged 5 commits into from
Jan 7, 2025
Merged

fix Iridescence name #2489

merged 5 commits into from
Jan 7, 2025

Conversation

hhhhkrx
Copy link
Contributor

@hhhhkrx hhhhkrx commented Jan 7, 2025

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

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

  • New Features
    • Enhanced material cloning process to preserve the iridescenceThicknessRange property during duplication.

Copy link

coderabbitai bot commented Jan 7, 2025

Walkthrough

The pull request modifies the clone() method in the PBRMaterial class to enhance the cloning process. Specifically, it adds functionality to clone the iridescenceThicknessRange property from the source instance to the destination instance. This change ensures that when a new PBRMaterial instance is created by cloning an existing one, the iridescenceThicknessRange is preserved, maintaining the state of the original material.

Changes

File Change Summary
packages/core/src/material/PBRMaterial.ts Enhanced clone() method to include cloning of the iridescenceThicknessRange property.

Poem

🐰 In the land of shaders, a clone takes flight,
With iridescence added, oh what a sight!
Thickness preserved, in each new embrace,
A material's journey, full of grace!
Clone on, dear shader, your magic's delight! 🎨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 45daa7d and 28fa125.

📒 Files selected for processing (1)
  • packages/core/src/material/PBRMaterial.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/core/src/material/PBRMaterial.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build (22.x, windows-latest)
  • GitHub Check: codecov
  • GitHub Check: e2e (22.x)

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.90%. Comparing base (7fae92c) to head (cce2ff8).
Report is 8 commits behind head on dev/1.4.

Additional details and impacted files
@@             Coverage Diff             @@
##           dev/1.4    #2489      +/-   ##
===========================================
- Coverage    68.91%   68.90%   -0.02%     
===========================================
  Files          923      923              
  Lines        96043    96007      -36     
  Branches      8134     8141       +7     
===========================================
- Hits         66189    66149      -40     
- Misses       29601    29604       +3     
- Partials       253      254       +1     
Flag Coverage Δ
unittests 68.90% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 07c6475 and 41450f3.

⛔ Files ignored due to path filters (3)
  • packages/shader-shaderlab/src/shaders/shadingPBR/BRDF.glsl is excluded by !**/*.glsl
  • packages/shader-shaderlab/src/shaders/shadingPBR/FragmentPBR.glsl is excluded by !**/*.glsl
  • packages/shader-shaderlab/src/shaders/shadingPBR/LightIndirectPBR.glsl is excluded by !**/*.glsl
📒 Files selected for processing (1)
  • packages/core/src/material/PBRMaterial.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build (22.x, windows-latest)
  • GitHub Check: e2e (22.x)
  • GitHub Check: codecov
🔇 Additional comments (1)
packages/core/src/material/PBRMaterial.ts (1)

489-490: LGTM! Fixed the iridescence bug.

The implementation correctly clones both iridescenceThicknessRange and ior properties, which were previously missing. This fixes the iridescence bug by ensuring these properties are properly copied during material cloning.

Let's verify the property types and default values are consistent:

✅ Verification successful

Property types and defaults are consistent

The implementation correctly handles both properties:

  • IOR is properly implemented as a float with a standard default of 1.5
  • IridescenceThicknessRange is correctly implemented as Vector2 with documented defaults [100, 400]
  • Both properties are properly validated and cloned
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify property types and defaults
ast-grep --pattern 'class PBRMaterial {
  $$$
  private _iridescenceRange = new Vector2($_, $_);
  $$$
  shaderData.setFloat(PBRMaterial._iorProp, $_);
  $$$
}'

Length of output: 162


Script:

#!/bin/bash
# Search for iridescence and ior related properties with more flexible patterns
echo "=== Searching for iridescence thickness range property ==="
ast-grep --pattern 'iridescenceThicknessRange'

echo -e "\n=== Searching for ior property ==="
ast-grep --pattern 'private _ior'

# Backup search using ripgrep for more context
echo -e "\n=== Backup search with ripgrep ==="
rg "iridescenceThicknessRange|_ior" -A 2 -B 2

Length of output: 8366

packages/core/src/material/PBRMaterial.ts Outdated Show resolved Hide resolved
@hhhhkrx hhhhkrx added Rendering Rendering related functions shader Shader related functions material labels Jan 7, 2025
@hhhhkrx hhhhkrx changed the title Iridescence bug fix Iridescence name Jan 7, 2025
@hhhhkrx hhhhkrx self-assigned this Jan 7, 2025
@GuoLei1990 GuoLei1990 merged commit f55f83e into galacean:dev/1.4 Jan 7, 2025
7 of 9 checks passed
@GuoLei1990 GuoLei1990 added the ignore for release ignore for release label Jan 7, 2025
singlecoder pushed a commit to singlecoder/engine that referenced this pull request Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore for release ignore for release material Rendering Rendering related functions shader Shader related functions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants