Class Quaternion

Serializable THREE.js Quaternion

Hierarchy (View Summary)

Quaternion
- Quaternion
  - Orientation

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
Inherited from THREE.Quaternion.constructor
- Defined in src/three/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
Inherited from THREE.Quaternion._onChange
- Defined in src/three/math/Quaternion.d.ts:164

[iterator]

"[iterator]"(): Generator<number, void>
Returns Generator<number, void>
Inherited from THREE.Quaternion.[iterator]
- Defined in src/three/math/Quaternion.d.ts:188

angleTo

angleTo(q: Quaternion): number
Parameters
- q: Quaternion
Returns number
Inherited from THREE.Quaternion.angleTo
- Defined in src/three/math/Quaternion.d.ts:87

clone

clone(): this
Clones this quaternion.

Returns this
Overrides THREE.Quaternion.clone
- Defined in src/utils/math/Quaternion.ts:159

conjugate

conjugate(): this
Returns this
Inherited from THREE.Quaternion.conjugate
- Defined in src/three/math/Quaternion.d.ts:97

copy

copy(q: QuaternionLike): this
Copies values of q to this quaternion.
Parameters
- q: QuaternionLike
Returns this
Inherited from THREE.Quaternion.copy
- Defined in src/three/math/Quaternion.d.ts:68

dot

dot(v: Quaternion): number
Parameters
- v: Quaternion
Returns number
Inherited from THREE.Quaternion.dot
- Defined in src/three/math/Quaternion.d.ts:98

equals

equals(v: Quaternion): boolean
Parameters
- v: Quaternion
Returns boolean
Inherited from THREE.Quaternion.equals
- Defined in src/three/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
Inherited from THREE.Quaternion.fromArray
- Defined in src/three/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
Inherited from THREE.Quaternion.fromBufferAttribute
- Defined in src/three/math/Quaternion.d.ts:162

identity

identity(): this
Returns this
Inherited from THREE.Quaternion.identity
- Defined in src/three/math/Quaternion.d.ts:90

invert

invert(): this
Inverts this quaternion.

Returns this
Inherited from THREE.Quaternion.invert
- Defined in src/three/math/Quaternion.d.ts:95

length

length(): number
Computes length of this quaternion.

Returns number
Inherited from THREE.Quaternion.length
- Defined in src/three/math/Quaternion.d.ts:104

lengthSq

lengthSq(): number
Returns number
Inherited from THREE.Quaternion.lengthSq
- Defined in src/three/math/Quaternion.d.ts:99

multiply

multiply(q: Quaternion): this
Multiplies this quaternion by b.
Parameters
- q: Quaternion
Returns this
Inherited from THREE.Quaternion.multiply
- Defined in src/three/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
Inherited from THREE.Quaternion.multiplyQuaternions
- Defined in src/three/math/Quaternion.d.ts:121

normalize

normalize(): this
Normalizes this quaternion.

Returns this
Inherited from THREE.Quaternion.normalize
- Defined in src/three/math/Quaternion.d.ts:109

premultiply

premultiply(q: Quaternion): this
Parameters
- q: Quaternion
Returns this
Inherited from THREE.Quaternion.premultiply
- Defined in src/three/math/Quaternion.d.ts:115

random

random(): this
Returns this
Inherited from THREE.Quaternion.random
- Defined in src/three/math/Quaternion.d.ts:186

rotateTowards

rotateTowards(q: Quaternion, step: number): this
Parameters
- q: Quaternion
- step: number
Returns this
Inherited from THREE.Quaternion.rotateTowards
- Defined in src/three/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
Inherited from THREE.Quaternion.set
- Defined in src/three/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
Inherited from THREE.Quaternion.setFromAxisAngle
- Defined in src/three/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
Inherited from THREE.Quaternion.setFromEuler
- Defined in src/three/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
Inherited from THREE.Quaternion.setFromRotationMatrix
- Defined in src/three/math/Quaternion.d.ts:85

setFromUnitVectors

setFromUnitVectors(vFrom: Vector3, vTo: Vector3Like): this
Parameters
- vFrom: Vector3
- vTo: Vector3Like
Returns this
Inherited from THREE.Quaternion.setFromUnitVectors
- Defined in src/three/math/Quaternion.d.ts:86

slerp

slerp(qb: Quaternion, t: number): this
Parameters
- qb: Quaternion
- t: number
Returns this
Inherited from THREE.Quaternion.slerp
- Defined in src/three/math/Quaternion.d.ts:123

slerpQuaternions

slerpQuaternions(qa: Quaternion, qb: Quaternion, t: number): this
Parameters
- qa: Quaternion
- qb: Quaternion
- t: number
Returns this
Inherited from THREE.Quaternion.slerpQuaternions
- Defined in src/three/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.
Inherited from THREE.Quaternion.toArray
- Defined in src/three/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.
Inherited from THREE.Quaternion.toArray
- Defined in src/three/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.
Inherited from THREE.Quaternion.toArray
- Defined in src/three/math/Quaternion.d.ts:149

toAxisAngle

toAxisAngle(): AxisAngle
Convert the quaternion to axis angles

Returns AxisAngle
Converted axis angle
- Defined in src/utils/math/Quaternion.ts:147

toEuler

toEuler(order?: EulerOrder): Euler
Convert the quaternion to euler angles
Parameters
- Optionalorder: EulerOrder
  Euler order
Returns Euler
Converted euler
- Defined in src/utils/math/Quaternion.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].
Inherited from THREE.Quaternion.toJSON
- Defined in src/three/math/Quaternion.d.ts:155

toRotationMatrix

toRotationMatrix(): Matrix4
Convert quaternion to rotation matrix

Returns Matrix4
Rotation matrix
- Defined in src/utils/math/Quaternion.ts:155

`Static`fromAxisAngle

fromAxisAngle<T extends typeof Quaternion>(
this: T,
axis: { angle?: number; unit?: AngleUnit; x: number; y: number; z: number },
): InstanceType<T>
Convert axis angle rotation to quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- axis: { angle?: number; unit?: AngleUnit; x: number; y: number; z: number }
  Axis-angle rotation
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:96
fromAxisAngle<T extends typeof Quaternion>(
this: T,
axis: number[],
): InstanceType<T>
Convert axis angle rotation to quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- axis: number[]
  Axis-angle rotation
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:106
fromAxisAngle<T extends typeof Quaternion>(
this: T,
axis: AxisAngle,
): InstanceType<T>
Convert axis angle rotation to quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- axis: AxisAngle
  Axis-angle rotation
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:107

`Static`fromEuler

fromEuler<T extends typeof Quaternion>(this: T, euler: Vector3): InstanceType<T>
Convert euler angles to quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: Vector3
  Euler vector
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:53
fromEuler<T extends typeof Quaternion>(this: T, euler: Euler): InstanceType<T>
Convert euler angles to quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: Euler
  Euler vector
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:54
fromEuler<T extends typeof Quaternion>(
this: T,
euler: { pitch: number; roll: number; unit?: AngleUnit; yaw: number },
): InstanceType<T>
Convert euler angles to quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: { pitch: number; roll: number; unit?: AngleUnit; yaw: number }
  Euler vector
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:55
fromEuler<T extends typeof Quaternion>(
    this: T,
    euler: {
        order?: EulerOrder;
        unit?: AngleUnit;
        x: number;
        y: number;
        z: number;
    },
): InstanceType<T>
Convert euler angles to quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: { order?: EulerOrder; unit?: AngleUnit; x: number; y: number; z: number }
  Euler vector
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:64
fromEuler<T extends typeof Quaternion>(
this: T,
euler: number[],
): InstanceType<T>
Convert euler angles to quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: number[]
  Euler vector
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:74

`Static`fromRotationMatrix

fromRotationMatrix<T extends typeof Quaternion>(
this: T,
matrix: Matrix4,
): InstanceType<T>
Convert rotation matrix to quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
  This type
- matrix: Matrix4
  Rotation matrix
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:128

`Static`fromThreeJS

fromThreeJS<T extends typeof Quaternion>(
threeQuaternion: Quaternion,
): InstanceType<T>
Convert a threejs quaternion to serializable quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- threeQuaternion: Quaternion
  ThreeJS created quaternion
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:39

`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[]
Inherited from THREE.Quaternion.multiplyQuaternionsFlat
- Defined in src/three/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
Inherited from THREE.Quaternion.slerpFlat
- Defined in src/three/math/Quaternion.d.ts:167

Class Quaternion

Hierarchy (View Summary)

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`fromAxisAngle

`Static`fromEuler

`Static`fromRotationMatrix

`Static`fromThreeJS

`Static`multiplyQuaternionsFlat

`Static`slerpFlat