vec2-fn

Index

Interfaces

Vec2

Type aliases

Variables

Functions

Type aliases

Vec2Array

Vec2Array<T>: T

Vec2-like array object.

Type parameters

T: number[] = [number, number]

Vec2Param

Vec2Param: Vec2 | Vec2Array

A Vec2 array or object.

Vec2Readonly

Vec2Readonly: Readonly<Vec2>

Readonly Vec2

Variables

Const APPROX_THRESHOLD

APPROX_THRESHOLD: 1e-8 = 0.00000001

Approximate threshold for approx comparison

Const MINUS_ONE

MINUS_ONE: Vec2Readonly = ...

Constant readonly Vec2 with both values equalling -1

Const ONE

ONE: Vec2Readonly = ...

Constant readonly Vec2 with both values equalling 1

Const PRECISION

PRECISION: 11 = 11

The number of decimal places calculations are made to.

Const VEC2_DOWN

VEC2_DOWN: Vec2Readonly = ...

Normalized Vec2 pointing down

Const VEC2_DOWN_LEFT

VEC2_DOWN_LEFT: Vec2Readonly = ...

Normalized Vec2 pointing down-left

Const VEC2_DOWN_RIGHT

VEC2_DOWN_RIGHT: Vec2Readonly = ...

Normalized Vec2 pointing down-right

Const VEC2_LEFT

VEC2_LEFT: Vec2Readonly = ...

Normalized Vec2 pointing left

Const VEC2_RIGHT

VEC2_RIGHT: Vec2Readonly = ...

Normalized Vec2 pointing right

Const VEC2_UP

VEC2_UP: Vec2Readonly = ...

Normalized Vec2 pointing up

Const VEC2_UP_LEFT

VEC2_UP_LEFT: Vec2Readonly = ...

Normalized Vec2 pointing up-left

Const VEC2_UP_RIGHT

VEC2_UP_RIGHT: Vec2Readonly = ...

Normalized Vec2 pointing up-right

Const ZERO

ZERO: Vec2Readonly = ...

Constant readonly Vec2 with both values equalling 0

Functions

abs

abs<T>(target: T): T
abs<D>(target: Vec2Param, dest?: D): D

- Defined in fn/abs.ts:19
Calculate vec2 absolute value.
example
```
abs({ x: -1, y: -1 }); // -> { x: 0, y: 0 }
```
Type parameters
- T: Vec2Param
Parameters
- target: T
  
  Target vector.
Returns T
- A reference to the modified target vector.
- Defined in fn/abs.ts:34
Calculate vec2 absolute value.
example
```
abs({ x: -1, y: -1 }); // -> { x: 0, y: 0 }
```
Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  Target vector.
- Optional dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination object.

add

add<T>(target: T, value: Vec2Param | number): T
add<D>(target: Vec2Param, value: Vec2Param | number, dest: D): D

- Defined in fn/add.ts:17
Add vectors together.
example
```
add({ x: -1, y: -1 }, { x: 1, y: 1 }); // -> { x: 0, y: 0 }
```
Type parameters
- T: Vec2Param
Parameters
- target: T
  
  Target vector.
- value: Vec2Param | number
  
  The vector to add.
Returns T
- A reference to the modified target object.
- Defined in fn/add.ts:34
Add vectors together.
example
```
let result = { x: 0, y: 0 };

add({ x: -1, y: -1 }, { x: 1, y: 1 }, result); // -> { x: 0, y: 0 }
```
Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  Target vector.
- value: Vec2Param | number
  
  The vector to add.
- dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination object.

angleTo

angleTo(to: Vec2Param, from?: Vec2Param): number

- Defined in fn/angle-to.ts:14
Calculate angle.

Parameters
- to: Vec2Param
  
  Vector to calculate to.
- from: Vec2Param = ...
  
  Vector to calculate from. Defaults to ZERO.
Returns number
- Number angle result.

approx

approx(v1: Vec2Param, v2: Vec2Param, threshold?: number): boolean

- Defined in fn/approx.ts:15
Calculate whether two vectors are approximately equal.

Parameters
- v1: Vec2Param
  
  First vector for comparison.
- v2: Vec2Param
  
  Second vector for comparison.
- threshold: number = ...
Returns boolean
- Whether the vectors are approximately equal or not.

ceil

ceil<T>(target: T): T
ceil<D>(target: Vec2Param, dest: D): D

- Defined in fn/ceil.ts:12
Ceil the values of a vector.

Type parameters
- T: Vec2Param
Parameters
- target: T
  
  The target vector.
Returns T
- A reference to the modified target vector.
- Defined in fn/ceil.ts:20
Ceil the values of a vector.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  The target vector.
- dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination vector.

clamp

clamp<T>(target: T, vMin: Vec2Param | number, vMax: Vec2Param | number): T
clamp<D>(target: Vec2Param, vMin: Vec2Param | number, vMax: Vec2Param | number, dest: D): D

- Defined in fn/clamp.ts:14
Clamp a vector by min and max limits.

Type parameters
- T: Vec2Param
Parameters
- target: T
  
  Target object.
- vMin: Vec2Param | number
  
  Minimum vector.
- vMax: Vec2Param | number
  
  Maximum vector.
Returns T
- A reference to the modified target object.
- Defined in fn/clamp.ts:24
Clamp a vector by min and max limits.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  Target object.
- vMin: Vec2Param | number
  
  Minimum vector.
- vMax: Vec2Param | number
  
  Maximum vector.
- dest: D
  
  Destination object to store the values.
Returns D
- A reference to the modified destination object.

copy

copy<D>(target: Vec2Param, dest: D): D

- Defined in fn/copy.ts:13
Copy one vectors values to another.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  Target to be copied from.
- dest: D
  
  The destination object.
Returns D
- The destination object reference.

distance

distance(from: Vec2Param, to: Vec2Param): number

- Defined in fn/distance.ts:11
Get the distance between two vectors.

Parameters
- from: Vec2Param
  
  From vector.
- to: Vec2Param
  
  To vector.
Returns number
- Number distance result.

distanceSq

distanceSq(from: Vec2Param, to: Vec2Param): number

- Defined in fn/distance-sq.ts:13
Get the squared distance between two vectors.

Parameters
- from: Vec2Param
  
  From vector.
- to: Vec2Param
  
  To vector.
Returns number
- Number distance squared result.

divide

divide<T>(target: T, value: Vec2Param | number): T
divide<D>(target: Vec2Param, value: Vec2Param | number, dest: D): D

- Defined in fn/divide.ts:11
Divide two vectors.

Type parameters
- T: Vec2Param
Parameters
- target: T
  
  Target vector.
- value: Vec2Param | number
  
  The vector to divide by.
Returns T
- A reference to the modified target object.
- Defined in fn/divide.ts:20
Divide two vectors.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  Target vector.
- value: Vec2Param | number
  
  The vector to divide by.
- dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination object.

dot

dot(v1: Vec2Param, v2: Vec2Param): number

- Defined in fn/dot.ts:13
Calculate the dot product of two vectors.

Parameters
- v1: Vec2Param
  
  Vector 1.
- v2: Vec2Param
  
  = Vector 2.
Returns number
- Number result of the dot product.

dotPerp

dotPerp(v1: Vec2Param, v2: Vec2Param): number

- Defined in fn/dot-perp.ts:13
Calculate the perpendicular dot product of two vectors.

Parameters
- v1: Vec2Param
  
  Vector 1.
- v2: Vec2Param
  
  = Vector 2.
Returns number
- Number result of the perpendicular dot product.

equal

equal(target: Vec2Param, value: Vec2Param | number): boolean

- Defined in fn/equal.ts:13
Check whether two vectors are exactly equal to system precision.

Parameters
- target: Vec2Param
  
  Target vector.
- value: Vec2Param | number
  
  Value vector.
Returns boolean
- Boolean result of whether the vectors are equal.

floor

floor<T>(target: T): T
floor<D>(target: Vec2Param, dest: D): D

- Defined in fn/floor.ts:12
Floor the values of a vector.

Type parameters
- T: Vec2Param
Parameters
- target: T
  
  The target vector.
Returns T
- A reference to the modified target vector.
- Defined in fn/floor.ts:20
Floor the values of a vector.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  The target vector.
- dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination vector.

isOne

isOne(target: Vec2Param): boolean

- Defined in fn/is-one.ts:11
Check whether a vector is exactly equal to one (1,1).

Parameters
- target: Vec2Param
  
  Target vector.
Returns boolean
- Boolean result of whether the vector is equal to one.

isVec2LikeArray

isVec2LikeArray<T>(value: T): value is T extends [number, number] ? T : never

- Defined in fn/is-vec2-array.ts:9
Check whether a value is a vec2-like array.

Type parameters
- T: unknown
Parameters
- value: T
  
  Input value to check.
Returns value is T extends [number, number] ? T : never
- Boolean result of whether the input is a vec2-like array.

isVec2LikeObject

isVec2LikeObject<T>(value: T): value is T extends Vec2 ? T : never

- Defined in fn/is-vec2-object.ts:12
Check whether a value is a vec2-like object.

Type parameters
- T: unknown
Parameters
- value: T
  
  Input value to check.
Returns value is T extends Vec2 ? T : never
- Boolean result of whether the input is a vec2-like object.

isZero

isZero(vec1: Vec2Param): boolean

- Defined in fn/is-zero.ts:11
Check whether a vector is exactly equal to zero (0,0).

Parameters
- vec1: Vec2Param
Returns boolean
- Boolean result of whether the vector is equal to zero.

length

length(vec: Vec2Param): number

- Defined in fn/length.ts:10
Get the length of a vector.

Parameters
- vec: Vec2Param
  
  The input vector.
Returns number
- The number result of the vector length.

lengthSq

lengthSq(vec: Vec2Param): number

- Defined in fn/length-sq.ts:12
Get the squared length of a vector.

Parameters
- vec: Vec2Param
  
  The input vector.
Returns number
- The number result of the squared vector length.

lerp

lerp<T, V>(target: T, value: V, k: number): T
lerp<D>(target: Vec2Param, value: Vec2Param, k: number, dest: D): D

- Defined in fn/lerp.ts:15
Linear interpolate two vectors.

Type parameters
- T: Vec2Param
- V: Vec2Param
Parameters
- target: T
  
  Vector A.
- value: V
  
  Vector B.
- k: number
  
  The amount to interpolate by.
Returns T
- A reference to the modified target object.
- Defined in fn/lerp.ts:25
Linear interpolate two vectors.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  Vector A.
- value: Vec2Param
  
  Vector B.
- k: number
  
  The amount to interpolate by.
- dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination object.

max

max<D>(dest: D, ...values: (Vec2Param | number)[]): D

- Defined in fn/max.ts:13
Returns the max x and y of a set of vectors.

Type parameters
- D: Vec2Param
Parameters
- dest: D
  
  -
- Rest ...values: (Vec2Param | number)[]
  
  -
Returns D

-

min

min<D>(dest: D, ...values: (Vec2Param | number)[]): D

- Defined in fn/min.ts:13
Returns the min x and y of a set of vectors.

Type parameters
- D: Vec2Param
Parameters
- dest: D
- Rest ...values: (Vec2Param | number)[]
  
  -
Returns D

-

multiply

multiply<T>(target: T, value: Vec2Param | number): T
multiply<D>(target: Vec2Param, value: Vec2Param | number, dest: D): D

- Defined in fn/multiply.ts:11
Multiply two vectors.

Type parameters
- T: Vec2Param
Parameters
- target: T
  
  The target vector.
- value: Vec2Param | number
  
  The vector to multiply by.
Returns T
- A reference to the modified target object.
- Defined in fn/multiply.ts:20
Multiply two vectors.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  The target vector.
- value: Vec2Param | number
  
  The vector to multiply by.
- dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination object.

negate

negate<T>(target: T): T
negate<D>(target: Vec2Param, dest: D): D

- Defined in fn/negate.ts:12
Negate a vector.

Type parameters
- T: Vec2Param
Parameters
- target: T
  
  The target vector.
Returns T
- A reference to the modified target vector.
- Defined in fn/negate.ts:20
Negate a vector.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  The target vector.
- dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination vector.

normalize

normalize<T>(target: T): T
normalize<D>(target: Vec2Param, dest?: D): D

- Defined in fn/normalize.ts:13
Normalize a vector.

Type parameters
- T: Vec2Param
Parameters
- target: T
  
  Target can be vec object or array.
Returns T
- The modified target object.
- Defined in fn/normalize.ts:21
Normalize a vector.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  Target can be vec object or array.
- Optional dest: D
  
  destination object to store the result.
Returns D
- A reference to the destination object.

rotate

rotate<T>(target: T, angle: number): T
rotate<D>(target: Vec2Param, angle: number, dest?: D): D

- Defined in fn/rotate.ts:14
Rotate a vector around zero point.
readonly
- A reference to the modified target vector.
Type parameters
- T: Vec2Param
Parameters
- target: T
  
  The target vector.
- angle: number
  
  The amount of rotation to apply in radians.
Returns T
- Defined in fn/rotate.ts:23
Rotate a vector around zero point.
readonly
- A reference to the modified destination vector.
Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  The target vector.
- angle: number
  
  The amount of rotation to apply in radians.
- Optional dest: D
  
  Optional destination object to store the result.
Returns D

round

round<T>(target: T): T
round<D>(target: Vec2Param, dest: D): D

- Defined in fn/round.ts:12
Round the values of a vector.

Type parameters
- T: Vec2Param
Parameters
- target: T
  
  The target vector.
Returns T
- A reference to the modified target vector.
- Defined in fn/round.ts:20
Round the values of a vector.

Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  The target vector.
- dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination vector.

subtract

subtract<T>(target: T, value: Vec2Param | number): T
subtract<D>(target: Vec2Param, value: Vec2Param | number, dest?: D): D

- Defined in fn/subtract.ts:17
Subtract one vector from another.
example
```
subtract({ x: 1, y: 1 }, { x: 1, y: 1 }); // -> { x: 0, y: 0 }
```
Type parameters
- T: Vec2Param
Parameters
- target: T
  
  The target vector.
- value: Vec2Param | number
  
  The vector to subtract.
Returns T
- A reference to the modified target vector.
- Defined in fn/subtract.ts:33
Subtract one vector from another.
example
```
let result = { x: 0, y: 0 };
subtract({ x: 1, y: 1 }, { x: 1, y: 1 }, result); // -> { x: 0, y: 0 }
```
Type parameters
- D: Vec2Param
Parameters
- target: Vec2Param
  
  The target vector.
- value: Vec2Param | number
  
  The vector to subtract.
- Optional dest: D
  
  Destination object to store the result.
Returns D
- A reference to the modified destination vector.

toArray

toArray(target: Vec2): Vec2Array

- Defined in fn/to-array.ts:12
Convert a vec2-like object to an array.

Parameters
- target: Vec2
Returns Vec2Array
- Newly created array.

toObject

toObject(target: Vec2Array): Vec2

- Defined in fn/to-object.ts:12
Convert a vec2-like array to an object.

Parameters
- target: Vec2Array
Returns Vec2
- Newly created Vec2 object.

zero

zero<T>(target: T): T

- Defined in fn/zero.ts:12
Set vector to zero.

Type parameters
- T: Vec2Param
Parameters
- target: T
  
  Target Vec2-like object the values will be written to.
Returns T
- A reference to the object the result was written to.

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

Vec2Array

Type parameters

T: number[] = [number, number]

Vec2Param

Vec2Readonly

Variables

Const APPROX_THRESHOLD

Const MINUS_ONE

Const ONE

Const PRECISION

Const VEC2_DOWN

Const VEC2_DOWN_LEFT

Const VEC2_DOWN_RIGHT

Const VEC2_LEFT

Const VEC2_RIGHT

Const VEC2_UP

Const VEC2_UP_LEFT

Const VEC2_UP_RIGHT

Const ZERO

Functions

abs

Type parameters

T: Vec2Param

Parameters

target: T

Returns T

Type parameters

D: Vec2Param

Parameters

target: Vec2Param

Optional dest: D

Returns D

add

Type parameters

T: Vec2Param

Parameters

target: T

value: Vec2Param | number

Returns T

Type parameters

D: Vec2Param

Parameters

target: Vec2Param

value: Vec2Param | number

dest: D

Returns D

angleTo

Parameters

to: Vec2Param

from: Vec2Param = ...

Returns number

approx

Parameters

v1: Vec2Param

v2: Vec2Param

threshold: number = ...

Returns boolean

ceil

Type parameters

T: Vec2Param

Parameters

target: T

Returns T

Type parameters

D: Vec2Param

Parameters

target: Vec2Param

dest: D

Returns D

clamp

Type parameters

T: Vec2Param

Parameters

target: T