godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Address a few issues in Transform3D documentation

This commit is contained in:
Micky 2024-03-04 17:53:15 +01:00
parent 01dc5c5b58
commit abf4894677
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/classes/Transform3D.xml
View File

@ -62,7 +62,7 @@
<return type="Transform3D" /> <return type="Transform3D" />
<description> <description>
Returns the inverted version of this transform. Unlike [method inverse], this method works with almost any [member basis], including non-uniform ones, but is slower. See also [method Basis.inverse]. Returns the inverted version of this transform. Unlike [method inverse], this method works with almost any [member basis], including non-uniform ones, but is slower. See also [method Basis.inverse].
[b]Note:[/b] For this method to return correctly, the transform's [member basis] needs to not have a determinant of exactly [code]0[/code] (see [method Basis.determinant]). [b]Note:[/b] For this method to return correctly, the transform's [member basis] needs to have a determinant that is not exactly [code]0[/code] (see [method Basis.determinant]).
</description> </description>
</method> </method>
<method name="interpolate_with" qualifiers="const"> <method name="interpolate_with" qualifiers="const">
@ -71,7 +71,7 @@
<param index="1" name="weight" type="float" /> <param index="1" name="weight" type="float" />
<description> <description>
Returns the result of the linear interpolation between this transform and [param xform] by the given [param weight]. Returns the result of the linear interpolation between this transform and [param xform] by the given [param weight].
The [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). Values outside this range are allowed and can be used to perform [i]extrapolation[/i], instead. The [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). Values outside this range are allowed and can be used to perform [i]extrapolation[/i] instead.
</description> </description>
</method> </method>
<method name="inverse" qualifiers="const"> <method name="inverse" qualifiers="const">
@ -172,7 +172,7 @@
</methods> </methods>
<members> <members>
<member name="basis" type="Basis" setter="" getter="" default="Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)"> <member name="basis" type="Basis" setter="" getter="" default="Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)">
The [Basis] of this transform. It is composed by 3 axes ([member Basis.x], [member Basis.y], and [member Basis.z]). Together, these represent the transform's rotation, scale, and shearing. The [Basis] of this transform. It is composed by 3 axes ([member Basis.x], [member Basis.y], and [member Basis.z]). Together, these represent the transform's rotation, scale, and shear.
</member> </member>
<member name="origin" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> <member name="origin" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
The translation offset of this transform. In 3D space, this can be seen as the position. The translation offset of this transform. In 3D space, this can be seen as the position.
@ -247,28 +247,28 @@
<return type="Transform3D" /> <return type="Transform3D" />
<param index="0" name="right" type="float" /> <param index="0" name="right" type="float" />
<description> <description>
Multiplies all components of the [Transform3D] by the given [float], including the [member origin]. This affects the transform's scale uniformly, also resizing the [member basis]. Multiplies all components of the [Transform3D] by the given [float], including the [member origin]. This affects the transform's scale uniformly, scaling the [member basis].
</description> </description>
</operator> </operator>
<operator name="operator *"> <operator name="operator *">
<return type="Transform3D" /> <return type="Transform3D" />
<param index="0" name="right" type="int" /> <param index="0" name="right" type="int" />
<description> <description>
Multiplies all components of the [Transform3D] by the given [int], including the [member origin]. This affects the transform's scale uniformly, also resizing the [member basis]. Multiplies all components of the [Transform3D] by the given [int], including the [member origin]. This affects the transform's scale uniformly, scaling the [member basis].
</description> </description>
</operator> </operator>
<operator name="operator /"> <operator name="operator /">
<return type="Transform3D" /> <return type="Transform3D" />
<param index="0" name="right" type="float" /> <param index="0" name="right" type="float" />
<description> <description>
Divides all components of the [Transform3D] by the given [float], including the [member origin]. This affects the transform's scale uniformly, also resizing the [member basis]. Divides all components of the [Transform3D] by the given [float], including the [member origin]. This affects the transform's scale uniformly, scaling the [member basis].
</description> </description>
</operator> </operator>
<operator name="operator /"> <operator name="operator /">
<return type="Transform3D" /> <return type="Transform3D" />
<param index="0" name="right" type="int" /> <param index="0" name="right" type="int" />
<description> <description>
Divides all components of the [Transform3D] by the given [int], including the [member origin]. This affects the transform's scale uniformly, also resizing the [member basis]. Divides all components of the [Transform3D] by the given [int], including the [member origin]. This affects the transform's scale uniformly, scaling the [member basis].
</description> </description>
</operator> </operator>
<operator name="operator =="> <operator name="operator ==">