pex-math v4.1.0

pex-math

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

Installation

npm install pex-math

Usage

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

Typedefs

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

pex-math.mat2x3 : mat2x3

Kind: static property of pex-math

pex-math.mat3 : mat3

Kind: static property of pex-math

pex-math.mat4 : mat4

Kind: static property of pex-math

pex-math.vec2 : vec2

Kind: static property of pex-math

pex-math.vec3 : vec3

Kind: static property of pex-math

pex-math.vec4 : vec4

Kind: static property of pex-math

pex-math.avec2 : avec2

Kind: static property of pex-math

pex-math.avec3 : avec3

Kind: static property of pex-math

pex-math.avec4 : avec4

Kind: static property of pex-math

pex-math.quat : quat

Kind: static property of pex-math

pex-math.euler : euler

Kind: static property of pex-math

pex-math.utils : utils

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

avec2.set2(a, i, x, y)

Sets a vector components.

Kind: static method of avec2

avec2.set(a, i, b, j)

Sets a vector to another vector.

Kind: static method of avec2

avec2.equals(a, i, b, j) ⇒ boolean

Compares two vectors.

Kind: static method of avec2

avec2.add(a, i, b, j)

Adds a vector to another.

Kind: static method of avec2

avec2.sub(a, i, b, j)

Subtracts a vector from another.

Kind: static method of avec2

avec2.scale(a, i, s)

Scales a vector by a number.

Kind: static method of avec2

avec2.addScaled(a, i, b, j, s)

Adds two vectors after scaling the second one.

Kind: static method of avec2

avec2.dot(a, i, b, j) ⇒ number

Calculates the dot product of two vectors.

Kind: static method of avec2

avec2.length(a, i) ⇒ number

Calculates the length of a vector.

Kind: static method of avec2

avec2.lengthSq(a, i) ⇒ number

Calculates the squared length of a vector.

Kind: static method of avec2

avec2.normalize(a, i)

Normalises a vector.

Kind: static method of avec2

avec2.distance(a, i, b, j) ⇒ number

Calculates the distance between two vectors.

Kind: static method of avec2

avec2.distanceSq(a, i, b, j) ⇒ number

Calculates the squared distance between two vectors.

Kind: static method of avec2

avec2.limit(a, i, len)

Limits a vector to a length.

Kind: static method of avec2

avec2.lerp(a, i, b, j, t)

Linearly interpolates between two vectors.

Kind: static method of avec2

avec2.forEach(a, callbackFn)

Executes a function once for each array element.

Kind: static method of avec2

avec2.map(a, callbackFn) ⇒ 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

avec2.toString(a, i, precision) ⇒ string

Prints a vector to a string.

Kind: static method of avec2

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

avec3.set3(a, i, x, y, z)

Sets a vector components.

Kind: static method of avec3

avec3.set(a, i, b, j)

Sets a vector to another vector.

Kind: static method of avec3

avec3.equals(a, i, b, j) ⇒ boolean

Compares two vectors.

Kind: static method of avec3

avec3.add(a, i, b, j)

Adds a vector to another.

Kind: static method of avec3

avec3.sub(a, i, b, j)

Subtracts a vector from another.

Kind: static method of avec3

avec3.scale(a, i, s)

Scales a vector by a number.

Kind: static method of avec3

avec3.addScaled(a, i, b, j, s)

Adds two vectors after scaling the second one.

Kind: static method of avec3

avec3.multMat4(a, i, m, j)

Multiplies a vector by a matrix.

Kind: static method of avec3

avec3.multQuat(a, i, q, j)

Multiplies a vector by a quaternion.

Kind: static method of avec3

avec3.dot(a, i, b, j) ⇒ number

Calculates the dot product of two vectors.

Kind: static method of avec3

avec3.cross(a, i, b, j)

Calculates the cross product of two vectors.

Kind: static method of avec3

avec3.length(a, i) ⇒ number

Calculates the length of a vector.

Kind: static method of avec3

avec3.lengthSq(a, i) ⇒ number

Calculates the squared length of a vector.

Kind: static method of avec3

avec3.normalize(a, i)

Normalises a vector.

Kind: static method of avec3

avec3.distance(a, i, b, j) ⇒ number

Calculates the distance between two vectors.

Kind: static method of avec3

avec3.distanceSq(a, i, b, j) ⇒ number

Calculates the squared distance between two vectors.

Kind: static method of avec3

avec3.limit(a, i, len)

Limits a vector to a length.

Kind: static method of avec3

avec3.lerp(a, i, b, j, t)

Linearly interpolates between two vectors.

Kind: static method of avec3

avec3.forEach(a, callbackFn)

Executes a function once for each array element.

Kind: static method of avec3

avec3.map(a, callbackFn) ⇒ 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

avec3.toString(a, i, precision) ⇒ string

Prints a vector to a string.

Kind: static method of avec3

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

avec4.set4(a, i, x, y, z, w)

Sets a vector components.

Kind: static method of avec4

avec4.set(a, i, b, j)

Sets a vector to another vector.

Kind: static method of avec4

avec4.equals(a, i, b, j) ⇒ boolean

Compares two vectors.

Kind: static method of avec4

avec4.add(a, i, b, j)

Adds a vector to another.

Kind: static method of avec4

avec4.sub(a, i, b, j)

Subtracts a vector from another.

Kind: static method of avec4

avec4.scale(a, i, s)

Scales a vector by a number.

Kind: static method of avec4

avec4.addScaled(a, i, b, j, s)

Adds two vectors after scaling the second one.

Kind: static method of avec4

avec4.multMat4(a, i, m, j)

Multiplies a vector with a matrix.

Kind: static method of avec4

avec4.lerp(a, i, b, j, t)

Linearly interpolates between two vectors.

Kind: static method of avec4

avec4.forEach(a, callbackFn)

Executes a function once for each array element.

Kind: static method of avec4

avec4.map(a, callbackFn) ⇒ 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

avec4.toString(a, i, precision) ⇒ string

Prints a vector to a string.

Kind: static method of avec4

euler

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

euler.create() ⇒ 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

euler.fromQuat(a, q) ⇒ euler

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

Kind: static method of euler

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

mat2x3.create() ⇒ 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

mat2x3.identity(a) ⇒ mat2x3

Sets a matrix to the identity matrix.

Kind: static method of mat2x3

mat2x3.copy(a) ⇒ mat2x3

Returns a copy of a matrix.

Kind: static method of mat2x3

mat2x3.set(a, b) ⇒ mat2x3

Sets a matrix from another matrix.

Kind: static method of mat2x3

mat2x3.equals(a, b) ⇒ boolean

Compares two matrices.

Kind: static method of mat2x3

mat2x3.mult(a, b) ⇒ mat2x3

Multiplies two matrices.

Kind: static method of mat2x3

mat2x3.translate(a, v) ⇒ mat2x3

Translates a matrix by a vector.

Kind: static method of mat2x3

mat2x3.rotate(a, rad) ⇒ mat2x3

Rotates a matrix by an angle.

Kind: static method of mat2x3

mat2x3.scale(a, v) ⇒ mat2x3

Scales a matrix by a vector.

Kind: static method of mat2x3

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

mat3.create() ⇒ 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

mat3.identity(a) ⇒ mat3

Sets a matrix to the identity matrix.

Kind: static method of mat3

mat3.copy(a) ⇒ mat3

Returns a copy of a matrix.

Kind: static method of mat3

mat3.set(a, b) ⇒ mat3

Sets a matrix from another matrix.

Kind: static method of mat3

mat3.equals(a, b) ⇒ boolean

Compares two matrices.

Kind: static method of mat3

mat3.mult(a, b) ⇒ mat3

Multiplies two matrices.

Kind: static method of mat3

mat3.transpose(a) ⇒ mat3

Transposes a matrix.

Kind: static method of mat3

mat3.fromQuat(a, q) ⇒ mat3

Sets matrix to a quaternion.

Kind: static method of mat3

mat3.fromMat2x3(a, b) ⇒ mat3

Sets a 3x3 matrix from a 2x3 matrix.

Kind: static method of mat3

mat3.fromMat4(a, b) ⇒ mat3

Sets a 3x3 matrix to a 4x4 matrix.

Kind: static method of mat3

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

mat4.create() ⇒ 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

mat4.identity(a) ⇒ mat4

Sets a matrix to the identity matrix.

Kind: static method of mat4

mat4.copy(a) ⇒ mat4

Returns a copy of a matrix.

Kind: static method of mat4

mat4.set(a, b) ⇒ mat4

Sets a matrix from another matrix.

Kind: static method of mat4

mat4.equals(a, b) ⇒ boolean

Compares two matrices.

Kind: static method of mat4

mat4.mult(a, b) ⇒ mat4

Multiplies two matrices.

Kind: static method of mat4

mat4.invert(a) ⇒ mat4

Inverts a matrix.

Kind: static method of mat4

mat4.transpose(a) ⇒ mat4

Transposes a matrix.

Kind: static method of mat4

mat4.translate(a, v) ⇒ mat4

Translates a matrix by a vector.

Kind: static method of mat4

mat4.rotate(a, r, v) ⇒ mat4

Rotates a matrix by an angle at an axis.

Kind: static method of mat4

mat4.scale(a, v) ⇒ mat4

Scales a matrix by a vector.

Kind: static method of mat4

mat4.fromQuat(a, q) ⇒ mat4

Sets a matrix to a quaternion.

Kind: static method of mat4

mat4.fromTranslationRotationScale(a, v, q, s) ⇒ mat4

Sets a matrix to the TRS matrix.

Kind: static method of mat4

mat4.fromMat3(a, b) ⇒ mat4

Sets a 4x4 matrix to a 3x3 matrix.

Kind: static method of mat4

mat4.frustum(a, left, right, bottom, top, near, far) ⇒ mat4

Creates a frustum matrix.

Kind: static method of mat4

mat4.perspective(a, fovy, aspectRatio, near, far) ⇒ mat4

Creates a perspective matrix.

Kind: static method of mat4

mat4.ortho(a, left, right, bottom, top, near, far) ⇒ mat4

Creates an orthographic matrix.

Kind: static method of mat4

mat4.lookAt(a, from, to, up) ⇒ mat4

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

Kind: static method of mat4

mat4.fromDirection(a, direction, up) ⇒ mat4

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

Kind: static method of mat4

mat4.fromPointToPoint(a, from, to, up) ⇒ mat4

Sets a matrix from a point to another.

Kind: static method of mat4

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

quat.set ⇒ quat

Sets a quaternion to another quaternion.

Kind: static constant of quat

quat.equals ⇒ boolean

Compares two quaternions.

Kind: static constant of quat

quat.toString ⇒ quat

Prints a quaternion to a string.

Kind: static constant of quat

quat.create() ⇒ quat

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

Kind: static method of quat

quat.identity(a) ⇒ quat

Sets a quaternion to the identity quaternion.

Kind: static method of quat

quat.copy(a) ⇒ quat

Returns a copy of a quaternion.

Kind: static method of quat

quat.mult(a, b) ⇒ quat

Multiplies one quaternion by another.

Kind: static method of quat

quat.invert(a) ⇒ quat

Inverts a quaternion.

Kind: static method of quat

quat.conjugate(a) ⇒ quat

Conjugates a quaternion.

Kind: static method of quat

quat.length(a) ⇒ quat

Calculates the length of a quaternion.

Kind: static method of quat

quat.normalize(a) ⇒ quat

Normalizes a quaternion.

Kind: static method of quat

quat.dot(a, b) ⇒ quat

Calculates the dot product of two quaternions.

Kind: static method of quat

quat.fromEuler(a, e) ⇒ quat

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

Kind: static method of quat

quat.fromAxisAngle(a, v, r) ⇒ quat

Set the angle at an axis of a quaternion.

Kind: static method of quat

quat.fromAxes(a, x, y, z) ⇒ quat

Sets a quaternion from orthonormal base xyz.

Kind: static method of quat

quat.fromMat3(a, m) ⇒ quat

Sets a quaternion to a 3x3 matrix.

Kind: static method of quat

quat.fromMat4(a, m) ⇒ quat

Sets a quaternion to a 4x4 matrix.

Kind: static method of quat

quat.fromDirection(a, direction, up) ⇒ quat

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

Kind: static method of quat

quat.fromPointToPoint(a, from, to, up) ⇒ quat

Sets a quaternion from a point to another.

Kind: static method of quat

quat.slerp(a, b, t) ⇒ quat

Spherical linear interpolates between two quaternions.

Kind: static method of quat

utils

• utils
  • .EPSILON : 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

utils.EPSILON : number

Kind: static constant of utils

utils.Y_UP : vec3

Kind: static constant of utils

utils.lerp(a, b, t) ⇒ number

Linear interpolation between two numbers.

Kind: static method of utils

utils.clamp(n, min, max) ⇒ number

Clamps a number between two numbers.

Kind: static method of utils

utils.smoothstep(n, min, max) ⇒ number

Smooth Hermite interpolation between 0 and 1

Kind: static method of utils

utils.remap(n, inStart, inEnd, outStart, outEnd) ⇒ number

Maps a number from one range to another.

Kind: static method of utils

utils.toRadians(degrees) ⇒ Radians

Transforms degrees into radians.

Kind: static method of utils

utils.toDegrees(radians) ⇒ Degrees

Transforms radians into degrees.

Kind: static method of utils

utils.isPowerOfTwo(a) ⇒ boolean

Check if a number is a power of two

Kind: static method of utils

utils.nextPowerOfTwo(n) ⇒ number

Returns the next highest power of two.

Kind: static method of utils

utils.prevPowerOfTwo(n) ⇒ number

Returns the previous power of two.

Kind: static method of utils

vec2

• 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

vec2.create() ⇒ vec2

Returns a new vec2 at 0, 0.

Kind: static method of vec2

vec2.copy(a) ⇒ vec2

Returns a copy of a vector.

Kind: static method of vec2

vec2.set(a, b) ⇒ vec2

Sets a vector to another vector.

Kind: static method of vec2

| Param | Type