diff options
| author | Aaron Franke <arnfranke@yahoo.com> | 2019-12-13 15:23:26 -0500 |
|---|---|---|
| committer | Aaron Franke <arnfranke@yahoo.com> | 2019-12-15 12:31:08 -0500 |
| commit | 1b8b380993bf9ee253a72b6da7d7d7cc55868976 (patch) | |
| tree | 374b8530cb57fa941d0e7af0caa91e43b9c08247 /doc | |
| parent | d8d96c9fa78395db8cf8eca65439ee1dfe18a424 (diff) | |
| download | redot-engine-1b8b380993bf9ee253a72b6da7d7d7cc55868976.tar.gz | |
Document that translated does not behave like rotated or scaled
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Transform.xml | 9 | ||||
| -rw-r--r-- | doc/classes/Transform2D.xml | 7 |
2 files changed, 9 insertions, 7 deletions
diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 4c4022b3b5..2e447ca1ba 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -126,7 +126,7 @@ <argument index="1" name="phi" type="float"> </argument> <description> - Rotates the transform around given axis by phi. The axis must be a normalized vector. + Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector. </description> </method> <method name="scaled"> @@ -135,16 +135,17 @@ <argument index="0" name="scale" type="Vector3"> </argument> <description> - Scales the transform by the specified 3D scaling factors. + Scales the transform by the given scale factor, using matrix multiplication. </description> </method> <method name="translated"> <return type="Transform"> </return> - <argument index="0" name="ofs" type="Vector3"> + <argument index="0" name="offset" type="Vector3"> </argument> <description> - Translates the transform by the specified offset. + Translates the transform by the given offset, relative to the transform's basis vectors. + Unlike [method rotated] and [method scaled], this does not use matrix multiplication. </description> </method> <method name="xform"> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 6288bb074c..afc8b04dc7 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -128,7 +128,7 @@ <argument index="0" name="phi" type="float"> </argument> <description> - Rotates the transform by the given angle (in radians). + Rotates the transform by the given angle (in radians), using matrix multiplication. </description> </method> <method name="scaled"> @@ -137,7 +137,7 @@ <argument index="0" name="scale" type="Vector2"> </argument> <description> - Scales the transform by the given factor. + Scales the transform by the given scale factor, using matrix multiplication. </description> </method> <method name="translated"> @@ -146,7 +146,8 @@ <argument index="0" name="offset" type="Vector2"> </argument> <description> - Translates the transform by the given offset. + Translates the transform by the given offset, relative to the transform's basis vectors. + Unlike [method rotated] and [method scaled], this does not use matrix multiplication. </description> </method> <method name="xform"> |