Class Quaternion

constructor

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

  Creates a quaternion from components.

  Parameters

  • Optionalx: number
  • Optionaly: number
  • Optionalz: number
  • Optionalw: number

  Returns Quaternion

w

x

y

z

Static ReadonlyIdentity

Static ReadonlyZero

[iterator]

• "[iterator]"(): IterableIterator<number>

  Iterates over quaternion components in order.

  Returns IterableIterator<number>

clone

• clone(): Quaternion

  Creates a new quaternion with the same components.

  Returns Quaternion

copy

• copy(quaternion: Quaternion): this

  Copies another quaternion into this one.

  Parameters

  • quaternion: Quaternion

  Returns this

dot

• dot(v: Quaternion): number

  Computes the dot product with another quaternion.

  Parameters

  • v: Quaternion

  Returns number

equals

• equals(quaternion: Quaternion): boolean

  Checks component-wise equality.

  Parameters

  • quaternion: Quaternion

  Returns boolean

magnitude

• magnitude(): number

  Returns the magnitude of this quaternion.

  Returns number

magnitudeSquared

• magnitudeSquared(): number

  Returns the squared magnitude of this quaternion.

  Returns number

multiply

• multiply(q: Quaternion): Quaternion

  Multiplies this quaternion by another.

  Parameters

  • q: Quaternion

  Returns Quaternion

normalize

• normalize(): Quaternion

  Normalizes this quaternion in place.

  Returns Quaternion

reverse

• reverse(): Quaternion

  Negates the vector part of this quaternion.

  Returns Quaternion

rotateX

• rotateX(angle: number): Quaternion

  Applies an X-axis rotation to this quaternion.

  Parameters

  • angle: number

  Returns Quaternion

rotateY

• rotateY(angle: number): Quaternion

  Applies a Y-axis rotation to this quaternion.

  Parameters

  • angle: number

  Returns Quaternion

rotateZ

• rotateZ(angle: number): Quaternion

  Applies a Z-axis rotation to this quaternion.

  Parameters

  • angle: number

  Returns Quaternion

serialize

• serialize(): QuaternionLike

  Serializes this quaternion.

  Returns QuaternionLike

set

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

  Sets this quaternion from components.

  Parameters

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

  Returns this

StaticangleBetween

• angleBetween(a: Quaternion, b: Quaternion): number

  Returns the angular distance between two quaternions.

  Parameters

  • a: Quaternion
  • b: Quaternion

  Returns number

Staticcopy

• copy(from: Quaternion, to?: Quaternion): Quaternion

  Copies a quaternion into an output quaternion.

  Parameters

  • from: Quaternion
  • Optionalto: Quaternion

  Returns Quaternion

Staticdeserialize

• deserialize(value: QuaternionLike, out?: Quaternion): Quaternion

  Deserializes a quaternion from an object.

  Parameters

  • value: QuaternionLike
  • Optionalout: Quaternion

  Returns Quaternion

Staticdot

• dot(q1: Quaternion, q2: Quaternion): number

  Computes the dot product between two quaternions.

  Parameters

  • q1: Quaternion
  • q2: Quaternion

  Returns number

Staticequal

• equal(a: Quaternion, b: Quaternion): boolean

  Checks component-wise equality for two quaternions.

  Parameters

  • a: Quaternion
  • b: Quaternion

  Returns boolean

StaticfromAxisAngle

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

  Builds a quaternion from an axis and angle.

  Parameters

  • axis: Vector3
  • angle: number
  • Optionalout: Quaternion

  Returns Quaternion

StaticfromEuler

• fromEuler(x: number, y: number, z: number, out?: Quaternion): Quaternion

  Builds a quaternion from Euler angles.

  Parameters

  • x: number
  • y: number
  • z: number
  • Optionalout: Quaternion

  Returns Quaternion

StaticfromRotationMatrix

• fromRotationMatrix(matrix: Matrix3, out?: Quaternion): Quaternion

  Builds a quaternion from a rotation matrix.

  Parameters

  • matrix: Matrix3
  • Optionalout: Quaternion

  Returns Quaternion

StaticfuzzyEqual

• fuzzyEqual(a: Quaternion, b: Quaternion, tolerance?: number): boolean

  Checks approximate equality for two quaternions.

  Parameters

  • a: Quaternion
  • b: Quaternion
  • Optionaltolerance: number

  Returns boolean

Staticidentity

• identity(out?: Quaternion): Quaternion

  Writes the identity quaternion.

  Parameters

  • Optionalout: Quaternion

  Returns Quaternion

Staticmagnitude

• magnitude(q: Quaternion): number

  Computes the magnitude of a quaternion.

  Parameters

  • q: Quaternion

  Returns number

StaticmagnitudeSquared

• magnitudeSquared(q: Quaternion): number

  Computes the squared magnitude of a quaternion.

  Parameters

  • q: Quaternion

  Returns number

Staticmultiply

• multiply(a: Quaternion, b: Quaternion, out?: Quaternion): Quaternion

  Multiplies two quaternions.

  Parameters

  • a: Quaternion
  • b: Quaternion
  • Optionalout: Quaternion

  Returns Quaternion

StaticmultiplyScalar

• multiplyScalar(q: Quaternion, s: number, out?: Quaternion): Quaternion

  Multiplies a quaternion by a scalar.

  Parameters

  • q: Quaternion
  • s: number
  • Optionalout: Quaternion

  Returns Quaternion

Staticnormalize

• normalize(q: Quaternion, out?: Quaternion): Quaternion

  Normalizes a quaternion.

  Parameters

  • q: Quaternion
  • Optionalout: Quaternion

  Returns Quaternion

Staticrandom

• random(out?: Quaternion): Quaternion

  Creates a uniformly random unit quaternion.

  Parameters

  • Optionalout: Quaternion

  Returns Quaternion

Staticreverse

• reverse(a: Quaternion, out?: Quaternion): Quaternion

  Negates the vector part of a quaternion.

  Parameters

  • a: Quaternion
  • Optionalout: Quaternion

  Returns Quaternion

StaticrotateX

• rotateX(angle: number, out?: Quaternion): Quaternion

  Applies an X-axis rotation to a quaternion.

  Parameters

  • angle: number
  • Optionalout: Quaternion

  Returns Quaternion

StaticrotateY

• rotateY(angle: number, out?: Quaternion): Quaternion

  Applies a Y-axis rotation to a quaternion.

  Parameters

  • angle: number
  • Optionalout: Quaternion

  Returns Quaternion

StaticrotateZ

• rotateZ(angle: number, out?: Quaternion): Quaternion

  Applies a Z-axis rotation to a quaternion.

  Parameters

  • angle: number
  • Optionalout: Quaternion

  Returns Quaternion

Staticserialize

• serialize(value: Quaternion): QuaternionLike

  Serializes a quaternion to an object.

  Parameters

  • value: Quaternion

  Returns QuaternionLike

Staticset

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

  Creates or overwrites a quaternion from components.

  Parameters

  • x: number
  • y: number
  • z: number
  • w: number
  • Optionalout: Quaternion

  Returns Quaternion

Staticslerp

• slerp(
      a: Quaternion,
      b: Quaternion,
      t: number,
      out?: Quaternion,
  ): typeof Quaternion | Quaternion

  Spherically interpolates between two quaternions.

  Parameters

  • a: Quaternion
  • b: Quaternion
  • t: number
  • Optionalout: Quaternion

  Returns typeof Quaternion | Quaternion

StatictransformVector3

• transformVector3(orientation: Quaternion, vector: Vector3): Vector3

  Rotates a vector by a quaternion in place.

  Parameters

  • orientation: Quaternion
  • vector: Vector3

  Returns Vector3

StaticvalidateSerial

• validateSerial(value: unknown): value is QuaternionLike

  Checks whether a value is a valid quaternion serial.

  Parameters

  • value: unknown

  Returns value is QuaternionLike

Staticzero

• zero(out?: Quaternion): Quaternion

  Writes the zero quaternion.

  Parameters

  • Optionalout: Quaternion

  Returns Quaternion