melonjs 15.2.1 → 15.4.0

package/dist/melonjs.mjs/math/vector2.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS Game Engine - v15.2.1
+ * melonJS Game Engine - v15.4.0
  * http://www.melonjs.org
  * melonjs is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -12,7 +12,7 @@ import pool from '../system/pooling.js';
  * @classdesc
  * a generic 2D Vector Object
  */
- class Vector2d {
+class Vector2d {
     /**
      * @param {number} [x=0] - x value of the vector
      * @param {number} [y=0] - y value of the vector
@@ -42,8 +42,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
@@ -78,8 +76,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() {
@@ -88,8 +84,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
      */
@@ -99,8 +93,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
      */
@@ -110,8 +102,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
      */
@@ -121,8 +111,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
@@ -133,8 +121,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() {
@@ -143,8 +129,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() {
@@ -153,8 +137,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
      */
@@ -164,8 +146,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
      */
@@ -175,8 +155,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() {
@@ -185,8 +163,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
@@ -197,8 +173,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
@@ -209,8 +183,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
      */
@@ -220,8 +192,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
      */
@@ -231,8 +201,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Floor the vector values
-     * @name floor
-     * @memberof Vector2d
      * @returns {Vector2d} new me.Vector2d
      */
     floor() {
@@ -241,8 +209,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() {
@@ -251,8 +217,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Ceil the vector values
-     * @name ceil
-     * @memberof Vector2d
      * @returns {Vector2d} new me.Vector2d
      */
     ceil() {
@@ -261,8 +225,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() {
@@ -271,8 +233,6 @@ import pool from '../system/pooling.js';
 
     /**
      * Negate the vector values
-     * @name negate
-     * @memberof Vector2d
      * @returns {Vector2d} new me.Vector2d
      */
     negate() {
@@ -281,8 +241,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() {
@@ -291,8 +249,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
      */
@@ -301,19 +257,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() {
@@ -332,8 +278,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() {
@@ -343,8 +287,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() {
@@ -353,8 +295,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
@@ -379,8 +319,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.
      */
@@ -390,8 +328,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.
      */
@@ -399,10 +335,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() {
@@ -411,8 +345,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() {
@@ -421,8 +353,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
@@ -435,13 +365,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);
@@ -458,8 +386,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}
      */
@@ -470,8 +396,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
      */
@@ -481,8 +405,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
      */
@@ -493,8 +415,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
      */
@@ -504,8 +424,6 @@ import pool from '../system/pooling.js';
 
     /**
      * return a clone copy of this vector
-     * @name clone
-     * @memberof Vector2d
      * @returns {Vector2d} new me.Vector2d
      */
     clone() {
@@ -514,8 +432,6 @@ import pool from '../system/pooling.js';
 
     /**
      * convert the object to a string representation
-     * @name toString
-     * @memberof Vector2d
      * @returns {string}
      */
     toString() {