Class Quaternion

constructor

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

  Creates a new Quaternion instance with the specified components.

  Parameters

  • x: number = 0

    The x component of the quaternion. Default is 0.

  • y: number = 0

    The y component of the quaternion. Default is 0.

  • z: number = 0

    The z component of the quaternion. Default is 0.

  • w: number = 1

    The w component of the quaternion. Default is 1 (identity rotation).

  Returns Quaternion

w

x

y

z

clone

• clone(): Quaternion

  Creates a new quaternion with the same components as this one.

  Returns Quaternion

  A new quaternion instance with copied values.

copy

• copy(source: Quaternion): this

  Copies the components from another quaternion to this one.

  Parameters

  • source: Quaternion

    The quaternion to copy from.

  Returns this

  This quaternion instance for method chaining.

equal

• equal(source: Quaternion): boolean

  Determines if this quaternion is equal to another quaternion.

  Parameters

  • source: Quaternion

    The quaternion to compare with.

  Returns boolean

  True if all components are equal, false otherwise.

  Remarks

  This is a strict equality check using ===, so it may return false for quaternions that represent the same rotation but have different component values due to floating-point precision.

set

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

  Sets the components of this quaternion.

  Parameters

  • x: number

    The new x component.

  • y: number

    The new y component.

  • z: number

    The new z component.

  • w: number

    The new w component.

  Returns this

  This quaternion instance for method chaining.

setFromEuler

• setFromEuler(euler: Euler): this

  Sets the quaternion components based on Euler angles. Converts Euler angles (rotation around x, y, z axes) to a quaternion representation.

  Parameters

  • euler: Euler

    The Euler angles to convert from, including rotation order.

  Returns this

  This quaternion instance for method chaining.

  Remarks

  The conversion uses the rotation order specified in the Euler object (XYZ, YXZ, ZXY, ZYX, YZX, or XZY).