Class Quaternion

Hierarchy (View Summary)

Quaternion
- Orientation3D

Constructors

constructor

new Quaternion(x?: number, y?: number, z?: number, w?: number): Quaternion
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
- w: number = 1
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:6

Properties

w

w: number

x

x: number

y

y: number

z

z: number

`Static` `Readonly`Identity

Identity: Quaternion = ...

`Static` `Readonly`Zero

Zero: Quaternion = ...

Methods

[iterator]

"[iterator]"(): Generator<number, void, unknown>
Returns Generator<number, void, unknown>
- Defined in packages/math/src/core/angles/quaternion.js:610

clone

clone(): Quaternion
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:34

copy

copy(quaternion: Quaternion): Quaternion
Parameters
- quaternion: Quaternion
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:28

dot

dot(v: Quaternion): number
Parameters
- v: Quaternion
Returns number
- Defined in packages/math/src/core/angles/quaternion.js:50

equals

equals(quaternion: Quaternion): boolean
Parameters
- quaternion: Quaternion
Returns boolean
- Defined in packages/math/src/core/angles/quaternion.js:112

magnitude

magnitude(): number
Returns number
- Defined in packages/math/src/core/angles/quaternion.js:58

magnitudeSquared

magnitudeSquared(): number
Returns number
- Defined in packages/math/src/core/angles/quaternion.js:54

multiply

multiply(q: Quaternion): Quaternion
Parameters
- q: Quaternion
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:75

normalize

normalize(): Quaternion
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:65

reverse

reverse(): Quaternion
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:41

rotateX

rotateX(angle: number): Quaternion
Parameters
- angle: number
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:84

rotateY

rotateY(angle: number): Quaternion
Parameters
- angle: number
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:93

rotateZ

rotateZ(angle: number): Quaternion
Parameters
- angle: number
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:102

set

set(x: number, y: number, z: number, w: number): Quaternion
Parameters
- x: number
- y: number
- z: number
- w: number
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:19

`Static`angleBetween

angleBetween(a: Quaternion, b: Quaternion): number
Parameters
- a: Quaternion
- b: Quaternion
Returns number
- Defined in packages/math/src/core/angles/quaternion.js:388

`Static`copy

copy(from: Quaternion, to?: Quaternion): Quaternion
Parameters
- from: Quaternion
- to: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:136

`Static`deserialize

deserialize(value: QuaternionSerial, out?: Quaternion): Quaternion
Parameters
- value: QuaternionSerial
- Optionalout: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:161

`Static`dot

dot(q1: Quaternion, q2: Quaternion): number
Parameters
- q1: Quaternion
- q2: Quaternion
Returns number
- Defined in packages/math/src/core/angles/quaternion.js:380

`Static`equal

equal(a: Quaternion, b: Quaternion): boolean
Parameters
- a: Quaternion
- b: Quaternion
Returns boolean
- Defined in packages/math/src/core/angles/quaternion.js:575

`Static`fromAxisAngle

fromAxisAngle(axis: Vector3, angle: number, out?: Quaternion): Quaternion
Parameters
- axis: Vector3
- angle: number
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:472

`Static`fromEuler

fromEuler(x: number, y: number, z: number, out?: Quaternion): Quaternion
Parameters
- x: number
- y: number
- z: number
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:398

`Static`fromRotationMatrix

fromRotationMatrix(matrix: Matrix3, out?: Quaternion): Quaternion
Parameters
- matrix: Matrix3
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:420

`Static`fuzzyEqual

fuzzyEqual(a: Quaternion, b: Quaternion, tolerance?: number): boolean
Parameters
- a: Quaternion
- b: Quaternion
- Optionaltolerance: number
Returns boolean
- Defined in packages/math/src/core/angles/quaternion.js:585

`Static`identity

identity(out?: Quaternion): Quaternion
Parameters
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:192

`Static`magnitude

magnitude(q: Quaternion): number
Parameters
- q: Quaternion
Returns number
- Defined in packages/math/src/core/angles/quaternion.js:225

`Static`magnitudeSquared

magnitudeSquared(q: Quaternion): number
Parameters
- q: Quaternion
Returns number
- Defined in packages/math/src/core/angles/quaternion.js:217

`Static`multiply

multiply(a: Quaternion, b: Quaternion, out?: Quaternion): Quaternion
Parameters
- a: Quaternion
- b: Quaternion
- Optionalout: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:329

`Static`multiplyScalar

multiplyScalar(q: Quaternion, s: number, out?: Quaternion): Quaternion
Parameters
- q: Quaternion
- s: number
- Optionalout: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:353

`Static`normalize

normalize(q: Quaternion, out?: Quaternion): Quaternion
Parameters
- q: Quaternion
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:234

`Static`random

random(out?: Quaternion): Quaternion
Parameters
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:594

`Static`reverse

reverse(a: Quaternion, out?: Quaternion): Quaternion
Parameters
- a: Quaternion
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:366

`Static`rotateX

rotateX(angle: number, out?: Quaternion): Quaternion
Parameters
- angle: number
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:255

`Static`rotateY

rotateY(angle: number, out?: Quaternion): Quaternion
Parameters
- angle: number
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:279

`Static`rotateZ

rotateZ(angle: number, out?: Quaternion): Quaternion
Parameters
- angle: number
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:303

`Static`serialize

serialize(value: Quaternion): { w: number; x: number; y: number; z: number }
Parameters
- value: Quaternion
Returns { w: number; x: number; y: number; z: number }
- Defined in packages/math/src/core/angles/quaternion.js:148

`Static`set

set(x: number, y: number, z: number, w: number, out?: Quaternion): Quaternion
Parameters
- x: number
- y: number
- z: number
- w: number
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:123

`Static`slerp

slerp(
    a: Quaternion,
    b: Quaternion,
    t: number,
    out?: Quaternion,
): Quaternion | typeof Quaternion
Parameters
- a: Quaternion
- b: Quaternion
- t: number
- Optionalout: Quaternion = ...
Returns Quaternion | typeof Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:515

`Static`transformVector3

transformVector3(orientation: Quaternion, vector: Vector3): Vector3
Parameters
- orientation: Quaternion
- vector: Vector3
Returns Vector3
- Defined in packages/math/src/core/angles/quaternion.js:489

`Static`validateSerial

validateSerial(value: unknown): value is QuaternionSerial
Parameters
- value: unknown
Returns value is QuaternionSerial
- Defined in packages/math/src/core/angles/quaternion.js:174

`Static`zero

zero(out?: Quaternion): Quaternion
Parameters
- out: Quaternion = ...
Returns Quaternion
- Defined in packages/math/src/core/angles/quaternion.js:204