melonjs 15.2.1 → 15.4.0

package/src/math/vector2.js

@@ -5,7 +5,7 @@ import pool from "./../system/pooling.js";
  * @classdesc
  * a generic 2D Vector Object
  */
- export default class Vector2d {
+export default class Vector2d {
     /**
      * @param {number} [x=0] - x value of the vector
      * @param {number} [y=0] - y value of the vector
@@ -35,8 +35,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * set the Vector x and y properties to the given values<br>
-     * @name set
-     * @memberof Vector2d
      * @param {number} x
      * @param {number} y
      * @returns {Vector2d} Reference to this object for method chaining
@@ -71,8 +69,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * set the Vector x and y properties to 0
-     * @name setZero
-     * @memberof Vector2d
      * @returns {Vector2d} Reference to this object for method chaining
      */
     setZero() {
@@ -81,8 +77,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * set the Vector x and y properties using the passed vector
-     * @name setV
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -92,8 +86,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Add the passed vector to this vector
-     * @name add
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -103,8 +95,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Substract the passed vector to this vector
-     * @name sub
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -114,8 +104,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Multiply this vector values by the given scalar
-     * @name scale
-     * @memberof Vector2d
      * @param {number} x
      * @param {number} [y=x]
      * @returns {Vector2d} Reference to this object for method chaining
@@ -126,8 +114,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Convert this vector into isometric coordinate space
-     * @name toIso
-     * @memberof Vector2d
      * @returns {Vector2d} Reference to this object for method chaining
      */
     toIso() {
@@ -136,8 +122,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Convert this vector into 2d coordinate space
-     * @name to2d
-     * @memberof Vector2d
      * @returns {Vector2d} Reference to this object for method chaining
      */
     to2d() {
@@ -146,8 +130,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Multiply this vector values by the passed vector
-     * @name scaleV
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -157,8 +139,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Divide this vector values by the passed value
-     * @name div
-     * @memberof Vector2d
      * @param {number} n - the value to divide the vector by
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -168,8 +148,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Update this vector values to absolute values
-     * @name abs
-     * @memberof Vector2d
      * @returns {Vector2d} Reference to this object for method chaining
      */
     abs() {
@@ -178,8 +156,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Clamp the vector value within the specified value range
-     * @name clamp
-     * @memberof Vector2d
      * @param {number} low
      * @param {number} high
      * @returns {Vector2d} new me.Vector2d
@@ -190,8 +166,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Clamp this vector value within the specified value range
-     * @name clampSelf
-     * @memberof Vector2d
      * @param {number} low
      * @param {number} high
      * @returns {Vector2d} Reference to this object for method chaining
@@ -202,8 +176,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Update this vector with the minimum value between this and the passed vector
-     * @name minV
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -213,8 +185,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Update this vector with the maximum value between this and the passed vector
-     * @name maxV
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -224,8 +194,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Floor the vector values
-     * @name floor
-     * @memberof Vector2d
      * @returns {Vector2d} new me.Vector2d
      */
     floor() {
@@ -234,8 +202,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Floor this vector values
-     * @name floorSelf
-     * @memberof Vector2d
      * @returns {Vector2d} Reference to this object for method chaining
      */
     floorSelf() {
@@ -244,8 +210,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Ceil the vector values
-     * @name ceil
-     * @memberof Vector2d
      * @returns {Vector2d} new me.Vector2d
      */
     ceil() {
@@ -254,8 +218,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Ceil this vector values
-     * @name ceilSelf
-     * @memberof Vector2d
      * @returns {Vector2d} Reference to this object for method chaining
      */
     ceilSelf() {
@@ -264,8 +226,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Negate the vector values
-     * @name negate
-     * @memberof Vector2d
      * @returns {Vector2d} new me.Vector2d
      */
     negate() {
@@ -274,8 +234,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Negate this vector values
-     * @name negateSelf
-     * @memberof Vector2d
      * @returns {Vector2d} Reference to this object for method chaining
      */
     negateSelf() {
@@ -284,8 +242,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Copy the x,y values of the passed vector to this one
-     * @name copy
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -294,19 +250,9 @@ import pool from "./../system/pooling.js";
     }
 
     /**
-     * return true if the two vectors are the same
-     * @name equals
-     * @memberof Vector2d
-     * @method
-     * @param {Vector2d} v
-     * @returns {boolean}
-     */
-    /**
-     * return true if this vector is equal to the given values
-     * @name equals
-     * @memberof Vector2d
-     * @param {number} x
-     * @param {number} y
+     * return true if this vector is equal to the given values or vector
+     * @param {number|Vector2d|ObservableVector2d} x
+     * @param {number} [y]
      * @returns {boolean}
      */
     equals() {
@@ -325,8 +271,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * normalize this vector (scale the vector so that its magnitude is 1)
-     * @name normalize
-     * @memberof Vector2d
      * @returns {Vector2d} Reference to this object for method chaining
      */
     normalize() {
@@ -336,8 +280,6 @@ import pool from "./../system/pooling.js";
     /**
      * change this vector to be perpendicular to what it was before.<br>
      * (Effectively rotates it 90 degrees in a clockwise direction)
-     * @name perp
-     * @memberof Vector2d
      * @returns {Vector2d} Reference to this object for method chaining
      */
     perp() {
@@ -346,8 +288,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
-     * @name rotate
-     * @memberof Vector2d
      * @param {number} angle - The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around
      * @returns {Vector2d} Reference to this object for method chaining
@@ -372,8 +312,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the dot product of this vector and the passed one
-     * @name dot
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {number} The dot product.
      */
@@ -383,8 +321,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the cross product of this vector and the passed one
-     * @name cross
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {number} The cross product.
      */
@@ -392,10 +328,8 @@ import pool from "./../system/pooling.js";
         return this.x * v.y - this.y * v.x;
     }
 
-   /**
+    /**
     * return the square length of this vector
-    * @name length2
-    * @memberof Vector2d
     * @returns {number} The length^2 of this vector.
     */
     length2() {
@@ -404,8 +338,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the length (magnitude) of this vector
-     * @name length
-     * @memberof Vector2d
      * @returns {number} the length of this vector
      */
     length() {
@@ -414,8 +346,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Linearly interpolate between this vector and the given one.
-     * @name lerp
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @param {number} alpha - distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
      * @returns {Vector2d} Reference to this object for method chaining
@@ -428,13 +358,11 @@ import pool from "./../system/pooling.js";
 
     /**
      * interpolate the position of this vector towards the given one by the given maximum step.
-     * @name moveTowards
-     * @memberof Vector2d
      * @param {Vector2d} target
      * @param {number} step - the maximum step per iteration (Negative values will push the vector away from the target)
      * @returns {Vector2d} Reference to this object for method chaining
      */
-     moveTowards(target, step) {
+    moveTowards(target, step) {
         let angle = Math.atan2(target.y - this.y, target.x - this.x);
 
         let distance = this.distance(target);
@@ -451,8 +379,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the distance between this vector and the passed one
-     * @name distance
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {number}
      */
@@ -463,8 +389,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the angle between this vector and the passed one
-     * @name angle
-     * @memberof Vector2d
      * @param {Vector2d} v
      * @returns {number} angle in radians
      */
@@ -474,8 +398,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * project this vector on to another vector.
-     * @name project
-     * @memberof Vector2d
      * @param {Vector2d} v - The vector to project onto.
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -486,8 +408,6 @@ import pool from "./../system/pooling.js";
     /**
      * Project this vector onto a vector of unit length.<br>
      * This is slightly more efficient than `project` when dealing with unit vectors.
-     * @name projectN
-     * @memberof Vector2d
      * @param {Vector2d} v - The unit vector to project onto.
      * @returns {Vector2d} Reference to this object for method chaining
      */
@@ -497,8 +417,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return a clone copy of this vector
-     * @name clone
-     * @memberof Vector2d
      * @returns {Vector2d} new me.Vector2d
      */
     clone() {
@@ -507,8 +425,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * convert the object to a string representation
-     * @name toString
-     * @memberof Vector2d
      * @returns {string}
      */
     toString() {

package/src/math/vector3.js

@@ -5,7 +5,7 @@ import pool from "./../system/pooling.js";
  * @classdesc
  * a generic 3D Vector Object
  */
- export default class Vector3d {
+export default class Vector3d {
     /**
      * @param {number} [x=0] - x value of the vector
      * @param {number} [y=0] - y value of the vector
@@ -38,8 +38,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * set the Vector x and y properties to the given values<br>
-     * @name set
-     * @memberof Vector3d
      * @param {number} x
      * @param {number} y
      * @param {number} [z=0]
@@ -84,8 +82,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * set the Vector x and y properties to 0
-     * @name setZero
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     setZero() {
@@ -94,8 +90,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * set the Vector x and y properties using the passed vector
-     * @name setV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -105,8 +99,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Add the passed vector to this vector
-     * @name add
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -116,8 +108,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Substract the passed vector to this vector
-     * @name sub
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -127,8 +117,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Multiply this vector values by the given scalar
-     * @name scale
-     * @memberof Vector3d
      * @param {number} x
      * @param {number} [y=x]
      * @param {number} [z=1]
@@ -140,8 +128,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Multiply this vector values by the passed vector
-     * @name scaleV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -151,8 +137,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Convert this vector into isometric coordinate space
-     * @name toIso
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     toIso() {
@@ -161,8 +145,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Convert this vector into 2d coordinate space
-     * @name to2d
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     to2d() {
@@ -171,8 +153,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Divide this vector values by the passed value
-     * @name div
-     * @memberof Vector3d
      * @param {number} n - the value to divide the vector by
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -182,8 +162,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Update this vector values to absolute values
-     * @name abs
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     abs() {
@@ -192,8 +170,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Clamp the vector value within the specified value range
-     * @name clamp
-     * @memberof Vector3d
      * @param {number} low
      * @param {number} high
      * @returns {Vector3d} new me.Vector3d
@@ -204,8 +180,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Clamp this vector value within the specified value range
-     * @name clampSelf
-     * @memberof Vector3d
      * @param {number} low
      * @param {number} high
      * @returns {Vector3d} Reference to this object for method chaining
@@ -216,8 +190,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Update this vector with the minimum value between this and the passed vector
-     * @name minV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -228,8 +200,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Update this vector with the maximum value between this and the passed vector
-     * @name maxV
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -240,8 +210,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Floor the vector values
-     * @name floor
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     floor() {
@@ -250,8 +218,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Floor this vector values
-     * @name floorSelf
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     floorSelf() {
@@ -260,8 +226,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Ceil the vector values
-     * @name ceil
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     ceil() {
@@ -270,8 +234,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Ceil this vector values
-     * @name ceilSelf
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     ceilSelf() {
@@ -280,8 +242,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Negate the vector values
-     * @name negate
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     negate() {
@@ -290,8 +250,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Negate this vector values
-     * @name negateSelf
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     negateSelf() {
@@ -300,8 +258,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Copy the components of the given vector into this one
-     * @name copy
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -310,19 +266,9 @@ import pool from "./../system/pooling.js";
     }
 
     /**
-     * return true if the two vectors are the same
-     * @name equals
-     * @memberof Vector3d
-     * @method
-     * @param {Vector2d|Vector3d} v
-     * @returns {boolean}
-     */
-    /**
-     * return true if this vector is equal to the given values
-     * @name equals
-     * @memberof Vector3d
-     * @param {number} x
-     * @param {number} y
+     * return true if this vector is equal to the given values or vector
+     * @param {number|Vector2d|ObservableVector2d|Vector3d|ObservableVector3d} x
+     * @param {number} [y]
      * @param {number} [z]
      * @returns {boolean}
      */
@@ -349,8 +295,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * normalize this vector (scale the vector so that its magnitude is 1)
-     * @name normalize
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     normalize() {
@@ -360,8 +304,6 @@ import pool from "./../system/pooling.js";
     /**
      * change this vector to be perpendicular to what it was before.<br>
      * (Effectively rotates it 90 degrees in a clockwise direction around the z axis)
-     * @name perp
-     * @memberof Vector3d
      * @returns {Vector3d} Reference to this object for method chaining
      */
     perp() {
@@ -370,8 +312,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Rotate this vector (counter-clockwise) by the specified angle (in radians) around the z axis
-     * @name rotate
-     * @memberof Vector3d
      * @param {number} angle - The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] - an optional point to rotate around (on the same z axis)
      * @returns {Vector3d} Reference to this object for method chaining
@@ -397,8 +337,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the dot product of this vector and the passed one
-     * @name dot
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {number} The dot product.
      */
@@ -408,8 +346,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * calculate the cross product of this vector and the passed one
-     * @name cross
-     * @memberof Vector3d
      * @param {Vector3d} v
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -424,10 +360,8 @@ import pool from "./../system/pooling.js";
         return this;
     }
 
-   /**
+    /**
     * return the square length of this vector
-    * @name length2
-    * @memberof Vector3d
     * @returns {number} The length^2 of this vector.
     */
     length2() {
@@ -436,8 +370,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the length (magnitude) of this vector
-     * @name length
-     * @memberof Vector3d
      * @returns {number} the length of this vector
      */
     length() {
@@ -446,8 +378,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * Linearly interpolate between this vector and the given one.
-     * @name lerp
-     * @memberof Vector3d
      * @param {Vector3d} v
      * @param {number} alpha - distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
      * @returns {Vector3d} Reference to this object for method chaining
@@ -461,8 +391,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * interpolate the position of this vector on the x and y axis towards the given one by the given maximum step.
-     * @name moveTowards
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} target
      * @param {number} step - the maximum step per iteration (Negative values will push the vector away from the target)
      * @returns {Vector3d} Reference to this object for method chaining
@@ -487,8 +415,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the distance between this vector and the passed one
-     * @name distance
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {number}
      */
@@ -501,8 +427,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return the angle between this vector and the passed one
-     * @name angle
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v
      * @returns {number} angle in radians
      */
@@ -512,8 +436,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * project this vector on to another vector.
-     * @name project
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v - The vector to project onto.
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -525,8 +447,6 @@ import pool from "./../system/pooling.js";
     /**
      * Project this vector onto a vector of unit length.<br>
      * This is slightly more efficient than `project` when dealing with unit vectors.
-     * @name projectN
-     * @memberof Vector3d
      * @param {Vector2d|Vector3d} v - The unit vector to project onto.
      * @returns {Vector3d} Reference to this object for method chaining
      */
@@ -537,8 +457,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * return a clone copy of this vector
-     * @name clone
-     * @memberof Vector3d
      * @returns {Vector3d} new me.Vector3d
      */
     clone() {
@@ -547,8 +465,6 @@ import pool from "./../system/pooling.js";
 
     /**
      * convert the object to a string representation
-     * @name toString
-     * @memberof Vector3d
      * @returns {string}
      */
     toString() {