galacean / engine

A typescript interactive engine, support 2D, 3D, animation, physics, built on WebGL and glTF.
https://www.galacean.com/engine
MIT License
4.3k stars 307 forks source link

Fix physics event index exceeds the length of the array. #2366

Closed cptbtptpbcptdtptp closed 2 months ago

cptbtptpbcptdtptp commented 3 months 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 3 months ago

Walkthrough

The changes involve significant updates to the DisorderedArray class, introducing a loop tracking mechanism using an integer tag instead of a boolean flag. Method signatures for iteration functions have been modified to include an index parameter in their callbacks. The LitePhysicsScene and PhysXPhysicsScene classes now utilize the forEach method for event handling, and import statements for DisorderedArray have been standardized across various files to improve clarity and maintainability.

Changes

Files Change Summary
packages/core/src/DisorderedArray.ts, packages/core/src/index.ts Updated DisorderedArray class to use _loopCounter for loop management and modified method signatures for forEach and forEachAndClean to include an index parameter. Added export in index.ts.
packages/physics-lite/src/LitePhysicsScene.ts, packages/physics-physx/src/PhysXPhysicsScene.ts Replaced traditional for-loops with forEach in event handling methods to improve readability. Updated import statements to include DisorderedArray from @galacean/engine.
packages/physics-physx/src/shape/PhysXColliderShape.ts Modified import statement to source DisorderedArray directly from @galacean/engine, removing the local import.
packages/core/src/2d/assembler/TiledSpriteAssembler.ts, packages/core/src/ComponentsManager.ts, packages/core/src/Entity.ts, packages/core/src/RenderPipeline/MaskManager.ts, packages/core/src/input/keyboard/KeyboardManager.ts, packages/core/src/input/pointer/Pointer.ts, packages/core/src/input/pointer/PointerManager.ts, packages/core/src/lighting/LightManager.ts, packages/core/src/physics/PhysicsScene.ts Updated import paths for DisorderedArray to a new location in utils directory, enhancing modularity and clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DisorderedArray
    participant LitePhysicsScene
    participant PhysXPhysicsScene

    User->>DisorderedArray: Invoke forEach
    DisorderedArray->>DisorderedArray: Execute callback with index
    DisorderedArray-->>User: Return results

    User->>LitePhysicsScene: Trigger event
    LitePhysicsScene->>LitePhysicsScene: Handle event with forEach
    LitePhysicsScene-->>User: Event processed

    User->>PhysXPhysicsScene: Trigger event
    PhysXPhysicsScene->>PhysXPhysicsScene: Handle event with forEach
    PhysXPhysicsScene-->>User: Event processed

Poem

🐰 In the garden of code, changes bloom bright,
A tag for loops dances, a wondrous sight.
With forEach we leap, through events we glide,
In the realm of DisorderedArray, we take pride!
Hops and skips in the code we weave,
A joyful update, we all believe! 🌼


Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between a89b77d7ffaa54eab558bf91b2b80a37999a3617 and 8c29d8511b132ff7e5475bed3de2aecb55b76afd.
Files selected for processing (1) * packages/core/src/utils/DisorderedArray.ts (6 hunks)
Additional comments not posted (13)
packages/core/src/utils/DisorderedArray.ts (13)
`23-29`: **LGTM!** The constructor is correctly implemented and the JSDoc comment provides a clear description of the `count` parameter. --- Line range hint `31-43`: **LGTM!** The `add` method is correctly implemented and the JSDoc comment provides a clear description of the `element` parameter. --- `44-53`: **LGTM!** The `delete` method is correctly implemented and the JSDoc comment provides a clear description of the `element` parameter. --- `54-65`: **LGTM!** The `set` method is correctly implemented and the JSDoc comment provides a clear description of the `index` and `element` parameters. --- Line range hint `66-77`: **LGTM!** The `get` method is correctly implemented and the JSDoc comment provides a clear description of the `index` parameter and return value. --- Line range hint `86-100`: **LGTM!** The `deleteByIndex` method is correctly implemented and the loop counter mechanism is a good improvement over the previous boolean flag. --- `102-115`: **LGTM!** The `forEach` method is correctly implemented and the changes to include the index in the callback function and make `swapFn` optional are good improvements. --- `117-131`: **LGTM!** The `forEachAndClean` method is correctly implemented and the changes to include the index in the callback function and make `swapFn` optional are good improvements. --- `133-140`: **LGTM!** The `sort` method is correctly implemented and the JSDoc comment provides a clear description of the `compareFn` parameter. --- `141-146`: **LGTM!** The `garbageCollection` method is correctly implemented. --- `148-150`: **LGTM!** The `_startLoop` method is correctly implemented. --- Line range hint `152-181`: **LGTM!** The `_endLoop` method is correctly implemented and the change to call `swapFn` with the element and index is a good improvement. --- Line range hint `183-199`: **LGTM!** The `_endLoopAndClean` method is correctly implemented and the change to call `swapFn` with the element and index is a good improvement.
--- 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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.