Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Quaternion

struct in UnityEngine

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Quaternions are used to represent rotations.

A quaternion is a four-tuple of real numbers {x,y,z,w}. A quaternion is a mathematically convenient alternative to the euler angle representation. You can interpolate a quaternion without experiencing gimbal lock. You can also use a quaternion to concatenate a series of rotations into a single representation.

Unity internally uses Quaternions to represent all rotations.

In most cases, you can use existing rotations from methods such as Transform.localRotation or Transform.rotation to construct new rotations. For example, use existing rotations to smoothly interpolate between two rotations. The most used Quaternion functions are as follows: Quaternion.LookRotation, Quaternion.Angle, Quaternion.Euler, Quaternion.Slerp, Quaternion.FromToRotation, and Quaternion.identity.

You can use the Quaternion.operator * to rotate one rotation by another, or to rotate a vector by a rotation.

Note that Unity expects Quaternions to be normalized.

Static Properties

identityThe identity rotation (Read Only).

Properties

eulerAnglesReturns or sets the euler angle representation of the rotation in degrees.
normalizedReturns this quaternion with a magnitude of 1 (Read Only).
this[int]Access the x, y, z, w components using [0], [1], [2], [3] respectively.
wW component of the Quaternion. Do not directly modify quaternions.
xX component of the Quaternion. Don't modify this directly unless you know quaternions inside out.
yY component of the Quaternion. Don't modify this directly unless you know quaternions inside out.
zZ component of the Quaternion. Don't modify this directly unless you know quaternions inside out.

Constructors

QuaternionConstructs new Quaternion with given x,y,z,w components.

Public Methods

SetSet x, y, z and w components of an existing Quaternion.
SetFromToRotationCreates a rotation which rotates from fromDirection to toDirection.
SetLookRotationCreates a rotation with the specified forward and upwards directions.
ToAngleAxisConverts a rotation to angle-axis representation (angles in degrees).
ToStringReturns a formatted string for this quaternion.

Static Methods

AngleReturns the angle in degrees between two rotations a and b. The resulting angle ranges from 0 to 180.
AngleAxisCreates a rotation which rotates angle degrees around axis.
DotThe dot product between two rotations.
EulerReturns a rotation that rotates z degrees around the z axis, x degrees around the x axis, and y degrees around the y axis; applied in that order.
FromToRotationCreates a rotation from fromDirection to toDirection.
InverseReturns the Inverse of rotation.
LerpInterpolates between a and b by t and normalizes the result afterwards.
LerpUnclampedInterpolates between a and b by t and normalizes the result afterwards. The parameter t is not clamped.
LookRotationCreates a rotation with the specified forward and upwards directions.
NormalizeConverts this quaternion to a quaternion with the same orientation but with a magnitude of 1.0.
RotateTowardsRotates a rotation from towards to.
SlerpSpherically linear interpolates between unit quaternions a and b by a ratio of t.
SlerpUnclampedSpherically linear interpolates between unit quaternions a and b by t.

Operators

operator *Combines rotations lhs and rhs.
operator ==Are two quaternions equal to each other?