geom-vector2d
v0.0.1
Published
2d geometric vectors
Downloads
1
Readme
#Vector2D x-------------------------------->
2D geometric vector library
##SetUp
npm install vector2d
note: Vector2D is compatiable with: commonjs, amd or as a stand-alone library
##Use
var v1 = new Vector2D(0,1);
var v2 = new Vector2D(1,0);
v1.add(v2)// v1 is now <1,1>
v1.dot(v2)// 1.0
###API
get()
returns the 2d vector instanceadd(v)
adds two vectorssub(v)
subtracts two vectorsmult(n)
multiples vector by scalarget(n)
divides vector by scalarmag()
returns magnitude of the vector instancenormalize()
unit vectorizeheading()
angle of rotationdot(v)
dot productangle(v)
angle between to vectors in radians- more coming soon...(make a pull request!)
##Contribute
npm install
npm test
##License The MIT License (MIT)
Copyright (c) 2014 Paul Serraino
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.