Class Quaternion

Serializable THREE.js Quaternion

Hierarchy (view full)

Quaternion
- Quaternion
  - Orientation

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

Properties

_onChangeCallback

_onChangeCallback: (() => void)

Type declaration

- (): void
- Returns void

`Readonly` isQuaternion

isQuaternion: true

w

w: number

x

x: number

y

y: number

z

z: number

Methods

[iterator]

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

_onChange

_onChange(callback): this
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns this
Inherited from THREE.Quaternion._onChange
- Defined in src/three/math/Quaternion.d.ts:161

angleTo

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

clone

clone(): this
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:95

copy

copy(q): 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:66

dot

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

equals

equals(v): boolean
Parameters
- v: Quaternion
Returns boolean
Inherited from THREE.Quaternion.equals
- Defined in src/three/math/Quaternion.d.ts:123

fromArray

fromArray(array, offset?): 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.
- Optional offset: number
  (optional) offset into the array. Default is 0.
Returns this
Inherited from THREE.Quaternion.fromArray
- Defined in src/three/math/Quaternion.d.ts:130

fromBufferAttribute

fromBufferAttribute(attribute, index): 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:159

identity

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

invert

invert(): this
Inverts this quaternion.

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

length

length(): number
Computes length of this quaternion.

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

lengthSq

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

multiply

multiply(q): this
Multiplies this quaternion by b.
Parameters
- q: Quaternion
Returns this
Inherited from THREE.Quaternion.multiply
- Defined in src/three/math/Quaternion.d.ts:112

multiplyQuaternions

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

normalize

normalize(): this
Normalizes this quaternion.

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

premultiply

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

random

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

rotateTowards

rotateTowards(q, step): this
Parameters
- q: Quaternion
- step: number
Returns this
Inherited from THREE.Quaternion.rotateTowards
- Defined in src/three/math/Quaternion.d.ts:86

set

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

setFromAxisAngle

setFromAxisAngle(axis, angle): 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:78

setFromEuler

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

setFromRotationMatrix

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

setFromUnitVectors

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

slerp

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

slerpQuaternions

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

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.
Inherited from THREE.Quaternion.toArray
- Defined in src/three/math/Quaternion.d.ts:138
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.
Inherited from THREE.Quaternion.toArray
- Defined in src/three/math/Quaternion.d.ts:146

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?): Euler
Convert the quaternion to euler angles
Parameters
- Optional order: 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:152

toRotationMatrix

toRotationMatrix(): Matrix4
Convert quaternion to rotation matrix

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

`Static` fromAxisAngle

fromAxisAngle<T>(this, axis): 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
  - Optional angle?: number
  - Optional unit?: AngleUnit
  - x: number
  - y: number
  - z: number
Returns InstanceType<T>
Serializable quaternion
- Defined in src/utils/math/Quaternion.ts:96
fromAxisAngle<T>(this, axis): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- axis: number[]
Returns InstanceType<T>
- Defined in src/utils/math/Quaternion.ts:106
fromAxisAngle<T>(this, axis): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- axis: AxisAngle
Returns InstanceType<T>
- Defined in src/utils/math/Quaternion.ts:107

`Static` fromEuler

fromEuler<T>(this, euler): 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>(this, euler): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: Euler
Returns InstanceType<T>
- Defined in src/utils/math/Quaternion.ts:54
fromEuler<T>(this, euler): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: {
      pitch: number;
      roll: number;
      unit?: AngleUnit;
      yaw: number;
  }
  - pitch: number
  - roll: number
  - Optional unit?: AngleUnit
  - yaw: number
Returns InstanceType<T>
- Defined in src/utils/math/Quaternion.ts:55
fromEuler<T>(this, euler): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: {
      order?: EulerOrder;
      unit?: AngleUnit;
      x: number;
      y: number;
      z: number;
  }
  - Optional order?: EulerOrder
  - Optional unit?: AngleUnit
  - x: number
  - y: number
  - z: number
Returns InstanceType<T>
- Defined in src/utils/math/Quaternion.ts:64
fromEuler<T>(this, euler): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: number[]
Returns InstanceType<T>
- Defined in src/utils/math/Quaternion.ts:74

`Static` fromRotationMatrix

fromRotationMatrix<T>(this, matrix): 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>(threeQuaternion): 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, dstOffset, src0, srcOffset, src1, stcOffset1): 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:174

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

Class Quaternion

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Quaternion

Properties

_onChangeCallback

Type declaration

Returns void

Readonly isQuaternion

w

x

y

z

Methods

[iterator]

Returns Generator<number, void, unknown>

_onChange

Parameters

Returns void

Returns this

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

Parameters

`Readonly` isQuaternion

`Static` fromAxisAngle

`Optional` angle?: number

`Optional` unit?: AngleUnit

`Static` fromEuler

`Optional` unit?: AngleUnit

`Optional` order?: EulerOrder

`Optional` unit?: AngleUnit

`Static` fromRotationMatrix