mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
228 lines
14 KiB
ReStructuredText
228 lines
14 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Transform.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Transform:
|
|
|
|
Transform
|
|
=========
|
|
|
|
**Category:** Built-In Types
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
3D Transformation. 3x4 matrix.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+------------------------------------------------+
|
|
| :ref:`Basis<class_Basis>` | :ref:`basis<class_Transform_property_basis>` |
|
|
+-------------------------------+------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`origin<class_Transform_property_origin>` |
|
|
+-------------------------------+------------------------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`Transform<class_Transform_method_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_method_Transform>` **(** :ref:`Basis<class_Basis>` basis, :ref:`Vector3<class_Vector3>` origin **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`Transform<class_Transform_method_Transform>` **(** :ref:`Transform2D<class_Transform2D>` from **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`Transform<class_Transform_method_Transform>` **(** :ref:`Quat<class_Quat>` from **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`Transform<class_Transform_method_Transform>` **(** :ref:`Basis<class_Basis>` from **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`affine_inverse<class_Transform_method_affine_inverse>` **(** **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`interpolate_with<class_Transform_method_interpolate_with>` **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` weight **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`inverse<class_Transform_method_inverse>` **(** **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`looking_at<class_Transform_method_looking_at>` **(** :ref:`Vector3<class_Vector3>` target, :ref:`Vector3<class_Vector3>` up **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`orthonormalized<class_Transform_method_orthonormalized>` **(** **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`rotated<class_Transform_method_rotated>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`scaled<class_Transform_method_scaled>` **(** :ref:`Vector3<class_Vector3>` scale **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform<class_Transform>` | :ref:`translated<class_Transform_method_translated>` **(** :ref:`Vector3<class_Vector3>` ofs **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`xform<class_Transform_method_xform>` **(** :ref:`Variant<class_Variant>` v **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`xform_inv<class_Transform_method_xform_inv>` **(** :ref:`Variant<class_Variant>` v **)** |
|
|
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Constants
|
|
---------
|
|
|
|
.. _class_Transform_constant_IDENTITY:
|
|
|
|
.. _class_Transform_constant_FLIP_X:
|
|
|
|
.. _class_Transform_constant_FLIP_Y:
|
|
|
|
.. _class_Transform_constant_FLIP_Z:
|
|
|
|
- **IDENTITY** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** --- :ref:`Transform<class_Transform>` with no translation, rotation or scaling applied. When applied to other data structures, :ref:`IDENTITY<class_Transform_constant_IDENTITY>` performs no transformation.
|
|
|
|
- **FLIP_X** = **Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** --- :ref:`Transform<class_Transform>` with mirroring applied perpendicular to the YZ plane.
|
|
|
|
- **FLIP_Y** = **Transform( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )** --- :ref:`Transform<class_Transform>` with mirroring applied perpendicular to the XZ plane.
|
|
|
|
- **FLIP_Z** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )** --- :ref:`Transform<class_Transform>` with mirroring applied perpendicular to the XY plane.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a :ref:`Basis<class_Basis>` "basis" and an :ref:`Vector3<class_Vector3>` "origin". It is similar to a 3x4 matrix.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/math/index`
|
|
|
|
- :doc:`../tutorials/3d/using_transforms`
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_Transform_property_basis:
|
|
|
|
- :ref:`Basis<class_Basis>` **basis**
|
|
|
|
The basis is a matrix containing 3 :ref:`Vector3<class_Vector3>` as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object.
|
|
|
|
----
|
|
|
|
.. _class_Transform_property_origin:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **origin**
|
|
|
|
The translation offset of the transform.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_Transform_method_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 **)**
|
|
|
|
Constructs the Transform from four :ref:`Vector3<class_Vector3>`. Each axis corresponds to local basis vectors (some of which may be scaled).
|
|
|
|
----
|
|
|
|
- :ref:`Transform<class_Transform>` **Transform** **(** :ref:`Basis<class_Basis>` basis, :ref:`Vector3<class_Vector3>` origin **)**
|
|
|
|
Constructs the Transform from a :ref:`Basis<class_Basis>` and :ref:`Vector3<class_Vector3>`.
|
|
|
|
----
|
|
|
|
- :ref:`Transform<class_Transform>` **Transform** **(** :ref:`Transform2D<class_Transform2D>` from **)**
|
|
|
|
Constructs the Transform from a :ref:`Transform2D<class_Transform2D>`.
|
|
|
|
----
|
|
|
|
- :ref:`Transform<class_Transform>` **Transform** **(** :ref:`Quat<class_Quat>` from **)**
|
|
|
|
Constructs the Transform from a :ref:`Quat<class_Quat>`. The origin will be Vector3(0, 0, 0).
|
|
|
|
----
|
|
|
|
- :ref:`Transform<class_Transform>` **Transform** **(** :ref:`Basis<class_Basis>` from **)**
|
|
|
|
Constructs the Transform from a :ref:`Basis<class_Basis>`. The origin will be Vector3(0, 0, 0).
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_affine_inverse:
|
|
|
|
- :ref:`Transform<class_Transform>` **affine_inverse** **(** **)**
|
|
|
|
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_interpolate_with:
|
|
|
|
- :ref:`Transform<class_Transform>` **interpolate_with** **(** :ref:`Transform<class_Transform>` transform, :ref:`float<class_float>` weight **)**
|
|
|
|
Interpolates the transform to other Transform by weight amount (0-1).
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_inverse:
|
|
|
|
- :ref:`Transform<class_Transform>` **inverse** **(** **)**
|
|
|
|
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling).
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_looking_at:
|
|
|
|
- :ref:`Transform<class_Transform>` **looking_at** **(** :ref:`Vector3<class_Vector3>` target, :ref:`Vector3<class_Vector3>` up **)**
|
|
|
|
Returns a copy of the transform rotated such that its -Z axis points towards the ``target`` position.
|
|
|
|
The transform will first be rotated around the given ``up`` vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the ``target`` and ``up`` vectors.
|
|
|
|
Operations take place in global space.
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_orthonormalized:
|
|
|
|
- :ref:`Transform<class_Transform>` **orthonormalized** **(** **)**
|
|
|
|
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_rotated:
|
|
|
|
- :ref:`Transform<class_Transform>` **rotated** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi **)**
|
|
|
|
Rotates the transform around given axis by phi. The axis must be a normalized vector.
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_scaled:
|
|
|
|
- :ref:`Transform<class_Transform>` **scaled** **(** :ref:`Vector3<class_Vector3>` scale **)**
|
|
|
|
Scales the transform by the specified 3D scaling factors.
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_translated:
|
|
|
|
- :ref:`Transform<class_Transform>` **translated** **(** :ref:`Vector3<class_Vector3>` ofs **)**
|
|
|
|
Translates the transform by the specified offset.
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_xform:
|
|
|
|
- :ref:`Variant<class_Variant>` **xform** **(** :ref:`Variant<class_Variant>` v **)**
|
|
|
|
Transforms the given :ref:`Vector3<class_Vector3>`, :ref:`Plane<class_Plane>`, or :ref:`AABB<class_AABB>` by this transform.
|
|
|
|
----
|
|
|
|
.. _class_Transform_method_xform_inv:
|
|
|
|
- :ref:`Variant<class_Variant>` **xform_inv** **(** :ref:`Variant<class_Variant>` v **)**
|
|
|
|
Inverse-transforms the given :ref:`Vector3<class_Vector3>`, :ref:`Plane<class_Plane>`, or :ref:`AABB<class_AABB>` by this transform.
|
|
|