godot-docs/classes/class_basis.rst

:github_url: hide

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

.. _class_Basis:

Basis
=====

3×3 matrix datatype.

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

3×3 matrix used for 3D rotation and scale. Almost always used as an orthogonal basis for a :ref:`Transform3D<class_Transform3D>`.

Contains 3 vector fields X, Y and Z as its columns, which are typically interpreted as the local basis vectors of a transformation. For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S).

Can also be accessed as array of 3D vectors. These vectors are normally orthogonal to each other, but are not necessarily normalized (due to scaling).

For more information, read the "Matrices and transforms" documentation article.

Tutorials
---------

- :doc:`Math documentation index <../tutorials/math/index>`

- :doc:`Matrices and transforms <../tutorials/math/matrices_and_transforms>`

- :doc:`Using 3D transforms <../tutorials/3d/using_transforms>`

- `Matrix Transform Demo <https://godotengine.org/asset-library/asset/584>`__

- `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`__

- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`__

- `2.5D Demo <https://godotengine.org/asset-library/asset/583>`__

Properties
----------

+-------------------------------+----------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`x<class_Basis_property_x>` | ``Vector3(1, 0, 0)`` |
+-------------------------------+----------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`y<class_Basis_property_y>` | ``Vector3(0, 1, 0)`` |
+-------------------------------+----------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`z<class_Basis_property_z>` | ``Vector3(0, 0, 1)`` |
+-------------------------------+----------------------------------+----------------------+

Constructors
------------

+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_constructor_Basis>` **(** **)**                                                                                                                  |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_constructor_Basis>` **(** :ref:`Basis<class_Basis>` from **)**                                                                                   |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_constructor_Basis>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)**                                                |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_constructor_Basis>` **(** :ref:`Quaternion<class_Quaternion>` from **)**                                                                         |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>` | :ref:`Basis<class_Basis_constructor_Basis>` **(** :ref:`Vector3<class_Vector3>` x_axis, :ref:`Vector3<class_Vector3>` y_axis, :ref:`Vector3<class_Vector3>` z_axis **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Methods
-------

+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`           | :ref:`determinant<class_Basis_method_determinant>` **(** **)** |const|                                                                                        |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`           | :ref:`from_euler<class_Basis_method_from_euler>` **(** :ref:`Vector3<class_Vector3>` euler, :ref:`int<class_int>` order=2 **)** |static|                      |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`           | :ref:`from_scale<class_Basis_method_from_scale>` **(** :ref:`Vector3<class_Vector3>` scale **)** |static|                                                     |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>`       | :ref:`get_euler<class_Basis_method_get_euler>` **(** :ref:`int<class_int>` order=2 **)** |const|                                                              |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`               | :ref:`get_orthogonal_index<class_Basis_method_get_orthogonal_index>` **(** **)** |const|                                                                      |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quaternion<class_Quaternion>` | :ref:`get_rotation_quaternion<class_Basis_method_get_rotation_quaternion>` **(** **)** |const|                                                                |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>`       | :ref:`get_scale<class_Basis_method_get_scale>` **(** **)** |const|                                                                                            |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`           | :ref:`inverse<class_Basis_method_inverse>` **(** **)** |const|                                                                                                |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`             | :ref:`is_equal_approx<class_Basis_method_is_equal_approx>` **(** :ref:`Basis<class_Basis>` b **)** |const|                                                    |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`           | :ref:`looking_at<class_Basis_method_looking_at>` **(** :ref:`Vector3<class_Vector3>` target, :ref:`Vector3<class_Vector3>` up=Vector3(0, 1, 0) **)** |static| |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`           | :ref:`orthonormalized<class_Basis_method_orthonormalized>` **(** **)** |const|                                                                                |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`           | :ref:`rotated<class_Basis_method_rotated>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)** |const|                              |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`           | :ref:`scaled<class_Basis_method_scaled>` **(** :ref:`Vector3<class_Vector3>` scale **)** |const|                                                              |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`           | :ref:`slerp<class_Basis_method_slerp>` **(** :ref:`Basis<class_Basis>` to, :ref:`float<class_float>` weight **)** |const|                                     |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`           | :ref:`tdotx<class_Basis_method_tdotx>` **(** :ref:`Vector3<class_Vector3>` with **)** |const|                                                                 |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`           | :ref:`tdoty<class_Basis_method_tdoty>` **(** :ref:`Vector3<class_Vector3>` with **)** |const|                                                                 |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`           | :ref:`tdotz<class_Basis_method_tdotz>` **(** :ref:`Vector3<class_Vector3>` with **)** |const|                                                                 |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`           | :ref:`transposed<class_Basis_method_transposed>` **(** **)** |const|                                                                                          |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+

Operators
---------

+-------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`operator !=<class_Basis_operator_neq_bool>` **(** **)**                                       |
+-------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`operator !=<class_Basis_operator_neq_bool>` **(** :ref:`Basis<class_Basis>` right **)**       |
+-------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`     | :ref:`operator *<class_Basis_operator_mul_Basis>` **(** :ref:`Basis<class_Basis>` right **)**       |
+-------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`operator *<class_Basis_operator_mul_Vector3>` **(** :ref:`Vector3<class_Vector3>` right **)** |
+-------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`     | :ref:`operator *<class_Basis_operator_mul_Basis>` **(** :ref:`float<class_float>` right **)**       |
+-------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>`     | :ref:`operator *<class_Basis_operator_mul_Basis>` **(** :ref:`int<class_int>` right **)**           |
+-------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`operator ==<class_Basis_operator_eq_bool>` **(** **)**                                        |
+-------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`operator ==<class_Basis_operator_eq_bool>` **(** :ref:`Basis<class_Basis>` right **)**        |
+-------------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`operator []<class_Basis_operator_idx_Vector3>` **(** :ref:`int<class_int>` index **)**        |
+-------------------------------+-----------------------------------------------------------------------------------------------------+

Constants
---------

.. _class_Basis_constant_EULER_ORDER_XYZ:

.. _class_Basis_constant_EULER_ORDER_XZY:

.. _class_Basis_constant_EULER_ORDER_YXZ:

.. _class_Basis_constant_EULER_ORDER_YZX:

.. _class_Basis_constant_EULER_ORDER_ZXY:

.. _class_Basis_constant_EULER_ORDER_ZYX:

.. _class_Basis_constant_IDENTITY:

.. _class_Basis_constant_FLIP_X:

.. _class_Basis_constant_FLIP_Y:

.. _class_Basis_constant_FLIP_Z:

- **EULER_ORDER_XYZ** = **0**

- **EULER_ORDER_XZY** = **1**

- **EULER_ORDER_YXZ** = **2**

- **EULER_ORDER_YZX** = **3**

- **EULER_ORDER_ZXY** = **4**

- **EULER_ORDER_ZYX** = **5**

- **IDENTITY** = **Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)** --- The identity basis, with no rotation or scaling applied.

This is identical to calling ``Basis()`` without any parameters. This constant can be used to make your code clearer, and for consistency with C#.

- **FLIP_X** = **Basis(-1, 0, 0, 0, 1, 0, 0, 0, 1)** --- The basis that will flip something along the X axis when used in a transformation.

- **FLIP_Y** = **Basis(1, 0, 0, 0, -1, 0, 0, 0, 1)** --- The basis that will flip something along the Y axis when used in a transformation.

- **FLIP_Z** = **Basis(1, 0, 0, 0, 1, 0, 0, 0, -1)** --- The basis that will flip something along the Z axis when used in a transformation.

Property Descriptions
---------------------

.. _class_Basis_property_x:

- :ref:`Vector3<class_Vector3>` **x**

+-----------+----------------------+
| *Default* | ``Vector3(1, 0, 0)`` |
+-----------+----------------------+

The basis matrix's X vector (column 0). Equivalent to array index ``0``.

----

.. _class_Basis_property_y:

- :ref:`Vector3<class_Vector3>` **y**

+-----------+----------------------+
| *Default* | ``Vector3(0, 1, 0)`` |
+-----------+----------------------+

The basis matrix's Y vector (column 1). Equivalent to array index ``1``.

----

.. _class_Basis_property_z:

- :ref:`Vector3<class_Vector3>` **z**

+-----------+----------------------+
| *Default* | ``Vector3(0, 0, 1)`` |
+-----------+----------------------+

The basis matrix's Z vector (column 2). Equivalent to array index ``2``.

Constructor Descriptions
------------------------

.. _class_Basis_constructor_Basis:

- :ref:`Basis<class_Basis>` **Basis** **(** **)**

Constructs a default-initialized ``Basis`` set to :ref:`IDENTITY<class_Basis_constant_IDENTITY>`.

----

- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Basis<class_Basis>` from **)**

Constructs a ``Basis`` as a copy of the given ``Basis``.

----

- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)**

Constructs a pure rotation basis matrix, rotated around the given ``axis`` by ``phi``, in radians. The axis must be a normalized vector.

----

- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Quaternion<class_Quaternion>` from **)**

Constructs a pure rotation basis matrix from the given quaternion.

----

- :ref:`Basis<class_Basis>` **Basis** **(** :ref:`Vector3<class_Vector3>` x_axis, :ref:`Vector3<class_Vector3>` y_axis, :ref:`Vector3<class_Vector3>` z_axis **)**

Constructs a basis matrix from 3 axis vectors (matrix columns).

Method Descriptions
-------------------

.. _class_Basis_method_determinant:

- :ref:`float<class_float>` **determinant** **(** **)** |const|

Returns the determinant of the basis matrix. If the basis is uniformly scaled, its determinant is the square of the scale.

A negative determinant means the basis has a negative scale. A zero determinant means the basis isn't invertible, and is usually considered invalid.

----

.. _class_Basis_method_from_euler:

- :ref:`Basis<class_Basis>` **from_euler** **(** :ref:`Vector3<class_Vector3>` euler, :ref:`int<class_int>` order=2 **)** |static|

----

.. _class_Basis_method_from_scale:

- :ref:`Basis<class_Basis>` **from_scale** **(** :ref:`Vector3<class_Vector3>` scale **)** |static|

Constructs a pure scale basis matrix with no rotation or shearing. The scale values are set as the diagonal of the matrix, and the other parts of the matrix are zero.

----

.. _class_Basis_method_get_euler:

- :ref:`Vector3<class_Vector3>` **get_euler** **(** :ref:`int<class_int>` order=2 **)** |const|

Returns the basis's rotation in the form of Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last). The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle).

Consider using the :ref:`get_rotation_quaternion<class_Basis_method_get_rotation_quaternion>` method instead, which returns a :ref:`Quaternion<class_Quaternion>` quaternion instead of Euler angles.

----

.. _class_Basis_method_get_orthogonal_index:

- :ref:`int<class_int>` **get_orthogonal_index** **(** **)** |const|

This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the :ref:`GridMap<class_GridMap>` editor. For further details, refer to the Godot source code.

----

.. _class_Basis_method_get_rotation_quaternion:

- :ref:`Quaternion<class_Quaternion>` **get_rotation_quaternion** **(** **)** |const|

Returns the basis's rotation in the form of a quaternion. See :ref:`get_euler<class_Basis_method_get_euler>` if you need Euler angles, but keep in mind quaternions should generally be preferred to Euler angles.

----

.. _class_Basis_method_get_scale:

- :ref:`Vector3<class_Vector3>` **get_scale** **(** **)** |const|

Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis.

----

.. _class_Basis_method_inverse:

- :ref:`Basis<class_Basis>` **inverse** **(** **)** |const|

Returns the inverse of the matrix.

----

.. _class_Basis_method_is_equal_approx:

- :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Basis<class_Basis>` b **)** |const|

Returns ``true`` if this basis and ``b`` are approximately equal, by calling ``is_equal_approx`` on each component.

----

.. _class_Basis_method_looking_at:

- :ref:`Basis<class_Basis>` **looking_at** **(** :ref:`Vector3<class_Vector3>` target, :ref:`Vector3<class_Vector3>` up=Vector3(0, 1, 0) **)** |static|

Creates a Basis with a rotation such that the forward axis (-Z) points towards the ``target`` position.

The up axis (+Y) points as close to the ``up`` vector as possible while staying perpendicular to the forward axis. The resulting Basis is orthonormalized. The ``target`` and ``up`` vectors cannot be zero, and cannot be parallel to each other.

----

.. _class_Basis_method_orthonormalized:

- :ref:`Basis<class_Basis>` **orthonormalized** **(** **)** |const|

Returns the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix.

----

.. _class_Basis_method_rotated:

- :ref:`Basis<class_Basis>` **rotated** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)** |const|

Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector.

----

.. _class_Basis_method_scaled:

- :ref:`Basis<class_Basis>` **scaled** **(** :ref:`Vector3<class_Vector3>` scale **)** |const|

Introduce an additional scaling specified by the given 3D scaling factor.

----

.. _class_Basis_method_slerp:

- :ref:`Basis<class_Basis>` **slerp** **(** :ref:`Basis<class_Basis>` to, :ref:`float<class_float>` weight **)** |const|

Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix.

----

.. _class_Basis_method_tdotx:

- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_Vector3>` with **)** |const|

Transposed dot product with the X axis of the matrix.

----

.. _class_Basis_method_tdoty:

- :ref:`float<class_float>` **tdoty** **(** :ref:`Vector3<class_Vector3>` with **)** |const|

Transposed dot product with the Y axis of the matrix.

----

.. _class_Basis_method_tdotz:

- :ref:`float<class_float>` **tdotz** **(** :ref:`Vector3<class_Vector3>` with **)** |const|

Transposed dot product with the Z axis of the matrix.

----

.. _class_Basis_method_transposed:

- :ref:`Basis<class_Basis>` **transposed** **(** **)** |const|

Returns the transposed version of the matrix.

Operator Descriptions
---------------------

.. _class_Basis_operator_neq_bool:

- :ref:`bool<class_bool>` **operator !=** **(** **)**

----

- :ref:`bool<class_bool>` **operator !=** **(** :ref:`Basis<class_Basis>` right **)**

Returns ``true`` if the ``Basis`` matrices are not equal.

**Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Basis_method_is_equal_approx>` instead, which is more reliable.

----

.. _class_Basis_operator_mul_Basis:

- :ref:`Basis<class_Basis>` **operator *** **(** :ref:`Basis<class_Basis>` right **)**

Composes these two basis matrices by multiplying them together. This has the effect of transforming the second basis (the child) by the first basis (the parent).

----

- :ref:`Vector3<class_Vector3>` **operator *** **(** :ref:`Vector3<class_Vector3>` right **)**

Transforms (multiplies) the :ref:`Vector3<class_Vector3>` by the given ``Basis`` matrix.

----

- :ref:`Basis<class_Basis>` **operator *** **(** :ref:`float<class_float>` right **)**

This operator multiplies all components of the ``Basis``, which scales it uniformly.

----

- :ref:`Basis<class_Basis>` **operator *** **(** :ref:`int<class_int>` right **)**

This operator multiplies all components of the ``Basis``, which scales it uniformly.

----

.. _class_Basis_operator_eq_bool:

- :ref:`bool<class_bool>` **operator ==** **(** **)**

----

- :ref:`bool<class_bool>` **operator ==** **(** :ref:`Basis<class_Basis>` right **)**

Returns ``true`` if the ``Basis`` matrices are exactly equal.

**Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Basis_method_is_equal_approx>` instead, which is more reliable.

----

.. _class_Basis_operator_idx_Vector3:

- :ref:`Vector3<class_Vector3>` **operator []** **(** :ref:`int<class_int>` index **)**

Access basis components using their index. ``b[0]`` is equivalent to ``b.x``, ``b[1]`` is equivalent to ``b.y``, and ``b[2]`` is equivalent to ``b.z``.

.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`