vec2-fn
v0.2.0TypeScript
A type-safe set of functions for working with vec2-like objects and arrays.
0/weekUpdated 3 years agoMITUnpacked: 248.2 KB
Published by Lloyd Evans
npm install vec2-fnvec2-fn
$3
This is a small JS library containing some utility functions for working with vector 2 (like) objects an arrays. The functions are sometimes not pure in the sense that they will modify the vector you provide to them. This allows the reuse of vector object instances and compatibility between different vector class types.
$3
``bash`
npm i -S vec2-fn
$3
API docs can be found here
$3
`ts
// Import star
import * as vec2 from "vec2-fn";
vec2.equal({ x: 0, y: 0 }, vec2.ZERO);
// Import named
import { equal, ZERO } from "vec2-fn";
equal({ x: 0, y: 0 }, ZERO);
`
$3
`js
// Import all
const vec2 = require("vec2-fn");
vec2.equal({ x: 0, y: 0 }, vec2.ZERO);
// Assign named
const { equal, ZERO } = require("vec2-fn");
equal({ x: 0, y: 0 }, ZERO);
`
$3
Old school method
`html`
For static usage, ambient type definitions can optionally be referenced here node_modules/vec2-fn/bin/vec2.d.ts.
Table of contents
$3
- Vec2
$3
- Vec2Array
- Vec2Param
- Vec2Readonly
$3
- APPROX\_THRESHOLD
- MINUS\_ONE
- ONE
- PRECISION
- VEC2\_DOWN
- VEC2\_DOWN\_LEFT
- VEC2\_DOWN\_RIGHT
- VEC2\_LEFT
- VEC2\_RIGHT
- VEC2\_UP
- VEC2\_UP\_LEFT
- VEC2\_UP\_RIGHT
- ZERO
$3
- abs
- add
- angleTo
- approx
- ceil
- clamp
- copy
- distance
- distanceSq
- divide
- dot
- dotPerp
- equal
- floor
- isOne
- isVec2LikeArray
- isVec2LikeObject
- isZero
- length
- lengthSq
- lerp
- max
- min
- multiply
- negate
- normalize
- rotate
- round
- subtract
- toArray
- toObject
- zero
Type aliases
$3
Ƭ Vec2Array
Vec2-like array object.
#### Type parameters
| Name | Type | Default |
| :------ | :------ | :------ |
| T | number[] | [number, number] |
Defined in: types/vec2-array.ts:2
___
$3
Ƭ Vec2Param: Vec2 \| Vec2Array
A Vec2 array or object.
Defined in: types/vec2-param.ts:5
___
$3
Ƭ Vec2Readonly: Readonly<Vec2\>
Readonly Vec2
Defined in: types/vec2-readonly.ts:4
Variables
$3
• Const APPROX\_THRESHOLD: 1e-8= 0.00000001
Approximate threshold for approx comparison
Defined in: constants/approx-threshold.ts:2
___
$3
• Const MINUS\_ONE: Vec2Readonly
Constant readonly Vec2 with both values equalling -1
Defined in: constants/minus-one.ts:4
___
$3
• Const ONE: Vec2Readonly
Constant readonly Vec2 with both values equalling 1
Defined in: constants/one.ts:4
___
$3
• Const PRECISION: 11= 11
The number of decimal places calculations are made to.
Defined in: constants/precision.ts:2
___
$3
• Const VEC2\_DOWN: Vec2Readonly
Normalized Vec2 pointing down
Defined in: constants/vec2-down.ts:4
___
$3
• Const VEC2\_DOWN\_LEFT: Vec2Readonly
Normalized Vec2 pointing down-left
Defined in: constants/vec2-down-left.ts:5
___
$3
• Const VEC2\_DOWN\_RIGHT: Vec2Readonly
Normalized Vec2 pointing down-right
Defined in: constants/vec2-down-right.ts:5
___
$3
• Const VEC2\_LEFT: Vec2Readonly
Normalized Vec2 pointing left
Defined in: constants/vec2-left.ts:4
___
$3
• Const VEC2\_RIGHT: Vec2Readonly
Normalized Vec2 pointing right
Defined in: constants/vec2-right.ts:4
___
$3
• Const VEC2\_UP: Vec2Readonly
Normalized Vec2 pointing up
Defined in: constants/vec2-up.ts:4
___
$3
• Const VEC2\_UP\_LEFT: Vec2Readonly
Normalized Vec2 pointing up-left
Defined in: constants/vec2-up-left.ts:5
___
$3
• Const VEC2\_UP\_RIGHT: Vec2Readonly
Normalized Vec2 pointing up-right
Defined in: constants/vec2-up-right.ts:5
___
$3
• Const ZERO: Vec2Readonly
Constant readonly Vec2 with both values equalling 0
Defined in: constants/zero.ts:4
Functions
$3
▸ abs: T): T
Calculate vec2 absolute value.
example
`ts`
abs({ x: -1, y: -1 }); // -> { x: 0, y: 0 }
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | T | Target vector. |
Returns: T
- A reference to the modified target vector.
Defined in: fn/abs.ts:19
▸ abs: Vec2Param, dest?: D): D
Calculate vec2 absolute value.
example
`ts`
abs({ x: -1, y: -1 }); // -> { x: 0, y: 0 }
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | Target vector. |dest?
| | D | Destination object to store the result. |
Returns: D
- A reference to the modified destination object.
Defined in: fn/abs.ts:34
___
$3
▸ add: T, value: Vec2Param \| number): T
Add vectors together.
example
`ts`
add({ x: -1, y: -1 }, { x: 1, y: 1 }); // -> { x: 0, y: 0 }
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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:17
▸ add: Vec2Param, value: Vec2Param \| number, dest: D): D
Add vectors together.
example
`ts
let result = { x: 0, y: 0 };
add({ x: -1, y: -1 }, { x: 1, y: 1 }, result); // -> { x: 0, y: 0 }
`
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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.
Defined in: fn/add.ts:34
___
$3
▸ angleTo(to: Vec2Param, from?: Vec2Param): number
Calculate angle.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| to | Vec2Param | Vector to calculate to. |from
| | Vec2Param | Vector to calculate from. Defaults to ZERO. |
Returns: number
- Number angle result.
Defined in: fn/angle-to.ts:14
___
$3
▸ approx(v1: Vec2Param, v2: Vec2Param, threshold?: number): boolean
Calculate whether two vectors are approximately equal.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| v1 | Vec2Param | First vector for comparison. |v2
| | Vec2Param | Second vector for comparison. |threshold
| | number | - |
Returns: boolean
- Whether the vectors are approximately equal or not.
Defined in: fn/approx.ts:15
___
$3
▸ ceil: T): T
Ceil the values of a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | T | The target vector. |
Returns: T
- A reference to the modified target vector.
Defined in: fn/ceil.ts:12
▸ ceil: Vec2Param, dest: D): D
Ceil the values of a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | The target vector. |dest
| | D | Destination object to store the result. |
Returns: D
- A reference to the modified destination vector.
Defined in: fn/ceil.ts:20
___
$3
▸ clamp: T, vMin: Vec2Param \| number, vMax: Vec2Param \| number): T
Clamp a vector by min and max limits.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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:14
▸ clamp: Vec2Param, vMin: Vec2Param \| number, vMax: Vec2Param \| number, dest: D): D
Clamp a vector by min and max limits.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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.
Defined in: fn/clamp.ts:24
___
$3
▸ copy: Vec2Param, dest: D): D
Copy one vectors values to another.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | Target to be copied from. |dest
| | D | The destination object. |
Returns: D
- The destination object reference.
Defined in: fn/copy.ts:13
___
$3
▸ distance(from: Vec2Param, to: Vec2Param): number
Get the distance between two vectors.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| from | Vec2Param | From vector. |to
| | Vec2Param | To vector. |
Returns: number
- Number distance result.
Defined in: fn/distance.ts:11
___
$3
▸ distanceSq(from: Vec2Param, to: Vec2Param): number
Get the squared distance between two vectors.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| from | Vec2Param | From vector. |to
| | Vec2Param | To vector. |
Returns: number
- Number distance squared result.
Defined in: fn/distance-sq.ts:13
___
$3
▸ divide: T, value: Vec2Param \| number): T
Divide two vectors.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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:11
▸ divide: Vec2Param, value: Vec2Param \| number, dest: D): D
Divide two vectors.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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.
Defined in: fn/divide.ts:20
___
$3
▸ dot(v1: Vec2Param, v2: Vec2Param): number
Calculate the dot product of two vectors.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| v1 | Vec2Param | Vector 1. |v2
| | Vec2Param | = Vector 2. |
Returns: number
- Number result of the dot product.
Defined in: fn/dot.ts:13
___
$3
▸ dotPerp(v1: Vec2Param, v2: Vec2Param): number
Calculate the perpendicular dot product of two vectors.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| v1 | Vec2Param | Vector 1. |v2
| | Vec2Param | = Vector 2. |
Returns: number
- Number result of the perpendicular dot product.
Defined in: fn/dot-perp.ts:13
___
$3
▸ equal(target: Vec2Param, value: Vec2Param \| number): boolean
Check whether two vectors are exactly equal to system precision.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | Target vector. |value
| | Vec2Param \| number | Value vector. |
Returns: boolean
- Boolean result of whether the vectors are equal.
Defined in: fn/equal.ts:13
___
$3
▸ floor: T): T
Floor the values of a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | T | The target vector. |
Returns: T
- A reference to the modified target vector.
Defined in: fn/floor.ts:12
▸ floor: Vec2Param, dest: D): D
Floor the values of a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | The target vector. |dest
| | D | Destination object to store the result. |
Returns: D
- A reference to the modified destination vector.
Defined in: fn/floor.ts:20
___
$3
▸ isOne(target: Vec2Param): boolean
Check whether a vector is exactly equal to one (1,1).
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | Target vector. |
Returns: boolean
- Boolean result of whether the vector is equal to one.
Defined in: fn/is-one.ts:11
___
$3
▸ isVec2LikeArray: T): value is T extends [number, number] ? T : never
Check whether a value is a vec2-like array.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | unknown |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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.
Defined in: fn/is-vec2-array.ts:9
___
$3
▸ isVec2LikeObject: T): value is T extends Vec2 ? T : never
Check whether a value is a vec2-like object.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | unknown |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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.
Defined in: fn/is-vec2-object.ts:12
___
$3
▸ isZero(vec1: Vec2Param): boolean
Check whether a vector is exactly equal to zero (0,0).
#### Parameters
| Name | Type |
| :------ | :------ |
| vec1 | Vec2Param |
Returns: boolean
- Boolean result of whether the vector is equal to zero.
Defined in: fn/is-zero.ts:11
___
$3
▸ length(vec: Vec2Param): number
Get the length of a vector.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| vec | Vec2Param | The input vector. |
Returns: number
- The number result of the vector length.
Defined in: fn/length.ts:10
___
$3
▸ lengthSq(vec: Vec2Param): number
Get the squared length of a vector.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| vec | Vec2Param | The input vector. |
Returns: number
- The number result of the squared vector length.
Defined in: fn/length-sq.ts:12
___
$3
▸ lerp: T, value: V, k: number): T
Linear interpolate two vectors.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |V
| | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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:15
▸ lerp: Vec2Param, value: Vec2Param, k: number, dest: D): D
Linear interpolate two vectors.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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.
Defined in: fn/lerp.ts:25
___
$3
▸ max: D, ...values: (Vec2Param \| number)[]): D
Returns the max x and y of a set of vectors.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| dest | D | - |...values
| | (Vec2Param \| number)[] | - |
Returns: D
-
Defined in: fn/max.ts:13
___
$3
▸ min: D, ...values: (Vec2Param \| number)[]): D
Returns the min x and y of a set of vectors.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| dest | D | - |...values
| | (Vec2Param \| number)[] | - |
Returns: D
-
Defined in: fn/min.ts:13
___
$3
▸ multiply: T, value: Vec2Param \| number): T
Multiply two vectors.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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:11
▸ multiply: Vec2Param, value: Vec2Param \| number, dest: D): D
Multiply two vectors.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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.
Defined in: fn/multiply.ts:20
___
$3
▸ negate: T): T
Negate a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | T | The target vector. |
Returns: T
- A reference to the modified target vector.
Defined in: fn/negate.ts:12
▸ negate: Vec2Param, dest: D): D
Negate a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | The target vector. |dest
| | D | Destination object to store the result. |
Returns: D
- A reference to the modified destination vector.
Defined in: fn/negate.ts:20
___
$3
▸ normalize: T): T
Normalize a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | T | Target can be vec object or array. |
Returns: T
- The modified target object.
Defined in: fn/normalize.ts:13
▸ normalize: Vec2Param, dest?: D): D
Normalize a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | Target can be vec object or array. |dest?
| | D | destination object to store the result. |
Returns: D
- A reference to the destination object.
Defined in: fn/normalize.ts:21
___
$3
▸ rotate: T, angle: number): T
Rotate a vector around zero point.
readonly - A reference to the modified target vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | T | The target vector. |angle
| | number | The amount of rotation to apply in radians. |
Returns: T
Defined in: fn/rotate.ts:14
▸ rotate: Vec2Param, angle: number, dest?: D): D
Rotate a vector around zero point.
readonly - A reference to the modified destination vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | The target vector. |angle
| | number | The amount of rotation to apply in radians. |dest?
| | D | Optional destination object to store the result. |
Returns: D
Defined in: fn/rotate.ts:23
___
$3
▸ round: T): T
Round the values of a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | T | The target vector. |
Returns: T
- A reference to the modified target vector.
Defined in: fn/round.ts:12
▸ round: Vec2Param, dest: D): D
Round the values of a vector.
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | The target vector. |dest
| | D | Destination object to store the result. |
Returns: D
- A reference to the modified destination vector.
Defined in: fn/round.ts:20
___
$3
▸ subtract: T, value: Vec2Param \| number): T
Subtract one vector from another.
example
`ts`
subtract({ x: 1, y: 1 }, { x: 1, y: 1 }); // -> { x: 0, y: 0 }
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| 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:17
▸ subtract: Vec2Param, value: Vec2Param \| number, dest?: D): D
Subtract one vector from another.
example
`ts`
let result = { x: 0, y: 0 };
subtract({ x: 1, y: 1 }, { x: 1, y: 1 }, result); // -> { x: 0, y: 0 }
#### Type parameters
| Name | Type |
| :------ | :------ |
| D | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target | Vec2Param | The target vector. |value
| | Vec2Param \| number | The vector to subtract. |dest?
| | D | Destination object to store the result. |
Returns: D
- A reference to the modified destination vector.
Defined in: fn/subtract.ts:33
___
$3
▸ toArray(target: Vec2): Vec2Array
Convert a vec2-like object to an array.
#### Parameters
| Name | Type |
| :------ | :------ |
| target | Vec2 |
Returns: Vec2Array
- Newly created array.
Defined in: fn/to-array.ts:12
___
$3
▸ toObject(target: Vec2Array): Vec2
Convert a vec2-like array to an object.
#### Parameters
| Name | Type |
| :------ | :------ |
| target | Vec2Array |
Returns: Vec2
- Newly created Vec2 object.
Defined in: fn/to-object.ts:12
___
$3
▸ zero: T): T
Set vector to zero.
#### Type parameters
| Name | Type |
| :------ | :------ |
| T | Vec2Param |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| target` | T | Target Vec2-like object the values will be written to. |
Returns: T
- A reference to the object the result was written to.
Defined in: fn/zero.ts:12