summaryrefslogtreecommitdiff
path: root/doc/classes/Transform3D.xml
diff options
context:
space:
mode:
authorMicky <66727710+Mickeon@users.noreply.github.com>2022-05-05 01:29:38 +0200
committerMicky <micheledevita2@gmail.com>2022-05-05 13:42:24 +0200
commit87599054d26faa534e206959c12ef70f3a1e92f5 (patch)
treef2cd824c706aedcc1d4a5a5e4fb70d86590f619d /doc/classes/Transform3D.xml
parent11b94351306247330db0971c0d682bc3dc8897aa (diff)
Specify return value of Transform3D.scaled() and more
Add more `[code]` (Transform3D) Co-authored-by: kleonc <9283098+kleonc@users.noreply.github.com> Add more `[code]` (Transform2D) Co-authored-by: kleonc <9283098+kleonc@users.noreply.github.com>
Diffstat (limited to 'doc/classes/Transform3D.xml')
-rw-r--r--doc/classes/Transform3D.xml6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml
index 5a72dc223c..4a08ab3bc7 100644
--- a/doc/classes/Transform3D.xml
+++ b/doc/classes/Transform3D.xml
@@ -96,14 +96,14 @@
<argument index="0" name="axis" type="Vector3" />
<argument index="1" name="phi" type="float" />
<description>
- Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector.
+ Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]phi[/code] angle (in radians), using matrix multiplication. The [code]axis[/code] must be a normalized vector.
</description>
</method>
<method name="scaled" qualifiers="const">
<return type="Transform3D" />
<argument index="0" name="scale" type="Vector3" />
<description>
- Scales basis and origin of the transform by the given scale factor, using matrix multiplication.
+ Returns a copy of the transform with its basis and origin scaled by the given [code]scale[/code] factor, using matrix multiplication.
</description>
</method>
<method name="sphere_interpolate_with" qualifiers="const">
@@ -118,7 +118,7 @@
<return type="Transform3D" />
<argument index="0" name="offset" type="Vector3" />
<description>
- Translates the transform by the given offset, relative to the transform's basis vectors.
+ Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
</description>
</method>