Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete the docs for Quaternion #84140

Merged
merged 1 commit into from
Jan 5, 2024
Merged

Complete the docs for Quaternion #84140

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/classes/Quaternion.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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">
Expand Down Expand Up @@ -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">
Expand Down
Loading