Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
Provides methods for some common 2D geometric operations.
Provides a set of helper functions to create geometric shapes, compute intersections between shapes, and process various other geometric operations in 2D.
PolyBooleanOperation OPERATION_UNION =
Create regions where either subject or clip polygons (or both) are filled.
PolyBooleanOperation OPERATION_DIFFERENCE =
Create regions where subject polygons are filled except where clip polygons are filled.
PolyBooleanOperation OPERATION_INTERSECTION =
Create regions where both subject and clip polygons are filled.
PolyBooleanOperation OPERATION_XOR =
Create regions where either subject or clip polygons are filled but not where both are filled.
PolyJoinType JOIN_SQUARE =
Squaring is applied uniformally at all convex edge joins at
1 * delta.
PolyJoinType JOIN_ROUND =
While flattened paths can never perfectly trace an arc, they are approximated by a series of arc chords.
PolyJoinType JOIN_MITER =
There's a necessary limit to mitered joins since offsetting edges that join at very acute angles will produce excessively long and narrow "spikes". For any given edge join, when miter offsetting would exceed that maximum distance, "square" joining is applied.
PolyEndType END_POLYGON =
Endpoints are joined using the PolyJoinType value and the path filled as a polygon.
PolyEndType END_JOINED =
Endpoints are joined using the PolyJoinType value and the path filled as a polyline.
PolyEndType END_BUTT =
Endpoints are squared off with no extension.
PolyEndType END_SQUARE =
Endpoints are squared off and extended by
PolyEndType END_ROUND =
Endpoints are rounded off and extended by
polygon_b and returns an array of clipped polygons. This performs OPERATION_DIFFERENCE between polygons. Returns an empty array if
polygon_b completely overlaps
polygon_b is enclosed by
polygon_a, returns an outer polygon (boundary) and inner polygon (hole) which could be distinguished by calling is_polygon_clockwise.
polygon and returns an array of clipped polylines. This performs OPERATION_DIFFERENCE between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape.
Given an array of Vector2s, returns the convex hull as a list of points in counterclockwise order. The last point is the same as the first