summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorHaoyu Qiu <timothyqiu32@gmail.com>2022-01-06 00:15:22 +0800
committerHaoyu Qiu <timothyqiu32@gmail.com>2022-01-11 11:48:45 +0800
commitd54586a8e6617e4e6bb070c97f4ee7a3744366cf (patch)
tree08c33b6fd38382aa51b55e04cfb3453832501cb9 /doc/classes
parentb52f90e795e0de9c0e7056fd5c83d2c5e3d207af (diff)
Explain what 2D cross product means
Diffstat (limited to 'doc/classes')
-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">