Maths

new Maths()

A Math class containing useful math functions. This class contains all the Mathamatical functions used by the engine. This class is static and should not be instantiated.

Source: maths/math.js, line 3

Members

(static, readonly) DEG_TO_RAD :number

Constant to multiply by to convert from degrees to radians.

Type:

number

Source: maths/math.js, line 32

(static, readonly) EXP :number

The value of e. Same as Math.E

Type:

number

Source: maths/math.js, line 25

(static, readonly) METER_TO_PIXEL :number

Constatnt to multiply by to convert Meter to Pixel.

Type:

number

Source: maths/math.js, line 46

(static, readonly) PI :number

The Value of PI. Same as Math.PI

Type:

number

Source: maths/math.js, line 18

(static, readonly) PIXEL_TO_METER :number

Constant to multiply by to convert from Pixel to Meter.

Type:

number

Source: maths/math.js, line 53

(static, readonly) RAD_TO_DEG :number

Constant to multiply by to convert from radians to degrees.

Type:

number

Source: maths/math.js, line 39

(static, readonly) VERY_LARGE_NUMBER :number

Very large number. This number is in meters. It is used in physics for aproximate equality.

Type:

number

Source: maths/math.js, line 70

(static, readonly) VERY_SMALL_NUMBER :number

Very small number. This number is in meters. It is used in physics for aproximate equality.

Type:

number

Source: maths/math.js, line 62

Methods

(static) Clamp(value, min, max) → {number}

Clamp a number between a min and max value.

Parameters:

Name	Type	Description
`value`	number
`min`	number
`max`	number

Source: maths/math.js, line 162

Returns:

Type:: number

(static) Cross(vector1, vector2) → {number}

Find the cross product of two vectors. The cross product is the determinant of the two vectors. It is the lenght projection of one vector onto the perpendicular of the other.

Parameters:

Name	Type	Description
`vector1`	Vector2
`vector2`	Vector2

Source: maths/math.js, line 151

Returns:

Type:: number

(static) Distance(vector1, vector2) → {number}

Find the distance between two points.

Parameters:

Name	Type	Description
`vector1`	Vector2
`vector2`	Vector2

Source: maths/math.js, line 98

Returns:

Type:: number

(static) DistanceSq(vector1, vector2) → {number}

Find the distance between two points squared. Finding Square root is expensive. To compare distances, it is better to compare the square of the distances.

Parameters:

Name	Type	Description
`vector1`	Vector2
`vector2`	Vector2

Source: maths/math.js, line 109

Returns:

Type:: number

(static) Dot(vector1, vector2) → {number}

Find the dot product of two vectors. The dot product is the sum of the products of the corresponding components of the two vectors. It is the lenght projection of one vector onto the other.

Parameters:

Name	Type	Description
`vector1`	Vector2
`vector2`	Vector2

Source: maths/math.js, line 141

Returns:

Type:: number

(static) Lenght(vector) → {number}

Find the lenght of a vector.

Parameters:

Name	Type	Description
`vector`	Vector2

Source: maths/math.js, line 77

Returns:

Type:: number

(static) LenghtSq(vector) → {number}

Find the lenght of a vector squared. Finding Square root is expensive. To compare lenghts, it is better to compare the square of the lenghts.

Parameters:

Name	Type	Description
`vector`	Vector2

Source: maths/math.js, line 87

Returns:

Type:: number

(static) MeterToPixel(meter) → {number}

Convert Meter to Pixel.

Parameters:

Name	Type	Description
`meter`	number

Source: maths/math.js, line 191

Returns:

Type:: number

(static) MeterToPixelVector2(meter) → {Vector2}

Convert Vector2 from Meter to Pixel.

Parameters:

Name	Type	Description
`meter`	Vector2

Source: maths/math.js, line 209

Returns:

Type:: Vector2

(static) NearlyEqual(a, b) → {boolean}

Find if two numbers /Vectors are approximately equal.

Parameters:

Name	Type	Description
`a`	number	can be a number or a Vector2.
`b`	number	can be a number or a Vector2.

Source: maths/math.js, line 219

Returns:

Type:: boolean

(static) Normalize(vector) → {Vector2}

Normalize a vector. A normalized vector has a lenght of 1, but the same direction as the original vector.

Parameters:

Name	Type	Description
`vector`	Vector2

Source: maths/math.js, line 118

Returns:

Type:: Vector2

(static) Perpendicular(vector) → {Vector2}

Find perpendicular vector. The perpendicular vector is 90 degrees to the original vector.

Parameters:

Name	Type	Description
`vector`	Vector2

Source: maths/math.js, line 131

Returns:

Type:: Vector2

(static) PixelToMeter(pixel) → {number}

Convert Pixel to Meter.

Parameters:

Name	Type	Description
`pixel`	number

Source: maths/math.js, line 182

Returns:

Type:: number

(static) PixelToMeterVector2(pixel) → {Vector2}

Convert Vector2 from Pixel to Meter.

Parameters:

Name	Type	Description
`pixel`	Vector2

Source: maths/math.js, line 200

Returns:

Type:: Vector2

(static) RandomVector2(min, max) → {Vector2}

Get a random Vector2 between min and max.

Parameters:

Name	Type	Description
`min`	Vector2	The minimum value of the random vector.
`max`	Vector2	The maximum value of the random vector.

Source: maths/math.js, line 173

Returns:

A random vector between min and max.

Type:: Vector2