2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-03-16 23:01:02 +01:00
<class name= "Transform2D" version= "3.5" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 22:42:36 +02:00
<brief_description >
2020-07-22 03:21:41 +02:00
2D transformation (2× 3 matrix).
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2021-08-03 06:37:57 +02: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 three [Vector2] values: [member x], [member y], and the [member origin].
2020-07-22 03:21:41 +02:00
For more information, read the "Matrices and transforms" documentation article.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2021-11-15 17:11:20 +01:00
<link title= "Math tutorial index" > $DOCS_URL/tutorials/math/index.html</link>
<link title= "Matrices and transforms" > $DOCS_URL/tutorials/math/matrices_and_transforms.html</link>
2020-10-01 10:34:47 +02:00
<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>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
<method name= "Transform2D" >
2021-07-30 15:28:05 +02:00
<return type= "Transform2D" />
<argument index= "0" name= "from" type= "Transform" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-24 22:12:07 +01:00
Constructs the transform from a 3D [Transform].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "Transform2D" >
2021-07-30 15:28:05 +02:00
<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" />
2017-09-12 22:42:36 +02:00
<description >
2020-07-22 03:21:41 +02:00
Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors).
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "Transform2D" >
2021-07-30 15:28:05 +02:00
<return type= "Transform2D" />
<argument index= "0" name= "rotation" type= "float" />
<argument index= "1" name= "position" type= "Vector2" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-24 22:12:07 +01:00
Constructs the transform from a given angle (in radians) and position.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "affine_inverse" >
2021-07-30 15:28:05 +02:00
<return type= "Transform2D" />
2017-09-12 22:42:36 +02:00
<description >
2020-07-22 03:21:41 +02:00
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "basis_xform" >
2021-07-30 15:28:05 +02:00
<return type= "Vector2" />
<argument index= "0" name= "v" type= "Vector2" />
2017-09-12 22:42:36 +02:00
<description >
2020-07-22 03:21:41 +02:00
Returns a vector transformed (multiplied) by the basis matrix.
This method does not account for translation (the origin vector).
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "basis_xform_inv" >
2021-07-30 15:28:05 +02:00
<return type= "Vector2" />
<argument index= "0" name= "v" type= "Vector2" />
2017-09-12 22:42:36 +02:00
<description >
2020-07-22 03:21:41 +02:00
Returns a vector transformed (multiplied) by the inverse basis matrix.
This method does not account for translation (the origin vector).
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_origin" >
2021-07-30 15:28:05 +02:00
<return type= "Vector2" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-24 22:12:07 +01:00
Returns the transform's origin (translation).
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_rotation" >
2021-07-30 15:28:05 +02:00
<return type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-24 22:12:07 +01:00
Returns the transform's rotation (in radians).
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_scale" >
2021-07-30 15:28:05 +02:00
<return type= "Vector2" />
2017-09-12 22:42:36 +02:00
<description >
2017-09-14 07:42:21 +02:00
Returns the scale.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "interpolate_with" >
2021-07-30 15:28:05 +02:00
<return type= "Transform2D" />
<argument index= "0" name= "transform" type= "Transform2D" />
<argument index= "1" name= "weight" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2021-04-22 19:59:16 +02:00
Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0).
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "inverse" >
2021-07-30 15:28:05 +02:00
<return type= "Transform2D" />
2017-09-12 22:42:36 +02:00
<description >
2020-07-22 03:21:41 +02: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 22:42:36 +02:00
</description>
</method>
2019-11-08 08:33:48 +01:00
<method name= "is_equal_approx" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "transform" type= "Transform2D" />
2019-11-08 08:33:48 +01:00
<description >
2019-11-30 21:08:50 +01: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 08:33:48 +01:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "orthonormalized" >
2021-07-30 15:28:05 +02:00
<return type= "Transform2D" />
2017-09-12 22:42:36 +02:00
<description >
2020-07-22 03:21:41 +02:00
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1).
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "rotated" >
2021-07-30 15:28:05 +02:00
<return type= "Transform2D" />
2022-05-05 13:25:04 +02:00
<argument index= "0" name= "angle" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2022-05-05 13:25:04 +02:00
Returns a copy of the transform rotated by the given [code]angle[/code] (in radians), using matrix multiplication.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "scaled" >
2021-07-30 15:28:05 +02:00
<return type= "Transform2D" />
<argument index= "0" name= "scale" type= "Vector2" />
2017-09-12 22:42:36 +02:00
<description >
2022-05-05 01:29:38 +02:00
Returns a copy of the transform scaled by the given [code]scale[/code] factor, using matrix multiplication.
2022-06-10 07:56:35 +02:00
[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.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "translated" >
2021-07-30 15:28:05 +02:00
<return type= "Transform2D" />
<argument index= "0" name= "offset" type= "Vector2" />
2017-09-12 22:42:36 +02:00
<description >
2022-05-05 01:29:38 +02:00
Returns a copy of the transform translated by the given [code]offset[/code], relative to the transform's basis vectors.
2019-12-13 21:23:26 +01:00
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "xform" >
2021-07-30 15:28:05 +02:00
<return type= "Variant" />
<argument index= "0" name= "v" type= "Variant" />
2017-09-12 22:42:36 +02:00
<description >
2019-08-29 12:20:10 +02:00
Transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "xform_inv" >
2021-07-30 15:28:05 +02:00
<return type= "Variant" />
<argument index= "0" name= "v" type= "Variant" />
2017-09-12 22:42:36 +02:00
<description >
2021-06-16 19:22:41 +02:00
Inverse-transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform, under the assumption that the transformation is composed of rotation and translation (no scaling). Equivalent to calling [code]inverse().xform(v)[/code] on this transform. For affine transformations (e.g. with scaling) see [method affine_inverse] method.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2019-06-29 12:38:01 +02:00
<member name= "origin" type= "Vector2" setter= "" getter= "" default= "Vector2( 0, 0 )" >
2020-07-22 03:21:41 +02:00
The origin vector (column 2, the third column). Equivalent to array index [code]2[/code]. The origin vector represents translation.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "x" type= "Vector2" setter= "" getter= "" default= "Vector2( 1, 0 )" >
2020-07-22 03:21:41 +02:00
The basis matrix's X vector (column 0). Equivalent to array index [code]0[/code].
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "y" type= "Vector2" setter= "" getter= "" default= "Vector2( 0, 1 )" >
2020-07-22 03:21:41 +02:00
The basis matrix's Y vector (column 1). Equivalent to array index [code]1[/code].
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
2018-08-21 00:35:30 +02:00
<constant name= "IDENTITY" value= "Transform2D( 1, 0, 0, 1, 0, 0 )" >
2020-07-22 03:21:41 +02:00
The identity [Transform2D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation.
2018-08-21 00:35:30 +02:00
</constant>
<constant name= "FLIP_X" value= "Transform2D( -1, 0, 0, 1, 0, 0 )" >
2020-07-22 03:21:41 +02:00
The [Transform2D] that will flip something along the X axis.
2018-08-21 00:35:30 +02:00
</constant>
<constant name= "FLIP_Y" value= "Transform2D( 1, 0, 0, -1, 0, 0 )" >
2020-07-22 03:21:41 +02:00
The [Transform2D] that will flip something along the Y axis.
2018-08-21 00:35:30 +02:00
</constant>
2017-09-12 22:42:36 +02:00
</constants>
</class>