summaryrefslogtreecommitdiff
path: root/doc/classes/Transform3D.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-08-08 22:50:35 +0200
committerGitHub <noreply@github.com>2022-08-08 22:50:35 +0200
commit682dbe5d00aa7730659771b16704eba83f166a7b (patch)
tree8555e07c3bfb3b2892d530bc93fbf47d14519e35 /doc/classes/Transform3D.xml
parentd9d5990c517b63f41881de05cb4644c36e0c77e0 (diff)
parentc5d7115038de5f83cb83e08748615a84fc26bee2 (diff)
Merge pull request #64008 from YuriSizov/doctool-add-param-reference-syntax
Diffstat (limited to 'doc/classes/Transform3D.xml')
-rw-r--r--doc/classes/Transform3D.xml64
1 files changed, 32 insertions, 32 deletions
diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml
index cefc74867c..b7fd5213aa 100644
--- a/doc/classes/Transform3D.xml
+++ b/doc/classes/Transform3D.xml
@@ -24,31 +24,31 @@
</constructor>
<constructor name="Transform3D">
<return type="Transform3D" />
- <argument index="0" name="from" type="Transform3D" />
+ <param index="0" name="from" type="Transform3D" />
<description>
Constructs a [Transform3D] as a copy of the given [Transform3D].
</description>
</constructor>
<constructor name="Transform3D">
<return type="Transform3D" />
- <argument index="0" name="basis" type="Basis" />
- <argument index="1" name="origin" type="Vector3" />
+ <param index="0" name="basis" type="Basis" />
+ <param index="1" name="origin" type="Vector3" />
<description>
Constructs a Transform3D from a [Basis] and [Vector3].
</description>
</constructor>
<constructor name="Transform3D">
<return type="Transform3D" />
- <argument index="0" name="from" type="Projection" />
+ <param index="0" name="from" type="Projection" />
<description>
</description>
</constructor>
<constructor name="Transform3D">
<return type="Transform3D" />
- <argument index="0" name="x_axis" type="Vector3" />
- <argument index="1" name="y_axis" type="Vector3" />
- <argument index="2" name="z_axis" type="Vector3" />
- <argument index="3" name="origin" type="Vector3" />
+ <param index="0" name="x_axis" type="Vector3" />
+ <param index="1" name="y_axis" type="Vector3" />
+ <param index="2" name="z_axis" type="Vector3" />
+ <param index="3" name="origin" type="Vector3" />
<description>
Constructs a Transform3D from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled).
</description>
@@ -63,8 +63,8 @@
</method>
<method name="interpolate_with" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="xform" type="Transform3D" />
- <argument index="1" name="weight" type="float" />
+ <param index="0" name="xform" type="Transform3D" />
+ <param index="1" name="weight" type="float" />
<description>
Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0).
</description>
@@ -77,15 +77,15 @@
</method>
<method name="is_equal_approx" qualifiers="const">
<return type="bool" />
- <argument index="0" name="xform" type="Transform3D" />
+ <param index="0" name="xform" type="Transform3D" />
<description>
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
</description>
</method>
<method name="looking_at" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="target" type="Vector3" />
- <argument index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" />
+ <param index="0" name="target" type="Vector3" />
+ <param index="1" name="up" type="Vector3" default="Vector3(0, 1, 0)" />
<description>
Returns a copy of the transform rotated such that the forward axis (-Z) points towards the [code]target[/code] position.
The up axis (+Y) points as close to the [code]up[/code] vector as possible while staying perpendicular to the forward axis. The resulting transform is orthonormalized. The existing rotation, scale, and skew information from the original transform is discarded. The [code]target[/code] and [code]up[/code] vectors cannot be zero, cannot be parallel to each other, and are defined in global/parent space.
@@ -99,8 +99,8 @@
</method>
<method name="rotated" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="axis" type="Vector3" />
- <argument index="1" name="angle" type="float" />
+ <param index="0" name="axis" type="Vector3" />
+ <param index="1" name="angle" type="float" />
<description>
Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]angle[/code] (in radians).
The [code]axis[/code] must be a normalized vector.
@@ -111,8 +111,8 @@
</method>
<method name="rotated_local" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="axis" type="Vector3" />
- <argument index="1" name="angle" type="float" />
+ <param index="0" name="axis" type="Vector3" />
+ <param index="1" name="angle" type="float" />
<description>
Returns a copy of the transform rotated around the given [code]axis[/code] by the given [code]angle[/code] (in radians).
The [code]axis[/code] must be a normalized vector.
@@ -123,7 +123,7 @@
</method>
<method name="scaled" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="scale" type="Vector3" />
+ <param index="0" name="scale" type="Vector3" />
<description>
Returns a copy of the transform scaled by the given [code]scale[/code] factor.
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -133,7 +133,7 @@
</method>
<method name="scaled_local" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="scale" type="Vector3" />
+ <param index="0" name="scale" type="Vector3" />
<description>
Returns a copy of the transform scaled by the given [code]scale[/code] factor.
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -143,15 +143,15 @@
</method>
<method name="spherical_interpolate_with" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="xform" type="Transform3D" />
- <argument index="1" name="weight" type="float" />
+ <param index="0" name="xform" type="Transform3D" />
+ <param index="1" name="weight" type="float" />
<description>
Returns a transform spherically interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0).
</description>
</method>
<method name="translated" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="offset" type="Vector3" />
+ <param index="0" name="offset" type="Vector3" />
<description>
Returns a copy of the transform translated by the given [code]offset[/code].
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -161,7 +161,7 @@
</method>
<method name="translated_local" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="offset" type="Vector3" />
+ <param index="0" name="offset" type="Vector3" />
<description>
Returns a copy of the transform translated by the given [code]offset[/code].
This method is an optimized version of multiplying the given transform [code]X[/code]
@@ -195,7 +195,7 @@
<operators>
<operator name="operator !=">
<return type="bool" />
- <argument index="0" name="right" type="Transform3D" />
+ <param 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.
@@ -203,56 +203,56 @@
</operator>
<operator name="operator *">
<return type="AABB" />
- <argument index="0" name="right" type="AABB" />
+ <param index="0" name="right" type="AABB" />
<description>
Transforms (multiplies) the [AABB] by the given [Transform3D] matrix.
</description>
</operator>
<operator name="operator *">
<return type="PackedVector3Array" />
- <argument index="0" name="right" type="PackedVector3Array" />
+ <param 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="Plane" />
- <argument index="0" name="right" type="Plane" />
+ <param index="0" name="right" type="Plane" />
<description>
Transforms (multiplies) the [Plane] by the given [Transform3D] transformation matrix.
</description>
</operator>
<operator name="operator *">
<return type="Transform3D" />
- <argument index="0" name="right" type="Transform3D" />
+ <param 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="Vector3" />
- <argument index="0" name="right" type="Vector3" />
+ <param index="0" name="right" type="Vector3" />
<description>
Transforms (multiplies) the [Vector3] by the given [Transform3D] matrix.
</description>
</operator>
<operator name="operator *">
<return type="Transform3D" />
- <argument index="0" name="right" type="float" />
+ <param index="0" name="right" type="float" />
<description>
This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly.
</description>
</operator>
<operator name="operator *">
<return type="Transform3D" />
- <argument index="0" name="right" type="int" />
+ <param index="0" name="right" type="int" />
<description>
This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly.
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
- <argument index="0" name="right" type="Transform3D" />
+ <param 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.