Clarify Geometry.offset_polygon_2d regarding vertices translation
#38390
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
Xrayez
commented
May 1, 2020
Xrayez
commented
Jul 1, 2020
| @@ -200,6 +200,13 @@ | |||
| Inflates or deflates [code]polygon[/code] by [code]delta[/code] units (pixels). If [code]delta[/code] is positive, makes the polygon grow outward. If [code]delta[/code] is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if [code]delta[/code] is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. | |||
| Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType]. | |||
| The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. | |||
| [b]Note:[/b] for translating the polygon's vertices specifically, use [method Transform2D.xform] method: | |||
| [codeblock] | |||
| var polygon = PackedVector2Array([Vector2(0, 0), Vector2(100, 0), Vector2(100, 100), Vector2(0, 100)]) | |||
There was a problem hiding this comment.
PackedVector2Array → PoolVector2Array in 3.2.
|
Not sure why I marked this as WIP, likely because of godotengine/godot-proposals#913, but it's fine to merge as is. The |
akien-mga
reviewed
Jul 1, 2020
akien-mga
approved these changes
Jul 1, 2020
The method is used to either inflate or deflate a polygon. For translating/transforming a polygon, use `Transform2D.xform`.
|
Thanks! |
akien-mga
added
the
cherrypick:3.x
|
Cherry-picked for 3.2.3. |
akien-mga
removed
the
cherrypick:3.x
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.
Kind of closes godotengine/godot-proposals#777 (renaming is subject to discussion, but I think it's more about the confusion in the first place).
The method is used to either inflate or deflate a polygon.
For translating/transforming a polygon, use
Transform2D.xform, as in #31761.