summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAaron Franke <arnfranke@yahoo.com>2021-06-15 21:15:38 -0400
committerAaron Franke <arnfranke@yahoo.com>2021-06-15 22:26:29 -0400
commitbd6ed3fb091d2d541f85e4152f0538088a3956db (patch)
tree564ea528f5533cf9b3d77c6d02df56a9877558a5 /doc
parentd36b220531198b494fc309c015e04867926992fd (diff)
Allow multiplying Transforms and Basis by numbers
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Basis.xml18
-rw-r--r--doc/classes/Transform2D.xml30
-rw-r--r--doc/classes/Transform3D.xml18
3 files changed, 60 insertions, 6 deletions
diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml
index 14fca04672..62d2bb2b54 100644
--- a/doc/classes/Basis.xml
+++ b/doc/classes/Basis.xml
@@ -155,6 +155,24 @@
<description>
</description>
</method>
+ <method name="operator *" qualifiers="operator">
+ <return type="Basis">
+ </return>
+ <argument index="0" name="right" type="float">
+ </argument>
+ <description>
+ This operator multiplies all components of the [Basis], which scales it uniformly.
+ </description>
+ </method>
+ <method name="operator *" qualifiers="operator">
+ <return type="Basis">
+ </return>
+ <argument index="0" name="right" type="int">
+ </argument>
+ <description>
+ This operator multiplies all components of the [Basis], which scales it uniformly.
+ </description>
+ </method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml
index 0dbf95376a..8e9f052ed2 100644
--- a/doc/classes/Transform2D.xml
+++ b/doc/classes/Transform2D.xml
@@ -148,9 +148,17 @@
</description>
</method>
<method name="operator *" qualifiers="operator">
- <return type="PackedVector2Array">
+ <return type="Vector2">
</return>
- <argument index="0" name="right" type="PackedVector2Array">
+ <argument index="0" name="right" type="Vector2">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="operator *" qualifiers="operator">
+ <return type="Rect2">
+ </return>
+ <argument index="0" name="right" type="Rect2">
</argument>
<description>
</description>
@@ -164,19 +172,29 @@
</description>
</method>
<method name="operator *" qualifiers="operator">
- <return type="Rect2">
+ <return type="PackedVector2Array">
</return>
- <argument index="0" name="right" type="Rect2">
+ <argument index="0" name="right" type="PackedVector2Array">
</argument>
<description>
</description>
</method>
<method name="operator *" qualifiers="operator">
- <return type="Vector2">
+ <return type="Transform2D">
</return>
- <argument index="0" name="right" type="Vector2">
+ <argument index="0" name="right" type="float">
+ </argument>
+ <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>
<description>
+ This operator multiplies all components of the [Transform2D], including the origin vector, which scales it uniformly.
</description>
</method>
<method name="operator ==" qualifiers="operator">
diff --git a/doc/classes/Transform3D.xml b/doc/classes/Transform3D.xml
index 0d49255523..785d274ec6 100644
--- a/doc/classes/Transform3D.xml
+++ b/doc/classes/Transform3D.xml
@@ -145,6 +145,24 @@
<description>
</description>
</method>
+ <method name="operator *" qualifiers="operator">
+ <return type="Transform3D">
+ </return>
+ <argument index="0" name="right" type="float">
+ </argument>
+ <description>
+ This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly.
+ </description>
+ </method>
+ <method name="operator *" qualifiers="operator">
+ <return type="Transform3D">
+ </return>
+ <argument index="0" name="right" type="int">
+ </argument>
+ <description>
+ This operator multiplies all components of the [Transform3D], including the origin vector, which scales it uniformly.
+ </description>
+ </method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>