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 );

Hierarchy

Quaternion

Constructors

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number): 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:21

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:178

_onChange

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

angleTo

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

clone

clone(): Quaternion
Clones this quaternion.

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

conjugate

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

copy

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

dot

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

equals

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

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): Quaternion
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
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:121

identity

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

inverse

inverse(): Quaternion
Deprecated
Use .invert() instead.

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

invert

invert(): Quaternion
Inverts this quaternion.

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

length

length(): number
Computes length of this quaternion.

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

lengthSq

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

multiply

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

multiplyQuaternions

multiplyQuaternions(a: Quaternion, b: Quaternion): 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:110

multiplyVector3

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

normalize

normalize(): Quaternion
Normalizes this quaternion.

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

premultiply

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

random

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

rotateTowards

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

set

set(x: number, y: number, z: number, w: number): 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:47

setFromAxisAngle

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

setFromEuler

setFromEuler(euler: Euler, update?: boolean): 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:62

setFromRotationMatrix

setFromRotationMatrix(m: Matrix4): 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:74

setFromUnitVectors

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

slerp

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

slerpQuaternions

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

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.

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[]
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:129
toArray(array: ArrayLike<number>, offset?: number): ArrayLike<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>
- Defined in node_modules/@types/three/src/math/Quaternion.d.ts:137

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

`Static` slerp

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

`Static` slerpFlat

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

Class Quaternion

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional x: number

Optional y: number

Optional z: number

Optional w: number

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

callback: (() => void)

Returns void

Returns Quaternion

angleTo

Parameters

q: Quaternion

Returns number

clone

Returns Quaternion

conjugate

Returns Quaternion

copy

Parameters

q: Quaternion

Returns Quaternion

dot

Parameters

v: Quaternion

Returns number

equals

Parameters

v: Quaternion

Returns boolean

fromArray

Parameters

array: number[] | ArrayLike<number>

Optional offset: number

Returns Quaternion

identity

Returns Quaternion

inverse

Deprecated

Returns Quaternion

invert

Returns Quaternion

length

Returns number

lengthSq

Returns number

multiply

Parameters

q: Quaternion

Returns Quaternion

multiplyQuaternions

Parameters

a: Quaternion

b: Quaternion

`Optional` x: number

`Optional` y: number

`Optional` z: number

`Optional` w: number

`Readonly` isQuaternion

`Optional` offset: number

`Optional` update: boolean

`Optional` array: number[]

`Optional` offset: number

`Optional` offset: number

`Static` multiplyQuaternionsFlat