npm.io
1.0.3 • Published 6 years ago

2dv

Licence
ISC
Version
1.0.3
Deps
0
Size
14 kB
Vulns
0
Weekly
0
Stars
3

2dv — Vector calculation package written in TypeScript

build npm

Very useful small class to perform vector calculations. Very practical as basis for all kinds of simulations and games where objects move through a two-dimensional space.

Get started

npm i 2dv

Use in your JavaScript/Typescript project

import { Vector } from '2dv';
// OR
const { Vector } = require('2dv');

const myVector = new Vector(10, 20);

myVector.add(100);
…

const newVector = Vector.add(myVector, 10);
…

Overview

Detailed documentation: https://wetterben.github.io/2dv/

Properties
  • x
  • y
Accessors
  • angle
  • length
  • magnitude
  • max
  • min
Methods
Instance
  • add
  • angleTo
  • clone
  • crossProduct
  • divide
  • dotProduct
  • equals
  • inverse
  • multiply
  • normalize
  • set
  • sub
  • toArray
Static
  • add
  • angleBetween
  • closestPointBetween
  • crossProduct
  • distance
  • divide
  • dotProduct
  • equals
  • fromArray
  • inverse
  • isOnLine
  • multiply
  • normalize
  • pointBetween
  • sub

Documentation

You can find a detailed documentation of all methods here: https://wetterben.github.io/2dv/

Roadmap

  • Automated tests
  • Visual Demo
  • More methods

Contribute

Feel free to add missing functions or fix things. Just do a PR.

Keywords