summaryrefslogtreecommitdiff
path: root/doc/classes/Transform2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Transform2D.xml')
-rw-r--r--doc/classes/Transform2D.xml159
1 files changed, 53 insertions, 106 deletions
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml
index 4f9b59c188..2c3eda1e07 100644
--- a/doc/classes/Transform2D.xml
+++ b/doc/classes/Transform2D.xml
@@ -15,243 +15,190 @@
</tutorials>
<methods>
<method name="Transform2D" qualifiers="constructor">
- <return type="Transform2D">
- </return>
+ <return type="Transform2D" />
<description>
Constructs a default-initialized [Transform2D] set to [constant IDENTITY].
</description>
</method>
<method name="Transform2D" qualifiers="constructor">
- <return type="Transform2D">
- </return>
- <argument index="0" name="from" type="Transform2D">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="from" type="Transform2D" />
<description>
Constructs a [Transform2D] as a copy of the given [Transform2D].
</description>
</method>
<method name="Transform2D" qualifiers="constructor">
- <return type="Transform2D">
- </return>
- <argument index="0" name="rotation" type="float">
- </argument>
- <argument index="1" name="position" type="Vector2">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="rotation" type="float" />
+ <argument index="1" name="position" type="Vector2" />
<description>
Constructs the transform from a given angle (in radians) and position.
</description>
</method>
<method name="Transform2D" qualifiers="constructor">
- <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>
+ <return type="Transform2D" />
+ <argument index="0" name="x_axis" type="Vector2" />
+ <argument index="1" name="y_axis" type="Vector2" />
+ <argument index="2" name="origin" type="Vector2" />
<description>
Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors).
</description>
</method>
<method name="affine_inverse" qualifiers="const">
- <return type="Transform2D">
- </return>
+ <return type="Transform2D" />
<description>
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.
</description>
</method>
<method name="basis_xform" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="v" type="Vector2">
- </argument>
+ <return type="Vector2" />
+ <argument index="0" name="v" type="Vector2" />
<description>
Returns a vector transformed (multiplied) by the basis matrix.
This method does not account for translation (the origin vector).
</description>
</method>
<method name="basis_xform_inv" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="v" type="Vector2">
- </argument>
+ <return type="Vector2" />
+ <argument index="0" name="v" type="Vector2" />
<description>
Returns a vector transformed (multiplied) by the inverse basis matrix.
This method does not account for translation (the origin vector).
</description>
</method>
<method name="get_origin" qualifiers="const">
- <return type="Vector2">
- </return>
+ <return type="Vector2" />
<description>
Returns the transform's origin (translation).
</description>
</method>
<method name="get_rotation" qualifiers="const">
- <return type="float">
- </return>
+ <return type="float" />
<description>
Returns the transform's rotation (in radians).
</description>
</method>
<method name="get_scale" qualifiers="const">
- <return type="Vector2">
- </return>
+ <return type="Vector2" />
<description>
Returns the scale.
</description>
</method>
<method name="interpolate_with" qualifiers="const">
- <return type="Transform2D">
- </return>
- <argument index="0" name="xform" type="Transform2D">
- </argument>
- <argument index="1" name="weight" type="float">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="xform" type="Transform2D" />
+ <argument index="1" name="weight" type="float" />
<description>
Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0).
</description>
</method>
<method name="inverse" qualifiers="const">
- <return type="Transform2D">
- </return>
+ <return type="Transform2D" />
<description>
Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use [method affine_inverse] for transforms with scaling).
</description>
</method>
<method name="is_equal_approx" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="xform" type="Transform2D">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="xform" type="Transform2D" />
<description>
Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
</description>
</method>
<method name="looking_at" qualifiers="const">
- <return type="Transform2D">
- </return>
- <argument index="0" name="target" type="Vector2" default="Transform2D(1, 0, 0, 1, 0, 0)">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="target" type="Vector2" default="Transform2D(1, 0, 0, 1, 0, 0)" />
<description>
Returns a copy of the transform rotated such that it's rotation on the X-axis points towards the [code]target[/code] position.
Operations take place in global space.
</description>
</method>
<method name="operator !=" qualifiers="operator">
- <return type="bool">
- </return>
- <argument index="0" name="right" type="Transform2D">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="right" type="Transform2D" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
- <return type="Vector2">
- </return>
- <argument index="0" name="right" type="Vector2">
- </argument>
+ <return type="Vector2" />
+ <argument index="0" name="right" type="Vector2" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
- <return type="Rect2">
- </return>
- <argument index="0" name="right" type="Rect2">
- </argument>
+ <return type="Rect2" />
+ <argument index="0" name="right" type="Rect2" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
- <return type="Transform2D">
- </return>
- <argument index="0" name="right" type="Transform2D">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="right" type="Transform2D" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
- <return type="PackedVector2Array">
- </return>
- <argument index="0" name="right" type="PackedVector2Array">
- </argument>
+ <return type="PackedVector2Array" />
+ <argument index="0" name="right" type="PackedVector2Array" />
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
- <return type="Transform2D">
- </return>
- <argument index="0" name="right" type="float">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="right" type="float" />
<description>
This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly.
</description>
</method>
<method name="operator *" qualifiers="operator">
- <return type="Transform2D">
- </return>
- <argument index="0" name="right" type="int">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="right" type="int" />
<description>
This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly.
</description>
</method>
<method name="operator ==" qualifiers="operator">
- <return type="bool">
- </return>
- <argument index="0" name="right" type="Transform2D">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="right" type="Transform2D" />
<description>
</description>
</method>
<method name="operator []" qualifiers="operator">
- <return type="Vector2">
- </return>
- <argument index="0" name="index" type="int">
- </argument>
+ <return type="Vector2" />
+ <argument index="0" name="index" type="int" />
<description>
</description>
</method>
<method name="orthonormalized" qualifiers="const">
- <return type="Transform2D">
- </return>
+ <return type="Transform2D" />
<description>
Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1).
</description>
</method>
<method name="rotated" qualifiers="const">
- <return type="Transform2D">
- </return>
- <argument index="0" name="phi" type="float">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="phi" type="float" />
<description>
Rotates the transform by the given angle (in radians), using matrix multiplication.
</description>
</method>
<method name="scaled" qualifiers="const">
- <return type="Transform2D">
- </return>
- <argument index="0" name="scale" type="Vector2">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="scale" type="Vector2" />
<description>
Scales the transform by the given scale factor, using matrix multiplication.
</description>
</method>
<method name="set_rotation">
- <return type="void">
- </return>
- <argument index="0" name="rotation" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="rotation" type="float" />
<description>
Sets the transform's rotation (in radians).
</description>
</method>
<method name="translated" qualifiers="const">
- <return type="Transform2D">
- </return>
- <argument index="0" name="offset" type="Vector2">
- </argument>
+ <return type="Transform2D" />
+ <argument index="0" name="offset" type="Vector2" />
<description>
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.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-20 05:46:39 +0000