summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-06-18 12:35:58 +0200
committerGitHub <noreply@github.com>2021-06-18 12:35:58 +0200
commit7aebb8f81c44f5f33c4387d32824a76e46266732 (patch)
treeb09b30950ae57cb6d7a543678e65aeefbfd52b70 /doc/classes
parent3fc39954ec3473cc022af615c5eb8b1ba271e008 (diff)
parent93b494d4ae136f43193a5a2da7a355938517767e (diff)
Merge pull request #44156 from aaronfranke/quat-angle-to
Add Quaternion angle_to method
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Quaternion.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/classes/Quaternion.xml b/doc/classes/Quaternion.xml
index 3f2c4f3085..660204ee7d 100644
--- a/doc/classes/Quaternion.xml
+++ b/doc/classes/Quaternion.xml
@@ -83,6 +83,16 @@
Constructs a quaternion defined by the given values.
</description>
</method>
+ <method name="angle_to" qualifiers="const">
+ <return type="float">
+ </return>
+ <argument index="0" name="to" type="Quaternion">
+ </argument>
+ <description>
+ Returns the angle between this quaternion and [code]to[/code]. This is the magnitude of the angle you would need to rotate by to get from one to the other.
+ [b]Note:[/b] This method has an abnormally high amount of floating-point error, so methods such as [code]is_zero_approx[/code] will not work reliably.
+ </description>
+ </method>
<method name="cubic_slerp" qualifiers="const">
<return type="Quaternion">
</return>