docs: Remove counterclockwise order requirement for PolygonComponent vertices #3352
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clockwise or counterclockwise order are both OK now in lists of polygon vertices. Check https://github.com/flame-engine/flame/blob/main/packages/flame/lib/src/geometry/polygon_component.dart#L122-L124
Clockwise or counterclockwise order are both OK now in lists of polygon vertices. Check https://github.com/flame-engine/flame/blob/main/packages/flame/lib/src/geometry/polygon_component.dart#L122-L124
spydon
reviewed
Oct 24, 2024
There was a problem hiding this comment.
Super! Could you update the example (https://github.com/flame-engine/flame/pull/3352/files#diff-69918961dcf0b9a380cc0a2d928308d19b63ce9ec8b6e69ee2e88d41792a03e2R1070-R1080) so that it has the correct "walls" in the comment too? Maybe the picture should be removed all together since that one is wrong too.
|
Good. I didn't realise those bits were wrong actually. Now I get what confused me in the first place! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The documentation used to require that lists of vertices in PolygonComponent (and its subclass PolygonHitbox) should be in counterclockwise order. This is no more necessary because the implementation is robust: https://github.com/flame-engine/flame/blob/main/packages/flame/lib/src/geometry/polygon_component.dart#L122-L124
Moreover, the wording was a bit confusing (the example looks clockwise).
The paragraphs mentioning the vertex order were deleted altogether.
Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues