Vector - Documentation

Constructor

new Vector(x, y, z)

Source:

vector.js, line 35

Parameters:

Name	Type	Description
`x`	float
`y`	float
`z`	float

Classes

Vector

Methods

add(b) → {Vector}

Source:

vector.js, line 122

Parameters:

Name	Type	Description
`b`	Vector

Returns:

Type: Vector

addScalar(b) → {Vector}

Source:

vector.js, line 159

Parameters:

Name	Type	Description
`b`	Float

Returns:

Type: Vector

cross(b) → {Vector}

Source:

vector.js, line 101

Parameters:

Name	Type	Description
`b`	Vector

Returns:

Type: Vector

distance(b)

Source:

vector.js, line 62

Parameters:

Name	Type	Description
`b`	Vector	is the point to check distance to

Returns:

distance as float

distanceSquared(b) → {Number}

Source:

vector.js, line 83

Parameters:

Name	Type	Description
`b`	Vector

Returns:

Type: Number

div(b) → {Vector}

Source:

vector.js, line 150

Parameters:

Name	Type	Description
`b`	Vector

Returns:

Type: Vector

divScalar(b) → {Vector}

Source:

vector.js, line 186

Parameters:

Name	Type	Description
`b`	Float

Returns:

Type: Vector

dot(b) → {Number}

Description:

dot product @see https://en.wikipedia.org/wiki/Dot_product

Source:

vector.js, line 92

Parameters:

Name	Type	Description
`b`	Vector

Returns:

Type: Number

length()

Source:

vector.js, line 53

Returns:

the length of the vector

lengthSquared() → {Number}

Source:

vector.js, line 73

Returns:

The length of the curren vector

Type: Number

minComponent()

Source:

vector.js, line 219

Returns:

whatever vector is lowest

mulScalar(b) → {Vector}

Source:

vector.js, line 177

Parameters:

Name	Type	Description
`b`	Float

Returns:

Type: Vector

mult(b) → {Vector}

Source:

vector.js, line 141

Parameters:

Name	Type	Description
`b`	Vector

Returns:

Type: Vector

normalize() → {Vector}

Source:

vector.js, line 112

Returns:

Vector between 0 and 1

Type: Vector

segmentDistance(v, w) → {Vector}

Source:

vector.js, line 229

Parameters:

Name	Type	Description
`v`	Vector
`w`	Number

Returns:

Type: Vector

sub(b) → {Vector}

Source:

vector.js, line 131

Parameters:

Name	Type	Description
`b`	Vector

Returns:

Type: Vector

subScalar(b) → {Vector}

Source:

vector.js, line 168

Parameters:

Name	Type	Description
`b`	Float

Returns:

Type: Vector