godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
3.1
godot-docs/classes/class_quat.rst
Rémi Verschelde 3e8e67ac95 Sync classref with current source
2020-01-21 09:28:25 +01:00

256 lines
13 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Quat.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Quat:
Quat
====
**Category:** Built-In Types
Brief Description
-----------------
Quaternion.
Properties
----------
+---------------------------+---------------------------------+
| :ref:`float<class_float>` | :ref:`w<class_Quat_property_w>` |
+---------------------------+---------------------------------+
| :ref:`float<class_float>` | :ref:`x<class_Quat_property_x>` |
+---------------------------+---------------------------------+
| :ref:`float<class_float>` | :ref:`y<class_Quat_property_y>` |
+---------------------------+---------------------------------+
| :ref:`float<class_float>` | :ref:`z<class_Quat_property_z>` |
+---------------------------+---------------------------------+
Methods
-------
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_Quat>` | :ref:`Quat<class_Quat_method_Quat>` **(** :ref:`Basis<class_Basis>` from **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_Quat>` | :ref:`Quat<class_Quat_method_Quat>` **(** :ref:`Vector3<class_Vector3>` euler **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_Quat>` | :ref:`Quat<class_Quat_method_Quat>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_Quat>` | :ref:`Quat<class_Quat_method_Quat>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z, :ref:`float<class_float>` w **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_Quat>` | :ref:`cubic_slerp<class_Quat_method_cubic_slerp>` **(** :ref:`Quat<class_Quat>` b, :ref:`Quat<class_Quat>` pre_a, :ref:`Quat<class_Quat>` post_b, :ref:`float<class_float>` t **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`dot<class_Quat_method_dot>` **(** :ref:`Quat<class_Quat>` b **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`get_euler<class_Quat_method_get_euler>` **(** **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_Quat>` | :ref:`inverse<class_Quat_method_inverse>` **(** **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_normalized<class_Quat_method_is_normalized>` **(** **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`length<class_Quat_method_length>` **(** **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`length_squared<class_Quat_method_length_squared>` **(** **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_Quat>` | :ref:`normalized<class_Quat_method_normalized>` **(** **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_axis_angle<class_Quat_method_set_axis_angle>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_euler<class_Quat_method_set_euler>` **(** :ref:`Vector3<class_Vector3>` euler **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_Quat>` | :ref:`slerp<class_Quat_method_slerp>` **(** :ref:`Quat<class_Quat>` b, :ref:`float<class_float>` t **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Quat<class_Quat>` | :ref:`slerpni<class_Quat_method_slerpni>` **(** :ref:`Quat<class_Quat>` b, :ref:`float<class_float>` t **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`xform<class_Quat_method_xform>` **(** :ref:`Vector3<class_Vector3>` v **)** |
+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Constants
---------
.. _class_Quat_constant_IDENTITY:
- **IDENTITY** = **Quat( 0, 0, 0, 1 )**
Description
-----------
A unit quaternion used for representing 3D rotations.
It is similar to :ref:`Basis<class_Basis>`, which implements matrix representation of rotations, and can be parametrized using both an axis-angle pair or Euler angles. But due to its compactness and the way it is stored in memory, certain operations (obtaining axis-angle and performing SLERP, in particular) are more efficient and robust against floating point errors.
Quaternions need to be (re)normalized.
Tutorials
---------
- `#interpolating-with-quaternions <../tutorials/3d/using_transforms.html#interpolating-with-quaternions>`_ in :doc:`../tutorials/3d/using_transforms`
Property Descriptions
---------------------
.. _class_Quat_property_w:
- :ref:`float<class_float>` **w**
W component of the quaternion. Default value: ``1``
----
.. _class_Quat_property_x:
- :ref:`float<class_float>` **x**
X component of the quaternion. Default value: ``0``
----
.. _class_Quat_property_y:
- :ref:`float<class_float>` **y**
Y component of the quaternion. Default value: ``0``
----
.. _class_Quat_property_z:
- :ref:`float<class_float>` **z**
Z component of the quaternion. Default value: ``0``
Method Descriptions
-------------------
.. _class_Quat_method_Quat:
- :ref:`Quat<class_Quat>` **Quat** **(** :ref:`Basis<class_Basis>` from **)**
Returns the rotation matrix corresponding to the given quaternion.
----
- :ref:`Quat<class_Quat>` **Quat** **(** :ref:`Vector3<class_Vector3>` euler **)**
Returns a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle).
----
- :ref:`Quat<class_Quat>` **Quat** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)**
Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector.
----
- :ref:`Quat<class_Quat>` **Quat** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z, :ref:`float<class_float>` w **)**
Returns a quaternion defined by these values.
----
.. _class_Quat_method_cubic_slerp:
- :ref:`Quat<class_Quat>` **cubic_slerp** **(** :ref:`Quat<class_Quat>` b, :ref:`Quat<class_Quat>` pre_a, :ref:`Quat<class_Quat>` post_b, :ref:`float<class_float>` t **)**
Performs a cubic spherical-linear interpolation with another quaternion.
----
.. _class_Quat_method_dot:
- :ref:`float<class_float>` **dot** **(** :ref:`Quat<class_Quat>` b **)**
Returns the dot product of two quaternions.
----
.. _class_Quat_method_get_euler:
- :ref:`Vector3<class_Vector3>` **get_euler** **(** **)**
Returns Euler angles (in the YXZ convention: first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle).
----
.. _class_Quat_method_inverse:
- :ref:`Quat<class_Quat>` **inverse** **(** **)**
Returns the inverse of the quaternion.
----
.. _class_Quat_method_is_normalized:
- :ref:`bool<class_bool>` **is_normalized** **(** **)**
Returns whether the quaternion is normalized or not.
----
.. _class_Quat_method_length:
- :ref:`float<class_float>` **length** **(** **)**
Returns the length of the quaternion.
----
.. _class_Quat_method_length_squared:
- :ref:`float<class_float>` **length_squared** **(** **)**
Returns the length of the quaternion, squared.
----
.. _class_Quat_method_normalized:
- :ref:`Quat<class_Quat>` **normalized** **(** **)**
Returns a copy of the quaternion, normalized to unit length.
----
.. _class_Quat_method_set_axis_angle:
- void **set_axis_angle** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)**
Set the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector.
----
.. _class_Quat_method_set_euler:
- void **set_euler** **(** :ref:`Vector3<class_Vector3>` euler **)**
Set the quaternion to a rotation specified by Euler angles (in the YXZ convention: first Z, then X, and Y last), given in the vector format as (X-angle, Y-angle, Z-angle).
----
.. _class_Quat_method_slerp:
- :ref:`Quat<class_Quat>` **slerp** **(** :ref:`Quat<class_Quat>` b, :ref:`float<class_float>` t **)**
Performs a spherical-linear interpolation with another quaternion.
----
.. _class_Quat_method_slerpni:
- :ref:`Quat<class_Quat>` **slerpni** **(** :ref:`Quat<class_Quat>` b, :ref:`float<class_float>` t **)**
Performs a spherical-linear interpolation with another quaterion without checking if the rotation path is not bigger than 90°.
----
.. _class_Quat_method_xform:
- :ref:`Vector3<class_Vector3>` **xform** **(** :ref:`Vector3<class_Vector3>` v **)**
Transforms the vector ``v`` by this quaternion.
Reference in New Issue View Git Blame Copy Permalink