Global

Methods

abs (v, clone)Array.<number>

index.js:325

Name	Type	Description
v	Array.<number>
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v or the cloned vector

add (v1, v2, clone)Array.<number>

index.js:109

v1 + v2 note: if clone is false, v1 is returned with the result

Name	Type	Description
v1	Array.<number>
v2	Array.<number>
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v1 or the cloned vector

angle (v1, v2)number

index.js:446

angle between v1 and v2

Name	Type	Description
v1	Array.<number>
v2	Array.<number>

Returns:

Type	Description
number

cacheClean ()

index.js:26

remove all entries from cache

cacheSize ()number

index.js:21

get cache size

Returns:

Type	Description
number

clamp (v, min, max, clone)Array.<number>

index.js:343

clamp vector using min/max values or vectors

Name	Type	Description
v	Array.<number>
min	number | Array.<number>	optional
max	number | Array.<number>	optional
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v or the cloned vector

clone (v)

index.js:71

Name	Type	Description
v	Array.<number>

copy (destination, source)Array.<number>

index.js:62

copy source values to destination

Name	Type	Description
destination	Array.<number>
source	Array.<number>

Returns:

Type	Description
Array.<number>	destination

distance (v1, v2)number

index.js:253

distance between two vectors

Name	Type	Description
v1	Array.<number>
v2	Array.<number>

Returns:

Type	Description
number

distanceSquared (v1, v2)number

index.js:263

distance squared between two vectors

Name	Type	Description
v1	Array.<number>
v2	Array.<number>

Returns:

Type	Description
number

divide (v1, v2, clone)Array.<number>

index.js:177

v1 / v2

Name	Type	Description
v1	Array.<number>
v2	Array.<number>
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v1 or the cloned vector

divideScalar (v, scalar, clone)Array.<number>

index.js:194

v / scalar

Name	Type	Description
v	Array.<number>
scalar	number
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v or the cloned vector

dot (v1, v2)number

index.js:427

Name	Type	Description
v1	Array.<number>
v2	Array.<number>

Returns:

Type	Description
number

dotPerpendicular (v1, v2)number

index.js:436

Name	Type	Description
v1	Array.<number>
v2	Array.<number>

Returns:

Type	Description
number

equal (v1, v2, precision)

index.js:312

Name	Type	Description
v1	Array.<number>
v2	Array.<number>
precision	number	optional difference between components to still be equal

isPointOnLine (point, start, end)boolean

index.js:456

Name	Type	Description
point	Array.<number>
start	Array.<number>
end	Array.<number>

Returns:

Type	Description
boolean

length (v)number

index.js:234

length of vector

Name	Type	Description
v	Array.<number>

Returns:

Type	Description
number

lengthSquared (v)number

index.js:243

squared length of vector

Name	Type	Description
v	Array.<number>

Returns:

Type	Description
number

lerp (v1, v2, percent, clone)Array.<number>

index.js:396

linear interpolation between two vectors

Name	Type	Description
v1	Array.<number>
v2	Array.<number>
percent	number	between 0 and 1
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v1 or the cloned vector

multiply (v1, v2, clone)Array.<number>

index.js:143

v1 * v2

Name	Type	Description
v1	Array.<number>
v2	Array.<number>
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v1 or the cloned vector

multiplyScalar (v, scalar, clone)Array.<number>

index.js:160

v * scalar

Name	Type	Description
v	Array.<number>
scalar	number
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v or the cloned vector

nearest (v, array)Array.<number>

index.js:273

returns closest vec2 to v in array

Name	Type	Description
v	Array.<number>
array	Array.<number>

Returns:

Type	Description
Array.<number>

negate (v, clone)Array.<number>

index.js:88

Name	Type	Description
v	Array.<number>
clone	boolean	optional leave original vec2 and return a cloned, negated version

Returns:

Type	Description
Array.<number>

normal (v, clone)Array.<number>

index.js:411

Name	Type	Description
v	Array.<number>
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v or the cloned vector

normalize (v, clone)Array.<number>

index.js:293

converts to unit vector

Name	Type	Description
v	Array.<number>
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v1 or the cloned vector

recycle (v)

index.js:79

recycle the vector for future use

Name	Type	Description
v	Array.<number>

rotate (v, radians, options)Array.<number>

index.js:213

rotates a vector

Name	Type	Description
v	Array.<number>
radians	number
options	options	optional Name Type Description inverse boolean optional clone boolean optional returns a new vector with the result

Returns:

Type	Description
Array.<number>	v or the cloned vector

set (v, x, y)Array.<number>

index.js:50

set the value of vec2

Name	Type	Description
v	Array.<number>
x	number
y	number	optional use x if not set

Returns:

Type	Description
Array.<number>

shrinkCache (length)

index.js:36

shrink cache to a certain number of entries

Name	Type	Description
length	number

subtract (v1, v2, clone)Array.<number>

index.js:126

v1 - v2

Name	Type	Description
v1	Array.<number>
v2	Array.<number>
clone	boolean	optional return a new vector with the result

Returns:

Type	Description
Array.<number>	v1 or the cloned vector