gaming/godot
gaming/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot synced 2024-10-14 20:07:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #92154 from lawnjelly/is_polygon_clockwise_doc

Browse source 
Clarify `is_polygon_clockwise()` coordinate system
This commit is contained in:
Rémi Verschelde 2024-05-21 11:22:53 +02:00
parent 149e3b85aa 331ecf3ca8
commit dcc7cb01a7
No known key found for this signature in database
GPG key ID: C3336907360768E1
2 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
core/math/geometry_2d.h
View file

@ -350,6 +350,8 @@ public:
return triangles;
}
// Assumes cartesian coordinate system with +x to the right, +y up.
// If using screen coordinates (+x to the right, +y down) the result will need to be flipped.
static bool is_polygon_clockwise(const Vector<Vector2> &p_polygon) {
int c = p_polygon.size();
if (c < 3) {

1
doc/classes/Geometry2D.xml
View file

@ -116,6 +116,7 @@
<param index="0" name="polygon" type="PackedVector2Array" />
<description>
Returns [code]true[/code] if [param polygon]'s vertices are ordered in clockwise order, otherwise returns [code]false[/code].
[b]Note:[/b] Assumes a Cartesian coordinate system where [code]+x[/code] is right and [code]+y[/code] is up. If using screen coordinates ([code]+y[/code] is down), the result will need to be flipped (i.e. a [code]true[/code] result will indicate counter-clockwise).
</description>
</method>
<method name="line_intersects_line">