Up to date
This page is up to date for Godot 4.2.
If you still find outdated information, please open an issue.
Geometry2D¶
Inherits: Object
Provides methods for some common 2D geometric operations.
Description¶
Provides a set of helper functions to create geometric shapes, compute intersections between shapes, and process various other geometric operations in 2D.
Methods¶
Enumerations¶
enum PolyBooleanOperation:
PolyBooleanOperation OPERATION_UNION = 0
Create regions where either subject or clip polygons (or both) are filled.
PolyBooleanOperation OPERATION_DIFFERENCE = 1
Create regions where subject polygons are filled except where clip polygons are filled.
PolyBooleanOperation OPERATION_INTERSECTION = 2
Create regions where both subject and clip polygons are filled.
PolyBooleanOperation OPERATION_XOR = 3
Create regions where either subject or clip polygons are filled but not where both are filled.
enum PolyJoinType:
PolyJoinType JOIN_SQUARE = 0
Squaring is applied uniformally at all convex edge joins at 1 * delta.
PolyJoinType JOIN_ROUND = 1
While flattened paths can never perfectly trace an arc, they are approximated by a series of arc chords.
PolyJoinType JOIN_MITER = 2
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.
enum PolyEndType:
PolyEndType END_POLYGON = 0
Endpoints are joined using the PolyJoinType value and the path filled as a polygon.
PolyEndType END_JOINED = 1
Endpoints are joined using the PolyJoinType value and the path filled as a polyline.
PolyEndType END_BUTT = 2
Endpoints are squared off with no extension.
PolyEndType END_SQUARE = 3
Endpoints are squared off and extended by delta units.
PolyEndType END_ROUND = 4
Endpoints are rounded off and extended by delta units.
Method Descriptions¶
PackedVector2Array[] clip_polygons ( PackedVector2Array polygon_a, PackedVector2Array polygon_b )
Clips polygon_a against 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_a.
If 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.
PackedVector2Array[] clip_polyline_with_polygon ( PackedVector2Array polyline, PackedVector2Array polygon )
Clips polyline against 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.
PackedVector2Array convex_hull ( PackedVector2Array points )
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 one.
PackedVector2Array[] decompose_polygon_in_convex ( PackedVector2Array polygon )
Decomposes the polygon into multiple convex hulls and returns an array of PackedVector2Array.
PackedVector2Array[] exclude_polygons ( PackedVector2Array polygon_a, PackedVector2Array polygon_b )
Mutually excludes common area defined by intersection of polygon_a and polygon_b (see intersect_polygons) and returns an array of excluded polygons. This performs OPERATION_XOR between polygons. In other words, returns all but common area between polygons.
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling is_polygon_clockwise.
Vector2 get_closest_point_to_segment ( Vector2 point, Vector2 s1, Vector2 s2 )
Returns the 2D point on the 2D segment (s1, s2) that is closest to point. The returned point will always be inside the specified segment.
Vector2 get_closest_point_to_segment_uncapped ( Vector2 point, Vector2 s1, Vector2 s2 )
Returns the 2D point on the 2D line defined by (s1, s2) that is closest to point. The returned point can be inside the segment (s1, s2) or outside of it, i.e. somewhere on the line extending from the segment.
PackedVector2Array get_closest_points_between_segments ( Vector2 p1, Vector2 q1, Vector2 p2, Vector2 q2 )
Given the two 2D segments (p1, q1) and (p2, q2), finds those two points on the two segments that are closest to each other. Returns a PackedVector2Array that contains this point on (p1, q1) as well the accompanying point on (p2, q2).
PackedVector2Array[] intersect_polygons ( PackedVector2Array polygon_a, PackedVector2Array polygon_b )
Intersects polygon_a with polygon_b and returns an array of intersected polygons. This performs OPERATION_INTERSECTION between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs.
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling is_polygon_clockwise.
PackedVector2Array[] intersect_polyline_with_polygon (