Class Quaternion

Hierarchy

Quaternion

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Quaternion(x?: undefined | number, y?: undefined | number, z?: undefined | number, w?: undefined | number): Quaternion

- Defined in src/math/Quaternion.ts:57
Parameters
- Optional x: undefined | number
- Optional y: undefined | number
- Optional z: undefined | number
- Optional w: undefined | number
Returns Quaternion

Properties

Static dummy

dummy: Quaternion = new Quaternion()

Static identity

identity: Quaternion = new Quaternion()

Static pool

pool: ObjectPool<Quaternion> = new ObjectPool(Quaternion, 64)

Accessors

length

get length(): number

- Defined in src/math/Quaternion.ts:20
Returns number

lengthSq

get lengthSq(): number

- Defined in src/math/Quaternion.ts:21
Returns number

w

get w(): number
set w(w: number): void

- Defined in src/math/Quaternion.ts:25
Returns number
- Defined in src/math/Quaternion.ts:29
Parameters
- w: number
Returns void

x

get x(): number
set x(x: number): void

- Defined in src/math/Quaternion.ts:22
Returns number
- Defined in src/math/Quaternion.ts:26
Parameters
- x: number
Returns void

y

get y(): number
set y(y: number): void

- Defined in src/math/Quaternion.ts:23
Returns number
- Defined in src/math/Quaternion.ts:27
Parameters
- y: number
Returns void

z

get z(): number
set z(z: number): void

- Defined in src/math/Quaternion.ts:24
Returns number
- Defined in src/math/Quaternion.ts:28
Parameters
- z: number
Returns void

Methods

conjugate

conjugate(): this

- Defined in src/math/Quaternion.ts:261
Returns this

copy

copy(other: Quaternion): this

- Defined in src/math/Quaternion.ts:244
Parameters
- other: Quaternion
Returns this

equals

equals(other: Quaternion): boolean

- Defined in src/math/Quaternion.ts:237
Parameters
- other: Quaternion
Returns boolean

getInverse

getInverse(out: Quaternion): Quaternion

- Defined in src/math/Quaternion.ts:257
Parameters
- out: Quaternion
Returns Quaternion

invert

invert(): this

- Defined in src/math/Quaternion.ts:252
Returns this

lookAt

lookAt(forward: Vector3, up: Vector3): this

- Defined in src/math/Quaternion.ts:196
Parameters
- forward: Vector3
- up: Vector3
Returns this

multiply

multiply(other: Quaternion): this

- Defined in src/math/Quaternion.ts:218
Parameters
- other: Quaternion
Returns this

multiplyQuaternions

multiplyQuaternions(b: Quaternion, a: Quaternion): this

- Defined in src/math/Quaternion.ts:222
Parameters
- b: Quaternion
- a: Quaternion
Returns this

normalize

normalize(): this

- Defined in src/math/Quaternion.ts:202
Returns this

set

set(x: number, y: number, z: number, w: number): void

- Defined in src/math/Quaternion.ts:66
Parameters
- x: number
- y: number
- z: number
- w: number
Returns void

setFromAxisAngle

setFromAxisAngle(axis: Vector3, radians: number): this

- Defined in src/math/Quaternion.ts:73
Parameters
- axis: Vector3
- radians: number
Returns this

setFromEulerAngles

setFromEulerAngles(x: number, y: number, z: number, order?: RotationOrder): this

- Defined in src/math/Quaternion.ts:89
Parameters
- x: number
  
  Rotation around the x axis in Radians
- y: number
  
  Rotation around the y axis in Radians
- z: number
  
  Rotation around the z axis in Radians
- Default value order: RotationOrder = "YXZ"
  
  Rotation order
Returns this

setFromEulerVector

setFromEulerVector(euler: Vector3): this

- Defined in src/math/Quaternion.ts:131
Parameters
- euler: Vector3
Returns this

setFromMatrix

setFromMatrix(m: Matrix44): this

- Defined in src/math/Quaternion.ts:156
Parameters
- m: Matrix44
Returns this

setFromUnitVectors

setFromUnitVectors(from: Vector3, to: Vector3): this

- Defined in src/math/Quaternion.ts:135
Parameters
- from: Vector3
- to: Vector3
Returns this

slerp

slerp(qb: Quaternion, t: number): this

- Defined in src/math/Quaternion.ts:272
Parameters
- qb: Quaternion
- t: number
Returns this

slerpQuaternions

slerpQuaternions(a: Quaternion, b: Quaternion, t: number): this

- Defined in src/math/Quaternion.ts:268
Parameters
- a: Quaternion
- b: Quaternion
- t: number
Returns this

toEuler

toEuler(euler: Vector3): Vector3

- Defined in src/math/Quaternion.ts:233
Parameters
- euler: Vector3
Returns Vector3

Static fromAxisAngle

fromAxisAngle(axis: Vector3, radians: number): Quaternion

- Defined in src/math/Quaternion.ts:51
Parameters
- axis: Vector3
- radians: number
Returns Quaternion

Static fromEulerAngles

fromEulerAngles(x: number, y: number, z: number, order?: RotationOrder): Quaternion

- Defined in src/math/Quaternion.ts:47
Parameters
- x: number
  
  Rotation around the x axis in Radians
- y: number
  
  Rotation around the y axis in Radians
- z: number
  
  Rotation around the z axis in Radians
- Default value order: RotationOrder = "YXZ"
  
  Rotation order
Returns Quaternion

Static fromPool

fromPool(): Quaternion

- Defined in src/math/Quaternion.ts:36
Returns Quaternion

Static fromUnitVectors

fromUnitVectors(from: Vector3, to: Vector3): Quaternion

- Defined in src/math/Quaternion.ts:55
Parameters
- from: Vector3
- to: Vector3
Returns Quaternion