godot-docs/classes/class_transform2d.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Transform2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Transform2D:

Transform2D
===========

**Category:** Built-In Types

Brief Description
-----------------

2D Transformation. 3x2 matrix.

Member Functions
----------------

+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`Transform2D<class_Transform2D_Transform2D>` **(** :ref:`Transform<class_transform>` from **)**                                                                           |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`Transform2D<class_Transform2D_Transform2D>` **(** :ref:`Vector2<class_vector2>` x_axis, :ref:`Vector2<class_vector2>` y_axis, :ref:`Vector2<class_vector2>` origin **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`Transform2D<class_Transform2D_Transform2D>` **(** :ref:`float<class_float>` rotation, :ref:`Vector2<class_vector2>` position **)**                                       |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`affine_inverse<class_Transform2D_affine_inverse>` **(** **)**                                                                                                            |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`basis_xform<class_Transform2D_basis_xform>` **(** var v **)**                                                                                                            |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`basis_xform_inv<class_Transform2D_basis_xform_inv>` **(** var v **)**                                                                                                    |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`          | :ref:`get_origin<class_Transform2D_get_origin>` **(** **)**                                                                                                                    |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`              | :ref:`get_rotation<class_Transform2D_get_rotation>` **(** **)**                                                                                                                |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`          | :ref:`get_scale<class_Transform2D_get_scale>` **(** **)**                                                                                                                      |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`interpolate_with<class_Transform2D_interpolate_with>` **(** :ref:`Transform2D<class_transform2d>` transform, :ref:`float<class_float>` weight **)**                      |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`inverse<class_Transform2D_inverse>` **(** **)**                                                                                                                          |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`orthonormalized<class_Transform2D_orthonormalized>` **(** **)**                                                                                                          |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`rotated<class_Transform2D_rotated>` **(** :ref:`float<class_float>` phi **)**                                                                                            |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`scaled<class_Transform2D_scaled>` **(** :ref:`Vector2<class_vector2>` scale **)**                                                                                        |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`translated<class_Transform2D_translated>` **(** :ref:`Vector2<class_vector2>` offset **)**                                                                               |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`xform<class_Transform2D_xform>` **(** var v **)**                                                                                                                        |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>`  | :ref:`xform_inv<class_Transform2D_xform_inv>` **(** var v **)**                                                                                                                |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

  .. _class_Transform2D_origin:

- :ref:`Vector2<class_vector2>` **origin** - The transform's translation offset.

  .. _class_Transform2D_x:

- :ref:`Vector2<class_vector2>` **x** - The X axis of 2x2 basis matrix containing 2 :ref:`Vector2<class_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.

  .. _class_Transform2D_y:

- :ref:`Vector2<class_vector2>` **y** - The Y axis of 2x2 basis matrix containing 2 :ref:`Vector2<class_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.


Description
-----------

Represents one or many transformations in 2D space such as translation, rotation, or scaling. It consists of a two :ref:`Vector2<class_vector2>` x, y and :ref:`Vector2<class_vector2>` "origin". It is similar to a 3x2 matrix.

Member Function Description
---------------------------

.. _class_Transform2D_Transform2D:

- :ref:`Transform2D<class_transform2d>` **Transform2D** **(** :ref:`Transform<class_transform>` from **)**

Constructs the transform from a 3D :ref:`Transform<class_transform>`.

.. _class_Transform2D_Transform2D:

- :ref:`Transform2D<class_transform2d>` **Transform2D** **(** :ref:`Vector2<class_vector2>` x_axis, :ref:`Vector2<class_vector2>` y_axis, :ref:`Vector2<class_vector2>` origin **)**

Constructs the transform from 3 :ref:`Vector2<class_vector2>`\ s representing x, y, and origin.

.. _class_Transform2D_Transform2D:

- :ref:`Transform2D<class_transform2d>` **Transform2D** **(** :ref:`float<class_float>` rotation, :ref:`Vector2<class_vector2>` position **)**

Constructs the transform from a given angle (in radians) and position.

.. _class_Transform2D_affine_inverse:

- :ref:`Transform2D<class_transform2d>` **affine_inverse** **(** **)**

Returns the inverse of the matrix.

.. _class_Transform2D_basis_xform:

- :ref:`Transform2D<class_transform2d>` **basis_xform** **(** var v **)**

Transforms the given vector by this transform's basis (no translation).

.. _class_Transform2D_basis_xform_inv:

- :ref:`Transform2D<class_transform2d>` **basis_xform_inv** **(** var v **)**

Inverse-transforms the given vector by this transform's basis (no translation).

.. _class_Transform2D_get_origin:

- :ref:`Vector2<class_vector2>` **get_origin** **(** **)**

Returns the transform's origin (translation).

.. _class_Transform2D_get_rotation:

- :ref:`float<class_float>` **get_rotation** **(** **)**

Returns the transform's rotation (in radians).

.. _class_Transform2D_get_scale:

- :ref:`Vector2<class_vector2>` **get_scale** **(** **)**

Returns the scale.

.. _class_Transform2D_interpolate_with:

- :ref:`Transform2D<class_transform2d>` **interpolate_with** **(** :ref:`Transform2D<class_transform2d>` transform, :ref:`float<class_float>` weight **)**

Returns a transform interpolated between this transform and another by a given weight (0-1).

.. _class_Transform2D_inverse:

- :ref:`Transform2D<class_transform2d>` **inverse** **(** **)**

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).

.. _class_Transform2D_orthonormalized:

- :ref:`Transform2D<class_transform2d>` **orthonormalized** **(** **)**

Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.

.. _class_Transform2D_rotated:

- :ref:`Transform2D<class_transform2d>` **rotated** **(** :ref:`float<class_float>` phi **)**

Rotates the transform by the given angle (in radians).

.. _class_Transform2D_scaled:

- :ref:`Transform2D<class_transform2d>` **scaled** **(** :ref:`Vector2<class_vector2>` scale **)**

Scales the transform by the given factor.

.. _class_Transform2D_translated:

- :ref:`Transform2D<class_transform2d>` **translated** **(** :ref:`Vector2<class_vector2>` offset **)**

Translates the transform by the given offset.

.. _class_Transform2D_xform:

- :ref:`Transform2D<class_transform2d>` **xform** **(** var v **)**

Transforms the given vector "v" by this transform.

.. _class_Transform2D_xform_inv:

- :ref:`Transform2D<class_transform2d>` **xform_inv** **(** var v **)**

Inverse-transforms the given vector "v" by this transform.