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

195 lines
6.4 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" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="Transform2D" version="4.0">
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
<brief_description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
2D transformation (3×2 matrix).
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
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Represents one or many transformations in 2D space such as translation, rotation, or scaling. It consists of two [member x] and [member y] [Vector2]s and an [member origin]. It is similar to a 3×2 matrix.
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>
<tutorials>
</tutorials>
<methods>
<method name="Transform2D">
<return type="Transform2D">
</return>
<argument index="0" name="from" type="Transform">
</argument>
<description>
[DOCS] minor corrections to Transform2D
2017-12-24 21:12:07 +00:00
Constructs the transform 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>
[DOCS] minor corrections to Transform2D
2017-12-24 21:12:07 +00:00
Constructs the transform from 3 [Vector2]s representing 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>
[DOCS] minor corrections to Transform2D
2017-12-24 21:12:07 +00:00
Constructs the transform from a given angle (in radians) and position.
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">
Fix wrong return type of xform functions
2018-01-30 11:45:54 +00:00
<return 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
</return>
Fix wrong return type of xform functions
2018-01-30 11:45:54 +00:00
<argument index="0" name="v" 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>
[DOCS] minor corrections to Transform2D
2017-12-24 21:12:07 +00:00
Transforms the given vector by this transform's 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="basis_xform_inv">
Fix wrong return type of xform functions
2018-01-30 11:45:54 +00:00
<return 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
</return>
Fix wrong return type of xform functions
2018-01-30 11:45:54 +00:00
<argument index="0" name="v" 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>
[DOCS] minor corrections to Transform2D
2017-12-24 21:12:07 +00:00
Inverse-transforms the given vector by this transform's 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>
[DOCS] minor corrections to Transform2D
2017-12-24 21:12:07 +00:00
Returns the transform's origin (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>
[DOCS] minor corrections to Transform2D
2017-12-24 21:12:07 +00:00
Returns the transform's 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>
[DOCS] minor corrections to Transform2D
2017-12-24 21:12:07 +00:00
Returns a transform interpolated between this transform and another by a given weight (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>
doc: Sync classref with current source
2019-11-08 07:33:48 +00:00
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="transform" type="Transform2D">
</argument>
<description>
Add docs for is_equal_approx on structures
2019-11-30 20:08:50 +00:00
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
doc: Sync classref with current source
2019-11-08 07:33:48 +00:00
</description>
</method>
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
<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>
Document that translated does not behave like rotated or scaled
2019-12-13 20:23:26 +00:00
Rotates the transform by the given angle (in radians), using matrix multiplication.
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>
Document that translated does not behave like rotated or scaled
2019-12-13 20:23:26 +00:00
Scales the transform by the given scale factor, using matrix multiplication.
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>
Document that translated does not behave like rotated or scaled
2019-12-13 20:23:26 +00:00
Translates the transform by the given offset, relative to the transform's basis vectors.
Unlike [method rotated] and [method scaled], this does not use matrix multiplication.
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">
doc: Sync classref with current source Fix wrong binding after #37111.
2020-03-18 08:14:39 +00:00
<return type="Variant">
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
</return>
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 20:38:28 +00:00
<argument index="0" name="v" type="Variant">
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>
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 12:59:24 +00:00
Transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this 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="xform_inv">
doc: Sync classref with current source Fix wrong binding after #37111.
2020-03-18 08:14:39 +00:00
<return type="Variant">
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
</return>
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 20:38:28 +00:00
<argument index="0" name="v" type="Variant">
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>
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 12:59:24 +00:00
Inverse-transforms the given [Vector2], [Rect2], or [PackedVector2Array] by this 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>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="origin" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )">
[DOCS] minor corrections to Transform2D
2017-12-24 21:12:07 +00:00
The transform's translation 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
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="x" type="Vector2" setter="" getter="" default="Vector2( 1, 0 )">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
The X axis of 2×2 basis matrix containing 2 [Vector2]s 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.
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
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="y" type="Vector2" setter="" getter="" default="Vector2( 0, 1 )">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
The Y axis of 2×2 basis matrix containing 2 [Vector2]s 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.
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
</member>
</members>
<constants>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<constant name="IDENTITY" value="Transform2D( 1, 0, 0, 1, 0, 0 )">
Document constants in Transform/Transform2D
2019-07-05 02:10:47 +00:00
[Transform2D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</constant>
<constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )">
Document constants in Transform/Transform2D
2019-07-05 02:10:47 +00:00
[Transform2D] with mirroring applied parallel to the X axis.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</constant>
<constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )">
Document constants in Transform/Transform2D
2019-07-05 02:10:47 +00:00
[Transform2D] with mirroring applied parallel to the Y axis.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</constant>
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
</constants>
</class>