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 rotation error when add joint(opt code) #2527

Merged
merged 9 commits into from
Jan 24, 2025

Conversation

luzhuang
Copy link
Contributor

@luzhuang luzhuang commented Jan 24, 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

  • Performance Optimization

    • Improved memory usage in joint operations by reusing quaternion objects
    • Optimized matrix transformations in joint calculations
  • Code Refinement

    • Minor adjustments to joint rotation and axis setting methods
    • Streamlined internal logic for joint positioning and transformations

Note: These changes are primarily internal improvements that may enhance overall system performance and code efficiency.

@luzhuang luzhuang added the ignore for release ignore for release label Jan 24, 2025
@luzhuang luzhuang requested a review from GuoLei1990 January 24, 2025 03:10
Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

This pull request introduces minor modifications across several physics-related TypeScript files. The changes include optimizing memory usage in joint handling, adjusting matrix operations, and making small syntactical improvements. The modifications primarily affect internal implementation details of physics components, with no significant changes to public interfaces or core functionality.

Changes

File Change Summary
packages/core/src/physics/DynamicCollider.ts Removed period from a comment in _onLateUpdate method
packages/core/src/physics/joint/Joint.ts Added static _tempQuat variable, replaced Matrix.copyFrom with Matrix.invert in _calculateConnectedAnchor
packages/physics-physx/src/joint/PhysXHingeJoint.ts Modified setRotation method to use local axis variable
packages/physics-physx/src/joint/PhysXJoint.ts Reordered operations in setRotation method, moving _rotation update before _setLocalPose

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • GuoLei1990

Poem

🐰 Hark! A physics dance of code so light,
Joints and colliders take their flight,
Quaternions spin, matrices twirl,
In this rabbit's algorithmic swirl!
Optimization's magic, clean and bright! 🌟

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@luzhuang luzhuang added the physics Engine's physical system label Jan 24, 2025
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.58%. Comparing base (0070d14) to head (3297b88).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2527      +/-   ##
==========================================
- Coverage   68.60%   68.58%   -0.03%     
==========================================
  Files         957      957              
  Lines      100123   100125       +2     
  Branches     8572     8569       -3     
==========================================
- Hits        68688    68669      -19     
- Misses      31179    31200      +21     
  Partials      256      256              
Flag Coverage Δ
unittests 68.58% <100.00%> (-0.03%) ⬇️

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: 0

🧹 Nitpick comments (1)
packages/core/src/physics/joint/Joint.ts (1)

18-18: Validate shared static usage for _tempQuat.
Reusing a static Quaternion improves performance by reducing allocations, but watch out for accidental reuse if multiple methods operate on it in parallel or re-entrantly.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0070d14 and 3297b88.

📒 Files selected for processing (4)
  • packages/core/src/physics/DynamicCollider.ts (1 hunks)
  • packages/core/src/physics/joint/Joint.ts (3 hunks)
  • packages/physics-physx/src/joint/PhysXHingeJoint.ts (1 hunks)
  • packages/physics-physx/src/joint/PhysXJoint.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/core/src/physics/DynamicCollider.ts
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: e2e (22.x)
🔇 Additional comments (4)
packages/physics-physx/src/joint/PhysXJoint.ts (1)

52-52: Check order of operations in setRotation method.
By copying _rotation after _setLocalPose(), the pose calculation for the connected anchor uses the old rotation. If this is intentional, consider adding a comment clarifying why _rotation must be updated afterward. Otherwise, swap the order to ensure everything stays in sync.

packages/physics-physx/src/joint/PhysXHingeJoint.ts (1)

31-33: Minor readability improvement with local variable usage.
Storing this._axis in a local axis variable clarifies the code and is consistent with best practices in many codebases. No further issues.

packages/core/src/physics/joint/Joint.ts (2)

246-246: Slightly more concise matrix inversion.
Replacing an extra copy step with Matrix.invert(...) is a fine micro-optimization. This is clear and looks correct.


281-281: Confirm correct usage of _tempQuat in _updateRotation().
Because _tempQuat is reused, ensure no asynchronous calls overwrite it within the same function scope. Otherwise, this approach is an efficient improvement.

@GuoLei1990 GuoLei1990 merged commit 547d03b into galacean:main Jan 24, 2025
8 of 9 checks passed
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 physics Engine's physical system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants