Vectory

<h1 align="center">Vectory</h1> <h4 align="center">High performant, DevTools friendly, Crankshaft tolerant 2d vectors</h4> <p align="center"> <a href="https://www.npmjs.com/package/vectory" target="_blank"> <img src="https://img.shields.io/npm/v/vectory.svg" alt="NPM version" target="_blank"></img> </a> <a href="https://travis-ci.org/broadsw0rd/vectory" target="_blank"> <img src="https://travis-ci.org/broadsw0rd/vectory.svg?branch=master" alt="Build Status" target="_blank"></img> </a> <a href='https://coveralls.io/github/broadsw0rd/vectory?branch=master' target="_blank"> <img src='https://coveralls.io/repos/broadsw0rd/vectory/badge.svg?branch=master&service=github' alt='Coverage Status' /> </a> <a href="https://www.bithound.io/github/broadsw0rd/vectory"> <img src="https://www.bithound.io/github/broadsw0rd/vectory/badges/score.svg" alt="bitHound Overall Score"> </a> <a href="https://github.com/feross/standard" target="_blank"> <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat" alt="js-standard-style"></img> </a> </p>

Yet another 2d vector implementation for basic motion

this.velocity.iadd(this.acceleration)
this.position.iadd(this.velocity)
this.acceleration.zero()

with rare methods such as lerp

var prev = new Vector(1, 2)
var next = new Vector(3, 4)
prev.lerp(next, 0.5) // Vector(2, 3)

and swizzling

var vector = new Vector(1 ,2)
vector.yx // Vector(2, 1)

with some ES6 support

var vector = new Vector(0, 0)
var vec3 = [...vector, 0] // [0, 0, 0]

and FP ability

// create vectors from raw data and scale them twice
var data = [[1, 2], [3, 4]/*,  ... */]
var vectors = data.map(Vector.from).map(Vector.mul.bind(null, 2))

Table of Contents

• Features
• Install
• Usage
• Support
• API
• Benchmark
• Development

Features

• Designed with performance in mind
• Simple - 371 LOC
• Lightweight - 4.5 Kb
• Well tested - 100% code coverage
• Rich api - 33 methods

Install

npm install --save vectory

import Vector from 'vectory'
var position = new Vector(0, 0)

or

<script src="https://rawgit.com/broadsw0rd/vectory/master/dist/vectory.min.js"></script>

var position = new Vector(0, 0)

Usage

Follow this link to read more about vectors' usage in the Daniel Shiffman's article

Support

• Latest Chrome, FF, Safari
• IE 9+
• Node 4+

API

Creation

• [x] new Vector(x, y)
• [x] Vector.from([x, y])
• [x] Vector.fromAngle(angle, magnitude)
• [x] Vector.parse(string)

Addition

• [x] Vector.add(one, another)
• [x] Vector.prototype.add(vector)
• [x] Vector.iadd(one, another)
• [x] Vector.prototype.iadd(vector)

Substraction

• [x] Vector.sub(one, another)
• [x] Vector.prototype.sub(vector)
• [x] Vector.isub(one, another)
• [x] Vector.prototype.isub(vector)

Multiplication

• [x] Vector.mul(scalar, vector)
• [x] Vector.prototype.mul(scalar)
• [x] Vector.imul(scalar, vector)
• [x] Vector.prototype.imul(scalar)

Division

• [x] Vector.div(scalar, vector)
• [x] Vector.prototype.div(scalar)
• [x] Vector.idiv(scalar, vector)
• [x] Vector.prototype.idiv(scalar)

Linear interpolation

• [x] Vector.lerp(one, another, t)
• [x] Vector.prototype.lerp(vector, t)

Normalization

• [x] Vector.normalized(vector)
• [x] Vector.prototype.normalized()
• [x] Vector.normalize(vector)
• [x] Vector.prototype.normalize()

Magnitude

• [x] Vector.magnitude(vector)
• [x] Vector.prototype.magnitude()

Dot product

• [x] Vector.dot(one, another)
• [x] Vector.prototype.dot(vector)

Distance

• [x] Vector.distance(one, another)
• [x] Vector.prototype.distance(vector)

Angle computing

• [x] Vector.angleOf(vector)
• [x] Vector.prototype.angleOf()
• [x] Vector.angleTo(one, another)
• [x] Vector.prototype.angleTo(vector)

Rotation

• [x] Vector.rotate(theta, vector)
• [x] Vector.prototype.rotate(theta)
• [x] Vector.irotate(theta, vector)
• [x] Vector.prototype.irotate(theta)

Resetting

• [x] Vector.reset(one, another)
• [x] Vector.prototype.reset(vector)
• [x] Vector.zero(vector)
• [x] Vector.prototype.zero()
• [x] Vector.set(x, y, vector)
• [x] Vector.prototype.set(x, y)

Copy

• [x] Vector.copy(vector) (alias Vector.clone(vector))
• [x] Vector.prototype.copy() (alias Vector.prototype.clone(vector))

Convertion

• [x] Vector.toJSON(vector)
• [x] Vector.prototype.toJSON()
• [x] Vector.toString(vector)
• [x] Vector.prototype.toString()
• [x] Vector.prototype[Symbol.toStringTag] (Latest Chrome and FF or shim)
• [x] Vector.toArray(vector)
• [x] Vector.prototype.toArray()

Equality

• [x] Vector.equals(one, another)
• [x] Vector.protototype.equals(vector)
• [x] Vector.compare(one, another)
• [x] Vector.protototype.compare(vector)

Swizzling

• [x] Vector.prototype.xx
• [x] Vector.prototype.xy
• [x] [`Vector.prot