Class: Vector

Constructor

new Vector(xopt, yopt, zopt)

Parameters:

Name	Type	Attributes
`x`	number	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 6

Methods

add(vopt, yopt, zopt)

adds two vectors together

Parameters:

Name	Type	Attributes
`v`	number \| Vector \| Array \| Object	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 73
See: Vector.from for parameters

array() → {Array.<number>}

returns the array form of the vector

Source: addons/vector.js, line 238

Returns:

the array

Type:: Array.<number>

cross(vopt, yopt, zopt) → {Vector}

get the cross product of two vectors

Parameters:

Name	Type	Attributes
`v`	number \| Vector \| Array \| Object	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 156
See: Vector.from for parameters

Returns:

the cross product

Type:: Vector

dist(vec) → {number}

gets the distance between two vectors

Parameters:

Name	Type	Description
`vec`	Vector	vector

Source: addons/vector.js, line 133

Returns:

the distance

Type:: number

div(vopt, yopt, zopt)

divide one vector from another

Parameters:

Name	Type	Attributes
`v`	number \| Vector \| Array \| Object	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 112
See: Vector.from for parameters

dot(vopt, yopt, zopt) → {number}

get the dot product of two vectors

Parameters:

Name	Type	Attributes
`v`	number \| Vector \| Array \| Object	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 144
See: Vector.from for parameters

Returns:

the dot product

Type:: number

get() → {Vector}

returns a new vector with the same (x, y, z) values

Source: addons/vector.js, line 22

Returns:

copied vector

Type:: Vector

heading() → {number}

returns the angle of the vector only for 2D vectors

Source: addons/vector.js, line 224

Returns:

angle

Type:: number

lerp(vopt, yopt, zopt)

lerps a vector toward another

Parameters:

Name	Type	Attributes
`v`	number \| Vector \| Array \| Object	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 195
See: Vector.from for parameters

limit(len)

limit the length of a vector

Parameters:

Name	Type	Description
`len`	number	length

Source: addons/vector.js, line 213

mag() → {number}

returns the magnitude of the vector

Source: addons/vector.js, line 39

Returns:

the magnitude

Type:: number

magSq() → {number}

returns the squared magnitude of the vector

Source: addons/vector.js, line 46

Returns:

the squared magnitude

Type:: number

mult(vopt, yopt, zopt)

multiply two vectors together

Parameters:

Name	Type	Attributes
`v`	number \| Vector \| Array \| Object	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 99
See: Vector.from for parameters

normalize()

normalizes a vector to length 1

Source: addons/vector.js, line 205

object() → {Object}

returns the object form of the vector

Source: addons/vector.js, line 231

Returns:

the object

Type:: Object

project(vopt, yopt, zopt) → {Vector}

xxx HS16 Projects the current vector onto another

Parameters:

Name	Type	Attributes
`v`	number \| Vector \| Array \| Object	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 177

Returns:

The projected vector

Type:: Vector

rotate(ang)

rotates a vector a certain angle for 2D vectors only

Parameters:

Name	Type	Description
`ang`	number	angle

Source: addons/vector.js, line 123

set(vopt, yopt, zopt)

sets the value of a vector

Parameters:

Name	Type	Attributes
`v`	number \| Vector \| Array \| Object	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 32
See: Vector.from for parameters

setMag(vec, lenopt) → {Vector}

sets the magnitude of the vector

Parameters:

Name	Type	Attributes	Description
`vec`	number \| Vector		length or vector
`len`	number	<optional>	length

Source: addons/vector.js, line 55

Returns:

only if len is defined

Type:: Vector

sub(vopt, yopt, zopt)

subtracts one vector from another

Parameters:

Name	Type	Attributes
`v`	number \| Vector \| Array \| Object	<optional>
`y`	number	<optional>
`z`	number	<optional>

Source: addons/vector.js, line 86
See: Vector.from for parameters

toString() → {string}

returns the string form of the vector

Source: addons/vector.js, line 245

Returns:

the string of the vector coordinates

Type:: string

(static) angleBetween(vec1, vec2) → {number}

returns the angle between two vectors

Parameters:

Name	Type	Description
`vec1`	Vector
`vec2`	Vector

Source: addons/vector.js, line 315

Returns:

angle

Type:: number

(static) from(vopt, yopt, zopt) → {Vector}

takes any range of values an' makes 'em a vector. aka magic.

Parameters:

Name	Type	Attributes	Default	Description
`v`	number \| Vector \| Array \| Object	<optional>		if y, Vector, object, or array of values representing the vector; else, x coordinate.
`y`	number	<optional>
`z`	number	<optional>	0

Source: addons/vector.js, line 256

Returns:

Type:: Vector

(static) fromAngle(ang, vecopt) → {Vector}

creates a vector from an angle

Parameters:

Name	Type	Attributes	Default	Description
`ang`	number			angle
`vec`	Vector	<optional>	new Vector	vector

Source: addons/vector.js, line 273

Returns:

the vector

Type:: Vector

(static) random2D(vecopt) → {Vector}

creates a random 2D vector

Parameters:

Name	Type	Attributes	Default	Description
`vec`	Vector	<optional>	new Vector	vector

Source: addons/vector.js, line 284

Returns:

the vector

Type:: Vector

(static) random3D(vecopt) → {Vector}

creates a random 3D vector

Parameters:

Name	Type	Attributes	Default	Description
`vec`	Vector	<optional>	new Vector	vector

Source: addons/vector.js, line 297

Returns:

the vector

Type:: Vector