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

Specify return value of Transform3D.scaled() and more

Browse source 
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>
(cherry picked from commit 87599054d2)
This commit is contained in:
Micky 2022-05-05 01:29:38 +02:00 committed by Rémi Verschelde
parent c89c21145b
commit 15f9803d28
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/classes/Transform.xml
View file

@ -103,21 +103,21 @@
<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">
<return type="Transform" />
<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="translated">
<return type="Transform" />
<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>

6
doc/classes/Transform2D.xml
View file

@ -109,21 +109,21 @@
<return type="Transform2D" />
<argument index="0" name="phi" type="float" />
<description>
Rotates the transform by the given angle (in radians), using matrix multiplication.
Returns a copy of the transform rotated by the given [code]phi[/code] angle (in radians), using matrix multiplication.
</description>
</method>
<method name="scaled">
<return type="Transform2D" />
<argument index="0" name="scale" type="Vector2" />
<description>
Scales the transform by the given scale factor, using matrix multiplication.
Returns a copy of the transform scaled by the given [code]scale[/code] factor, using matrix multiplication.
</description>
</method>
<method name="translated">
<return type="Transform2D" />
<argument index="0" name="offset" type="Vector2" />
<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>