summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémi Verschelde <remi@verschelde.fr>2022-01-11 13:35:38 +0100
committerGitHub <noreply@github.com>2022-01-11 13:35:38 +0100
commitadf29a0deb3790c6036c16ed1d1975bd2fc9ed91 (patch)
treeb83a011078a95eceee26326d4584c90714f4ac31
parent46624388d48379350ca9b9020bc55eef61102145 (diff)
parentd54586a8e6617e4e6bb070c97f4ee7a3744366cf (diff)
Merge pull request #56525 from timothyqiu/2d-cross-product
-rw-r--r--doc/classes/Vector2.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml
index 6c39efd2f9..f593134557 100644
--- a/doc/classes/Vector2.xml
+++ b/doc/classes/Vector2.xml
@@ -110,7 +110,9 @@
<return type="float" />
<argument index="0" name="with" type="Vector2" />
<description>
- Returns the cross product of this vector and [code]with[/code].
+ Returns the 2D analog of the cross product for this vector and [code]with[/code].
+ This is the signed area of the parallelogram formed by the two vectors. If the second vector is clockwise from the first vector, then the cross product is the positive area. If counter-clockwise, the cross product is the negative area.
+ [b]Note:[/b] Cross product is not defined in 2D mathematically. This method embeds the 2D vectors in the XY plane of 3D space and uses their cross product's Z component as the analog.
</description>
</method>
<method name="cubic_interpolate" qualifiers="const">