Class Quaternion

constructor

• new Quaternion(w?: number, x?: number, y?: number, z?: number): Quaternion

  Parameters

  • w: number = 1
  • x: number = 0
  • y: number = 0
  • z: number = 0

  Returns Quaternion

w

x

y

z

clone

• clone(): Quaternion

  Get a cloned/duplicated instance of this quaternion

  Returns Quaternion

conjugate

• conjugate(): Quaternion

  Opposite the unreal part of the quaternion

  Returns Quaternion

inverse

• inverse(): Quaternion

  Computes the inverse of this quaternion. The inverse is defined as the conjugate divided by the squared magnitude.

  Returns Quaternion

  A new quaternion representing the inverse.

lerp

• lerp(q1: Quaternion, q2: Quaternion, t: number): Quaternion

  Set the quaterion to linear interpolate between two quaternions

  Parameters

  • q1: Quaternion
  • q2: Quaternion
  • t: number

  Returns Quaternion

magnitudeSquared

• magnitudeSquared(): number

  Compute the magnitude of the quaternion (squared length)

  Returns number

multiply

• multiply(q: Quaternion): Quaternion

  Rotate this quaternion by another quaternion

  Parameters

  • q: Quaternion

  Returns Quaternion

normalize

• normalize(): Quaternion

  Normalize the quaternion

  Returns Quaternion

rotate

• rotate(q: Quaternion): Quaternion

  Rotate this quaternion by another quaternion

  Parameters

  • q: Quaternion

  Returns Quaternion

rotateAroundAxis

• rotateAroundAxis(axis: Vector3, angle: number): Quaternion

  Rotate this quaternion around a given axis by a specified angle (in radians).

  Parameters

  • axis: Vector3

    The axis of rotation (must be normalized).
  • angle: number

    The angle of rotation in radians.

  Returns Quaternion

  This quaternion after applying the rotation.

set

• set(w: number, x: number, y: number, z: number): Quaternion

  Set the quaternion from components

  Parameters

  • w: number
  • x: number
  • y: number
  • z: number

  Returns Quaternion

setFromEulerAngles

• setFromEulerAngles(
      pitch: number,
      yaw: number,
      roll: number,
      order?: EulerOrder,
  ): Quaternion

  Set this quaternion from Euler angles (in radians) with a specified order (default ZXY).

  Parameters

  • pitch: number
  • yaw: number
  • roll: number
  • order: EulerOrder = "ZXY"

  Returns Quaternion

setFromQuaternion

• setFromQuaternion(q: Quaternion): Quaternion

  Set the quaternion from another quaternion

  Parameters

  • q: Quaternion

  Returns Quaternion

setFromVectorEulerAngles

• setFromVectorEulerAngles(vector3: Vector3, order?: EulerOrder): Quaternion

  Set this quaternion from Euler angles (in radians) with a specified order (default ZXY).

  Parameters

  • vector3: Vector3
  • order: EulerOrder = "ZXY"

  Returns Quaternion

toEulerAngles

• toEulerAngles(order?: EulerOrder): Vector3

  Convert the quaternion to Euler angles (in radians) with a specified order (default ZXY).

  Parameters

  • order: EulerOrder = "ZXY"

  Returns Vector3

StaticfromAxisAngle

• fromAxisAngle(axis: Vector3, angle: number): Quaternion

  Create a quaternion from an axis and an angle (in radians).

  Parameters

  • axis: Vector3

    The axis of rotation (must be normalized).
  • angle: number

    The angle of rotation in radians.

  Returns Quaternion

  A new quaternion representing the rotation.

StaticfromEulerAngles

• fromEulerAngles(
      pitch: number,
      yaw: number,
      roll: number,
      order?: EulerOrder,
  ): Quaternion

  Return a new quaternion from Euler angles (in radians) with a specified order (default ZXY).

  Parameters

  • pitch: number
  • yaw: number
  • roll: number
  • order: EulerOrder = "ZXY"

  Returns Quaternion

StaticfromVectorEulerAngles

• fromVectorEulerAngles(vector3: Vector3, order?: EulerOrder): Quaternion

  Return a new quaternion from Euler angles (in radians, pitch yaw, roll order) with a specified order (default ZXY).

  Parameters

  • vector3: Vector3
  • order: EulerOrder = "ZXY"

  Returns Quaternion

Staticidentity

• identity(): Quaternion

  Get the identity quaternion

  Returns Quaternion