2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "Transform2D" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2019-06-22 07:04:47 +08:00
2D transformation (3× 2 matrix).
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2019-06-22 07:04:47 +08:00
Represents one or many transformations in 2D space such as translation, rotation, or scaling. It consists of two [member x] and [member y] [Vector2]s and an [member origin]. It is similar to a 3× 2 matrix.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "Transform2D" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "from" type= "Transform" >
</argument>
<description >
2017-12-25 05:12:07 +08:00
Constructs the transform from a 3D [Transform].
2017-09-13 04:42:36 +08: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 >
2017-12-25 05:12:07 +08:00
Constructs the transform from 3 [Vector2]s representing x, y, and origin.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "Transform2D" >
<return type= "Transform2D" >
</return>
2017-09-23 16:59:35 +08:00
<argument index= "0" name= "rotation" type= "float" >
2017-09-13 04:42:36 +08:00
</argument>
2017-09-10 21:37:49 +08:00
<argument index= "1" name= "position" type= "Vector2" >
2017-09-13 04:42:36 +08:00
</argument>
<description >
2017-12-25 05:12:07 +08:00
Constructs the transform from a given angle (in radians) and position.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "affine_inverse" >
<return type= "Transform2D" >
</return>
<description >
Returns the inverse of the matrix.
</description>
</method>
<method name= "basis_xform" >
2018-01-30 19:45:54 +08:00
<return type= "Vector2" >
2017-09-13 04:42:36 +08:00
</return>
2018-01-30 19:45:54 +08:00
<argument index= "0" name= "v" type= "Vector2" >
2017-09-13 04:42:36 +08:00
</argument>
<description >
2017-12-25 05:12:07 +08:00
Transforms the given vector by this transform's basis (no translation).
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "basis_xform_inv" >
2018-01-30 19:45:54 +08:00
<return type= "Vector2" >
2017-09-13 04:42:36 +08:00
</return>
2018-01-30 19:45:54 +08:00
<argument index= "0" name= "v" type= "Vector2" >
2017-09-13 04:42:36 +08:00
</argument>
<description >
2017-12-25 05:12:07 +08:00
Inverse-transforms the given vector by this transform's basis (no translation).
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_origin" >
<return type= "Vector2" >
</return>
<description >
2017-12-25 05:12:07 +08:00
Returns the transform's origin (translation).
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_rotation" >
<return type= "float" >
</return>
<description >
2017-12-25 05:12:07 +08:00
Returns the transform's rotation (in radians).
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "get_scale" >
<return type= "Vector2" >
</return>
<description >
2017-09-14 13:42:21 +08:00
Returns the scale.
2017-09-13 04:42:36 +08: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 >
2017-12-25 05:12:07 +08:00
Returns a transform interpolated between this transform and another by a given weight (0-1).
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "inverse" >
<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 affine_inverse for transforms with scaling).
</description>
</method>
2019-11-08 15:33:48 +08:00
<method name= "is_equal_approx" >
<return type= "bool" >
</return>
<argument index= "0" name= "transform" type= "Transform2D" >
</argument>
<description >
2019-12-01 04:08:50 +08: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 15:33:48 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "orthonormalized" >
<return type= "Transform2D" >
</return>
<description >
2017-10-14 18:45:26 +08:00
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "rotated" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "phi" type= "float" >
</argument>
<description >
2019-12-14 04:23:26 +08:00
Rotates the transform by the given angle (in radians), using matrix multiplication.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "scaled" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "scale" type= "Vector2" >
</argument>
<description >
2019-12-14 04:23:26 +08:00
Scales the transform by the given scale factor, using matrix multiplication.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "translated" >
<return type= "Transform2D" >
</return>
<argument index= "0" name= "offset" type= "Vector2" >
</argument>
<description >
2019-12-14 04:23:26 +08: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-13 04:42:36 +08:00
</description>
</method>
<method name= "xform" >
2018-09-01 04:38:28 +08:00
<return type= "Variant" >
2017-09-13 04:42:36 +08:00
</return>
2018-09-01 04:38:28 +08:00
<argument index= "0" name= "v" type= "Variant" >
2017-09-13 04:42:36 +08:00
</argument>
<description >
2020-02-18 20:59:24 +08:00
Transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "xform_inv" >
2018-09-01 04:38:28 +08:00
<return type= "Variant" >
2017-09-13 04:42:36 +08:00
</return>
2018-09-01 04:38:28 +08:00
<argument index= "0" name= "v" type= "Variant" >
2017-09-13 04:42:36 +08:00
</argument>
<description >
2020-02-18 20:59:24 +08:00
Inverse-transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this transform.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "origin" type= "Vector2" setter= "" getter= "" default= "Vector2( 0, 0 )" >
2017-12-25 05:12:07 +08:00
The transform's translation offset.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "x" type= "Vector2" setter= "" getter= "" default= "Vector2( 1, 0 )" >
2019-06-22 07:04:47 +08:00
The X axis of 2× 2 basis matrix containing 2 [Vector2]s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "y" type= "Vector2" setter= "" getter= "" default= "Vector2( 0, 1 )" >
2019-06-22 07:04:47 +08:00
The Y axis of 2× 2 basis matrix containing 2 [Vector2]s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object.
2017-09-13 04:42:36 +08:00
</member>
</members>
<constants >
2018-08-21 06:35:30 +08:00
<constant name= "IDENTITY" value= "Transform2D( 1, 0, 0, 1, 0, 0 )" >
2019-07-05 10:10:47 +08:00
[Transform2D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation.
2018-08-21 06:35:30 +08:00
</constant>
<constant name= "FLIP_X" value= "Transform2D( -1, 0, 0, 1, 0, 0 )" >
2019-07-05 10:10:47 +08:00
[Transform2D] with mirroring applied parallel to the X axis.
2018-08-21 06:35:30 +08:00
</constant>
<constant name= "FLIP_Y" value= "Transform2D( 1, 0, 0, -1, 0, 0 )" >
2019-07-05 10:10:47 +08:00
[Transform2D] with mirroring applied parallel to the Y axis.
2018-08-21 06:35:30 +08:00
</constant>
2017-09-13 04:42:36 +08:00
</constants>
</class>