<?xml version="1.0" encoding="UTF-8" ?> <class name="Transform2D" version="4.0"> <brief_description> 2D transformation (2×3 matrix). </brief_description> <description> 2×3 matrix (2 rows, 3 columns) used for 2D linear transformations. It can represent transformations such as translation, rotation, or scaling. It consists of a three [Vector2] values: [member x], [member y], and the [member origin]. For more information, read the "Matrices and transforms" documentation article. </description> <tutorials> <link title="Math tutorial 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="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"> <return type="Transform2D"> </return> <description> Constructs a default-initialized [Transform] set to [constant IDENTITY]. </description> </method> <method name="Transform2D" qualifiers="constructor"> <return type="Transform2D"> </return> <argument index="0" name="from" type="Transform2D"> </argument> <description> Constructs a [Transform2D] as a copy of the given [Transform2D]. </description> </method> <method name="Transform2D" qualifiers="constructor"> <return type="Transform2D"> </return> <argument index="0" name="rotation" type="float"> </argument> <argument index="1" name="position" type="Vector2"> </argument> <description> Constructs the transform from a given angle (in radians) and position. </description> </method> <method name="Transform2D" qualifiers="constructor"> <return type="Transform2D"> </return> <argument index="0" name="x_axis" type="Vector2"> </argument> <argument index="1" name="y_axis" type="Vector2"> </argument> <argument index="2" name="origin" type="Vector2"> </argument> <description> Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors). </description> </method> <method name="affine_inverse" qualifiers="const"> <return type="Transform2D"> </return> <description> Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. </description> </method> <method name="basis_xform" qualifiers="const"> <return type="Vector2"> </return> <argument index="0" name="v" type="Vector2"> </argument> <description> Returns a vector transformed (multiplied) by the basis matrix. This method does not account for translation (the origin vector). </description> </method> <method name="basis_xform_inv" qualifiers="const"> <return type="Vector2"> </return> <argument index="0" name="v" type="Vector2"> </argument> <description> Returns a vector transformed (multiplied) by the inverse basis matrix. This method does not account for translation (the origin vector). </description> </method> <method name="get_origin" qualifiers="const"> <return type="Vector2"> </return> <description> Returns the transform's origin (translation). </description> </method> <method name="get_rotation" qualifiers="const"> <return type="float"> </return> <description> Returns the transform's rotation (in radians). </description> </method> <method name="get_scale" qualifiers="const"> <return type="Vector2"> </return> <description> Returns the scale. </description> </method> <method name="interpolate_with" qualifiers="const"> <return type="Transform2D"> </return> <argument index="0" name="xform" type="Transform2D"> </argument> <argument index="1" name="weight" type="float"> </argument> <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> </method> <method name="inverse" qualifiers="const"> <return type="Transform2D"> </return> <description> Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use [method affine_inverse] for transforms with scaling). </description> </method> <method name="is_equal_approx" qualifiers="const"> <return type="bool"> </return> <argument index="0" name="xform" type="Transform2D"> </argument> <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="operator !=" qualifiers="operator"> <return type="bool"> </return> <argument index="0" name="right" type="Transform2D"> </argument> <description> </description> </method> <method name="operator *" qualifiers="operator"> <return type="Vector2"> </return> <argument index="0" name="right" type="Vector2"> </argument> <description> </description> </method> <method name="operator *" qualifiers="operator"> <return type="Rect2"> </return> <argument index="0" name="right" type="Rect2"> </argument> <description> </description> </method> <method name="operator *" qualifiers="operator"> <return type="Transform2D"> </return> <argument index="0" name="right" type="Transform2D"> </argument> <description> </description> </method> <method name="operator *" qualifiers="operator"> <return type="PackedVector2Array"> </return> <argument index="0" name="right" type="PackedVector2Array"> </argument> <description> </description> </method> <method name="operator ==" qualifiers="operator"> <return type="bool"> </return> <argument index="0" name="right" type="Transform2D"> </argument> <description> </description> </method> <method name="operator []" qualifiers="operator"> <return type="Vector2"> </return> <argument index="0" name="index" type="int"> </argument> <description> </description> </method> <method name="orthonormalized" qualifiers="const"> <return type="Transform2D"> </return> <description> Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1). </description> </method> <method name="rotated" qualifiers="const"> <return type="Transform2D"> </return> <argument index="0" name="phi" type="float"> </argument> <description> Rotates the transform by the given angle (in radians), using matrix multiplication. </description> </method> <method name="scaled" qualifiers="const"> <return type="Transform2D"> </return> <argument index="0" name="scale" type="Vector2"> </argument> <description> Scales the transform by the given scale factor, using matrix multiplication. </description> </method> <method name="translated" qualifiers="const"> <return type="Transform2D"> </return> <argument index="0" name="offset" type="Vector2"> </argument> <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. </description> </method> </methods> <members> <member name="origin" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )"> The origin vector (column 2, the third column). Equivalent to array index [code]2[/code]. The origin vector represents translation. </member> <member name="x" type="Vector2" setter="" getter="" default="Vector2( 1, 0 )"> The basis matrix's X vector (column 0). Equivalent to array index [code]0[/code]. </member> <member name="y" type="Vector2" setter="" getter="" default="Vector2( 0, 1 )"> The basis matrix's Y vector (column 1). Equivalent to array index [code]1[/code]. </member> </members> <constants> <constant name="IDENTITY" value="Transform2D( 1, 0, 0, 1, 0, 0 )"> The identity [Transform2D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. </constant> <constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )"> The [Transform2D] that will flip something along the X axis. </constant> <constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )"> The [Transform2D] that will flip something along the Y axis. </constant> </constants> </class>