pex-math

v4.1.0

Published

3 months ago

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

Downloads

156

0High
0Medium
0Low

vorg

automat

dmnsgn

pex math webgl 3d vector quaternion matrix vec2 vec3 vec4 quat mat2x3 mat3 mat4

pex-math

$npm version$ $npm minzipped size$ $dependencies$ $types$ $license$

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

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

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

Sets a vector to another vector.

Kind: static method of avec2

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

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

Compares two vectors.

Kind: static method of avec2

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

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

Adds a vector to another.

Kind: static method of avec2

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

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

Subtracts a vector from another.

Kind: static method of avec2

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

avec2.scale(a, i, s)

Scales a vector by a number.

Kind: static method of avec2

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

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

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 |

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

Calculates the dot product of two vectors.

Kind: static method of avec2

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

avec2.length(a, i) ⇒ number

Calculates the length of a vector.

Kind: static method of avec2

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

avec2.lengthSq(a, i) ⇒ number

Calculates the squared length of a vector.

Kind: static method of avec2

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

avec2.normalize(a, i)

Normalises a vector.

Kind: static method of avec2

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

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

Calculates the distance between two vectors.

Kind: static method of avec2

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

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

Calculates the squared distance between two vectors.

Kind: static method of avec2

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

avec2.limit(a, i, len)

Limits a vector to a length.

Kind: static method of avec2

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

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

Linearly interpolates between two vectors.

Kind: static method of avec2

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

avec2.forEach(a, callbackFn)

Executes a function once for each array element.

Kind: static method of avec2

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

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

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

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

Prints a vector to a string.

Kind: static method of avec2

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