2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "Transform2D" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
2020-07-21 18:07:00 +00:00
2D transformation (2× 3 matrix).
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2020-07-21 18:07:00 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2020-07-21 18:07:00 +00:00
<link > https://docs.godotengine.org/en/latest/tutorials/math/matrices_and_transforms.html</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
<method name= "Transform2D" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "from" type= "Transform" >
</argument>
<description >
2017-12-24 21:12:07 +00:00
Constructs the transform from a 3D [Transform].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "Transform2D" >
<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 >
2020-07-21 18:07:00 +00:00
Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "Transform2D" >
<return type= "Transform2D" >
</return>
2017-09-23 08:59:35 +00:00
<argument index= "0" name= "rotation" type= "float" >
2017-09-12 20:42:36 +00:00
</argument>
2017-09-10 13:37:49 +00:00
<argument index= "1" name= "position" type= "Vector2" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2017-12-24 21:12:07 +00:00
Constructs the transform from a given angle (in radians) and position.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "affine_inverse" >
<return type= "Transform2D" >
</return>
<description >
2020-07-21 18:07:00 +00:00
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "basis_xform" >
2018-01-30 11:45:54 +00:00
<return type= "Vector2" >
2017-09-12 20:42:36 +00:00
</return>
2018-01-30 11:45:54 +00:00
<argument index= "0" name= "v" type= "Vector2" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns a vector transformed (multiplied) by the basis matrix.
This method does not account for translation (the origin vector).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "basis_xform_inv" >
2018-01-30 11:45:54 +00:00
<return type= "Vector2" >
2017-09-12 20:42:36 +00:00
</return>
2018-01-30 11:45:54 +00:00
<argument index= "0" name= "v" type= "Vector2" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns a vector transformed (multiplied) by the inverse basis matrix.
This method does not account for translation (the origin vector).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_origin" >
<return type= "Vector2" >
</return>
<description >
2017-12-24 21:12:07 +00:00
Returns the transform's origin (translation).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_rotation" >
<return type= "float" >
</return>
<description >
2017-12-24 21:12:07 +00:00
Returns the transform's rotation (in radians).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_scale" >
<return type= "Vector2" >
</return>
<description >
2017-09-14 05:42:21 +00:00
Returns the scale.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "interpolate_with" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "transform" type= "Transform2D" >
</argument>
<argument index= "1" name= "weight" type= "float" >
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns a transform interpolated between this transform and another by a given weight (on the range of 0.0 to 1.0).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "inverse" >
<return type= "Transform2D" >
</return>
<description >
2020-07-21 18:07:00 +00:00
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).
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-11-08 07:33:48 +00:00
<method name= "is_equal_approx" >
<return type= "bool" >
</return>
<argument index= "0" name= "transform" type= "Transform2D" >
</argument>
<description >
2019-11-30 20:08:50 +00:00
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
2019-11-08 07:33:48 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "orthonormalized" >
<return type= "Transform2D" >
</return>
<description >
2020-07-21 18:07:00 +00:00
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "rotated" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "phi" type= "float" >
</argument>
<description >
2019-12-13 20:23:26 +00:00
Rotates the transform by the given angle (in radians), using matrix multiplication.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "scaled" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "scale" type= "Vector2" >
</argument>
<description >
2019-12-13 20:23:26 +00:00
Scales the transform by the given scale factor, using matrix multiplication.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "translated" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "offset" type= "Vector2" >
</argument>
<description >
2019-12-13 20:23:26 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "xform" >
2020-03-18 08:14:39 +00:00
<return type= "Variant" >
2017-09-12 20:42:36 +00:00
</return>
2018-08-31 20:38:28 +00:00
<argument index= "0" name= "v" type= "Variant" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-02-18 12:59:24 +00:00
Transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "xform_inv" >
2020-03-18 08:14:39 +00:00
<return type= "Variant" >
2017-09-12 20:42:36 +00:00
</return>
2018-08-31 20:38:28 +00:00
<argument index= "0" name= "v" type= "Variant" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-02-18 12:59:24 +00:00
Inverse-transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members >
2019-06-29 10:38:01 +00:00
<member name= "origin" type= "Vector2" setter= "" getter= "" default= "Vector2( 0, 0 )" >
2020-07-21 18:07:00 +00:00
The origin vector (column 2, the third column). Equivalent to array index [code]2[/code]. The origin vector represents translation.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "x" type= "Vector2" setter= "" getter= "" default= "Vector2( 1, 0 )" >
2020-07-21 18:07:00 +00:00
The basis matrix's X vector (column 0). Equivalent to array index [code]0[/code].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "y" type= "Vector2" setter= "" getter= "" default= "Vector2( 0, 1 )" >
2020-07-21 18:07:00 +00:00
The basis matrix's Y vector (column 1). Equivalent to array index [code]1[/code].
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants >
2018-08-20 22:35:30 +00:00
<constant name= "IDENTITY" value= "Transform2D( 1, 0, 0, 1, 0, 0 )" >
2020-07-21 18:07:00 +00:00
The identity [Transform2D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation.
2018-08-20 22:35:30 +00:00
</constant>
<constant name= "FLIP_X" value= "Transform2D( -1, 0, 0, 1, 0, 0 )" >
2020-07-21 18:07:00 +00:00
The [Transform2D] that will flip something along the X axis.
2018-08-20 22:35:30 +00:00
</constant>
<constant name= "FLIP_Y" value= "Transform2D( 1, 0, 0, -1, 0, 0 )" >
2020-07-21 18:07:00 +00:00
The [Transform2D] that will flip something along the Y axis.
2018-08-20 22:35:30 +00:00
</constant>
2017-09-12 20:42:36 +00:00
</constants>
</class>