virtualx-engine/doc/classes/Transform2D.xml

178 lines
5.3 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Transform2D" category="Built-In Types" version="3.0.alpha.custom_build">
<brief_description>
2D Transformation. 3x2 matrix.
</brief_description>
<description>
Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a two [Vector2] x, y and [Vector2] "origin". It is similar to a 3x2 matrix.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="Transform2D">
<return type="Transform2D">
</return>
<argument index="0" name="from" type="Transform">
</argument>
<description>
Constructs the [code]Transform2D[/code] from a 3D [Transform].
</description>
</method>
<method name="Transform2D">
<return type="Transform2D">
</return>
<argument index="0" name="x_axis" type="Vector2">
</argument>
<argument index="1" name="y_axis" type="Vector2">
</argument>
<argument index="2" name="origin" type="Vector2">
</argument>
<description>
Constructs the [code]Transform2D[/code] from 3 [Vector2] consisting of rows x, y and origin.
</description>
</method>
<method name="Transform2D">
<return type="Transform2D">
</return>
<argument index="0" name="rotation" type="float">
</argument>
<argument index="1" name="position" type="Vector2">
</argument>
<description>
Constructs the [code]Transform2D[/code] from rotation angle in radians and position [Vector2].
</description>
</method>
<method name="affine_inverse">
<return type="Transform2D">
</return>
<description>
Returns the inverse of the matrix.
</description>
</method>
<method name="basis_xform">
<return type="Transform2D">
</return>
<argument index="0" name="v" type="var">
</argument>
<description>
Transforms the given vector "v" by this transform basis (no translation).
</description>
</method>
<method name="basis_xform_inv">
<return type="Transform2D">
</return>
<argument index="0" name="v" type="var">
</argument>
<description>
Inverse-transforms the given vector "v" by this transform basis (no translation).
</description>
</method>
<method name="get_origin">
<return type="Vector2">
</return>
<description>
Returns the origin [Vector2] (translation).
</description>
</method>
<method name="get_rotation">
<return type="float">
</return>
<description>
Returns the rotation (in radians).
</description>
</method>
<method name="get_scale">
<return type="Vector2">
</return>
<description>
Returns the scale.
</description>
</method>
<method name="interpolate_with">
<return type="Transform2D">
</return>
<argument index="0" name="transform" type="Transform2D">
</argument>
<argument index="1" name="weight" type="float">
</argument>
<description>
Interpolates the transform to other Transform2D by weight amount (0-1).
</description>
</method>
<method name="inverse">
<return type="Transform2D">
</return>
<description>
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).
</description>
</method>
<method name="orthonormalized">
<return type="Transform2D">
</return>
<description>
2017-10-14 12:45:26 +02:00
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.
</description>
</method>
<method name="rotated">
<return type="Transform2D">
</return>
<argument index="0" name="phi" type="float">
</argument>
<description>
Rotates the transform by phi.
</description>
</method>
<method name="scaled">
<return type="Transform2D">
</return>
<argument index="0" name="scale" type="Vector2">
</argument>
<description>
Scales the transform by the specified 2D scaling factors.
</description>
</method>
<method name="translated">
<return type="Transform2D">
</return>
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
Translates the transform by the specified offset.
</description>
</method>
<method name="xform">
<return type="Transform2D">
</return>
<argument index="0" name="v" type="var">
</argument>
<description>
Transforms the given vector "v" by this transform.
</description>
</method>
<method name="xform_inv">
<return type="Transform2D">
</return>
<argument index="0" name="v" type="var">
</argument>
<description>
Inverse-transforms the given vector "v" by this transform.
</description>
</method>
</methods>
<members>
<member name="origin" type="Vector2" setter="" getter="">
The translation offset of the transform.
</member>
<member name="x" type="Vector2" setter="" getter="">
The X axis of 2x2 basis matrix containing 2 [Vector2] as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object.
</member>
<member name="y" type="Vector2" setter="" getter="">
The Y axis of 2x2 basis matrix containing 2 [Vector2] as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object.
</member>
</members>
<constants>
</constants>
</class>