diff options
Diffstat (limited to 'doc/classes/Transform2D.xml')
| -rw-r--r-- | doc/classes/Transform2D.xml | 250 |
1 files changed, 146 insertions, 104 deletions
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index d64752a00f..905b3d77af 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Transform2D" version="4.0"> +<class name="Transform2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> 2D transformation (2×3 matrix). </brief_description> @@ -8,52 +8,54 @@ For more information, read the "Matrices and transforms" documentation article. </description> <tutorials> - <link title="Math documentation index">https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> - <link title="Matrices and transforms">https://docs.godotengine.org/en/latest/tutorials/math/matrices_and_transforms.html</link> + <link title="Math documentation index">$DOCS_URL/tutorials/math/index.html</link> + <link title="Matrices and transforms">$DOCS_URL/tutorials/math/matrices_and_transforms.html</link> <link title="Matrix Transform Demo">https://godotengine.org/asset-library/asset/584</link> <link title="2.5D Demo">https://godotengine.org/asset-library/asset/583</link> </tutorials> - <methods> - <method name="Transform2D" qualifiers="constructor"> + <constructors> + <constructor name="Transform2D"> <return type="Transform2D" /> <description> Constructs a default-initialized [Transform2D] set to [constant IDENTITY]. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> - <argument index="0" name="from" type="Transform2D" /> + <param index="0" name="from" type="Transform2D" /> <description> Constructs a [Transform2D] as a copy of the given [Transform2D]. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> - <argument index="0" name="rotation" type="float" /> - <argument index="1" name="position" type="Vector2" /> + <param index="0" name="rotation" type="float" /> + <param index="1" name="position" type="Vector2" /> <description> Constructs the transform from a given angle (in radians) and position. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> - <argument index="0" name="rotation" type="float" /> - <argument index="1" name="scale" type="Vector2" /> - <argument index="2" name="skew" type="float" /> - <argument index="3" name="position" type="Vector2" /> + <param index="0" name="rotation" type="float" /> + <param index="1" name="scale" type="Vector2" /> + <param index="2" name="skew" type="float" /> + <param index="3" name="position" type="Vector2" /> <description> Constructs the transform from a given angle (in radians), scale, skew (in radians) and position. </description> - </method> - <method name="Transform2D" qualifiers="constructor"> + </constructor> + <constructor name="Transform2D"> <return type="Transform2D" /> - <argument index="0" name="x_axis" type="Vector2" /> - <argument index="1" name="y_axis" type="Vector2" /> - <argument index="2" name="origin" type="Vector2" /> + <param index="0" name="x_axis" type="Vector2" /> + <param index="1" name="y_axis" type="Vector2" /> + <param index="2" name="origin" type="Vector2" /> <description> Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors). </description> - </method> + </constructor> + </constructors> + <methods> <method name="affine_inverse" qualifiers="const"> <return type="Transform2D" /> <description> @@ -62,7 +64,7 @@ </method> <method name="basis_xform" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="v" type="Vector2" /> + <param index="0" name="v" type="Vector2" /> <description> Returns a vector transformed (multiplied) by the basis matrix. This method does not account for translation (the origin vector). @@ -70,7 +72,7 @@ </method> <method name="basis_xform_inv" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="v" type="Vector2" /> + <param index="0" name="v" type="Vector2" /> <description> Returns a vector transformed (multiplied) by the inverse basis matrix. This method does not account for translation (the origin vector). @@ -102,10 +104,10 @@ </method> <method name="interpolate_with" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="xform" type="Transform2D" /> - <argument index="1" name="weight" type="float" /> + <param index="0" name="xform" type="Transform2D" /> + <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). + Returns a transform interpolated between this transform and another by a given [param weight] (on the range of 0.0 to 1.0). </description> </method> <method name="inverse" qualifiers="const"> @@ -116,132 +118,105 @@ </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool" /> - <argument index="0" name="xform" type="Transform2D" /> + <param index="0" name="xform" type="Transform2D" /> <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="Transform2D" /> - <argument index="0" name="target" type="Vector2" default="Vector2(0, 0)" /> + <param index="0" name="target" type="Vector2" default="Vector2(0, 0)" /> <description> - Returns a copy of the transform rotated such that it's rotation on the X-axis points towards the [code]target[/code] position. + Returns a copy of the transform rotated such that it's rotation on the X-axis points towards the [param target] position. Operations take place in global space. </description> </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator !=" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="PackedVector2Array" /> - <argument index="0" name="right" type="PackedVector2Array" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Transform2D" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Rect2" /> - <argument index="0" name="right" type="Rect2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="right" type="Vector2" /> - <description> - </description> - </method> - <method name="operator *" qualifiers="operator"> + <method name="orthonormalized" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="right" type="float" /> <description> - This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. + Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1). </description> </method> - <method name="operator *" qualifiers="operator"> + <method name="rotated" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="right" type="int" /> - <description> - This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <description> - </description> - </method> - <method name="operator ==" qualifiers="operator"> - <return type="bool" /> - <argument index="0" name="right" type="Transform2D" /> - <description> - </description> - </method> - <method name="operator []" qualifiers="operator"> - <return type="Vector2" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="angle" type="float" /> <description> + Returns a copy of the transform rotated by the given [param angle] (in radians). + This method is an optimized version of multiplying the given transform [code]X[/code] + with a corresponding rotation transform [code]R[/code] from the left, i.e., [code]R * X[/code]. + This can be seen as transforming with respect to the global/parent frame. </description> </method> - <method name="orthonormalized" qualifiers="const"> + <method name="rotated_local" qualifiers="const"> <return type="Transform2D" /> + <param index="0" name="angle" type="float" /> <description> - Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1). + Returns a copy of the transform rotated by the given [param angle] (in radians). + This method is an optimized version of multiplying the given transform [code]X[/code] + with a corresponding rotation transform [code]R[/code] from the right, i.e., [code]X * R[/code]. + This can be seen as transforming with respect to the local frame. </description> </method> - <method name="rotated" qualifiers="const"> + <method name="scaled" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="phi" type="float" /> + <param index="0" name="scale" type="Vector2" /> <description> - Rotates the transform by the given angle (in radians), using matrix multiplication. + Returns a copy of the transform scaled by the given [param scale] factor. + This method is an optimized version of multiplying the given transform [code]X[/code] + with a corresponding scaling transform [code]S[/code] from the left, i.e., [code]S * X[/code]. + This can be seen as transforming with respect to the global/parent frame. </description> </method> - <method name="scaled" qualifiers="const"> + <method name="scaled_local" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="scale" type="Vector2" /> + <param 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 [param scale] factor. + This method is an optimized version of multiplying the given transform [code]X[/code] + with a corresponding scaling transform [code]S[/code] from the right, i.e., [code]X * S[/code]. + This can be seen as transforming with respect to the local frame. </description> </method> <method name="set_rotation"> <return type="void" /> - <argument index="0" name="rotation" type="float" /> + <param index="0" name="rotation" type="float" /> <description> Sets the transform's rotation (in radians). </description> </method> <method name="set_scale"> <return type="void" /> - <argument index="0" name="scale" type="Vector2" /> + <param index="0" name="scale" type="Vector2" /> <description> Sets the transform's scale. + [b]Note:[/b] Negative X scales in 2D are not decomposable from the transformation matrix. Due to the way scale is represented with transformation matrices in Godot, negative scales on the X axis will be changed to negative scales on the Y axis and a rotation of 180 degrees when decomposed. </description> </method> <method name="set_skew"> <return type="void" /> - <argument index="0" name="skew" type="float" /> + <param index="0" name="skew" type="float" /> <description> Sets the transform's skew (in radians). </description> </method> <method name="translated" qualifiers="const"> <return type="Transform2D" /> - <argument index="0" name="offset" type="Vector2" /> + <param index="0" name="offset" type="Vector2" /> + <description> + Returns a copy of the transform translated by the given [param offset]. + This method is an optimized version of multiplying the given transform [code]X[/code] + with a corresponding translation transform [code]T[/code] from the left, i.e., [code]T * X[/code]. + This can be seen as transforming with respect to the global/parent frame. + </description> + </method> + <method name="translated_local" qualifiers="const"> + <return type="Transform2D" /> + <param index="0" name="offset" type="Vector2" /> <description> - Translates the transform by the given offset, relative to the transform's basis vectors. - Unlike [method rotated] and [method scaled], this does not use matrix multiplication. + Returns a copy of the transform translated by the given [param offset]. + This method is an optimized version of multiplying the given transform [code]X[/code] + with a corresponding translation transform [code]T[/code] from the right, i.e., [code]X * T[/code]. + This can be seen as transforming with respect to the local frame. </description> </method> </methods> @@ -267,4 +242,71 @@ The [Transform2D] that will flip something along the Y axis. </constant> </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <param index="0" name="right" type="Transform2D" /> + <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. + </description> + </operator> + <operator name="operator *"> + <return type="PackedVector2Array" /> + <param index="0" name="right" type="PackedVector2Array" /> + <description> + Transforms (multiplies) each element of the [Vector2] array by the given [Transform2D] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Rect2" /> + <param index="0" name="right" type="Rect2" /> + <description> + Transforms (multiplies) the [Rect2] by the given [Transform2D] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Transform2D" /> + <param index="0" name="right" type="Transform2D" /> + <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="Vector2" /> + <param index="0" name="right" type="Vector2" /> + <description> + Transforms (multiplies) the [Vector2] by the given [Transform2D] matrix. + </description> + </operator> + <operator name="operator *"> + <return type="Transform2D" /> + <param index="0" name="right" type="float" /> + <description> + This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator *"> + <return type="Transform2D" /> + <param index="0" name="right" type="int" /> + <description> + This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly. + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <param index="0" name="right" type="Transform2D" /> + <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. + </description> + </operator> + <operator name="operator []"> + <return type="Vector2" /> + <param index="0" name="index" type="int" /> + <description> + Access transform components using their index. [code]t[0][/code] is equivalent to [code]t.x[/code], [code]t[1][/code] is equivalent to [code]t.y[/code], and [code]t[2][/code] is equivalent to [code]t.origin[/code]. + </description> + </operator> + </operators> </class> |