Class Orientation

Orientation quaternion with accuracy

Hierarchy-Diagram

Legend

class

Hierarchy

Quaternion
- Orientation

Constructors

constructor

new Orientation(x?: number, y?: number, z?: number, w?: number, accuracy?: Accuracy<AngleUnit, number>): Orientation
Parameters
- Optional x: number
- Optional y: number
- Optional z: number
- Optional w: number
- Optional accuracy: Accuracy<AngleUnit, number>
Returns Orientation
Overrides Quaternion.constructor
- Defined in src/data/position/Orientation.ts:26

Properties

_onChangeCallback

_onChangeCallback: (() => void)

Type declaration

- (): void
- Returns void

accuracy

accuracy: Accuracy<AngleUnit, number>

`Readonly` isQuaternion

isQuaternion: true

timestamp

timestamp: number

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 Quaternion.[iterator]
- Defined in src/three/math/Quaternion.d.ts:182

_onChange

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

angleTo

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

clone

clone(): Orientation
Returns Orientation
Overrides Quaternion.clone
- Defined in src/data/position/Orientation.ts:36

conjugate

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

copy

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

dot

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

equals

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

fromArray

fromArray(array: number[] | ArrayLike<number>, offset?: number): Orientation
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 Orientation
Inherited from Quaternion.fromArray
- Defined in src/three/math/Quaternion.d.ts:123

fromBufferAttribute

fromBufferAttribute(attribute: BufferAttribute | InterleavedBufferAttribute, index: number): 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
Inherited from Quaternion.fromBufferAttribute
- Defined in src/three/math/Quaternion.d.ts:146

identity

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

invert

invert(): Quaternion
Inverts this quaternion.

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

length

length(): number
Computes length of this quaternion.

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

lengthSq

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

multiply

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

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

multiplyVector3

multiplyVector3(v: any): any
Deprecated
Use Vector#applyQuaternion vector.applyQuaternion( quaternion ) instead.
Parameters
- v: any
Returns any
Inherited from Quaternion.multiplyVector3
- Defined in src/three/math/Quaternion.d.ts:178

normalize

normalize(): Quaternion
Normalizes this quaternion.

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

premultiply

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

random

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

rotateTowards

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

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

setFromAxisAngle

setFromAxisAngle(axis: 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: Vector3
- angle: number
Returns Quaternion
Inherited from Quaternion.setFromAxisAngle
- Defined in src/three/math/Quaternion.d.ts:71

setFromEuler

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

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

setFromUnitVectors

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

slerp

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

slerpQuaternions

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

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[]
Inherited from Quaternion.toArray
- Defined in src/three/math/Quaternion.d.ts:131
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>
Inherited from Quaternion.toArray
- Defined in src/three/math/Quaternion.d.ts:139

toAxisAngle

toAxisAngle(): AxisAngle
Convert the quaternion to axis angles

Returns
Converted axis angle

Returns AxisAngle
Inherited from Quaternion.toAxisAngle
- Defined in src/utils/math/Quaternion.ts:153

toEuler

toEuler(order?: EulerOrder): Euler
Convert the quaternion to euler angles

Returns
Converted euler
Parameters
- Optional order: EulerOrder
  
  Euler order
Returns Euler
Inherited from Quaternion.toEuler
- Defined in src/utils/math/Quaternion.ts:144

toRotationMatrix

toRotationMatrix(): Matrix4
Convert quaternion to rotation matrix

Returns
Rotation matrix

Returns Matrix4
Inherited from Quaternion.toRotationMatrix
- Defined in src/utils/math/Quaternion.ts:162

`Static` fromAxisAngle

fromAxisAngle<T>(this: T, axis: {
    angle?: number;
    unit?: AngleUnit;
    x: number;
    y: number;
    z: number;
}): InstanceType<T>
Convert axis angle rotation to quaternion

Returns
Serializable 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>
Inherited from Quaternion.fromAxisAngle
- Defined in src/utils/math/Quaternion.ts:99
fromAxisAngle<T>(this: T, axis: number[]): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- axis: number[]
Returns InstanceType<T>
Inherited from Quaternion.fromAxisAngle
- Defined in src/utils/math/Quaternion.ts:109
fromAxisAngle<T>(this: T, axis: AxisAngle): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- axis: AxisAngle
Returns InstanceType<T>
Inherited from Quaternion.fromAxisAngle
- Defined in src/utils/math/Quaternion.ts:110

`Static` fromEuler

fromEuler<T>(this: T, euler: Vector3): InstanceType<T>
Convert euler angles to quaternion

Returns
Serializable quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: Vector3
  
  Euler vector
Returns InstanceType<T>
Inherited from Quaternion.fromEuler
- Defined in src/utils/math/Quaternion.ts:55
fromEuler<T>(this: T, euler: Euler): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: Euler
Returns InstanceType<T>
Inherited from Quaternion.fromEuler
- Defined in src/utils/math/Quaternion.ts:56
fromEuler<T>(this: T, euler: {
    pitch: number;
    roll: number;
    unit?: AngleUnit;
    yaw: number;
}): 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>
Inherited from Quaternion.fromEuler
- Defined in src/utils/math/Quaternion.ts:57
fromEuler<T>(this: T, euler: {
    order?: EulerOrder;
    unit?: AngleUnit;
    x: number;
    y: number;
    z: number;
}): 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>
Inherited from Quaternion.fromEuler
- Defined in src/utils/math/Quaternion.ts:66
fromEuler<T>(this: T, euler: number[]): InstanceType<T>
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
- euler: number[]
Returns InstanceType<T>
Inherited from Quaternion.fromEuler
- Defined in src/utils/math/Quaternion.ts:76

`Static` fromQuaternion

fromQuaternion(quat: Quaternion | Quaternion): Orientation
Parameters
- quat: Quaternion | Quaternion
Returns Orientation
- Defined in src/data/position/Orientation.ts:32

`Static` fromRotationMatrix

fromRotationMatrix<T>(this: T, matrix: Matrix4): InstanceType<T>
Convert rotation matrix to quaternion

Returns
Serializable quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- this: T
  
  This type
- matrix: Matrix4
  
  Rotation matrix
Returns InstanceType<T>
Inherited from Quaternion.fromRotationMatrix
- Defined in src/utils/math/Quaternion.ts:132

`Static` fromThreeJS

fromThreeJS<T>(threeQuaternion: Quaternion): InstanceType<T>
Convert a threejs quaternion to serializable quaternion

Returns
Serializable quaternion
Type Parameters
- T extends typeof Quaternion
Parameters
- threeQuaternion: Quaternion
  
  ThreeJS created quaternion
Returns InstanceType<T>
Inherited from Quaternion.fromThreeJS
- Defined in src/utils/math/Quaternion.ts:40

`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 Quaternion.multiplyQuaternionsFlat
- Defined in src/three/math/Quaternion.d.ts:161

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

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

Class Orientation

Hierarchy-Diagram

Legend

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional x: number

Optional y: number

Optional z: number

Optional w: number

Optional accuracy: Accuracy<AngleUnit, number>

Returns Orientation

Properties

_onChangeCallback

Type declaration

Returns void

accuracy

Readonly isQuaternion

timestamp

w

x

y

z

Methods

[iterator]

Returns Generator<number, void, unknown>

_onChange

Parameters

callback: (() => void)

Returns void

Returns Quaternion

angleTo

Parameters

q: Quaternion

Returns number

clone

Returns Orientation

conjugate

Returns Quaternion

copy

Parameters

q: Quaternion

Returns Orientation

dot

Parameters

v: Quaternion

Returns number

equals

Parameters

v: Quaternion

Returns boolean

fromArray

Parameters

array: number[] | ArrayLike<number>

Optional offset: number

Returns Orientation

fromBufferAttribute

Parameters

attribute: BufferAttribute | InterleavedBufferAttribute

index: number

Returns Quaternion

identity

Returns Quaternion

invert

Returns Quaternion

length

Returns number

lengthSq

Returns number

multiply

Parameters

q: Quaternion

Returns Quaternion

multiplyQuaternions

Parameters

`Optional` x: number

`Optional` y: number

`Optional` z: number

`Optional` w: number

`Optional` accuracy: Accuracy<AngleUnit, number>

`Readonly` isQuaternion

`Optional` offset: number

`Optional` update: boolean

`Optional` array: number[]

`Optional` offset: number

`Optional` offset: number