2d and 3d vector using the same code


Keywords
vector, math, physics
License
ISC
Install
npm install vectorx@3.3.1

Documentation

Vector2D and Vector3D class for all your vector needs

A vector2D and vector3D class that hold probably any vector operation that you would ever need(knock on wood).
1 feature that javascript doesn't have is is generics or templates which is what i was hoping to work around using javascript classes.
nearly all methods return themselve again so chaining methods together is more than possible.

example to invert a vector and add 3 to it

//var Vector2 = require('vectorx').Vector2
var Vector3 = require('vectorx').Vector3

var myVector = new Vector3(10,5,2);
var changedVecor = myVector.c().scale(-1).add(new Vector3(3,0,0))

notice the .c() that method makes a copy of myVector otherwise myVector and changedVector wuld point to the same object.

shared methods

add(vector)
adds another vector to this one modifying itself

sub(vector)
subtracts another vector from this one modifiying itself

scale(number)
scales this factor by a number(scalar) modifying itself

normalize()
sets this vectors length to 1

length()
calculates the length of this vector

lerp(vector, weight)
linearly interpolates to the second vector

project(vector)
projects this vector onto another one modifying itself

dot(vector)
calculates the dot product of this and the other vector

c()
make a copy of this vector and returns the copy

equals(vector)
returns true if all fieds are equal to the other vector and false otherwise

overwrite(vector)
sets this vector's values to the other one

iterate(callback(i))
calls the callback as many times as the vector has dimensions. mainly meant to replace this code construct

for(var i = 0; i < this.dimensions;i++){
    console.log(this.get(i))
}

with this

return this.iterate((i) => console.log(this.get(i)))

loop(callback(array))
calls the callback once with each possible combination of the values. very useful with 2d vectors and 2d arrays so you dont have to write that nested for loop. replaces this code construct

for(int x = 0; x < vector.x; x++){
    for(int y = 0; y < vector.y; y++){
        //some code that can now be replaced with the callback
        console.log(`x:${x}, y:${y}`)
    }
}

becomes

myvector.loop((array) => {
    console.log(`x:${array[0]}, y:${array[1]}`)
})

get(i)
gets the corresponding value of the vector x being 0, y 1 and z 2 very useful in combination with iterate

set(i, value)
sets the corresponding value of the vector just like get and sets it to the passed in value very useful in combination with iterate

toArray()
returns an the vector in array form

static fromArray(array)
turns an array into a vector

2d

draw(2DcanvasContext)
draws the vector on the passed in graphicsContect

3d

cross(vector)
calculates the cross product and returns it as a new vector