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

Support destroy physicsMaterial #2481

Open
wants to merge 25 commits into
base: dev/1.4
Choose a base branch
from

Conversation

luzhuang
Copy link
Contributor

@luzhuang luzhuang commented Dec 27, 2024

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

    • The method for destroying materials has been made public, enhancing accessibility for users.
  • Bug Fixes

    • Updated tests to ensure that accessing properties after destruction throws an error, improving reliability.
  • Tests

    • Added a new test case for the destroy method in the PhysicsMaterial test suite to verify correct behavior post-destruction.

@luzhuang luzhuang added physics Engine's physical system ignore for release ignore for release labels Dec 27, 2024
@luzhuang luzhuang added this to the 1.4 milestone Dec 27, 2024
@luzhuang luzhuang requested a review from GuoLei1990 December 27, 2024 09:42
Copy link

coderabbitai bot commented Dec 27, 2024

Walkthrough

The changes involve modifying the PhysicsMaterial class in the core physics module. The primary modification is changing the internal _destroy() method to a public destroy() method, which allows external destruction of the physics material. A corresponding test case has been added to verify the method's behavior, ensuring that attempting to access properties after destruction results in an error.

Changes

File Change Summary
packages/core/src/physics/PhysicsMaterial.ts Changed internal _destroy() method to public destroy() method
tests/src/core/physics/PhysicsMaterial.test.ts Added new test case to verify material destruction behavior

Suggested Reviewers

  • MrKou47

Poem

🐰 A physics material's tale of might,
Destroyed with method now in sight!
From underscore to public glee,
Cleanup dance of property free
Rabbit hops with code delight! 🔧

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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 changed the title Feat/physics parser Support destroy physicsMaterial Dec 27, 2024
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 (2)
packages/core/src/physics/PhysicsMaterial.ts (1)

100-100: Correct the docstring to enhance clarity.

"Destroy the material when the material is no be used by any shape." → Consider changing it to "Destroy the material when it is no longer used by any shape." for improved readability and clarity.

 /**
-  * Destroy the material when the material is no be used by any shape.
+  * Destroy the material when it is no longer used by any shape.
  */
tests/src/core/physics/PhysicsMaterial.test.ts (1)

490-496: Improve test coverage with repeated destroy calls.

This test correctly verifies that the material can no longer be manipulated after destruction. Consider adding a scenario in which destroy() is called multiple times to ensure the method remains idempotent and no errors occur on subsequent calls.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ab48451 and ac34ad0.

📒 Files selected for processing (2)
  • packages/core/src/physics/PhysicsMaterial.ts (1 hunks)
  • tests/src/core/physics/PhysicsMaterial.test.ts (1 hunks)
🔇 Additional comments (1)
packages/core/src/physics/PhysicsMaterial.ts (1)

102-102: Implementation logic looks good.

The null-check-style pattern using !this._destroyed is concise and ensures that the native material’s destruction is idempotent. This public method is a welcomed improvement over the previous _destroy() method and should not introduce breaking changes.

Copy link

codecov bot commented Dec 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.40%. Comparing base (ab48451) to head (ac34ad0).

Additional details and impacted files
@@             Coverage Diff             @@
##           dev/1.4    #2481      +/-   ##
===========================================
- Coverage    68.42%   68.40%   -0.03%     
===========================================
  Files          923      923              
  Lines        95940    95928      -12     
  Branches      8140     8139       -1     
===========================================
- Hits         65647    65618      -29     
- Misses       30040    30056      +16     
- Partials       253      254       +1     
Flag Coverage Δ
unittests 68.40% <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.

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