MoverPoint

A basic Class representing a point/vector that will be used for movement.

Constructor

new MoverPoint(x, y)

Parameters:

Name	Type	Description
`x`	Number	The x position of the MoverPoint
`y`	Number	The y position of the MoverPoint

Members

_angle

_length

The square root of the squared length of the point. Math.sqrt(xx + yy); Use .getLength();

constructor

x

The x position of the MoverPoint

y

The y position of the MoverPoint.

Methods

(static) angleBetweenMoverPoints(mp1, mp2) → {Number}

Returns the angel between the two given MoverPoints

Parameters:

Name	Type	Description
`mp1`	MoverPoint
`mp2`	MoverPoint

Returns:

Type: Number

(static) distBetween(mp1, mp2) → {Number}

Returns the distance between the two points.

Parameters:

Name	Type	Description
`mp1`	MoverPoint
`mp2`	MoverPoint

Returns:

Type: Number

(static) squaredDistanceBetween(mp1, mp2) → {Number}

Returns the squared distance between the two MoverPoints.

Parameters:

Name	Type	Description
`mp1`	MoverPoint
`mp2`	MoverPoint

Returns:

Type: Number

add(mp, makeNew) → {MoverPoint}

Parameters:

Name	Type	Description
`mp`	MoverPoint
`makeNew`	Boolean

Returns:

Type: MoverPoint

addBy(xAmount, yAmount, makeNew) → {MoverPoint}

Parameters:

Name	Type	Description
`xAmount`	Number
`yAmount`	Number
`makeNew`	Boolean

Returns:

Type: MoverPoint

clone() → {MoverPoint}

Returns a new MoverPoint that has the same values as this.

Returns:

Type: MoverPoint

dist(mp) → {Number}

Returns the distance between the given MoverPoint and this.

Parameters:

Name	Type	Description
`mp`	MoverPoint

Returns:

Type: Number

divide(value, makeNew) → {MoverPoint}

Parameters:

Name	Type	Description
`value`	Number	The amount to divide x and y by.
`makeNew`	Boolean

Returns:

Type: MoverPoint

dotProduct(mp) → {Number}

Parameters:

Name	Type	Description
`mp`	moverPoint

Returns:

Type: Number

equals(mp) → {Boolean}

Returns true if the given MoverPoint has the same values as this.

Parameters:

Name	Type	Description
`mp`	MoverPoint

Returns:

Type: Boolean

getAngle() → {Number}

Sets ._angle to the atangent of y and x if it is not set, then returns _angle.

Returns:

Type: Number

getLength() → {Number}

Returns the length of the MoverPoint.

Returns:

Type: Number

getSquaredLength() → {Number}

Returns:

Type: Number

getX() → {Number}

Returns:

Type: Number

getY() → {Number}

Returns:

Type: Number

lesserClone() → {MoverPoint}

Uses a MoverPoint from a pool of premade MoverPoints.

Returns:

Type: MoverPoint

multiply(value, makeNew) → {MoverPoint}

Parameters:

Name	Type	Description
`value`
`makeNew`

Returns:

Type: MoverPoint

normalize() → {MoverPoint}

Divides x and y by length. Normalizes the point to a unit vector.

Returns:

Type: MoverPoint

perp() → {MoverPoint}

A MoverPoint perpendicular to this one.

Returns:

Type: MoverPoint

reset()

Resets the values of the MoverPoint.

reverse() → {MoverPoint}

Returns this MoverPoint with its values reversed.

Returns:

Type: MoverPoint

setAngle(toThis)

Sets _angle to the value given.

Parameters:

Name	Type	Description
`toThis`	Number

setLength(toThis)

Sets the length of the MoverPoint to the value given.

Parameters:

Name	Type	Description
`toThis`	Number

setX(toThis)

Parameters:

Name	Type	Description
`toThis`

setY(toThis)

Parameters:

Name	Type	Description
`toThis`

sign(mp) → {Number}

Parameters:

Name	Type	Description
`mp`	MoverPoint

Returns:

Type: Number

squaredDistance(mp) → {Number}

Parameters:

Name	Type	Description
`mp`	MoverPoint

Returns:

Type: Number

subtract(mp, makeNew) → {MoverPoint}

Subtracts the values of mp from this MoverPoint and returns this or a new MoverPoint.

Parameters:

Name	Type	Description
`mp`	MoverPoint
`makeNew`	Boolean

Returns:

Type: MoverPoint

subtractBy(xAmount, yAmount, makeNew) → {MoverPoint}

Parameters:

Name	Type	Description
`xAmount`	Number
`yAmount`	Number
`makeNew`	Boolean	If true a new MoverPoint is returned, otherwise this is returned.

Returns:

Type: MoverPoint

truncate(max) → {MoverPoint}

Parameters:

Name	Type	Description
`max`	Number

Returns:

Type: MoverPoint