diff options
Diffstat (limited to 'doc/classes/Quaternion.xml')
| -rw-r--r-- | doc/classes/Quaternion.xml | 102 |
1 files changed, 58 insertions, 44 deletions
diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml index 48e6317b11..a521af5709 100644 --- a/doc/classes/Quaternion.xml +++ b/doc/classes/Quaternion.xml @@ -21,45 +21,45 @@ </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="from" type="Quaternion" /> + <param index="0" name="from" type="Quaternion" /> <description> Constructs a [Quaternion] as a copy of the given [Quaternion]. </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="arc_from" type="Vector3" /> - <argument index="1" name="arc_to" type="Vector3" /> + <param index="0" name="arc_from" type="Vector3" /> + <param index="1" name="arc_to" type="Vector3" /> <description> </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <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> Constructs a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="euler_yxz" type="Vector3" /> + <param index="0" name="euler_yxz" type="Vector3" /> <description> </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="from" type="Basis" /> + <param index="0" name="from" type="Basis" /> <description> Constructs a quaternion from the given [Basis]. </description> </constructor> <constructor name="Quaternion"> <return type="Quaternion" /> - <argument index="0" name="x" type="float" /> - <argument index="1" name="y" type="float" /> - <argument index="2" name="z" type="float" /> - <argument index="3" name="w" type="float" /> + <param index="0" name="x" type="float" /> + <param index="1" name="y" type="float" /> + <param index="2" name="z" type="float" /> + <param index="3" name="w" type="float" /> <description> Constructs a quaternion defined by the given values. </description> @@ -68,25 +68,15 @@ <methods> <method name="angle_to" qualifiers="const"> <return type="float" /> - <argument index="0" name="to" type="Quaternion" /> + <param index="0" name="to" type="Quaternion" /> <description> - Returns the angle between this quaternion and [code]to[/code]. This is the magnitude of the angle you would need to rotate by to get from one to the other. - [b]Note:[/b] This method has an abnormally high amount of floating-point error, so methods such as [code]is_zero_approx[/code] will not work reliably. - </description> - </method> - <method name="cubic_slerp" qualifiers="const"> - <return type="Quaternion" /> - <argument index="0" name="b" type="Quaternion" /> - <argument index="1" name="pre_a" type="Quaternion" /> - <argument index="2" name="post_b" type="Quaternion" /> - <argument index="3" name="weight" type="float" /> - <description> - Performs a cubic spherical interpolation between quaternions [code]pre_a[/code], this vector, [code]b[/code], and [code]post_b[/code], by the given amount [code]weight[/code]. + Returns the angle between this quaternion and [param to]. This is the magnitude of the angle you would need to rotate by to get from one to the other. + [b]Note:[/b] This method has an abnormally high number of floating-point errors, so methods such as [code]is_zero_approx[/code] will not work reliably. </description> </method> <method name="dot" qualifiers="const"> <return type="float" /> - <argument index="0" name="with" type="Quaternion" /> + <param index="0" name="with" type="Quaternion" /> <description> Returns the dot product of two quaternions. </description> @@ -120,9 +110,9 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="to" type="Quaternion" /> + <param index="0" name="to" type="Quaternion" /> <description> - Returns [code]true[/code] if this quaternion and [code]quat[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. + Returns [code]true[/code] if this quaternion and [param to] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. </description> </method> <method name="is_normalized" qualifiers="const"> @@ -156,19 +146,43 @@ </method> <method name="slerp" qualifiers="const"> <return type="Quaternion" /> - <argument index="0" name="to" type="Quaternion" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Quaternion" /> + <param index="1" name="weight" type="float" /> <description> - Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code]. + Returns the result of the spherical linear interpolation between this quaternion and [param to] by amount [param weight]. [b]Note:[/b] Both quaternions must be normalized. </description> </method> <method name="slerpni" qualifiers="const"> <return type="Quaternion" /> - <argument index="0" name="to" type="Quaternion" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="to" type="Quaternion" /> + <param index="1" name="weight" type="float" /> + <description> + Returns the result of the spherical linear interpolation between this quaternion and [param to] by amount [param weight], but without checking if the rotation path is not bigger than 90 degrees. + </description> + </method> + <method name="spherical_cubic_interpolate" qualifiers="const"> + <return type="Quaternion" /> + <param index="0" name="b" type="Quaternion" /> + <param index="1" name="pre_a" type="Quaternion" /> + <param index="2" name="post_b" type="Quaternion" /> + <param index="3" name="weight" type="float" /> + <description> + Performs a spherical cubic interpolation between quaternions [param pre_a], this vector, [param b], and [param post_b], by the given amount [param weight]. + </description> + </method> + <method name="spherical_cubic_interpolate_in_time" qualifiers="const"> + <return type="Quaternion" /> + <param index="0" name="b" type="Quaternion" /> + <param index="1" name="pre_a" type="Quaternion" /> + <param index="2" name="post_b" type="Quaternion" /> + <param index="3" name="weight" type="float" /> + <param index="4" name="b_t" type="float" /> + <param index="5" name="pre_a_t" type="float" /> + <param index="6" name="post_b_t" type="float" /> <description> - Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code], but without checking if the rotation path is not bigger than 90 degrees. + Performs a spherical cubic interpolation between quaternions [param pre_a], this vector, [param b], and [param post_b], by the given amount [param weight]. + It can perform smoother interpolation than [code]spherical_cubic_interpolate()[/code] by the time values. </description> </method> </methods> @@ -198,7 +212,7 @@ <operators> <operator name="operator !="> <return type="bool" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Returns [code]true[/code] if the quaternions are not equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -206,63 +220,63 @@ </operator> <operator name="operator *"> <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Composes these two quaternions by multiplying them together. This has the effect of rotating the second quaternion (the child) by the first quaternion (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> Rotates (multiplies) the [Vector3] by the given [Quaternion]. </description> </operator> <operator name="operator *"> <return type="Quaternion" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Multiplies each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator *"> <return type="Quaternion" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Multiplies each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator +"> <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Adds each component of the left [Quaternion] to the right [Quaternion]. This operation is not meaningful on its own, but it can be used as a part of a larger expression, such as approximating an intermediate rotation between two nearby rotations. </description> </operator> <operator name="operator -"> <return type="Quaternion" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Subtracts each component of the left [Quaternion] by the right [Quaternion]. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator /"> <return type="Quaternion" /> - <argument index="0" name="right" type="float" /> + <param index="0" name="right" type="float" /> <description> Divides each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator /"> <return type="Quaternion" /> - <argument index="0" name="right" type="int" /> + <param index="0" name="right" type="int" /> <description> Divides each component of the [Quaternion] by the given value. This operation is not meaningful on its own, but it can be used as a part of a larger expression. </description> </operator> <operator name="operator =="> <return type="bool" /> - <argument index="0" name="right" type="Quaternion" /> + <param index="0" name="right" type="Quaternion" /> <description> Returns [code]true[/code] if the quaternions are exactly equal. [b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable. @@ -270,7 +284,7 @@ </operator> <operator name="operator []"> <return type="float" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Access quaternion components using their index. [code]q[0][/code] is equivalent to [code]q.x[/code], [code]q[1][/code] is equivalent to [code]q.y[/code], [code]q[2][/code] is equivalent to [code]q.z[/code], and [code]q[3][/code] is equivalent to [code]q.w[/code]. </description> |