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 doc/base/classes.xml source instead.

.. _class_Transform2D:

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

**Category:** Built-In Types

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

3x2 Matrix for 2D transforms.

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>` rot, :ref:`Vector2<class_vector2>` pos  **)**                                                 |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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>` m, :ref:`float<class_float>` c  **)**                                   |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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
----------------

- :ref:`Vector2<class_vector2>` **origin**
- :ref:`Vector2<class_vector2>` **x**
- :ref:`Vector2<class_vector2>` **y**

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

3x2 Matrix for 2D transforms.

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

.. _class_Transform2D_Transform2D:

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

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

.. _class_Transform2D_Transform2D:

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

.. _class_Transform2D_affine_inverse:

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

Return the inverse of the matrix.

.. _class_Transform2D_basis_xform:

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

.. _class_Transform2D_basis_xform_inv:

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

.. _class_Transform2D_get_origin:

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

.. _class_Transform2D_get_rotation:

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

Return the rotation (in radians).

.. _class_Transform2D_get_scale:

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

.. _class_Transform2D_interpolate_with:

- :ref:`Transform2D<class_transform2d>`  **interpolate_with**  **(** :ref:`Transform2D<class_transform2d>` m, :ref:`float<class_float>` c  **)**

.. _class_Transform2D_inverse:

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

.. _class_Transform2D_orthonormalized:

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

.. _class_Transform2D_rotated:

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

.. _class_Transform2D_scaled:

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

.. _class_Transform2D_translated:

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

.. _class_Transform2D_xform:

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

.. _class_Transform2D_xform_inv:

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