Class Quaternion

Serializable THREE.js Quaternion

Hierarchy-Diagram

UML class diagram of Quaternion
Legend
icon for a class in the UML class diagram class

Hierarchy

Constructors

  • Parameters

    • Optional x: number

      x coordinate

    • Optional y: number

      y coordinate

    • Optional z: number

      z coordinate

    • Optional w: number

      w coordinate

    Returns Quaternion

Properties

_onChangeCallback: (() => void)

Type declaration

    • (): void
    • Returns void

isQuaternion: true
w: number
x: number
y: number
z: number

Methods

  • Returns Generator<number, void, unknown>

  • Parameters

    • callback: (() => void)
        • (): void
        • Returns void

    Returns Quaternion

  • Parameters

    • q: Quaternion

    Returns number

  • Returns Quaternion

  • Copies values of q to this quaternion.

    Parameters

    • q: Quaternion

    Returns Quaternion

  • Parameters

    • v: Quaternion

    Returns number

  • Parameters

    • v: Quaternion

    Returns boolean

  • Sets this quaternion's x, y, z and w value from the provided array or array-like.

    Parameters

    • array: number[] | ArrayLike<number>

      the source array or array-like.

    • Optional offset: number

      (optional) offset into the array. Default is 0.

    Returns Quaternion

  • Sets x, y, z, w properties of this quaternion from the attribute.

    Parameters

    • attribute: BufferAttribute | InterleavedBufferAttribute

      the source attribute.

    • index: number

      index in the attribute.

    Returns Quaternion

  • Returns Quaternion

  • Inverts this quaternion.

    Returns Quaternion

  • Computes length of this quaternion.

    Returns number

  • Returns number

  • Multiplies this quaternion by b.

    Parameters

    • q: Quaternion

    Returns Quaternion

  • Deprecated

    Use Vector#applyQuaternion vector.applyQuaternion( quaternion ) instead.

    Parameters

    • v: any

    Returns any

  • Normalizes this quaternion.

    Returns Quaternion

  • Parameters

    • q: Quaternion

    Returns Quaternion

  • Returns Quaternion

  • Parameters

    • q: Quaternion
    • step: number

    Returns Quaternion

  • Sets values of this quaternion.

    Parameters

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

    Returns Quaternion

  • Sets this quaternion from rotation specified by Euler angles.

    Parameters

    • euler: Euler
    • Optional update: boolean

    Returns Quaternion

  • Parameters

    • vFrom: Vector3
    • vTo: Vector3

    Returns Quaternion

  • Parameters

    • qb: Quaternion
    • t: number

    Returns Quaternion

  • Parameters

    • qa: Quaternion
    • qb: Quaternion
    • t: number

    Returns Quaternion

  • Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.

    Returns

    The created or provided array.

    Parameters

    • Optional array: number[]

      (optional) array to store the quaternion to. If this is not provided, a new array will be created.

    • Optional offset: number

      (optional) optional offset into the array.

    Returns number[]

  • Copies x, y, z and w into the provided array-like.

    Returns

    The provided array-like.

    Parameters

    • array: ArrayLike<number>

      array-like to store the quaternion to.

    • Optional offset: number

      (optional) optional offset into the array.

    Returns ArrayLike<number>

  • Convert axis angle rotation to quaternion

    Returns

    Serializable quaternion

    Type Parameters

    Parameters

    • this: T
    • axis: {
          angle?: number;
          unit?: AngleUnit;
          x: number;
          y: number;
          z: number;
      }

      Axis-angle rotation

      • Optional angle?: number
      • Optional unit?: AngleUnit
      • x: number
      • y: number
      • z: number

    Returns InstanceType<T>

  • Type Parameters

    Parameters

    • this: T
    • axis: number[]

    Returns InstanceType<T>

  • Type Parameters

    Parameters

    Returns InstanceType<T>

  • Convert euler angles to quaternion

    Returns

    Serializable quaternion

    Type Parameters

    Parameters

    • this: T
    • euler: Vector3

      Euler vector

    Returns InstanceType<T>

  • Type Parameters

    Parameters

    Returns InstanceType<T>

  • Type Parameters

    Parameters

    • this: T
    • euler: {
          pitch: number;
          roll: number;
          unit?: AngleUnit;
          yaw: number;
      }
      • pitch: number
      • roll: number
      • Optional unit?: AngleUnit
      • yaw: number

    Returns InstanceType<T>

  • Type Parameters

    Parameters

    • this: T
    • euler: {
          order?: EulerOrder;
          unit?: AngleUnit;
          x: number;
          y: number;
          z: number;
      }

    Returns InstanceType<T>

  • Type Parameters

    Parameters

    • this: T
    • euler: number[]

    Returns InstanceType<T>

  • Convert rotation matrix to quaternion

    Returns

    Serializable quaternion

    Type Parameters

    Parameters

    • this: T

      This type

    • matrix: Matrix4

      Rotation matrix

    Returns InstanceType<T>

  • Convert a threejs quaternion to serializable quaternion

    Returns

    Serializable quaternion

    Type Parameters

    Parameters

    • threeQuaternion: Quaternion

      ThreeJS created quaternion

    Returns InstanceType<T>

  • Parameters

    • dst: number[]
    • dstOffset: number
    • src0: number[]
    • srcOffset: number
    • src1: number[]
    • stcOffset1: number

    Returns number[]

  • Deprecated

    Use qm.slerpQuaternions( qa, qb, t ) instead..

    Parameters

    • qa: Quaternion
    • qb: Quaternion
    • qm: Quaternion
    • t: number

    Returns number

  • Parameters

    • dst: number[]
    • dstOffset: number
    • src0: number[]
    • srcOffset: number
    • src1: number[]
    • stcOffset1: number
    • t: number

    Returns void