pex-math

![npm version](https://www.npmjs.com/package/pex-math)
![stability-stable](https://www.npmjs.com/package/pex-math)
![npm minzipped size](https://bundlephobia.com/package/pex-math)
![dependencies](https://github.com/pex-gl/pex-math/blob/main/package.json)
![types](https://github.com/microsoft/TypeScript)
![Conventional Commits](https://conventionalcommits.org)
![styled with prettier](https://github.com/prettier/prettier)
![linted with eslint](https://github.com/eslint/eslint)
![license](https://github.com/pex-gl/pex-math/blob/main/LICENSE.md)

Array-based vector, quaternion and matrix math with utils for PEX.

Installation

``bash npm install pex-math`

`Usage`

`javascript import { mat4 } from "pex-math";

const identityMatrix = mat4.create(); // => [1, 0, 0, 0, // 0, 1, 0, 0, // 0, 0, 1, 0, // 0, 0, 0, 1]`

`API`

`Modules`

pex-math
avec2
avec3
avec4
eases
euler
mat2x3
mat3
mat4
quat
utils
vec2
vec3
vec4

`Typedefs`

TypedArray : Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array
avec2 : TypedArray
avec3 : TypedArray
avec4 : TypedArray
amat4 : TypedArray
aquat : TypedArray
euler : Array.<number>
mat2x3 : Array.<number>
mat3 : Array.<number>
mat4 : Array.<number>
quat : Array.<number>
vec2 : Array.<number>
vec3 : Array.<number>
vec4 : Array.<number>
Degrees : number
Radians : number
iterativeCallback : function: Callback for iterating typed arrays.
easeFn ⇒ number: Ease functions signature.
easeStepFn ⇒ number: Ease step functions signature.

`pex-math`

- pex-math - .mat2x3 : mat2x3 - .mat3 : mat3 - .mat4 : mat4 - .vec2 : vec2 - .vec3 : vec3 - .vec4 : vec4 - .avec2 : avec2 - .avec3 : avec3 - .avec4 : avec4 - .quat : quat - .euler : euler - .eases : eases - .utils : utils

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`avec2`

- avec2 - .set2(a, i, x, y) - .set(a, i, b, j) - .equals(a, i, b, j) ⇒ boolean - .add(a, i, b, j) - .sub(a, i, b, j) - .scale(a, i, s) - .addScaled(a, i, b, j, s) - .dot(a, i, b, j) ⇒ number - .length(a, i) ⇒ number - .lengthSq(a, i) ⇒ number - .normalize(a, i) - .distance(a, i, b, j) ⇒ number - .distanceSq(a, i, b, j) ⇒ number - .limit(a, i, len) - .lerp(a, i, b, j, t) - .forEach(a, callbackFn) - .map(a, callbackFn) ⇒ avec2 - [.toString(a, i, [precision])](#module_avec2.toString) ⇒ string

`$3`

Sets a vector components.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | x | number | | y | number |

`$3`

Sets a vector to another vector.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Compares two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Adds a vector to another.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Subtracts a vector from another.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Scales a vector by a number.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | s | number |

`$3`

Adds two vectors after scaling the second one.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number | | s | number |

`$3`

Calculates the dot product of two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Calculates the length of a vector.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number |

`$3`

Calculates the squared length of a vector.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number |

`$3`

Normalises a vector.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number |

`$3`

Calculates the distance between two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Calculates the squared distance between two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Limits a vector to a length.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | len | number |

`$3`

Linearly interpolates between two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number | | t | number |

`$3`

Executes a function once for each array element.

Kind: static method of avec2

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec2 | | callbackFn | iterativeCallback |

`$3`

Creates a new array populated with the results of calling a provided function on every element in the calling array.

Kind: static method of avec2

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec2 | | callbackFn | iterativeCallback |

`$3`

Prints a vector to a string.

Kind: static method of avec2

| Param | Type | Default | | ----------- | ---------------------------- | -------------- | | a | avec2 | | | i | number | | | [precision] | number | 4 |

`avec3`

- avec3 - .set3(a, i, x, y, z) - .set(a, i, b, j) - .equals(a, i, b, j) ⇒ boolean - .add(a, i, b, j) - .sub(a, i, b, j) - .scale(a, i, s) - .addScaled(a, i, b, j, s) - .multMat4(a, i, m, j) - .multQuat(a, i, q, j) - .dot(a, i, b, j) ⇒ number - .cross(a, i, b, j) - .length(a, i) ⇒ number - .lengthSq(a, i) ⇒ number - .normalize(a, i) - .distance(a, i, b, j) ⇒ number - .distanceSq(a, i, b, j) ⇒ number - .limit(a, i, len) - .lerp(a, i, b, j, t) - .forEach(a, callbackFn) - .map(a, callbackFn) ⇒ avec3 - [.toString(a, i, [precision])](#module_avec3.toString) ⇒ string

`$3`

Sets a vector components.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | x | number | | y | number | | z | number |

`$3`

Sets a vector to another vector.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Compares two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Adds a vector to another.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Subtracts a vector from another.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Scales a vector by a number.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | s | number |

`$3`

Adds two vectors after scaling the second one.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number | | s | number |

`$3`

Multiplies a vector by a matrix.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | m | amat4 | | j | number |

`$3`

Multiplies a vector by a quaternion.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | q | aquat | | j | number |

`$3`

Calculates the dot product of two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Calculates the cross product of two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Calculates the length of a vector.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number |

`$3`

Calculates the squared length of a vector.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number |

`$3`

Normalises a vector.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number |

`$3`

Calculates the distance between two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Calculates the squared distance between two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Limits a vector to a length.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | len | number |

`$3`

Linearly interpolates between two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number | | t | number |

`$3`

Executes a function once for each array element.

Kind: static method of avec3

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec3 | | callbackFn | iterativeCallback |

`$3`

Creates a new array populated with the results of calling a provided function on every element in the calling array.

Kind: static method of avec3

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec3 | | callbackFn | iterativeCallback |

`$3`

Prints a vector to a string.

Kind: static method of avec3

| Param | Type | Default | | ----------- | ---------------------------- | -------------- | | a | avec3 | | | i | number | | | [precision] | number | 4 |

`avec4`

- avec4 - .set4(a, i, x, y, z, w) - .set(a, i, b, j) - .equals(a, i, b, j) ⇒ boolean - .add(a, i, b, j) - .sub(a, i, b, j) - .scale(a, i, s) - .addScaled(a, i, b, j, s) - .multMat4(a, i, m, j) - .lerp(a, i, b, j, t) - .forEach(a, callbackFn) - .map(a, callbackFn) ⇒ avec4 - [.toString(a, i, [precision])](#module_avec4.toString) ⇒ string

`$3`

Sets a vector components.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | x | number | | y | number | | z | number | | w | number |

`$3`

Sets a vector to another vector.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number |

`$3`

Compares two vectors.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number |

`$3`

Adds a vector to another.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number |

`$3`

Subtracts a vector from another.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number |

`$3`

Scales a vector by a number.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | s | number |

`$3`

Adds two vectors after scaling the second one.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number | | s | number |

`$3`

Multiplies a vector with a matrix.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | m | amat4 | | j | number |

`$3`

Linearly interpolates between two vectors.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number | | t | number |

`$3`

Executes a function once for each array element.

Kind: static method of avec4

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec4 | | callbackFn | iterativeCallback |

`$3`

Creates a new array populated with the results of calling a provided function on every element in the calling array.

Kind: static method of avec4

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec4 | | callbackFn | iterativeCallback |

`$3`

Prints a vector to a string.

Kind: static method of avec4

| Param | Type | Default | | ----------- | ---------------------------- | -------------- | | a | avec4 | | | i | number | | | [precision] | number | 4 |

`eases`

- eases - .linear() : easeFn - .sineIn() : easeFn - .sineOut() : easeFn - .sineInOut() : easeFn - .quadIn() : easeFn - .quadOut() : easeFn - .quadInOut() : easeFn - .cubicIn() : easeFn - .cubicOut() : easeFn - .cubicInOut() : easeFn - .quartIn() : easeFn - .quartOut() : easeFn - .quartInOut() : easeFn - .quintIn() : easeFn - .quintOut() : easeFn - .quintInOut() : easeFn - .expoIn() : easeFn - .expoOut() : easeFn - .expoInOut() : easeFn - .circIn() : easeFn - .circOut() : easeFn - .circInOut() : easeFn - .backIn() : easeFn - .backOut() : easeFn - .backInOut() : easeFn - .elasticIn() : easeFn - .elasticOut() : easeFn - .elasticInOut() : easeFn - .bounceIn() : easeFn - .bounceOut() : easeFn - .bounceInOut() : easeFn - .stepStart() : easeStepFn - .stepEnd() : easeStepFn - .stepNone() : easeStepFn - .stepBoth() : easeStepFn

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`euler`

- euler - .create() ⇒ euler - .fromQuat(a, q) ⇒ euler

`$3`

Create a new euler angles [0, 0, 0]: vec3 array of [x, y, z] rotation [yaw, pitch, roll] in radians.

Kind: static method of euler

`$3`

Creates euler angles from quaternion. Assumes XYZ order of rotations.

Kind: static method of euler

| Param | Type | | ----- | ---------------------------- | | a | euler | | q | quat |

`mat2x3`

- mat2x3 - .create() ⇒ mat2x3 - .identity(a) ⇒ mat2x3 - .copy(a) ⇒ mat2x3 - .set(a, b) ⇒ mat2x3 - .equals(a, b) ⇒ boolean - .mult(a, b) ⇒ mat2x3 - .translate(a, v) ⇒ mat2x3 - .rotate(a, rad) ⇒ mat2x3 - .scale(a, v) ⇒ mat2x3

`$3`

Returns a 2x3 identity matrix, a short form for a 3x3 matrix with the last row ignored.

Row major memory layout:

`0 1 2 3 4 5`

Equivalent to the column major OpenGL spec:

`0 3 1 4 2 5

m00 m10 m01 m11 m02 m12`

Kind: static method of mat2x3

`$3`

Sets a matrix to the identity matrix.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 |

`$3`

Returns a copy of a matrix.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 |

`$3`

Sets a matrix from another matrix.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | b | mat2x3 |

`$3`

Compares two matrices.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | b | mat2x3 |

`$3`

Multiplies two matrices.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | b | mat2x3 |

`$3`

Translates a matrix by a vector.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | v | vec2 |

`$3`

Rotates a matrix by an angle.

Kind: static method of mat2x3

| Param | Type | | ----- | -------------------------------- | | a | mat2x3 | | rad | Radians |

`$3`

Scales a matrix by a vector.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | v | vec2 |

`mat3`

- mat3 - .create() ⇒ mat3 - .identity(a) ⇒ mat3 - .copy(a) ⇒ mat3 - .set(a, b) ⇒ mat3 - .equals(a, b) ⇒ boolean - .mult(a, b) ⇒ mat3 - .transpose(a) ⇒ mat3 - .fromQuat(a, q) ⇒ mat3 - .fromMat2x3(a, b) ⇒ mat3 - .fromMat4(a, b) ⇒ mat3

`$3`

Returns a 3x3 identity matrix.

Row major memory layout:

`0 1 2 3 4 5 6 7 8`

Equivalent to the column major OpenGL spec:

`0 3 6 1 4 7 2 5 8

m00 m10 m20 m01 m11 m21 m02 m12 m22`

Kind: static method of mat3

`$3`

Sets a matrix to the identity matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 |

`$3`

Returns a copy of a matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 |

`$3`

Sets a matrix from another matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | b | mat3 |

`$3`

Compares two matrices.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | b | mat3 |

`$3`

Multiplies two matrices.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | b | mat3 |

`$3`

Transposes a matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 |

`$3`

Sets matrix to a quaternion.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | q | quat |

`$3`

Sets a 3x3 matrix from a 2x3 matrix.

Kind: static method of mat3

| Param | Type | | ----- | ------------------------------ | | a | mat3 | | b | mat2x3 |

`$3`

Sets a 3x3 matrix to a 4x4 matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | b | mat4 |

`mat4`

- mat4 - .create() ⇒ mat4 - .identity(a) ⇒ mat4 - .copy(a) ⇒ mat4 - .set(a, b) ⇒ mat4 - .equals(a, b) ⇒ boolean - .mult(a, b) ⇒ mat4 - .invert(a) ⇒ mat4 - .transpose(a) ⇒ mat4 - .translate(a, v) ⇒ mat4 - .rotate(a, r, v) ⇒ mat4 - .scale(a, v) ⇒ mat4 - .fromQuat(a, q) ⇒ mat4 - .fromTranslationRotationScale(a, v, q, s) ⇒ mat4 - .fromMat3(a, b) ⇒ mat4 - .frustum(a, left, right, bottom, top, near, far) ⇒ mat4 - .perspective(a, fovy, aspectRatio, near, far) ⇒ mat4 - .ortho(a, left, right, bottom, top, near, far) ⇒ mat4 - [.lookAt(a, from, to, [up])](#module_mat4.lookAt) ⇒ mat4 - [.fromDirection(a, direction, [up])](#module_mat4.fromDirection) ⇒ mat4 - [.fromPointToPoint(a, from, to, [up])](#module_mat4.fromPointToPoint) ⇒ mat4

`$3`

Returns a 4x4 identity matrix.

Row major memory layout:

`0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15`

Equivalent to the column major OpenGL spec:

`0 4 8 12 1 5 9 13 2 6 10 14 3 7 11 15

m00 m10 m20 m30 m01 m11 m21 m31 m02 m12 m22 m32 m03 m13 m23 m33``

Kind: static method of mat4

$3

Sets a matrix to the identity matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |

$3

Returns a copy of a matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |

$3

Sets a matrix from another matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| b | mat4 |

$3

Compares two matrices.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| b | mat4 |

$3

Multiplies two matrices.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| b | mat4 |

$3

Inverts a matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |

$3

Transposes a matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |

$3

Translates a matrix by a vector.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| v | vec3 |

$3

Rotates a matrix by an angle at an axis.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------------- |
| a | mat4 |
| r | Radians |
| v | vec3 |

$3

Scales a matrix by a vector.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| v | vec3 |

$3

Sets a matrix to a quaternion.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| q | quat |

$3

Sets a matrix to the TRS matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| v | vec3 |
| q | quat |
| s | vec3 |

$3

Sets a 4x4 matrix to a 3x3 matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| b | mat3 |

$3

Creates a frustum matrix.

Kind: static method of mat4

| Param | Type |
| ------ | -------------------------- |
| a | mat4 |
| left | number |
| right | number |
| bottom | number |
| top | number |
| near | number |
| far | number |

$3

Creates a perspective matrix.

Kind: static method of mat4

| Param | Type |
| ----------- | -------------------------------- |
| a | mat4 |
| fovy | Radians |
| aspectRatio | number |
| near | number |
| far | number |

$3

Creates an orthographic matrix.

Kind: static method of mat4

| Param | Type |
| ------ | -------------------------- |
| a | mat4 |
| left | number |
| right | number |
| bottom | number |
| top | number |
| near | number |
| far | number |

$3

Calculates a lookAt matrix from position, target and up vectors.

Kind: static method of mat4

| Param | Type | Default |
| ----- | -------------------------- | ----------------- |
| a | mat4 | |
| from | vec3 | |
| to | vec3 | |
| [up] | vec3 | Y_UP |

$3

Sets a matrix from a direction.
Note: we assume +Z facing models.

Kind: static method of mat4

| Param | Type | Default |
| --------- | -------------------------- | ----------------- |
| a | mat4 | |
| direction | vec3 | |
| [up] | vec3 | Y_UP |

$3

Sets a matrix from a point to another.

Kind: static method of mat4

| Param | Type | Default |
| ----- | -------------------------- | ----------------- |
| a | mat4 | |
| from | vec3 | |
| to | vec3 | |
| [up] | vec3 | Y_UP |

quat

- quat
- .set ⇒ quat
- .equals ⇒ boolean
- .toString ⇒ quat
- .create() ⇒ quat
- .identity(a) ⇒ quat
- .copy(a) ⇒ quat
- .mult(a, b) ⇒ quat
- .invert(a) ⇒ quat
- .conjugate(a) ⇒ quat
- .length(a) ⇒ quat
- .normalize(a) ⇒ quat
- .dot(a, b) ⇒ quat
- .fromEuler(a, e) ⇒ quat
- .fromAxisAngle(a, v, r) ⇒ quat
- .fromAxes(a, x, y, z) ⇒ quat
- .fromMat3(a, m) ⇒ quat
- .fromMat4(a, m) ⇒ quat
- [.fromDirection(a, direction, [up])](#module_quat.fromDirection) ⇒ quat
- [.fromPointToPoint(a, from, to, [up])](#module_quat.fromPointToPoint) ⇒ quat
- .slerp(a, b, t) ⇒ quat

$3

Sets a quaternion to another quaternion.

Kind: static constant of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |
| b | quat |

$3

Compares two quaternions.

Kind: static constant of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |
| b | quat |

$3

Prints a quaternion to a string.

Kind: static constant of quat

| Param | Type |
| --------- | -------------------------- |
| a | quat |
| precision | number |

$3

Returns a new quat at 0, 0, 0, 1.

Kind: static method of quat

$3

Sets a quaternion to the identity quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Returns a copy of a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Multiplies one quaternion by another.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |
| b | quat |

$3

Inverts a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Conjugates a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Calculates the length of a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Normalizes a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Calculates the dot product of two quaternions.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |
| b | quat |

$3

Set euler angles to a quaternion. Assumes XYZ rotation order.

Kind: static method of quat

| Param | Type |
| ----- | ---------------------------- |
| a | quat |
| e | euler |

$3

Set the angle at an axis of a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------------- |
| a | quat |
| v | vec3 |
| r | Radians |

$3

pex-math

Array-based vector, quaternion and matrix math with utils for PEX.

Installation

``bash npm install pex-math`

`Usage`

`javascript import { mat4 } from "pex-math";

const identityMatrix = mat4.create(); // => [1, 0, 0, 0, // 0, 1, 0, 0, // 0, 0, 1, 0, // 0, 0, 0, 1]`

`API`

`Modules`

pex-math
avec2
avec3
avec4
eases
euler
mat2x3
mat3
mat4
quat
utils
vec2
vec3
vec4

`Typedefs`

TypedArray : Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array
avec2 : TypedArray
avec3 : TypedArray
avec4 : TypedArray
amat4 : TypedArray
aquat : TypedArray
euler : Array.<number>
mat2x3 : Array.<number>
mat3 : Array.<number>
mat4 : Array.<number>
quat : Array.<number>
vec2 : Array.<number>
vec3 : Array.<number>
vec4 : Array.<number>
Degrees : number
Radians : number
iterativeCallback : function: Callback for iterating typed arrays.
easeFn ⇒ number: Ease functions signature.
easeStepFn ⇒ number: Ease step functions signature.

`pex-math`

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`$3`

Kind: static property of pex-math

`avec2`

`$3`

Sets a vector components.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | x | number | | y | number |

`$3`

Sets a vector to another vector.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Compares two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Adds a vector to another.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Subtracts a vector from another.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Scales a vector by a number.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | s | number |

`$3`

Adds two vectors after scaling the second one.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number | | s | number |

`$3`

Calculates the dot product of two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Calculates the length of a vector.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number |

`$3`

Calculates the squared length of a vector.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number |

`$3`

Normalises a vector.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number |

`$3`

Calculates the distance between two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Calculates the squared distance between two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number |

`$3`

Limits a vector to a length.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | len | number |

`$3`

Linearly interpolates between two vectors.

Kind: static method of avec2

| Param | Type | | ----- | ---------------------------- | | a | avec2 | | i | number | | b | avec2 | | j | number | | t | number |

`$3`

Executes a function once for each array element.

Kind: static method of avec2

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec2 | | callbackFn | iterativeCallback |

`$3`

Creates a new array populated with the results of calling a provided function on every element in the calling array.

Kind: static method of avec2

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec2 | | callbackFn | iterativeCallback |

`$3`

Prints a vector to a string.

Kind: static method of avec2

| Param | Type | Default | | ----------- | ---------------------------- | -------------- | | a | avec2 | | | i | number | | | [precision] | number | 4 |

`avec3`

`$3`

Sets a vector components.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | x | number | | y | number | | z | number |

`$3`

Sets a vector to another vector.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Compares two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Adds a vector to another.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Subtracts a vector from another.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Scales a vector by a number.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | s | number |

`$3`

Adds two vectors after scaling the second one.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number | | s | number |

`$3`

Multiplies a vector by a matrix.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | m | amat4 | | j | number |

`$3`

Multiplies a vector by a quaternion.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | q | aquat | | j | number |

`$3`

Calculates the dot product of two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Calculates the cross product of two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Calculates the length of a vector.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number |

`$3`

Calculates the squared length of a vector.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number |

`$3`

Normalises a vector.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number |

`$3`

Calculates the distance between two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Calculates the squared distance between two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number |

`$3`

Limits a vector to a length.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | len | number |

`$3`

Linearly interpolates between two vectors.

Kind: static method of avec3

| Param | Type | | ----- | ---------------------------- | | a | avec3 | | i | number | | b | avec3 | | j | number | | t | number |

`$3`

Executes a function once for each array element.

Kind: static method of avec3

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec3 | | callbackFn | iterativeCallback |

`$3`

Creates a new array populated with the results of calling a provided function on every element in the calling array.

Kind: static method of avec3

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec3 | | callbackFn | iterativeCallback |

`$3`

Prints a vector to a string.

Kind: static method of avec3

| Param | Type | Default | | ----------- | ---------------------------- | -------------- | | a | avec3 | | | i | number | | | [precision] | number | 4 |

`avec4`

`$3`

Sets a vector components.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | x | number | | y | number | | z | number | | w | number |

`$3`

Sets a vector to another vector.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number |

`$3`

Compares two vectors.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number |

`$3`

Adds a vector to another.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number |

`$3`

Subtracts a vector from another.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number |

`$3`

Scales a vector by a number.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | s | number |

`$3`

Adds two vectors after scaling the second one.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number | | s | number |

`$3`

Multiplies a vector with a matrix.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | m | amat4 | | j | number |

`$3`

Linearly interpolates between two vectors.

Kind: static method of avec4

| Param | Type | | ----- | ---------------------------- | | a | avec4 | | i | number | | b | avec4 | | j | number | | t | number |

`$3`

Executes a function once for each array element.

Kind: static method of avec4

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec4 | | callbackFn | iterativeCallback |

`$3`

Creates a new array populated with the results of calling a provided function on every element in the calling array.

Kind: static method of avec4

| Param | Type | | ---------- | ---------------------------------------------------- | | a | avec4 | | callbackFn | iterativeCallback |

`$3`

Prints a vector to a string.

Kind: static method of avec4

| Param | Type | Default | | ----------- | ---------------------------- | -------------- | | a | avec4 | | | i | number | | | [precision] | number | 4 |

`eases`

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`$3`

Kind: static method of eases

`euler`

- euler - .create() ⇒ euler - .fromQuat(a, q) ⇒ euler

`$3`

Create a new euler angles [0, 0, 0]: vec3 array of [x, y, z] rotation [yaw, pitch, roll] in radians.

Kind: static method of euler

`$3`

Creates euler angles from quaternion. Assumes XYZ order of rotations.

Kind: static method of euler

| Param | Type | | ----- | ---------------------------- | | a | euler | | q | quat |

`mat2x3`

`$3`

Returns a 2x3 identity matrix, a short form for a 3x3 matrix with the last row ignored.

Row major memory layout:

`0 1 2 3 4 5`

Equivalent to the column major OpenGL spec:

`0 3 1 4 2 5

m00 m10 m01 m11 m02 m12`

Kind: static method of mat2x3

`$3`

Sets a matrix to the identity matrix.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 |

`$3`

Returns a copy of a matrix.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 |

`$3`

Sets a matrix from another matrix.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | b | mat2x3 |

`$3`

Compares two matrices.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | b | mat2x3 |

`$3`

Multiplies two matrices.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | b | mat2x3 |

`$3`

Translates a matrix by a vector.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | v | vec2 |

`$3`

Rotates a matrix by an angle.

Kind: static method of mat2x3

| Param | Type | | ----- | -------------------------------- | | a | mat2x3 | | rad | Radians |

`$3`

Scales a matrix by a vector.

Kind: static method of mat2x3

| Param | Type | | ----- | ------------------------------ | | a | mat2x3 | | v | vec2 |

`mat3`

`$3`

Returns a 3x3 identity matrix.

Row major memory layout:

`0 1 2 3 4 5 6 7 8`

Equivalent to the column major OpenGL spec:

`0 3 6 1 4 7 2 5 8

m00 m10 m20 m01 m11 m21 m02 m12 m22`

Kind: static method of mat3

`$3`

Sets a matrix to the identity matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 |

`$3`

Returns a copy of a matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 |

`$3`

Sets a matrix from another matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | b | mat3 |

`$3`

Compares two matrices.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | b | mat3 |

`$3`

Multiplies two matrices.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | b | mat3 |

`$3`

Transposes a matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 |

`$3`

Sets matrix to a quaternion.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | q | quat |

`$3`

Sets a 3x3 matrix from a 2x3 matrix.

Kind: static method of mat3

| Param | Type | | ----- | ------------------------------ | | a | mat3 | | b | mat2x3 |

`$3`

Sets a 3x3 matrix to a 4x4 matrix.

Kind: static method of mat3

| Param | Type | | ----- | -------------------------- | | a | mat3 | | b | mat4 |

`mat4`

`$3`

Returns a 4x4 identity matrix.

Row major memory layout:

`0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15`

Equivalent to the column major OpenGL spec:

`0 4 8 12 1 5 9 13 2 6 10 14 3 7 11 15

m00 m10 m20 m30 m01 m11 m21 m31 m02 m12 m22 m32 m03 m13 m23 m33``

Kind: static method of mat4

$3

Sets a matrix to the identity matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |

$3

Returns a copy of a matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |

$3

Sets a matrix from another matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| b | mat4 |

$3

Compares two matrices.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| b | mat4 |

$3

Multiplies two matrices.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| b | mat4 |

$3

Inverts a matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |

$3

Transposes a matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |

$3

Translates a matrix by a vector.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| v | vec3 |

$3

Rotates a matrix by an angle at an axis.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------------- |
| a | mat4 |
| r | Radians |
| v | vec3 |

$3

Scales a matrix by a vector.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| v | vec3 |

$3

Sets a matrix to a quaternion.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| q | quat |

$3

Sets a matrix to the TRS matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| v | vec3 |
| q | quat |
| s | vec3 |

$3

Sets a 4x4 matrix to a 3x3 matrix.

Kind: static method of mat4

| Param | Type |
| ----- | -------------------------- |
| a | mat4 |
| b | mat3 |

$3

Creates a frustum matrix.

Kind: static method of mat4

| Param | Type |
| ------ | -------------------------- |
| a | mat4 |
| left | number |
| right | number |
| bottom | number |
| top | number |
| near | number |
| far | number |

$3

Creates a perspective matrix.

Kind: static method of mat4

| Param | Type |
| ----------- | -------------------------------- |
| a | mat4 |
| fovy | Radians |
| aspectRatio | number |
| near | number |
| far | number |

$3

Creates an orthographic matrix.

Kind: static method of mat4

| Param | Type |
| ------ | -------------------------- |
| a | mat4 |
| left | number |
| right | number |
| bottom | number |
| top | number |
| near | number |
| far | number |

$3

Calculates a lookAt matrix from position, target and up vectors.

Kind: static method of mat4

| Param | Type | Default |
| ----- | -------------------------- | ----------------- |
| a | mat4 | |
| from | vec3 | |
| to | vec3 | |
| [up] | vec3 | Y_UP |

$3

Sets a matrix from a direction.
Note: we assume +Z facing models.

Kind: static method of mat4

| Param | Type | Default |
| --------- | -------------------------- | ----------------- |
| a | mat4 | |
| direction | vec3 | |
| [up] | vec3 | Y_UP |

$3

Sets a matrix from a point to another.

Kind: static method of mat4

| Param | Type | Default |
| ----- | -------------------------- | ----------------- |
| a | mat4 | |
| from | vec3 | |
| to | vec3 | |
| [up] | vec3 | Y_UP |

quat

$3

Sets a quaternion to another quaternion.

Kind: static constant of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |
| b | quat |

$3

Compares two quaternions.

Kind: static constant of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |
| b | quat |

$3

Prints a quaternion to a string.

Kind: static constant of quat

| Param | Type |
| --------- | -------------------------- |
| a | quat |
| precision | number |

$3

Returns a new quat at 0, 0, 0, 1.

Kind: static method of quat

$3

Sets a quaternion to the identity quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Returns a copy of a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Multiplies one quaternion by another.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |
| b | quat |

$3

Inverts a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Conjugates a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Calculates the length of a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Normalizes a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |

$3

Calculates the dot product of two quaternions.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------- |
| a | quat |
| b | quat |

$3

Set euler angles to a quaternion. Assumes XYZ rotation order.

Kind: static method of quat

| Param | Type |
| ----- | ---------------------------- |
| a | quat |
| e | euler |

$3

Set the angle at an axis of a quaternion.

Kind: static method of quat

| Param | Type |
| ----- | -------------------------------- |
| a | quat |
| v | vec3 |
| r | Radians |

$3