diff options
Diffstat (limited to 'doc/classes/Transform2D.xml')
| -rw-r--r-- | doc/classes/Transform2D.xml | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index bf0a745aa8..580da080b3 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -1,15 +1,13 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Transform2D" category="Built-In Types" version="3.1"> +<class name="Transform2D" category="Built-In Types" version="3.2"> <brief_description> - 2D Transformation. 3x2 matrix. + 2D transformation (3×2 matrix). </brief_description> <description> - Represents one or many transformations in 2D 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. + 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. </description> <tutorials> </tutorials> - <demos> - </demos> <methods> <method name="Transform2D"> <return type="Transform2D"> @@ -148,7 +146,7 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Transforms the given [Vector2] or [Rect2] by this transform. + Transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. </description> </method> <method name="xform_inv"> @@ -157,27 +155,30 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Inverse-transforms the given [Vector2] or [Rect2] by this transform. + Inverse-transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. </description> </method> </methods> <members> - <member name="origin" type="Vector2" setter="" getter=""> + <member name="origin" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )"> The transform's translation offset. </member> - <member name="x" type="Vector2" setter="" getter=""> - The X axis of 2x2 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. + <member name="x" type="Vector2" setter="" getter="" default="Vector2( 1, 0 )"> + 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. </member> - <member name="y" type="Vector2" setter="" getter=""> - The Y axis of 2x2 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. + <member name="y" type="Vector2" setter="" getter="" default="Vector2( 0, 1 )"> + 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. </member> </members> <constants> <constant name="IDENTITY" value="Transform2D( 1, 0, 0, 1, 0, 0 )"> + [Transform2D] with no translation, rotation or scaling applied. When applied to other data structures, [constant IDENTITY] performs no transformation. </constant> <constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )"> + [Transform2D] with mirroring applied parallel to the X axis. </constant> <constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )"> + [Transform2D] with mirroring applied parallel to the Y axis. </constant> </constants> </class> |