Struct Quaternion

Implements
Inherited Members
Namespace: UnityEngine
Assembly: UnityEngine.dll
Syntax
public struct Quaternion : IEquatable<Quaternion>

Constructors

| Improve this Doc View Source

Quaternion(Single, Single, Single, Single)

Declaration
public Quaternion(float x, float y, float z, float w)
Parameters
Type Name Description
Single x
Single y
Single z
Single w

Fields

| Improve this Doc View Source

kEpsilon

Declaration
public const float kEpsilon = 1E-06F
Field Value
Type Description
Single
| Improve this Doc View Source

w

Declaration
public float w
Field Value
Type Description
Single
| Improve this Doc View Source

x

Declaration
public float x
Field Value
Type Description
Single
| Improve this Doc View Source

y

Declaration
public float y
Field Value
Type Description
Single
| Improve this Doc View Source

z

Declaration
public float z
Field Value
Type Description
Single

Properties

| Improve this Doc View Source

eulerAngles

Declaration
public Vector3 eulerAngles { get; set; }
Property Value
Type Description
Vector3
| Improve this Doc View Source

identity

Declaration
public static Quaternion identity { get; }
Property Value
Type Description
Quaternion
| Improve this Doc View Source

Item[Int32]

Declaration
public float this[int index] { get; set; }
Parameters
Type Name Description
Int32 index
Property Value
Type Description
Single
| Improve this Doc View Source

normalized

Declaration
public Quaternion normalized { get; }
Property Value
Type Description
Quaternion

Methods

| Improve this Doc View Source

Angle(Quaternion, Quaternion)

Declaration
public static float Angle(Quaternion a, Quaternion b)
Parameters
Type Name Description
Quaternion a
Quaternion b
Returns
Type Description
Single

AngleAxis(Single, Vector3)

Declaration
public static Quaternion AngleAxis(float angle, Vector3 axis)
Parameters
Type Name Description
Single angle
Vector3 axis
Returns
Type Description
Quaternion
| Improve this Doc View Source

AxisAngle(Vector3, Single)

Declaration
[Obsolete("Use Quaternion.AngleAxis instead. This function was deprecated because it uses radians instead of degrees")]
public static Quaternion AxisAngle(Vector3 axis, float angle)
Parameters
Type Name Description
Vector3 axis
Single angle
Returns
Type Description
Quaternion
| Improve this Doc View Source

Dot(Quaternion, Quaternion)

Declaration
public static float Dot(Quaternion a, Quaternion b)
Parameters
Type Name Description
Quaternion a
Quaternion b
Returns
Type Description
Single
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
Object other
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

Equals(Quaternion)

Declaration
public bool Equals(Quaternion other)
Parameters
Type Name Description
Quaternion other
Returns
Type Description
Boolean
| Improve this Doc View Source

Euler(Single, Single, Single)

Declaration
public static Quaternion Euler(float x, float y, float z)
Parameters
Type Name Description
Single x
Single y
Single z
Returns
Type Description
Quaternion
| Improve this Doc View Source

Euler(Vector3)

Declaration
public static Quaternion Euler(Vector3 euler)
Parameters
Type Name Description
Vector3 euler
Returns
Type Description
Quaternion
| Improve this Doc View Source

EulerAngles(Single, Single, Single)

Declaration
[Obsolete("Use Quaternion.Euler instead. This function was deprecated because it uses radians instead of degrees.")]
public static Quaternion EulerAngles(float x, float y, float z)
Parameters
Type Name Description
Single x
Single y
Single z
Returns
Type Description
Quaternion
| Improve this Doc View Source

EulerAngles(Vector3)

Declaration
[Obsolete("Use Quaternion.Euler instead. This function was deprecated because it uses radians instead of degrees.")]
public static Quaternion EulerAngles(Vector3 euler)
Parameters
Type Name Description
Vector3 euler
Returns
Type Description
Quaternion
| Improve this Doc View Source

EulerRotation(Single, Single, Single)

Declaration
[Obsolete("Use Quaternion.Euler instead. This function was deprecated because it uses radians instead of degrees.")]
public static Quaternion EulerRotation(float x, float y, float z)
Parameters
Type Name Description
Single x
Single y
Single z
Returns
Type Description
Quaternion
| Improve this Doc View Source

EulerRotation(Vector3)

Declaration
[Obsolete("Use Quaternion.Euler instead. This function was deprecated because it uses radians instead of degrees.")]
public static Quaternion EulerRotation(Vector3 euler)
Parameters
Type Name Description
Vector3 euler
Returns
Type Description
Quaternion

FromToRotation(Vector3, Vector3)

Declaration
public static Quaternion FromToRotation(Vector3 fromDirection, Vector3 toDirection)
Parameters
Type Name Description
Vector3 fromDirection
Vector3 toDirection
Returns
Type Description
Quaternion
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

Inverse(Quaternion)

Declaration
public static Quaternion Inverse(Quaternion rotation)
Parameters
Type Name Description
Quaternion rotation
Returns
Type Description
Quaternion

Lerp(Quaternion, Quaternion, Single)

Declaration
public static Quaternion Lerp(Quaternion a, Quaternion b, float t)
Parameters
Type Name Description
Quaternion a
Quaternion b
Single t
Returns
Type Description
Quaternion

LerpUnclamped(Quaternion, Quaternion, Single)

Declaration
public static Quaternion LerpUnclamped(Quaternion a, Quaternion b, float t)
Parameters
Type Name Description
Quaternion a
Quaternion b
Single t
Returns
Type Description
Quaternion
| Improve this Doc View Source

LookRotation(Vector3)

Declaration
[ExcludeFromDocs]
public static Quaternion LookRotation(Vector3 forward)
Parameters
Type Name Description
Vector3 forward
Returns
Type Description
Quaternion

LookRotation(Vector3, Vector3)

Declaration
public static Quaternion LookRotation(Vector3 forward, [DefaultValue("Vector3.up")] Vector3 upwards)
Parameters
Type Name Description
Vector3 forward
Vector3 upwards
Returns
Type Description
Quaternion
| Improve this Doc View Source

Normalize()

Declaration
public void Normalize()
| Improve this Doc View Source

Normalize(Quaternion)

Declaration
public static Quaternion Normalize(Quaternion q)
Parameters
Type Name Description
Quaternion q
Returns
Type Description
Quaternion
| Improve this Doc View Source

RotateTowards(Quaternion, Quaternion, Single)

Declaration
public static Quaternion RotateTowards(Quaternion from, Quaternion to, float maxDegreesDelta)
Parameters
Type Name Description
Quaternion from
Quaternion to
Single maxDegreesDelta
Returns
Type Description
Quaternion
| Improve this Doc View Source

Set(Single, Single, Single, Single)

Declaration
public void Set(float newX, float newY, float newZ, float newW)
Parameters
Type Name Description
Single newX
Single newY
Single newZ
Single newW
| Improve this Doc View Source

SetAxisAngle(Vector3, Single)

Declaration
[Obsolete("Use Quaternion.AngleAxis instead. This function was deprecated because it uses radians instead of degrees.")]
public void SetAxisAngle(Vector3 axis, float angle)
Parameters
Type Name Description
Vector3 axis
Single angle
| Improve this Doc View Source

SetEulerAngles(Single, Single, Single)

Declaration
[Obsolete("Use Quaternion.Euler instead. This function was deprecated because it uses radians instead of degrees.")]
public void SetEulerAngles(float x, float y, float z)
Parameters
Type Name Description
Single x
Single y
Single z
| Improve this Doc View Source

SetEulerAngles(Vector3)

Declaration
[Obsolete("Use Quaternion.Euler instead. This function was deprecated because it uses radians instead of degrees.")]
public void SetEulerAngles(Vector3 euler)
Parameters
Type Name Description
Vector3 euler
| Improve this Doc View Source

SetEulerRotation(Single, Single, Single)

Declaration
[Obsolete("Use Quaternion.Euler instead. This function was deprecated because it uses radians instead of degrees.")]
public void SetEulerRotation(float x, float y, float z)
Parameters
Type Name Description
Single x
Single y
Single z
| Improve this Doc View Source

SetEulerRotation(Vector3)

Declaration
[Obsolete("Use Quaternion.Euler instead. This function was deprecated because it uses radians instead of degrees.")]
public void SetEulerRotation(Vector3 euler)
Parameters
Type Name Description
Vector3 euler
| Improve this Doc View Source

SetFromToRotation(Vector3, Vector3)

Declaration
public void SetFromToRotation(Vector3 fromDirection, Vector3 toDirection)
Parameters
Type Name Description
Vector3 fromDirection
Vector3 toDirection
| Improve this Doc View Source

SetLookRotation(Vector3)

Declaration
[ExcludeFromDocs]
public void SetLookRotation(Vector3 view)
Parameters
Type Name Description
Vector3 view
| Improve this Doc View Source

SetLookRotation(Vector3, Vector3)

Declaration
public void SetLookRotation(Vector3 view, [DefaultValue("Vector3.up")] Vector3 up)
Parameters
Type Name Description
Vector3 view
Vector3 up

Slerp(Quaternion, Quaternion, Single)

Declaration
public static Quaternion Slerp(Quaternion a, Quaternion b, float t)
Parameters
Type Name Description
Quaternion a
Quaternion b
Single t
Returns
Type Description
Quaternion

SlerpUnclamped(Quaternion, Quaternion, Single)

Declaration
public static Quaternion SlerpUnclamped(Quaternion a, Quaternion b, float t)
Parameters
Type Name Description
Quaternion a
Quaternion b
Single t
Returns
Type Description
Quaternion
| Improve this Doc View Source

ToAngleAxis(out Single, out Vector3)

Declaration
public void ToAngleAxis(out float angle, out Vector3 axis)
Parameters
Type Name Description
Single angle
Vector3 axis
| Improve this Doc View Source

ToAxisAngle(out Vector3, out Single)

Declaration
[Obsolete("Use Quaternion.ToAngleAxis instead. This function was deprecated because it uses radians instead of degrees.")]
public void ToAxisAngle(out Vector3 axis, out float angle)
Parameters
Type Name Description
Vector3 axis
Single angle
| Improve this Doc View Source

ToEuler()

Declaration
[Obsolete("Use Quaternion.eulerAngles instead. This function was deprecated because it uses radians instead of degrees.")]
public Vector3 ToEuler()
Returns
Type Description
Vector3
| Improve this Doc View Source

ToEulerAngles()

Declaration
[Obsolete("Use Quaternion.eulerAngles instead. This function was deprecated because it uses radians instead of degrees.")]
public Vector3 ToEulerAngles()
Returns
Type Description
Vector3
| Improve this Doc View Source

ToEulerAngles(Quaternion)

Declaration
[Obsolete("Use Quaternion.eulerAngles instead. This function was deprecated because it uses radians instead of degrees.")]
public static Vector3 ToEulerAngles(Quaternion rotation)
Parameters
Type Name Description
Quaternion rotation
Returns
Type Description
Vector3
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides
| Improve this Doc View Source

ToString(String)

Declaration
public string ToString(string format)
Parameters
Type Name Description
String format
Returns
Type Description
String

Operators

| Improve this Doc View Source

Equality(Quaternion, Quaternion)

Declaration
public static bool operator ==(Quaternion lhs, Quaternion rhs)
Parameters
Type Name Description
Quaternion lhs
Quaternion rhs
Returns
Type Description
Boolean
| Improve this Doc View Source

Inequality(Quaternion, Quaternion)

Declaration
public static bool operator !=(Quaternion lhs, Quaternion rhs)
Parameters
Type Name Description
Quaternion lhs
Quaternion rhs
Returns
Type Description
Boolean
| Improve this Doc View Source

Multiply(Quaternion, Quaternion)

Declaration
public static Quaternion operator *(Quaternion lhs, Quaternion rhs)
Parameters
Type Name Description
Quaternion lhs
Quaternion rhs
Returns
Type Description
Quaternion
| Improve this Doc View Source

Multiply(Quaternion, Vector3)

Declaration
public static Vector3 operator *(Quaternion rotation, Vector3 point)
Parameters
Type Name Description
Quaternion rotation
Vector3 point
Returns
Type Description
Vector3

Implements

Extension Methods