summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAaron Franke <arnfranke@yahoo.com>2022-10-01 21:54:19 -0500
committerAaron Franke <arnfranke@yahoo.com>2022-11-02 19:20:10 -0500
commit9e952c83869cd2c1d928beeb6493e635e2b690ff (patch)
treeba59f7a79bde5cf4aa878dad4478562f44a064a6 /doc
parent889868cbbc8beac74d5f49f9b7ef41efc4ae7d5a (diff)
Allow getting Quaternion rotation in different Euler orders
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Quaternion.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml
index 08a9231751..ac2eda9f28 100644
--- a/doc/classes/Quaternion.xml
+++ b/doc/classes/Quaternion.xml
@@ -99,8 +99,9 @@
</method>
<method name="get_euler" qualifiers="const">
<return type="Vector3" />
+ <param index="0" name="order" type="int" default="2" />
<description>
- Returns Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X angle, Y angle, Z angle).
+ Returns the quaternion's rotation in the form of Euler angles. The Euler order depends on the [param order] parameter, for example using the YXZ convention: since this method decomposes, first Z, then X, and Y last. See the [enum EulerOrder] enum for possible values. The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle).
</description>
</method>
<method name="inverse" qualifiers="const">