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

Don't break lerp effect in post-processing local mode #2513

Closed
wants to merge 2 commits into from

Conversation

zhuxudong
Copy link
Member

@zhuxudong zhuxudong commented Jan 16, 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

  • Bug Fixes
    • Improved post-processing logic for more accurate effect blending.
    • Enhanced handling of interpolation factors in global and local modes.
    • Refined conditions for applying post-process effects based on proximity.
    • Adjusted loop behavior to allow further checks even without collider shapes.

@zhuxudong zhuxudong added the bug Something isn't working label Jan 16, 2025
@zhuxudong zhuxudong added this to the 1.4 milestone Jan 16, 2025
@zhuxudong zhuxudong requested a review from GuoLei1990 January 16, 2025 08:33
@zhuxudong zhuxudong self-assigned this Jan 16, 2025
Copy link

coderabbitai bot commented Jan 16, 2025

Walkthrough

The changes in the PostProcessManager class focus on refining the post-processing logic, particularly the handling of the interpFactor variable. The modifications clarify the default value for global modes, introduce a new assignment for local modes, and adjust the conditional logic for applying post-process effects. The changes improve the clarity and functionality of the post-processing logic, particularly in distinguishing between global and local modes.

Changes

File Change Summary
packages/core/src/postProcess/PostProcessManager.ts - Updated comment for interpFactor in global mode
- Added new assignment for interpFactor in local mode (set to 0)
- Modified conditional logic for post-process effect application
- Retained warning log for absent collider shapes

Suggested Reviewers

  • MrKou47

Poem

🐰 Interpolation's Whisper
In post-process realm, a factor's dance,
Global and local, each with its chance,
Blending effects with mathematical grace,
Proximity's logic finds its embrace,
A rabbit's code, precise and bright! 🌟


📜 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 4d006a5 and 44d02e3.

📒 Files selected for processing (1)
  • packages/core/src/postProcess/PostProcessManager.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/core/src/postProcess/PostProcessManager.ts

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 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.02%. Comparing base (393f8e3) to head (44d02e3).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2513      +/-   ##
==========================================
+ Coverage   68.58%   69.02%   +0.44%     
==========================================
  Files         957      957              
  Lines      100052   100051       -1     
  Branches     8566     8562       -4     
==========================================
+ Hits        68617    69063     +446     
+ Misses      31179    30732     -447     
  Partials      256      256              
Flag Coverage Δ
unittests 69.02% <100.00%> (+0.44%) ⬆️

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

🧹 Nitpick comments (1)
packages/core/src/postProcess/PostProcessManager.ts (1)

Line range hint 73-111: Consider enhancing error handling for edge cases.

While the changes fix the lerp effect, consider adding the following improvements:

  1. Add debug logging when interpFactor is calculated to help troubleshoot blending issues.
  2. Consider clamping interpFactor to [0,1] range explicitly for safety.
  3. Add performance metrics for distance calculations in local mode.

Example implementation:

 let interpFactor = 1; // default value in global mode
 if (!isGlobal) {
   interpFactor = 0; // default value in local mode
+  const startTime = performance.now();
   const currentColliders = PostProcessManager._tempColliders;
   // ... distance calculation code ...
   if (closestDistance <= blendDistance && blendDistance > 0) {
     interpFactor = 1 - closestDistance / blendDistance;
+    interpFactor = Math.max(0, Math.min(1, interpFactor));
+    Logger.debug(`PostProcess: calculated interpFactor ${interpFactor} for ${postProcess.entity.name}`);
   }
+  const endTime = performance.now();
+  Logger.debug(`PostProcess: distance calculation took ${endTime - startTime}ms`);
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 15e7b8b and 4d006a5.

📒 Files selected for processing (1)
  • packages/core/src/postProcess/PostProcessManager.ts (2 hunks)
⏰ 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)
🔇 Additional comments (1)
packages/core/src/postProcess/PostProcessManager.ts (1)

73-75: LGTM! Clear initialization of interpolation factors.

The explicit initialization of interpFactor for both global and local modes improves code clarity and correctness. Setting it to 0 for local mode ensures proper blending behavior from the start.

Comment on lines 109 to 111
if (closestDistance <= blendDistance && blendDistance > 0) {
interpFactor = 1 - closestDistance / blendDistance;
}
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Consider adding property-level validation for blendDistance

While the runtime check prevents interpolation issues, consider adding validation in the PostProcess class to ensure blendDistance is always non-negative when set. This would catch invalid values earlier and provide clearer feedback to developers.

Example locations that need attention:

  • packages/core/src/postProcess/PostProcess.ts: Add validation for the blendDistance property
🔗 Analysis chain

Good fix for blend distance validation.

The additional check blendDistance > 0 prevents invalid interpolation when blend distance is zero or negative. This fixes the lerp effect in local mode.

Consider adding validation when setting blendDistance to ensure it's always positive.

Let's check if blendDistance validation exists:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for PostProcess class definition and blendDistance property
ast-grep --pattern 'class PostProcess {
  $$$
  blendDistance$$$
  $$$
}'

Length of output: 75


Script:

#!/bin/bash
# Find the class definition and blendDistance usage
rg "class.*PostProcess" -A 5
rg "blendDistance" -A 2 -B 2

Length of output: 14581

@zhuxudong
Copy link
Member Author

enhance it in #2514

@zhuxudong zhuxudong closed this Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant