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

npm install pex-math

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]

pex-math

avec2

avec3

avec4

eases

euler

mat2x3

mat3

mat4

quat

utils

vec2

vec3

vec4

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
  • .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

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

Kind: static property of pex-math

• 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]) ⇒ string

Sets a vector components.

Kind: static method of avec2

Sets a vector to another vector.

Kind: static method of avec2

Compares two vectors.

Kind: static method of avec2

Adds a vector to another.

Kind: static method of avec2

Subtracts a vector from another.

Kind: static method of avec2

Scales a vector by a number.

Kind: static method of avec2

Adds two vectors after scaling the second one.

Kind: static method of avec2

Calculates the dot product of two vectors.

Kind: static method of avec2

Calculates the length of a vector.

Kind: static method of avec2

Calculates the squared length of a vector.

Kind: static method of avec2

Normalises a vector.

Kind: static method of avec2

Calculates the distance between two vectors.

Kind: static method of avec2

Calculates the squared distance between two vectors.

Kind: static method of avec2

Limits a vector to a length.

Kind: static method of avec2

Linearly interpolates between two vectors.

Kind: static method of avec2

Executes a function once for each array element.

Kind: static method of avec2

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

Prints a vector to a string.

Kind: static method of avec2

• 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]) ⇒ string

Sets a vector components.

Kind: static method of avec3

Sets a vector to another vector.

Kind: static method of avec3

Compares two vectors.

Kind: static method of avec3

Adds a vector to another.

Kind: static method of avec3

Subtracts a vector from another.

Kind: static method of avec3

Scales a vector by a number.

Kind: static method of avec3

Adds two vectors after scaling the second one.

Kind: static method of avec3

Multiplies a vector by a matrix.

Kind: static method of avec3

Multiplies a vector by a quaternion.

Kind: static method of avec3

Calculates the dot product of two vectors.

Kind: static method of avec3

Calculates the cross product of two vectors.

Kind: static method of avec3

Calculates the length of a vector.

Kind: static method of avec3

Calculates the squared length of a vector.

Kind: static method of avec3

Normalises a vector.

Kind: static method of avec3

Calculates the distance between two vectors.

Kind: static method of avec3

Calculates the squared distance between two vectors.

Kind: static method of avec3

Limits a vector to a length.

Kind: static method of avec3

Linearly interpolates between two vectors.

Kind: static method of avec3

Executes a function once for each array element.

Kind: static method of avec3

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

Prints a vector to a string.

Kind: static method of avec3

• 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]) ⇒ string

Sets a vector components.

Kind: static method of avec4

Sets a vector to another vector.

Kind: static method of avec4

Compares two vectors.

Kind: static method of avec4

Adds a vector to another.

Kind: static method of avec4

Subtracts a vector from another.

Kind: static method of avec4

Scales a vector by a number.

Kind: static method of avec4

Adds two vectors after scaling the second one.

Kind: static method of avec4

Multiplies a vector with a matrix.

Kind: static method of avec4

Linearly interpolates between two vectors.

Kind: static method of avec4

Executes a function once for each array element.

Kind: static method of avec4

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

Prints a vector to a string.

Kind: static method of avec4

• 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

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

Kind: static method of eases

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

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

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

Kind: static method of euler

• 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

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

Sets a matrix to the identity matrix.

Kind: static method of mat2x3

Returns a copy of a matrix.

Kind: static method of mat2x3

Sets a matrix from another matrix.

Kind: static method of mat2x3

Compares two matrices.

Kind: static method of mat2x3

Multiplies two matrices.

Kind: static method of mat2x3

Translates a matrix by a vector.

Kind: static method of mat2x3

Rotates a matrix by an angle.

Kind: static method of mat2x3

Scales a matrix by a vector.

Kind: static method of mat2x3

• 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

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

Sets a matrix to the identity matrix.

Kind: static method of mat3

Returns a copy of a matrix.

Kind: static method of mat3

Sets a matrix from another matrix.

Kind: static method of mat3

Compares two matrices.

Kind: static method of mat3

Multiplies two matrices.

Kind: static method of mat3

Transposes a matrix.

Kind: static method of mat3

Sets matrix to a quaternion.

Kind: static method of mat3

Sets a 3x3 matrix from a 2x3 matrix.

Kind: static method of mat3

Sets a 3x3 matrix to a 4x4 matrix.

Kind: static method of mat3

• 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]) ⇒ mat4
  • .fromDirection(a, direction, [up]) ⇒ mat4
  • .fromPointToPoint(a, from, to, [up]) ⇒ mat4

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

Sets a matrix to the identity matrix.

Kind: static method of mat4

Returns a copy of a matrix.

Kind: static method of mat4

Sets a matrix from another matrix.

Kind: static method of mat4

Compares two matrices.

Kind: static method of mat4

Multiplies two matrices.

Kind: static method of mat4

Inverts a matrix.

Kind: static method of mat4

Transposes a matrix.

Kind: static method of mat4

Translates a matrix by a vector.

Kind: static method of mat4

Rotates a matrix by an angle at an axis.

Kind: static method of mat4

Scales a matrix by a vector.

Kind: static method of mat4

Sets a matrix to a quaternion.

Kind: static method of mat4

Sets a matrix to the TRS matrix.

Kind: static method of mat4

Sets a 4x4 matrix to a 3x3 matrix.

Kind: static method of mat4

Creates a frustum matrix.

Kind: static method of mat4

Creates a perspective matrix.

Kind: static method of mat4

Creates an orthographic matrix.

Kind: static method of mat4

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

Kind: static method of mat4

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

Kind: static method of mat4

Sets a matrix from a point to another.

Kind: static method of mat4

• 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]) ⇒ quat
  • .fromPointToPoint(a, from, to, [up]) ⇒ quat
  • .slerp(a, b, t) ⇒ quat

Sets a quaternion to another quaternion.

Kind: static constant of quat

Compares two quaternions.

Kind: static constant of quat

Prints a quaternion to a string.

Kind: static constant of quat

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

Kind: static method of quat

Sets a quaternion to the identity quaternion.

Kind: static method of quat

Returns a copy of a quaternion.

Kind: static method of quat

Multiplies one quaternion by another.

Kind: static method of quat

Inverts a quaternion.

Kind: static method of quat

Conjugates a quaternion.

Kind: static method of quat

Calculates the length of a quaternion.

Kind: static method of quat

Normalizes a quaternion.

Kind: static method of quat

Calculates the dot product of two quaternions.

Kind: static method of quat

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

Kind: static method of quat

Set the angle at an axis of a quaternion.

Kind: static method of quat

Sets a quaternion from orthonormal base xyz.

Kind: static method of quat

Sets a quaternion to a 3x3 matrix.

Kind: static method of quat

Sets a quaternion to a 4x4 matrix.

Kind: static method of quat

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

Kind: static method of quat

Sets a quaternion from a point to another.

Kind: static method of quat

Spherical linear interpolates between two quaternions.

Kind: static method of quat

• utils
  • .EPSILON : number
  • .HALF_PI : number
  • .Y_UP : vec3
  • .lerp(a, b, t) ⇒ number
  • .clamp(n, min, max) ⇒ number
  • .smoothstep(n, min, max) ⇒ number
  • .remap(n, inStart, inEnd, outStart, outEnd) ⇒ number
  • .toRadians(degrees) ⇒ Radians
  • .toDegrees(radians) ⇒ Degrees
  • .isPowerOfTwo(a) ⇒ boolean
  • .nextPowerOfTwo(n) ⇒ number
  • .prevPowerOfTwo(n) ⇒ number

Kind: static constant of utils

Kind: static constant of utils

Kind: static constant of utils

Linear interpolation between two numbers.

Kind: static method of utils

Clamps a number between two numbers.

Kind: static method of utils

Smooth Hermite interpolation between 0 and 1

Kind: static method of utils

Maps a number from one range to another.

Kind: static method of utils

Transforms degrees into radians.

Kind: static method of utils

Transforms radians into degrees.

Kind: static method of utils

Check if a number is a power of two

Kind: static method of utils

Returns the next highest power of two.

Kind: static method of utils

Returns the previous power of two.

Kind: static method of utils

• vec2
  • .create() ⇒ vec2
  • .copy(a) ⇒ vec2
  • .set(a, b) ⇒ vec2
  • .equals(a, b) ⇒ boolean
  • .add(a, b) ⇒ vec2
  • .sub(a, b) ⇒ vec2
  • .scale(a, s) ⇒ vec2
  • .addScaled(a, b, s) ⇒ vec2
  • .dot(a, b) ⇒ number
  • .length(a) ⇒ number
  • .lengthSq(a) ⇒ number
  • .normalize(a) ⇒ vec2
  • .distance(a, b) ⇒ number
  • .distanceSq(a, b) ⇒ number
  • .limit(a, len) ⇒ vec2
  • .lerp(a, b, t) ⇒ vec2
  • .toString(a, [precision]) ⇒ string

Returns a new vec2 at 0, 0.

Kind: static method of vec2

Returns a copy of a vector.

Kind: static method of vec2

Sets a vector to another vector.

Kind: static method of vec2

Compares two vectors.

Kind: static method of vec2

Add a vector to another.

Kind: static method of vec2

Subtracts a vector from another.

Kind: static method of vec2

Scales a vector by a number.

Kind: static method of vec2

Adds two vectors after scaling the second one.

Kind: static method of vec2

Calculates the dot product of two vectors.

Kind: static method of vec2

Calculates the length of a vector.

Kind: static method of vec2

Calculates the squared length of a vector.

Kind: static method of vec2

Normalises a vector.

Kind: static method of vec2

Calculates the distance between two vectors.

Kind: static method of vec2

Calculates the squared distance between two vectors.

Kind: static method of vec2

Limits a vector to a length.

Kind: static method of vec2

Linearly interpolates between two vectors.

Kind: static method of vec2

Prints a vector to a string.

Kind: static method of vec2

• vec3
  • .create() ⇒ vec3
  • .copy(a) ⇒ vec3
  • .set(a, b) ⇒ vec3
  • .equals(a, b) ⇒ boolean
  • .add(a, b) ⇒ vec3
  • .sub(a, b) ⇒ vec3
  • .scale(a, s) ⇒ vec3
  • .addScaled(a, b, s) ⇒ vec3
  • .multMat4(a, m) ⇒ vec3
  • .multQuat(a, q) ⇒ vec3
  • .dot(a, b) ⇒ number
  • .cross(a, b) ⇒ vec3
  • .length(a) ⇒ number
  • .lengthSq(a) ⇒ number
  • .normalize(a) ⇒ vec3
  • .distance(a, b) ⇒ number
  • .distanceSq(a, b) ⇒ number
  • .limit(a, len) ⇒ vec3
  • .lerp(a, b, t) ⇒ vec3
  • .toString(a, [precision]) ⇒ string

Returns a new vec3 at 0, 0, 0.

Kind: static method of vec3

Returns a copy of a vector.

Kind: static method of vec3

Sets a vector to another vector.

Kind: static method of vec3

Compares two vectors.

Kind: static method of vec3

Adds a vector to another.

Kind: static method of vec3

Subtracts a vector from another.

Kind: static method of vec3

Scales a vector by a number.

Kind: static method of vec3

Adds two vectors after scaling the second one.

Kind: static method of vec3

Multiplies a vector by a matrix.

Kind: static method of vec3

Multiplies a vector by a quaternion.

Kind: static method of vec3

Calculates the dot product of two vectors.

Kind: static method of vec3

Calculates the cross product of two vectors.

Kind: static method of vec3

Calculates the length of a vector.

Kind: static method of vec3

Calculates the squared length of a vector.

Kind: static method of vec3

Normalises a vector.

Kind: static method of vec3

Calculates the distance between two vectors.

Kind: static method of vec3

Calculates the squared distance between two vectors.

Kind: static method of vec3

Limits a vector to a length.

Kind: static method of vec3

Linearly interpolates between two vectors.

Kind: static method of vec3

Prints a vector to a string.

Kind: static method of vec3

• vec4
  • .create() ⇒ vec4
  • .copy(a) ⇒ vec4
  • .set(a, b) ⇒ vec4
  • .equals(a, b) ⇒ boolean
  • .add(a, b) ⇒ vec4
  • .sub(a, b) ⇒ vec4
  • .scale(a, s) ⇒ vec4
  • .addScaled(a, b, s) ⇒ vec4
  • .fromVec3(a, b) ⇒ vec4
  • .multMat4(a, m) ⇒ vec4
  • .lerp(a, b, t) ⇒ vec4
  • .toString(a, [precision]) ⇒ string

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

Kind: static method of vec4

Returns a copy of a vector.

Kind: static method of vec4

Sets a vector to another vector.

Kind: static method of vec4

Compares two vectors.

Kind: static method of vec4

Adds a vector to another.

Kind: static method of vec4

Subtracts a vector from another.

Kind: static method of vec4

Scales a vector by a number.

Kind: static method of vec4

Adds two vectors after scaling the second one.

Kind: static method of vec4

Create a vec4 from vec3.

Kind: static method of vec4

Multiplies a vector with a matrix.

Kind: static method of vec4

Linearly interpolates between two vectors.

Kind: static method of vec4

Prints a vector to a string.

Kind: static method of vec4

Kind: global typedef

Kind: global typedef

Kind: global typedef

Kind: global typedef