Class Orientation3D

Hierarchy (View Summary)

Quaternion
- Orientation3D

Constructors

constructor

new Orientation3D(x?: number, y?: number, z?: number, w?: number): Orientation3D
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
- w: number = 1
Returns Orientation3D
Inherited from Quaternion.constructor
- 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>
Inherited from Quaternion.[iterator]
- Defined in packages/math/src/core/angles/quaternion.js:610

clone

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

copy

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

dot

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

equals

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

magnitude

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

magnitudeSquared

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

multiply

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

normalize

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

reverse

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

rotateX

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

rotateY

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

rotateZ

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

set

set(x: number, y: number, z: number, w: number): Orientation3D
Parameters
- x: number
- y: number
- z: number
- w: number
Returns Orientation3D
Inherited from Quaternion.set
- 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
Inherited from Quaternion.angleBetween
- Defined in packages/math/src/core/angles/quaternion.js:388

`Static`clone

clone(target: Orientation3D): Quaternion
Parameters
- target: Orientation3D
Returns Quaternion
- Defined in packages/transform/src/components/3d/orientation.js:16

`Static`copy

copy(source: Orientation3D, target?: Orientation3D): Quaternion
Parameters
- source: Orientation3D
- target: Orientation3D = ...
Returns Quaternion
Overrides Quaternion.copy
- Defined in packages/transform/src/components/3d/orientation.js:9

`Static`deserialize

deserialize(value: QuaternionSerial, out?: Orientation3D): Quaternion
Parameters
- value: QuaternionSerial
- Optionalout: Orientation3D = ...
Returns Quaternion
Overrides Quaternion.deserialize
- Defined in packages/transform/src/components/3d/orientation.js:31

`Static`dot

dot(q1: Quaternion, q2: Quaternion): number
Parameters
- q1: Quaternion
- q2: Quaternion
Returns number
Inherited from Quaternion.dot
- 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
Inherited from Quaternion.equal
- 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
Inherited from Quaternion.fromAxisAngle
- 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
Inherited from Quaternion.fromEuler
- 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
Inherited from Quaternion.fromRotationMatrix
- 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
Inherited from Quaternion.fuzzyEqual
- Defined in packages/math/src/core/angles/quaternion.js:585

`Static`identity

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

`Static`magnitude

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

`Static`magnitudeSquared

magnitudeSquared(q: Quaternion): number
Parameters
- q: Quaternion
Returns number
Inherited from Quaternion.magnitudeSquared
- 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
Inherited from Quaternion.multiply
- 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
Inherited from Quaternion.multiplyScalar
- 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
Inherited from Quaternion.normalize
- Defined in packages/math/src/core/angles/quaternion.js:234

`Static`random

random(out?: Quaternion): Quaternion
Parameters
- out: Quaternion = ...
Returns Quaternion
Inherited from Quaternion.random
- 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
Inherited from Quaternion.reverse
- 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
Inherited from Quaternion.rotateX
- 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
Inherited from Quaternion.rotateY
- 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
Inherited from Quaternion.rotateZ
- Defined in packages/math/src/core/angles/quaternion.js:303

`Static`serialize

serialize(value: Orientation3D): { w: number; x: number; y: number; z: number }
Parameters
- value: Orientation3D
Returns { w: number; x: number; y: number; z: number }
Overrides Quaternion.serialize
- Defined in packages/transform/src/components/3d/orientation.js:23

`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
Inherited from Quaternion.set
- 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
Inherited from Quaternion.slerp
- 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
Inherited from Quaternion.transformVector3
- 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
Inherited from Quaternion.validateSerial
- Defined in packages/math/src/core/angles/quaternion.js:174

`Static`zero

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