godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-01 21:48:57 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
2.1
godot-docs/classes/class_transform.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

148 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_Transform:
Transform
=========
**Category:** Built-In Types
Brief Description
-----------------
3D Transformation.
Member Functions
----------------
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`Transform<class_Transform_Transform>` **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis, :ref:`Vector3<class_vector3>` origin **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`Transform<class_Transform_Transform>` **(** :ref:`Matrix3<class_matrix3>` basis, :ref:`Vector3<class_vector3>` origin **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`Transform<class_Transform_Transform>` **(** :ref:`Matrix32<class_matrix32>` from **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`Transform<class_Transform_Transform>` **(** :ref:`Quat<class_quat>` from **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`Transform<class_Transform_Transform>` **(** :ref:`Matrix3<class_matrix3>` from **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`affine_inverse<class_Transform_affine_inverse>` **(** **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`inverse<class_Transform_inverse>` **(** **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`looking_at<class_Transform_looking_at>` **(** :ref:`Vector3<class_vector3>` target, :ref:`Vector3<class_vector3>` up **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`orthonormalized<class_Transform_orthonormalized>` **(** **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`rotated<class_Transform_rotated>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`scaled<class_Transform_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`translated<class_Transform_translated>` **(** :ref:`Vector3<class_vector3>` ofs **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| var | :ref:`xform<class_Transform_xform>` **(** var v **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| var | :ref:`xform_inv<class_Transform_xform_inv>` **(** var v **)** |
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Matrix3<class_matrix3>` **basis** - The basis contains 3 [Vector3]. X axis, Y axis, and Z axis.
- :ref:`Vector3<class_vector3>` **origin** - The origin of the transform. Which is the translation offset.
Description
-----------
Transform is used to store transformations, including translations. It consists of a Matrix3 "basis" and Vector3 "origin". Transform is used to represent transformations of any object in space. It is similar to a 4x3 matrix.
Member Function Description
---------------------------
.. _class_Transform_Transform:
- :ref:`Transform<class_transform>` **Transform** **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis, :ref:`Vector3<class_vector3>` origin **)**
Construct the Transform from four Vector3. Each axis creates the basis.
.. _class_Transform_Transform:
- :ref:`Transform<class_transform>` **Transform** **(** :ref:`Matrix3<class_matrix3>` basis, :ref:`Vector3<class_vector3>` origin **)**
Construct the Transform from a Matrix3 and Vector3.
.. _class_Transform_Transform:
- :ref:`Transform<class_transform>` **Transform** **(** :ref:`Matrix32<class_matrix32>` from **)**
Construct the Transform from a Matrix32.
.. _class_Transform_Transform:
- :ref:`Transform<class_transform>` **Transform** **(** :ref:`Quat<class_quat>` from **)**
Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0)
.. _class_Transform_Transform:
- :ref:`Transform<class_transform>` **Transform** **(** :ref:`Matrix3<class_matrix3>` from **)**
Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0)
.. _class_Transform_affine_inverse:
- :ref:`Transform<class_transform>` **affine_inverse** **(** **)**
Returns the inverse of the transfrom, even if the transform has scale or the axis vectors are not orthogonal.
.. _class_Transform_inverse:
- :ref:`Transform<class_transform>` **inverse** **(** **)**
Returns the inverse of the transform.
.. _class_Transform_looking_at:
- :ref:`Transform<class_transform>` **looking_at** **(** :ref:`Vector3<class_vector3>` target, :ref:`Vector3<class_vector3>` up **)**
Rotate the transform around the up vector to face the target.
.. _class_Transform_orthonormalized:
- :ref:`Transform<class_transform>` **orthonormalized** **(** **)**
Returns a transfrom with the basis orthogonal (90 degrees), and normalized axis vectors.
.. _class_Transform_rotated:
- :ref:`Transform<class_transform>` **rotated** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
Rotate the transform locally.
.. _class_Transform_scaled:
- :ref:`Transform<class_transform>` **scaled** **(** :ref:`Vector3<class_vector3>` scale **)**
Scale the transform locally.
.. _class_Transform_translated:
- :ref:`Transform<class_transform>` **translated** **(** :ref:`Vector3<class_vector3>` ofs **)**
Translate the transform locally.
.. _class_Transform_xform:
- var **xform** **(** var v **)**
Transforms vector "v" by this transform.
.. _class_Transform_xform_inv:
- var **xform_inv** **(** var v **)**
Inverse-transforms vector "v" by this transform.
Reference in New Issue View Git Blame Copy Permalink