godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/Transform2D.xml

178 lines
5.3 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?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>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 10:56:11 +00:00
Constructs the [code]Transform2D[/code] from a 3D [Transform].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 10:56:11 +00:00
Constructs the [code]Transform2D[/code] from 3 [Vector2] consisting of rows x, y and origin.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="Transform2D">
<return type="Transform2D">
</return>
doc: Sync classref with current source [ci skip]
2017-09-23 08:59:35 +00:00
<argument index="0" name="rotation" type="float">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="1" name="position" type="Vector2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 10:56:11 +00:00
Constructs the [code]Transform2D[/code] from rotation angle in radians and position [Vector2].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Inverse-transforms the given vector "v" by this transform basis (no translation).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_origin">
<return type="Vector2">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the origin [Vector2] (translation).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_rotation">
<return type="float">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the rotation (in radians).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_scale">
<return type="Vector2">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the scale.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Interpolates the transform to other Transform2D by weight amount (0-1).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="rotated">
<return type="Transform2D">
</return>
<argument index="0" name="phi" type="float">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Rotates the transform by phi.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="scaled">
<return type="Transform2D">
</return>
<argument index="0" name="scale" type="Vector2">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Scales the transform by the specified 2D scaling factors.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="translated">
<return type="Transform2D">
</return>
<argument index="0" name="offset" type="Vector2">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Translates the transform by the specified offset.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="origin" type="Vector2" setter="" getter="">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
The translation offset of the transform.
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="x" type="Vector2" setter="" getter="">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
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>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="y" type="Vector2" setter="" getter="">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
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>