:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Transform2D.xml. .. _class_Transform2D: Transform2D =========== 2D transformation (2×3 matrix). .. rst-class:: classref-introduction-group 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 three :ref:`Vector2` values: :ref:`x`, :ref:`y`, and the :ref:`origin`. For more information, read the "Matrices and transforms" documentation article. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Math tutorial index <../tutorials/math/index>` - :doc:`Matrices and transforms <../tutorials/math/matrices_and_transforms>` - `Matrix Transform Demo `__ - `2.5D Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+--------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`origin` | ``Vector2( 0, 0 )`` | +-------------------------------+--------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`x` | ``Vector2( 1, 0 )`` | +-------------------------------+--------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`y` | ``Vector2( 0, 1 )`` | +-------------------------------+--------------------------------------------------+---------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Transform` from **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`Transform2D` **(** :ref:`float` rotation, :ref:`Vector2` position **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`affine_inverse` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`basis_xform` **(** :ref:`Vector2` v **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`basis_xform_inv` **(** :ref:`Vector2` v **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`determinant` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_origin` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rotation` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_scale` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`interpolate_with` **(** :ref:`Transform2D` transform, :ref:`float` weight **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`inverse` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Transform2D` transform **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`orthonormalized` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`rotated` **(** :ref:`float` angle **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`scaled` **(** :ref:`Vector2` scale **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`translated` **(** :ref:`Vector2` offset **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`xform` **(** :ref:`Variant` v **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`xform_inv` **(** :ref:`Variant` v **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_Transform2D_constant_IDENTITY: .. rst-class:: classref-constant **IDENTITY** = ``Transform2D( 1, 0, 0, 1, 0, 0 )`` The identity **Transform2D** with no translation, rotation or scaling applied. When applied to other data structures, :ref:`IDENTITY` performs no transformation. .. _class_Transform2D_constant_FLIP_X: .. rst-class:: classref-constant **FLIP_X** = ``Transform2D( -1, 0, 0, 1, 0, 0 )`` The **Transform2D** that will flip something along the X axis. .. _class_Transform2D_constant_FLIP_Y: .. rst-class:: classref-constant **FLIP_Y** = ``Transform2D( 1, 0, 0, -1, 0, 0 )`` The **Transform2D** that will flip something along the Y axis. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Transform2D_property_origin: .. rst-class:: classref-property :ref:`Vector2` **origin** = ``Vector2( 0, 0 )`` The origin vector (column 2, the third column). Equivalent to array index ``2``. The origin vector represents translation. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_property_x: .. rst-class:: classref-property :ref:`Vector2` **x** = ``Vector2( 1, 0 )`` The basis matrix's X vector (column 0). Equivalent to array index ``0``. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_property_y: .. rst-class:: classref-property :ref:`Vector2` **y** = ``Vector2( 0, 1 )`` The basis matrix's Y vector (column 1). Equivalent to array index ``1``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Transform2D_method_Transform2D: .. rst-class:: classref-method :ref:`Transform2D` **Transform2D** **(** :ref:`Transform` from **)** Constructs the transform from a 3D :ref:`Transform`. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-method :ref:`Transform2D` **Transform2D** **(** :ref:`Vector2` x_axis, :ref:`Vector2` y_axis, :ref:`Vector2` origin **)** Constructs the transform from 3 :ref:`Vector2` values representing :ref:`x`, :ref:`y`, and the :ref:`origin` (the three column vectors). .. rst-class:: classref-item-separator ---- .. rst-class:: classref-method :ref:`Transform2D` **Transform2D** **(** :ref:`float` rotation, :ref:`Vector2` position **)** Constructs the transform from a given angle (in radians) and position. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_affine_inverse: .. rst-class:: classref-method :ref:`Transform2D` **affine_inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_basis_xform: .. rst-class:: classref-method :ref:`Vector2` **basis_xform** **(** :ref:`Vector2` v **)** Returns a vector transformed (multiplied) by the basis matrix. This method does not account for translation (the origin vector). .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_basis_xform_inv: .. rst-class:: classref-method :ref:`Vector2` **basis_xform_inv** **(** :ref:`Vector2` v **)** Returns a vector transformed (multiplied) by the inverse basis matrix. This method does not account for translation (the origin vector). .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_determinant: .. rst-class:: classref-method :ref:`float` **determinant** **(** **)** Returns the determinant of the basis matrix. If the basis is uniformly scaled, then its determinant equals the square of the scale factor. A negative determinant means the basis was flipped, so one part of the scale is negative. A zero determinant means the basis isn't invertible, and is usually considered invalid. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_get_origin: .. rst-class:: classref-method :ref:`Vector2` **get_origin** **(** **)** Returns the transform's origin (translation). .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_get_rotation: .. rst-class:: classref-method :ref:`float` **get_rotation** **(** **)** Returns the transform's rotation (in radians). .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_get_scale: .. rst-class:: classref-method :ref:`Vector2` **get_scale** **(** **)** Returns the scale. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_interpolate_with: .. rst-class:: classref-method :ref:`Transform2D` **interpolate_with** **(** :ref:`Transform2D` transform, :ref:`float` weight **)** Returns a transform interpolated between this transform and another by a given ``weight`` (on the range of 0.0 to 1.0). .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_inverse: .. rst-class:: classref-method :ref:`Transform2D` **inverse** **(** **)** Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use :ref:`affine_inverse` for transforms with scaling). .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_is_equal_approx: .. rst-class:: classref-method :ref:`bool` **is_equal_approx** **(** :ref:`Transform2D` transform **)** Returns ``true`` if this transform and ``transform`` are approximately equal, by calling ``is_equal_approx`` on each component. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_orthonormalized: .. rst-class:: classref-method :ref:`Transform2D` **orthonormalized** **(** **)** Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1). .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_rotated: .. rst-class:: classref-method :ref:`Transform2D` **rotated** **(** :ref:`float` angle **)** Returns a copy of the transform rotated by the given ``angle`` (in radians), using matrix multiplication. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_scaled: .. rst-class:: classref-method :ref:`Transform2D` **scaled** **(** :ref:`Vector2` scale **)** Returns a copy of the transform scaled by the given ``scale`` factor, using matrix multiplication. \ **Note:** 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. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_translated: .. rst-class:: classref-method :ref:`Transform2D` **translated** **(** :ref:`Vector2` offset **)** Returns a copy of the transform translated by the given ``offset``, relative to the transform's basis vectors. Unlike :ref:`rotated` and :ref:`scaled`, this does not use matrix multiplication. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_xform: .. rst-class:: classref-method :ref:`Variant` **xform** **(** :ref:`Variant` v **)** Transforms the given :ref:`Vector2`, :ref:`Rect2`, or :ref:`PoolVector2Array` by this transform. .. rst-class:: classref-item-separator ---- .. _class_Transform2D_method_xform_inv: .. rst-class:: classref-method :ref:`Variant` **xform_inv** **(** :ref:`Variant` v **)** Inverse-transforms the given :ref:`Vector2`, :ref:`Rect2`, or :ref:`PoolVector2Array` by this transform, under the assumption that the transformation is composed of rotation and translation (no scaling). Equivalent to calling ``inverse().xform(v)`` on this transform. For affine transformations (e.g. with scaling) see :ref:`affine_inverse` method. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`