Nutmeg Pumpkin Macchiato

# npm

## vec-la

1.5.0 • Public • Published

# vec

Tiny linear algebra library specifically for 2d.

See it in action: https://codepen.io/fstokesman/pen/aWgEXv

## Installation

`npm install --save vec-la`

and import or require as needed. If you need to use a standalone windowed version in a script tag:

`<script src="node_modules/vec-la/dist/vec.window.js"></script>`

## Features

• Immutable functions for manipulating vectors
• Vectors and matrices represented as pure, single dimensional arrays
• Immutable Matrix builder helper object for sequentially composing matrices

## API

• `vec.add(v, v2)` : Result of adding `v` and `v2`
• `vec.sub(v, v2)` : Result of subtracting `v2` from `v`
• `vec.scale(v, sc)` : Result of multiplying components of `v` by `sc`
• `vec.midpoint(v, v2)` : Midpoint between `v` and `v2`
• `vec.norm(v)` : Result of normalising `v`
• `vec.mag(v)` : Magnitude of `v`
• `vec.normal(v)`: Normal vector of `v`
• `vec.towards(v, v2, t)`: A point in the interval [v, v2] along the direction formed from `v2 - v1`. `t` is a normalalised percentage [0, 1] of where in the interval the point falls.
• `vec.rotate(v, a)` : Result of rotating `v` around the origin by `a` radians
• `vec.rotatePointAround(v, cp, a)` : Result of rotating `v` around `cp` by `a` radians
• `vec.dot(v, v2)` : Dot product of `v` and `v2`
• `vec.det(v)` : Determinant of `v`
• `vec.dist(v, v2)` : Euclidean distance between `v` and `v2`
• `vec.matrixBuilder(m)` : Creates a matrix builder (see below)
• `vec.createMatrix(a, b, c, d, tx, ty)` : Helper function for matrix creation. Defaults to an identity matrix
• `vec.transform(v, m)` : Result of applying matrix tranformation `m` to `v`
• `vec.composeTransform(m, m2)` : Result of composing transformation matrix `m` with `m2`

Finally, when using the window version you can call `vec.polute()` to insert these functions into the global scope with the naming convention:

`vFunctionName` e.g `vAdd`, `vMidpoint`, `vDot` etc.

## Matrix Builder

`vec.matrixBuilder(m)` creates a builder object that can be used to easily chain together transformations. Call `get()` on the builder at any time to get a copy of the matrix at that point.

The function also accepts a matrix as it's argument.

• `rotate(a)` : Concatenate a rotation matrix of `a` radians
• `scale(x, y)` : Concatenate a scaling matrix
• `shear(x, y)` : Concatenate a shearing matrix
• `translate(x, y)` : Concatenate a translation matrix
• `add(m)` : Concatenate an arbitrary matrix
• `get()` : Return the resulting matrix

## Tests

Clone the repository, and then run `npm install && npm test`.

## Examples

(all examples assume vec is imported under `vec`)

## Motivation

Many linear algebra libraries represent their vectors as object like `{ x, y, mutableMethod, ... }`, which can be cumbersome to work with. Arrays are easier to map, reduce, combine and generally work with symbolically. Additionally, Vec is designed to be used with ES6 and thus the `...` rest syntax, and so can easily and cleanly be supplied to functions expecting `x` and `y` parameters as sequential arguments.

For example:

`ctx.arc(...point, radius, 0, 2 * Math.PI, false)`;

## Keywords

none

### Install

`npm i vec-la`

### Repository

github.com/francisrstokes/vec