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

docs: Add more guidance to collision detection algorithm choices #2624

Merged
merged 6 commits into from
Jul 26, 2023

Conversation

filiph
Copy link
Contributor

@filiph filiph commented Jul 24, 2023

Description

This is adding a bit more precise language and more context to API docs of HasCollisionDetection, Broadphase and HasQuadTreeCollisionDetection.

Checklist

  • I have followed the Contributor Guide when preparing my PR.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • I have updated/added relevant examples in examples or docs.

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Related Issues

Closes #2622 (imho)

Copy link
Member

@spydon spydon left a comment

Choose a reason for hiding this comment

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

Would be great with some comment about this in the normal docs too if you're up for it. :)
https://github.com/flame-engine/flame/blob/main/doc/flame/collision_detection.md

filiph and others added 2 commits July 24, 2023 22:21
…tree_collision_detection.dart

Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>
@filiph
Copy link
Contributor Author

filiph commented Jul 24, 2023

Good point. I made some improvements to the .md file.

@spydon spydon merged commit 781e898 into flame-engine:main Jul 26, 2023
6 checks passed
@filiph filiph deleted the doc_broadphase branch July 26, 2023 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Address performance issues of QuadTreeBroadphase collision detection
2 participants