summaryrefslogtreecommitdiffstats
path: root/doc/classes/Quaternion.xml
diff options
context:
space:
mode:
authorNico <nico.hex6@gmail.com>2023-10-29 15:29:41 +0100
committerNico <nico.hex6@gmail.com>2024-01-05 11:31:59 +0100
commitd67e7f872980011114f237c103e984c8772611ba (patch)
tree16e61be8c7ca9b56203f5dc7beb2bc187a98e59c /doc/classes/Quaternion.xml
parent179dfdc8d78b5bd5377dd115af026df58308bdaf (diff)
downloadredot-engine-d67e7f872980011114f237c103e984c8772611ba.tar.gz
Complete the docs for Quaternion
Diffstat (limited to 'doc/classes/Quaternion.xml')
-rw-r--r--doc/classes/Quaternion.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml
index 74dfae77fc..61bc4f4720 100644
--- a/doc/classes/Quaternion.xml
+++ b/doc/classes/Quaternion.xml
@@ -79,6 +79,7 @@
<method name="exp" qualifiers="const">
<return type="Quaternion" />
<description>
+ Returns the exponential of this quaternion. The rotation axis of the result is the normalized rotation axis of this quaternion, the angle of the result is the length of the vector part of this quaternion.
</description>
</method>
<method name="from_euler" qualifiers="static">
@@ -91,11 +92,14 @@
<method name="get_angle" qualifiers="const">
<return type="float" />
<description>
+ Returns the angle of the rotation represented by this quaternion.
+ [b]Note:[/b] The quaternion must be normalized.
</description>
</method>
<method name="get_axis" qualifiers="const">
<return type="Vector3" />
<description>
+ Returns the rotation axis of the rotation represented by this quaternion.
</description>
</method>
<method name="get_euler" qualifiers="const">
@@ -145,6 +149,7 @@
<method name="log" qualifiers="const">
<return type="Quaternion" />
<description>
+ Returns the logarithm of this quaternion. The vector part of the result is the rotation axis of this quaternion multiplied by its rotation angle, the real part of the result is zero.
</description>
</method>
<method name="normalized" qualifiers="const">