Class: Quaternion ​

Quaternions are used to represent rotations.

Constructors ​

• constructor

Properties ​

• HELP_0
• HELP_1
• HELP_2
• _zero
• CALCULATION_QUATERNION

Accessors ​

• magnitude

Methods ​

• identity
• quaternionToMatrix
• set
• divide
• multiply
• multiplyVector
• fromAxisAngle
• toAxisAngle
• slerp
• lerp
• fromEulerAngles
• setFromRotationMatrix
• getEulerAngles
• normalize
• toString
• fromMatrix
• inverse
• clone
• transformVector
• copyFrom
• mul

Constructors ​

constructor ​

• new Quaternion(x?, y?, z?, w?)

Create a new quaternion object

Parameters ​

Defined in ​

src/math/Quaternion.ts:39

Properties ​

HELP_0 ​

▪ Static HELP_0: Quaternion

Defined in ​

src/math/Quaternion.ts:10

HELP_1 ​

▪ Static HELP_1: Quaternion

Defined in ​

src/math/Quaternion.ts:11

HELP_2 ​

▪ Static HELP_2: Quaternion

Defined in ​

src/math/Quaternion.ts:12

_zero ​

▪ Static _zero: Quaternion

Defined in ​

src/math/Quaternion.ts:13

CALCULATION_QUATERNION ​

▪ Static CALCULATION_QUATERNION: Quaternion

Defined in ​

src/math/Quaternion.ts:14

Accessors ​

magnitude ​

• get magnitude(): number

Returns ​

number

Defined in ​

src/math/Quaternion.ts:101

Methods ​

identity ​

▸ Static identity(): Quaternion

Identity quaternion

Returns ​

Quaternion

Defined in ​

src/math/Quaternion.ts:50

quaternionToMatrix ​

▸ Static quaternionToMatrix(q, m): void

Converts quaternions to matrices

Parameters ​

Returns ​

void

Defined in ​

src/math/Quaternion.ts:59

set ​

▸ set(x?, y?, z?, w?): void

Set the x, y, z, and w components of the existing quaternions.

Parameters ​

Returns ​

void

Defined in ​

src/math/Quaternion.ts:112

divide ​

▸ divide(v): Quaternion

Parameters ​

Returns ​

Quaternion

Defined in ​

src/math/Quaternion.ts:119

multiply ​

▸ multiply(qa, qb): void

Multiply two quaternions

Parameters ​

Returns ​

void

Defined in ​

src/math/Quaternion.ts:147

multiplyVector ​

▸ multiplyVector(vector, target?): Quaternion

Parameters ​

Returns ​

Quaternion

Defined in ​

src/math/Quaternion.ts:163

fromAxisAngle ​

▸ fromAxisAngle(axis, angle): void

Set the quaternion with a given rotation of the axis and Angle.

Parameters ​

Returns ​

void

Defined in ​

src/math/Quaternion.ts:182

toAxisAngle ​

▸ toAxisAngle(axis): number

Turn quaternions into angles

Parameters ​

Returns ​

number

Defined in ​

src/math/Quaternion.ts:200

slerp ​

▸ slerp(qa, qb, t): void

Spherically interpolates between two quaternions, providing an interpolation between rotations with constant angle change rate.

Parameters ​

Returns ​

void

Defined in ​

src/math/Quaternion.ts:225

lerp ​

▸ lerp(qa, qb, t): void

Linearly interpolates between two quaternions.

Parameters ​

Returns ​

void

Defined in ​

src/math/Quaternion.ts:275

fromEulerAngles ​

▸ fromEulerAngles(ax, ay, az): Quaternion

Fills the quaternion object with values representing the given euler rotation.

Parameters ​

Returns ​

Quaternion

Defined in ​

src/math/Quaternion.ts:312

setFromRotationMatrix ​

▸ setFromRotationMatrix(m): Quaternion

Sets the current quaternion from the rotation matrix

Parameters ​

Returns ​

Quaternion

Defined in ​

src/math/Quaternion.ts:340

getEulerAngles ​

▸ getEulerAngles(eulers?): Vector3

Get the Euler Angle

Parameters ​

Returns ​

Vector3

Defined in ​

src/math/Quaternion.ts:391

normalize ​

▸ normalize(val?): void

The normalize of the quaternion. Convert this quaternion to a normalize coefficient.

Parameters ​

Returns ​

void

Defined in ​

src/math/Quaternion.ts:430

toString ​

▸ toString(): string

Returns the value of a quaternion as a string

Returns ​

string

Defined in ​

src/math/Quaternion.ts:443

fromMatrix ​

▸ fromMatrix(matrix): void

Extracts a quaternion rotation matrix out of a given Matrix3D object.

Parameters ​

Returns ​

void

Defined in ​

src/math/Quaternion.ts:451

inverse ​

▸ inverse(target?): Quaternion

Returns a quaternion that inverts the current quaternion

Parameters ​

Returns ​

Quaternion

Quaternion Result

Defined in ​

src/math/Quaternion.ts:464

clone ​

▸ clone(): Quaternion

Clones the quaternion.

Returns ​

Quaternion

An exact duplicate of the current Quaternion.

Defined in ​

src/math/Quaternion.ts:484

transformVector ​

▸ transformVector(vector, target?): Vector3

Rotates a point.

Parameters ​

Returns ​

Vector3

A Vector3D object containing the rotated point.

Defined in ​

src/math/Quaternion.ts:494

copyFrom ​

▸ copyFrom(q): Quaternion

Copies the data from a quaternion into this instance.

Parameters ​

Returns ​

Quaternion

Defined in ​

src/math/Quaternion.ts:521

mul ​

▸ mul(lhs, rhs, target?): Quaternion

from untiy API op

Parameters ​

Returns ​

Quaternion

Defined in ​

src/math/Quaternion.ts:534