Class Quaternion

Quaternion which is 4-dimensional complex number. See Wikipedia.

Hierarchy

Quaternion

Index

Constructors

constructor

Properties

_values

Accessors

Methods

Constructors

constructor

new Quaternion(x: number, y: number, z: number, w: number): Quaternion

- Defined in quaternion.ts:11
Parameters
- x: number
- y: number
- z: number
- w: number
Returns Quaternion

Properties

Protected _values

_values: Float32Array

Accessors

magnitude

get magnitude(): number

- Defined in quaternion.ts:101
Calc magnitude of the quaternion.

Returns number

norm

get norm(): number

- Defined in quaternion.ts:110
Calc norm of the quaternion. An alias for magnitude.

Returns number

values

get values(): Float32Array

- Defined in quaternion.ts:182
Returns values of the quaternion.

Returns Float32Array

w

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

- Defined in quaternion.ts:142
Returns w value of the vector.

Returns number
- Defined in quaternion.ts:174
Set the value as new w.

Parameters
- value: number
Returns void

x

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

- Defined in quaternion.ts:118
Returns x value of the vector.

Returns number
- Defined in quaternion.ts:150
Set the value as new x.

Parameters
- value: number
Returns void

y

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

- Defined in quaternion.ts:126
Returns y value of the vector.

Returns number
- Defined in quaternion.ts:158
Set the value as new y.

Parameters
- value: number
Returns void

z

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

- Defined in quaternion.ts:134
Returns z value of the vector.

Returns number
- Defined in quaternion.ts:166
Set the value as new z.

Parameters
- value: number
Returns void

Methods

add

add(other: Quaternion): Quaternion

- Defined in quaternion.ts:46
Adds the other to the quaternion and returns the sum.

This method does not mutate the quaternion.

Parameters
- other: Quaternion
Returns Quaternion

dot

dot(other: Quaternion): number

- Defined in quaternion.ts:66
Calculates dot product.

Parameters
- other: Quaternion
Returns number

mulByScalar

mulByScalar(scalar: number): Quaternion

- Defined in quaternion.ts:57
Multiplies the quaternion by scalar and returns the product.

This method does not mutate the quaternion.

Parameters
- scalar: number
Returns Quaternion

normalize

normalize(): Quaternion

- Defined in quaternion.ts:32
Returns a normalized quaternion.

Returns Quaternion

slerp

slerp(other: Quaternion, t: number, options?: { chooseShorterAngle: boolean }): Quaternion

- Defined in quaternion.ts:77
Calculates spherical linear interpolation(also known as Slerp) and returns new Quaternion between the quaternion and the other.

Parameters
- other: Quaternion
- t: number
  
  0.0 <= t <= 1.0
- options: { chooseShorterAngle: boolean } = ...
  
  Does not work currently. slerp chooses shorter angle regardless of this value.
  - chooseShorterAngle: boolean
Returns Quaternion

toRotationMatrix4

toRotationMatrix4(): Matrix4x4

- Defined in quaternion.ts:190
Convert the quaternion to a rotation matrix.

Returns Matrix4x4

toString

toString(): string

- Defined in quaternion.ts:225
Returns values as String.

Returns string

Static rotationAround

rotationAround(normalizedAxis: Float32Vector3, radian: number): Quaternion

- Defined in quaternion.ts:22
Create a rotation quaternion around normalizedAxis. normalizedAxis must be normalized.

Parameters
- normalizedAxis: Float32Vector3
- radian: number
Returns Quaternion

Generated using TypeDoc