asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Clarify the behavior of Vector2/3.cross and mention parallel vectors

Browse source
This commit is contained in:
A Thousand Ships 2024-03-31 16:08:20 +02:00
parent 29b3d9e9e5
commit 47a8033698
No known key found for this signature in database
GPG key ID: 2033189A662F8BD7
2 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/Vector2.xml
View file

@ -132,7 +132,7 @@
<param index="0" name="with" type="Vector2" /> <param index="0" name="with" type="Vector2" />
<description> <description>
Returns the 2D analog of the cross product for this vector and [param with]. Returns the 2D analog of the cross product for this vector and [param with].
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. 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. If the two vectors are parallel this returns zero, making it useful for testing if two vectors are parallel.
[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. [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> </description>
</method> </method>

1
doc/classes/Vector3.xml
View file

@ -108,6 +108,7 @@
<param index="0" name="with" type="Vector3" /> <param index="0" name="with" type="Vector3" />
<description> <description>
Returns the cross product of this vector and [param with]. Returns the cross product of this vector and [param with].
This returns a vector perpendicular to both this and [param with], which would be the normal vector of the plane defined by the two vectors. As there are two such vectors, in opposite directions, this method returns the vector defined by a right-handed coordinate system. If the two vectors are parallel this returns an empty vector, making it useful for testing if two vectors are parallel.
</description> </description>
</method> </method>
<method name="cubic_interpolate" qualifiers="const"> <method name="cubic_interpolate" qualifiers="const">