diff options
| author | Aaron Franke <arnfranke@yahoo.com> | 2021-11-04 10:58:20 -0500 |
|---|---|---|
| committer | Aaron Franke <arnfranke@yahoo.com> | 2021-11-04 14:44:55 -0500 |
| commit | 813466b3c893ce2d47098268475818d1e4e485b4 (patch) | |
| tree | b5f15a25d9680d88d08bb37f8afe67f5fc6fe3e9 /doc/classes/Transform3D.xml | |
| parent | ee939c919b14a1935a0b6ccde338846a14cb9744 (diff) | |
| download | redot-engine-813466b3c893ce2d47098268475818d1e4e485b4.tar.gz | |
Add documentation to operators for math types
Co-authored-by: Raul Santos <raulsntos@gmail.com>
Diffstat (limited to 'doc/classes/Transform3D.xml')
| -rw-r--r-- | doc/classes/Transform3D.xml | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml index 8c4965abb4..94b20b05c6 100644 --- a/doc/classes/Transform3D.xml +++ b/doc/classes/Transform3D.xml @@ -147,30 +147,36 @@ <return type="bool" /> <argument index="0" name="right" type="Transform3D" /> <description> + Returns [code]true[/code] if the transforms are not equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. </description> </operator> <operator name="operator *"> <return type="PackedVector3Array" /> <argument index="0" name="right" type="PackedVector3Array" /> <description> + Transforms (multiplies) each element of the [Vector3] array by the given [Transform3D] matrix. </description> </operator> <operator name="operator *"> <return type="Transform3D" /> <argument index="0" name="right" type="Transform3D" /> <description> + Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent). </description> </operator> <operator name="operator *"> <return type="AABB" /> <argument index="0" name="right" type="AABB" /> <description> + Transforms (multiplies) the [AABB] by the given [Transform3D] matrix. </description> </operator> <operator name="operator *"> <return type="Vector3" /> <argument index="0" name="right" type="Vector3" /> <description> + Transforms (multiplies) the [Vector3] by the given [Transform3D] matrix. </description> </operator> <operator name="operator *"> @@ -196,6 +202,8 @@ <return type="bool" /> <argument index="0" name="right" type="Transform3D" /> <description> + Returns [code]true[/code] if the transforms are exactly equal. + [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. </description> </operator> </operators> |