Class Quaternion

Implementation of a quaternion. This is used for rotating things without incurring in the dreaded gimbal lock issue, amongst other advantages.

Example

const quaternion = new THREE.Quaternion();
quaternion.setFromAxisAngle( new THREE.Vector3( 0, 1, 0 ), Math.PI / 2 );
const vector = new THREE.Vector3( 1, 0, 0 );
vector.applyQuaternion( quaternion );

Constructors

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number): Quaternion
Parameters
- Optionalx: number
  x coordinate
- Optionaly: number
  y coordinate
- Optionalz: number
  z coordinate
- Optionalw: number
  w coordinate
Returns Quaternion
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:32

Properties

_onChangeCallback

_onChangeCallback: () => void

`Readonly`isQuaternion

isQuaternion: true

w

w: number

Default

x

x: number

Default

y

y: number

Default

z

z: number

Default

Methods

_onChange

_onChange(callback: () => void): this
Parameters
- callback: () => void
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:164

[iterator]

"[iterator]"(): Generator<number, void>
Returns Generator<number, void>
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:188

angleTo

angleTo(q: Quaternion): number
Parameters
- q: Quaternion
Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:87

clone

clone(): this
Clones this quaternion.

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:63

conjugate

conjugate(): this
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:97

copy

copy(q: QuaternionLike): this
Copies values of q to this quaternion.
Parameters
- q: QuaternionLike
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:68

dot

dot(v: Quaternion): number
Parameters
- v: Quaternion
Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:98

equals

equals(v: Quaternion): boolean
Parameters
- v: Quaternion
Returns boolean
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:125

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): this
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.
- Optionaloffset: number
  (optional) offset into the array. Default is 0.
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:132

fromBufferAttribute

fromBufferAttribute(
attribute: BufferAttribute | InterleavedBufferAttribute,
index: number,
): this
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 this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:162

identity

identity(): this
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:90

invert

invert(): this
Inverts this quaternion.

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:95

length

length(): number
Computes length of this quaternion.

Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:104

lengthSq

lengthSq(): number
Returns number
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:99

multiply

multiply(q: Quaternion): this
Multiplies this quaternion by b.
Parameters
- q: Quaternion
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:114

multiplyQuaternions

multiplyQuaternions(a: Quaternion, b: Quaternion): this
Sets this quaternion to a x b Adapted from http://www.euclideanspace.com/maths/algebra/realNormedAlgebra/quaternions/code/index.htm.
Parameters
- a: Quaternion
- b: Quaternion
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:121

normalize

normalize(): this
Normalizes this quaternion.

Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:109

premultiply

premultiply(q: Quaternion): this
Parameters
- q: Quaternion
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:115

random

random(): this
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:186

rotateTowards

rotateTowards(q: Quaternion, step: number): this
Parameters
- q: Quaternion
- step: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:88

set

set(x: number, y: number, z: number, w: number): this
Sets values of this quaternion.
Parameters
- x: number
- y: number
- z: number
- w: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:58

setFromAxisAngle

setFromAxisAngle(axis: Vector3Like, angle: number): this
Sets this quaternion from rotation specified by axis and angle. Adapted from http://www.euclideanspace.com/maths/geometry/rotations/conversions/angleToQuaternion/index.htm. Axis have to be normalized, angle is in radians.
Parameters
- axis: Vector3Like
- angle: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:80

setFromEuler

setFromEuler(euler: Euler, update?: boolean): this
Sets this quaternion from rotation specified by Euler angles.
Parameters
- euler: Euler
- Optionalupdate: boolean
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:73

setFromRotationMatrix

setFromRotationMatrix(m: Matrix4): this
Sets this quaternion from rotation component of m. Adapted from http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/index.htm.
Parameters
- m: Matrix4
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:85

setFromUnitVectors

setFromUnitVectors(vFrom: Vector3, vTo: Vector3Like): this
Parameters
- vFrom: Vector3
- vTo: Vector3Like
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:86

slerp

slerp(qb: Quaternion, t: number): this
Parameters
- qb: Quaternion
- t: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:123

slerpQuaternions

slerpQuaternions(qa: Quaternion, qb: Quaternion, t: number): this
Parameters
- qa: Quaternion
- qb: Quaternion
- t: number
Returns this
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:124

toArray

toArray(array?: number[], offset?: number): number[]
Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.
Parameters
- Optionalarray: number[]
  (optional) array to store the quaternion to. If this is not provided, a new array will be created.
- Optionaloffset: number
  (optional) optional offset into the array.
Returns number[]
The created or provided array.
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:140
toArray(array?: QuaternionTuple, offset?: 0): QuaternionTuple
Returns an array [x, y, z, w], or copies x, y, z and w into the provided array.
Parameters
- Optionalarray: QuaternionTuple
  (optional) array to store the quaternion to. If this is not provided, a new array will be created.
- Optionaloffset: 0
  (optional) optional offset into the array.
Returns QuaternionTuple
The created or provided array.
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:141
toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>
Copies x, y, z and w into the provided array-like.
Parameters
- array: ArrayLike<number>
  array-like to store the quaternion to.
- Optionaloffset: number
  (optional) optional offset into the array.
Returns ArrayLike<number>
The provided array-like.
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:149

toJSON

toJSON(): [number, number, number, number]
This method defines the serialization result of Quaternion.

Returns [number, number, number, number]
The numerical elements of this quaternion in an array of format [x, y, z, w].
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:155

`Static`multiplyQuaternionsFlat

multiplyQuaternionsFlat(
    dst: number[],
    dstOffset: number,
    src0: number[],
    srcOffset: number,
    src1: number[],
    stcOffset1: number,
): number[]
Parameters
- dst: number[]
- dstOffset: number
- src0: number[]
- srcOffset: number
- src1: number[]
- stcOffset1: number
Returns number[]
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:177

`Static`slerpFlat

slerpFlat(
    dst: number[],
    dstOffset: number,
    src0: number[],
    srcOffset: number,
    src1: number[],
    stcOffset1: number,
    t: number,
): void
Parameters
- dst: number[]
- dstOffset: number
- src0: number[]
- srcOffset: number
- src1: number[]
- stcOffset1: number
- t: number
Returns void
- Defined in node_modules/.pnpm/@types+three@0.182.0/node_modules/@types/three/src/math/Quaternion.d.ts:167

Class Quaternion

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Quaternion

Properties

_onChangeCallback

ReadonlyisQuaternion

w

Default

x

Default

y

Default

z

Default

Methods

_onChange

Parameters

Returns this

[iterator]

Returns Generator<number, void>

angleTo

Parameters

Returns number

clone

Returns this

conjugate

Returns this

copy

Parameters

Returns this

dot

Parameters

Returns number

equals

Parameters

Returns boolean

fromArray

Parameters

Returns this

fromBufferAttribute

Parameters

Returns this

identity

Returns this

invert

Returns this

length

Returns number

lengthSq

Returns number

multiply

Parameters

Returns this

multiplyQuaternions

Parameters

Returns this

normalize

Returns this

premultiply

Parameters

Returns this

random

Returns this

rotateTowards

Parameters

Returns this

set

Parameters

Returns this

setFromAxisAngle

Parameters

Returns this

setFromEuler

`Readonly`isQuaternion

`Static`multiplyQuaternionsFlat

`Static`slerpFlat