Class: Vector

Vector

Vector This is a basic vector class that is used for geometry, position inforamtion, movement infomation, and more complex structures. The vector class follows a immutable paradigm where changes are not made to the vectors themselves. Any change to a vector is returned as a new vector that must be captured.

new Vector(x, y)

geometry/Vector.js, line 26

Create a 2D Vector object

This vector class was constructed so that it can mirror two types of common point/vector type objects. This is having object properties stored as object properties (eg. vector.x, vector.y) or as list properties, [x, y] which can be accessed by vector[0], or vector[1].
Name Type Description
x number | Vector The x component or another vector
y number optional The y component
Properties:
Name Type Description
x number The x vector component
y number The y vector component
0 number The x vector component
1 number The y vector component

Methods

staticVector.add(a, b){Vector}

geometry/Vector.js, line 114
Add two vectors element wise
Name Type Description
a Vector The first vector
b Vector The second vector
Returns:
Type Description
Vector The vector result of adding the two vectors

staticVector.angle(a, b)

geometry/Vector.js, line 317
Get the angle between two vectors
Name Type Description
a Vector The frist vector
b Vector The second vector
Returns:
The angle between vector a and vector b

staticVector.avg(vectors)

geometry/Vector.js, line 232
Get the average location between several vectors
Name Type Description
vectors Array.<Vector> The list of vectors to average

staticVector.copy(v){Vector}

geometry/Vector.js, line 89
Get a copy of the input vector
Name Type Description
v Vector the vector to be coppied
Returns:
Type Description
Vector The vector copy

staticVector.cross(a, b){number}

geometry/Vector.js, line 261
Get the cross product of two vectors
Name Type Description
a Vector The first vector
b Vector The second vector
Returns:
Type Description
number The cross product of the two vectors

staticVector.dist2(a, b)

geometry/Vector.js, line 347
Get the euclidean distnace squared between two vectors. This is used as a helper for the distnace function but can be used to save on speed by not doing the square root operation.
Name Type Description
a Vector The first vector
b Vector The second vector
See:
  • distnace
Returns:
The euclidean distance squared between vector a and vector b

staticVector.distance(a, b)

geometry/Vector.js, line 331
Get the euclidean distance between two vectors
Name Type Description
a Vector The first vector
b Vector The second vector
See:
  • dist2
Returns:
The euclidean distance between a and b

staticVector.distToSeg(p, v, w)

geometry/Vector.js, line 366
Get the shortest distance between the point p and the line segment v to w.
Name Type Description
p Vector The vector point
v Vector The first line segment endpoint
w Vector The second line segment endpoint
See:
Returns:
The shortest euclidean distance between point

staticVector.distToSegSquared(p, v, w)

geometry/Vector.js, line 383
Get the shortest distance squared between the point p and the line segment v to w.
Name Type Description
p Vector The vector point
v Vector The first line segment endpoint
w Vector The second line segment endpoint
See:
Returns:
The shortest euclidean distance squared between point

staticVector.dot(a, b){number}

geometry/Vector.js, line 222
Get the dot product of two vectors
Name Type Description
a Vector The first vector
b Vector The second vector
Returns:
Type Description
number The dot product of the two vectors

staticVector.down(){Vector}

geometry/Vector.js, line 443
Get the unit vector pointing in the negative y direction
Returns:
Type Description
Vector Unit vector pointing down

staticVector.left(){Vector}

geometry/Vector.js, line 456
Get the unit vector pointing in the negative x direction
Returns:
Type Description
Vector Unit vector pointing right

staticVector.midpoint(a, b)

geometry/Vector.js, line 288
Get the midpoint between two vectors
Name Type Description
a Vector The first vector
b Vector The second vector
Returns:
The midpoint of two vectors

staticVector.proj(a, b)

geometry/Vector.js, line 303
Get the projection of vector a onto vector b
Name Type Description
a Vector The first vector
b Vector The second vector
TODO
  • Add assertion for non-zero length b vector
Returns:
The projection vector of a onto b

staticVector.right(){Vector}

geometry/Vector.js, line 469
Get the unit vector pointing in the positive x direction
Returns:
Type Description
Vector Unit vector pointing right

staticVector.subtract(a, b){Vector}

geometry/Vector.js, line 138
Subtract two vectors element wise
Name Type Description
a Vector The first vector
b Vector The second Vector
Returns:
Type Description
Vector The vector result of subtracting the two vectors

staticVector.up(){Vector}

geometry/Vector.js, line 430
Get the unit vector pointing in the positive y direction
Returns:
Type Description
Vector Unit vector pointing up

staticVector.zero(){Vector}

geometry/Vector.js, line 417
Get a vector of no magnitude and no direction
Returns:
Type Description
Vector Vector of magnitude zero

add(other){Vector}

geometry/Vector.js, line 125
Add this vector with another vector element wise
Name Type Description
other Vector The other vector
Returns:
Type Description
Vector The vector result of adding the two vectors

cross(other){number}

geometry/Vector.js, line 272
Get the cross product of this and the other vector
Name Type Description
other Vector The other vector
Returns:
Type Description
number The cross product of this and the other vector

divide(scalar){Vector}

geometry/Vector.js, line 172
Divide the vector by a scalar value
Name Type Description
scalar number
Returns:
Type Description
Vector The result of multiplying the vector by a scalar

dot(other){number}

geometry/Vector.js, line 248
Get the dot product of this vector and another vector
Name Type Description
other Vector The other vector
Returns:
Type Description
number The dot product of this and the other vector

key(){Symbol}

geometry/Vector.js, line 57
Get the vector key:Symbol representation
Returns:
Type Description
Symbol The vector key element

list(){Array.<number>}

geometry/Vector.js, line 68
Get the vector in list form
Returns:
Type Description
Array.<number> List representation of the vector of length 2

magnitude(){number}

geometry/Vector.js, line 184
Get the magnitude of the vector
Returns:
Type Description
number The magniture of the vector

multiply(scalar){Vector}

geometry/Vector.js, line 161
Multiply the vector by a scalar value
Name Type Description
scalar number The number to multiply the vector by
Returns:
Type Description
Vector The result of multiplying the vector by a scalar element wise

normalize(){Vector}

geometry/Vector.js, line 195
Get the normal vector of the current vector.
Returns:
Type Description
Vector A vector that is the normal compenent of the vector

perpendiculars(){Array.<Vector>}

geometry/Vector.js, line 401
Get the two normal vectors that are perpendicular to the current vector
Returns:
Type Description
Array.<Vector> The two normal vectors that are perpendicular to the vector. The first vector is the normal vector that is +90 deg or +PI/2 rad. The second vector is the noraml vector that is -90 deg or -PI/2 rad.

rotate(radians){Vector}

geometry/Vector.js, line 207
Get the get the current vector rotated by a certain ammount
Name Type Description
radians number
Returns:
Type Description
Vector The vector that results from rotating the current vector by a particular ammount

subtract(other){Vector}

geometry/Vector.js, line 149
Subtract this vector with another vector element wise
Name Type Description
other Vector The other vector
Returns:
Type Description
Vector The vector result of subtracting the two vectors

toString(){string}

geometry/Vector.js, line 78
Returns the vector as a string of (x, y)
Returns:
Type Description
string The string representation of a vector in (x, y) form

toString(){string}

geometry/Vector.js, line 99
Returns the vector as a string of (x, y)
Returns:
Type Description
string The string representation of a vector in (x, y) form