Sync classref with source

This commit is contained in:
Rémi Verschelde
2016-06-05 00:21:57 +02:00
parent cff9fcb9ed
commit a54aea154b
30 changed files with 608 additions and 192 deletions

View File

@@ -49,8 +49,8 @@ Member Functions
Member Variables
----------------
- :ref:`Matrix3<class_matrix3>` **basis**
- :ref:`Vector3<class_vector3>` **origin**
- :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
-----------
@@ -64,6 +64,8 @@ Member Function Description
- :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** **(** **)**
@@ -74,22 +76,32 @@ Returns the inverse of the transform.
- :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 **)**
@@ -106,20 +118,30 @@ Inverse-transforms vector "v" by this 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)