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?, y?, z?, w?): Quaternion
Parameters
- Optional x: number
  x coordinate
- Optional y: number
  y coordinate
- Optional z: number
  z coordinate
- Optional w: number
  w coordinate
Returns Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:23

Properties

_onChangeCallback

_onChangeCallback: (() => void)

Type declaration

- (): void
- Returns void

`Readonly` isQuaternion

isQuaternion: true

w

w: number

Default

x

x: number

Default

y

y: number

Default

z

z: number

Default

Methods

[iterator]

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

_onChange

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

angleTo

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

clone

clone(): this
Clones this quaternion.

Returns this
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:54

conjugate

conjugate(): Quaternion
Returns Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:88

copy

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

dot

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

equals

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

fromArray

fromArray(array, offset?): this
Sets this quaternion's x, y, z and w value from the provided array or array-like.
Parameters
- array: ArrayLike<number> | number[]
  the source array or array-like.
- Optional offset: number
  (optional) offset into the array. Default is 0.
Returns this
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:123

fromBufferAttribute

fromBufferAttribute(attribute, index): 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
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:152

identity

identity(): Quaternion
Returns Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:81

invert

invert(): Quaternion
Inverts this quaternion.

Returns Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:86

length

length(): number
Computes length of this quaternion.

Returns number
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:95

lengthSq

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

multiply

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

multiplyQuaternions

multiplyQuaternions(a, b): Quaternion
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 Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:112

multiplyVector3

multiplyVector3(v): any
Parameters
- v: any
Returns any
Deprecated
Use Vector#applyQuaternion vector.applyQuaternion( quaternion ) instead.
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:184

normalize

normalize(): Quaternion
Normalizes this quaternion.

Returns Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:100

premultiply

premultiply(q): Quaternion
Parameters
- q: Quaternion
Returns Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:106

random

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

rotateTowards

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

set

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

setFromAxisAngle

setFromAxisAngle(axis, angle): Quaternion
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: Vector3
- angle: number
Returns Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:71

setFromEuler

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

setFromRotationMatrix

setFromRotationMatrix(m): Quaternion
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 Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:76

setFromUnitVectors

setFromUnitVectors(vFrom, vTo): Quaternion
Parameters
- vFrom: Vector3
- vTo: Vector3
Returns Quaternion
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:77

slerp

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

slerpQuaternions

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

toArray

toArray(array?, offset?): number[]
Returns an array [x, y, z, w], or copies x, y, z and w into the 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[]
The created or provided array.
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:131
toArray(array, offset?): ArrayLike<number>
Copies x, y, z and w into 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>
The provided array-like.
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:139

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/@types/three/src/math/Quaternion.d.ts:145

`Static` multiplyQuaternionsFlat

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

`Static` slerp

slerp(qa, qb, qm, t): number
Parameters
- qa: Quaternion
- qb: Quaternion
- qm: Quaternion
- t: number
Returns number
Deprecated
Use qm.slerpQuaternions( qa, qb, t ) instead..
- Defined in ../node_modules/@types/three/src/math/Quaternion.d.ts:179

`Static` slerpFlat

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

Class Quaternion

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Quaternion

Properties

_onChangeCallback

Type declaration

Returns void

Readonly isQuaternion

w

Default

x

Default

y

Default

z

Default

Methods

[iterator]

Returns Generator<number, void, unknown>

_onChange

Parameters

Returns void

Returns Quaternion

angleTo

Parameters

Returns number

clone

Returns this

conjugate

Returns Quaternion

copy

Parameters

Returns this

dot

Parameters

Returns number

equals

Parameters

Returns boolean

fromArray

Parameters

Returns this

fromBufferAttribute

Parameters

Returns Quaternion

identity

Returns Quaternion

invert

Returns Quaternion

length

Returns number

lengthSq

Returns number

multiply

Parameters

Returns Quaternion

multiplyQuaternions

Parameters

Returns Quaternion

multiplyVector3

Parameters

Returns any

Deprecated

normalize

Returns Quaternion

premultiply

Parameters

Returns Quaternion

random

Returns Quaternion

rotateTowards

Parameters

Returns Quaternion

`Readonly` isQuaternion

`Static` multiplyQuaternionsFlat

`Static` slerp

`Static` slerpFlat