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
2.1
godot-docs/classes/class_matrix3.rst
Rémi Verschelde 1b5e8c18fd classref: Order everything alphabetically 
And sync with current 2.0.x sources.
2016-06-25 02:10:54 +02:00

169 lines
10 KiB
ReStructuredText
Raw Permalink Blame History

.. 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_Matrix3:
Matrix3
=======
**Category:** Built-In Types
Brief Description
-----------------
3x3 matrix datatype.
Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`Matrix3<class_Matrix3_Matrix3>` **(** :ref:`Quat<class_quat>` from **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`Matrix3<class_Matrix3_Matrix3>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`Matrix3<class_Matrix3_Matrix3>` **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`determinant<class_Matrix3_determinant>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_euler<class_Matrix3_get_euler>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_orthogonal_index<class_Matrix3_get_orthogonal_index>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_scale<class_Matrix3_get_scale>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`inverse<class_Matrix3_inverse>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`orthonormalized<class_Matrix3_orthonormalized>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`rotated<class_Matrix3_rotated>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`scaled<class_Matrix3_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdotx<class_Matrix3_tdotx>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdoty<class_Matrix3_tdoty>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tdotz<class_Matrix3_tdotz>` **(** :ref:`Vector3<class_vector3>` with **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix3<class_matrix3>` | :ref:`transposed<class_Matrix3_transposed>` **(** **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`xform<class_Matrix3_xform>` **(** :ref:`Vector3<class_vector3>` v **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`xform_inv<class_Matrix3_xform_inv>` **(** :ref:`Vector3<class_vector3>` v **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Vector3<class_vector3>` **x**
- :ref:`Vector3<class_vector3>` **y**
- :ref:`Vector3<class_vector3>` **z**
Description
-----------
3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z. Can also be accessed as array of 3D vectors. Almost always used as orthogonal basis for a :ref:`Transform<class_transform>`.
Member Function Description
---------------------------
.. _class_Matrix3_Matrix3:
- :ref:`Matrix3<class_matrix3>` **Matrix3** **(** :ref:`Quat<class_quat>` from **)**
Create a matrix from a quaternion.
.. _class_Matrix3_Matrix3:
- :ref:`Matrix3<class_matrix3>` **Matrix3** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
Create a matrix from an axis vector and an angle.
.. _class_Matrix3_Matrix3:
- :ref:`Matrix3<class_matrix3>` **Matrix3** **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)**
Create a matrix from 3 axis vectors.
.. _class_Matrix3_determinant:
- :ref:`float<class_float>` **determinant** **(** **)**
Return the determinant of the matrix.
.. _class_Matrix3_get_euler:
- :ref:`Vector3<class_vector3>` **get_euler** **(** **)**
Return euler angles from the matrix.
.. _class_Matrix3_get_orthogonal_index:
- :ref:`int<class_int>` **get_orthogonal_index** **(** **)**
.. _class_Matrix3_get_scale:
- :ref:`Vector3<class_vector3>` **get_scale** **(** **)**
.. _class_Matrix3_inverse:
- :ref:`Matrix3<class_matrix3>` **inverse** **(** **)**
Return the affine inverse of the matrix.
.. _class_Matrix3_orthonormalized:
- :ref:`Matrix3<class_matrix3>` **orthonormalized** **(** **)**
Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error).
.. _class_Matrix3_rotated:
- :ref:`Matrix3<class_matrix3>` **rotated** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
Return the rotated version of the matrix, by a given axis and angle.
.. _class_Matrix3_scaled:
- :ref:`Matrix3<class_matrix3>` **scaled** **(** :ref:`Vector3<class_vector3>` scale **)**
Return the scaled version of the matrix, by a 3D scale.
.. _class_Matrix3_tdotx:
- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_vector3>` with **)**
Transposed dot product with the x axis of the matrix.
.. _class_Matrix3_tdoty:
- :ref:`float<class_float>` **tdoty** **(** :ref:`Vector3<class_vector3>` with **)**
Transposed dot product with the y axis of the matrix.
.. _class_Matrix3_tdotz:
- :ref:`float<class_float>` **tdotz** **(** :ref:`Vector3<class_vector3>` with **)**
Transposed dot product with the z axis of the matrix.
.. _class_Matrix3_transposed:
- :ref:`Matrix3<class_matrix3>` **transposed** **(** **)**
Return the transposed version of the matrix.
.. _class_Matrix3_xform:
- :ref:`Vector3<class_vector3>` **xform** **(** :ref:`Vector3<class_vector3>` v **)**
Return a vector transformed by the matrix and return it.
.. _class_Matrix3_xform_inv:
- :ref:`Vector3<class_vector3>` **xform_inv** **(** :ref:`Vector3<class_vector3>` v **)**
Return a vector transformed by the transposed matrix and return it.
Reference in New Issue View Git Blame Copy Permalink