module:Vector

Constructor

new module:Vector(start, end)

Vector constructor

Parameters:

Name	Type	Description
`start`	PositionDefinition	Starting vector's position
`end`	PositionDefinition	Ending vector's position

Source: modules/vector/vector.js, line 31

Members

height

Get this vector vertical component

Source: modules/vector/vector.js, line 53

length

Return this vector's length

Source: modules/vector/vector.js, line 61

width

Get this vector horizontal component

Source: modules/vector/vector.js, line 45

Methods

(static) from(vectorDefinitionopt) → {Vector}

Create a Vector from a generic definition

Parameters:

Name	Type	Attributes	Description
`vectorDefinition`	VectorDefinition	<optional>	Vector definition

Source: modules/vector/vector.js, line 225

Returns:

Type:: Vector

add(modification) → {Vector}

Add a vector

Parameters:

Name	Type	Description
`modification`	VectorDefinition \| PositionDefinition \| Number	Any Vector or Position or Number

Source: modules/vector/vector.js, line 95

Returns:

Itself

Type:: Vector

clone() → {Vector}

Create a new copy of this vector

Source: modules/vector/vector.js, line 69

Returns:

Type:: Vector

getClosestToPoint(positionDefinition) → {Position}

Find the closest position to a point on this vector

Parameters:

Name	Type	Description
`positionDefinition`	PositionDefinition	Any position

Source: modules/vector/vector.js, line 190

Returns:

Type:: Position

getDelta() → {Position}

Get the vector move with start at (0, 0)

Source: modules/vector/vector.js, line 87

Returns:

Type:: Position

getIntersectionPoint(vectorDefinition) → {Position}

Return the intersection point between two vector or null if no intersection happen

Parameters:

Name	Type	Description
`vectorDefinition`	VectorDefinition	Any vector

Source: modules/vector/vector.js, line 166

Returns:

Type:: Position

intersect(vectorDefinition) → {Boolean}

Define if this vector intersect another

Parameters:

Name	Type	Description
`vectorDefinition`	VectorDefinition	Any vector

Source: modules/vector/vector.js, line 134

Returns:

Type:: Boolean

multiply(modification) → {Vector}

Multiply this vector

Parameters:

Name	Type	Description
`modification`	VectorDefinition \| PositionDefinition \| Number	Any Vector or Position or Number

Source: modules/vector/vector.js, line 118

Returns:

Itself

Type:: Vector

toJSON() → {Array.<Array.<Number>>}

Return a JSON ready Vector definition

Source: modules/vector/vector.js, line 205

Returns:

Type:: Array.<Array.<Number>>

translate(modification) → {Vector}

Move this vector

Parameters:

Name	Type	Description
`modification`	VectorDefinition \| PositionDefinition \| Number	Any Vector or Position or Number

Source: modules/vector/vector.js, line 106

Returns:

Itself

Type:: Vector

(inner) sanitizeParameters(definition) → {Position|Number}

Accept all kind of type and return only Number or Position

Parameters:

Name	Type	Description
`definition`	VectorDefinition \| PositionDefinition \| Number	Value definition

Source: modules/vector/vector.js, line 9

Returns:

Type:: Position | Number

Type Definitions

AbstractVector

Type:

Object

Properties

Name	Type	Attributes	Description
`start`	PositionDefinition	<optional>	Start coordinates
`end`	PositionDefinition	<optional>	End coordinates

Source: modules/vector/vector.js, line 217

VectorDefinition

Type:

Array.<PositionDefinition> | AbstractVector

Source: modules/vector/vector.js, line 222