melonjs 10.2.3 → 10.3.0

package/src/math/observable_vector3.js

@@ -6,9 +6,8 @@ import pool from "./../system/pooling.js";
  * A Vector3d object that provide notification by executing the given callback when the vector is changed.
  * @classdesc
  * @class ObservableVector3d
- * @extends me.Vector3d
- * @memberOf me
- * @constructor
+ * @augments me.Vector3d
+ * @memberof me
  * @param {number} [x=0] x value of the vector
  * @param {number} [y=0] y value of the vector
  * @param {number} [z=0] z value of the vector
@@ -45,7 +44,7 @@ class ObservableVector3d extends Vector3d {
      * @public
      * @type {number}
      * @name x
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      */
 
     get x() {
@@ -66,7 +65,7 @@ class ObservableVector3d extends Vector3d {
      * @public
      * @type {number}
      * @name y
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      */
 
     get y() {
@@ -88,7 +87,7 @@ class ObservableVector3d extends Vector3d {
      * @public
      * @type {number}
      * @name z
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      */
 
 
@@ -125,7 +124,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * set the vector value without triggering the callback
      * @name setMuted
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {number} x x value of the vector
      * @param {number} y y value of the vector
@@ -142,7 +141,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * set the callback to be executed when the vector is changed
      * @name setCallback
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {Function} fn callback
      * @param {Function} [scope=null] scope
@@ -162,7 +161,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Add the passed vector to this vector
      * @name add
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
@@ -174,7 +173,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Substract the passed vector to this vector
      * @name sub
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
@@ -186,7 +185,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Multiply this vector values by the given scalar
      * @name scale
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {number} x
      * @param {number} [y=x]
@@ -201,7 +200,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Multiply this vector values by the passed vector
      * @name scaleV
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
@@ -213,7 +212,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Divide this vector values by the passed value
      * @name div
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {number} n the value to divide the vector by
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
@@ -225,7 +224,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Update this vector values to absolute values
      * @name abs
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
@@ -240,7 +239,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Clamp the vector value within the specified value range
      * @name clamp
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {number} low
      * @param {number} high
@@ -258,7 +257,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Clamp this vector value within the specified value range
      * @name clampSelf
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {number} low
      * @param {number} high
@@ -275,7 +274,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Update this vector with the minimum value between this and the passed vector
      * @name minV
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
@@ -292,7 +291,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Update this vector with the maximum value between this and the passed vector
      * @name maxV
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
@@ -309,7 +308,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Floor the vector values
      * @name floor
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.ObservableVector3d} new me.ObservableVector3d
      */
@@ -325,7 +324,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Floor this vector values
      * @name floorSelf
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
@@ -336,7 +335,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Ceil the vector values
      * @name ceil
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.ObservableVector3d} new me.ObservableVector3d
      */
@@ -352,7 +351,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Ceil this vector values
      * @name ceilSelf
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
@@ -363,7 +362,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Negate the vector values
      * @name negate
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.ObservableVector3d} new me.ObservableVector3d
      */
@@ -379,7 +378,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Negate this vector values
      * @name negateSelf
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
@@ -390,7 +389,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Copy the components of the given vector into this one
      * @name copy
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
@@ -402,7 +401,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * return true if the two vectors are the same
      * @name equals
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
      * @returns {boolean}
@@ -415,7 +414,7 @@ class ObservableVector3d extends Vector3d {
      * change this vector to be perpendicular to what it was before.<br>
      * (Effectively rotates it 90 degrees in a clockwise direction)
      * @name perp
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
@@ -426,7 +425,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around (on the same z axis)
@@ -453,20 +452,39 @@ class ObservableVector3d extends Vector3d {
 
     /**
      * return the dot product of this vector and the passed one
-     * @name dotProduct
-     * @memberOf me.ObservableVector3d
+     * @name dot
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
      * @returns {number} The dot product.
      */
-    dotProduct(v) {
+    dot(v) {
         return this._x * v.x + this._y * v.y + this._z * (v.z || 1);
     }
 
+    /**
+     * calculate the cross product of this vector and the passed one
+     * @name cross
+     * @memberof me.ObservableVector3d
+     * @function
+     * @param {me.Vector3d|me.ObservableVector3d} v
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
+     */
+    cross(v) {
+        var ax = this._x, ay = this._y, az = this._z;
+        var bx = v.x, by = v.y, bz = v.z;
+
+        return this._set(
+            ay * bz - az * by,
+            az * bx - ax * bz,
+            ax * by - ay * bx
+        );
+    }
+
     /**
      * Linearly interpolate between this vector and the given one.
      * @name lerp
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector3d|me.ObservableVector3d} v
      * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
@@ -482,7 +500,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * return the distance between this vector and the passed one
      * @name distance
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
      * @returns {number}
@@ -497,7 +515,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * return a clone copy of this vector
      * @name clone
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.ObservableVector3d} new me.ObservableVector3d
      */
@@ -513,7 +531,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * return a `me.Vector3d` copy of this `me.ObservableVector3d` object
      * @name toVector3d
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {me.Vector3d} new me.Vector3d
      */
@@ -524,7 +542,7 @@ class ObservableVector3d extends Vector3d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.ObservableVector3d
+     * @memberof me.ObservableVector3d
      * @function
      * @returns {string}
      */

package/src/math/vector2.js

@@ -5,8 +5,7 @@ import pool from "./../system/pooling.js";
  * @classdesc
  * a generic 2D Vector Object
  * @class Vector2d
- * @memberOf me
- * @constructor
+ * @memberof me
  * @param {number} [x=0] x value of the vector
  * @param {number} [y=0] y value of the vector
  */
@@ -38,7 +37,7 @@ class Vector2d {
     /**
      * set the Vector x and y properties to the given values<br>
      * @name set
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {number} x
      * @param {number} y
@@ -56,7 +55,7 @@ class Vector2d {
          * @public
          * @type {number}
          * @name x
-         * @memberOf me.Vector2d
+         * @memberof me.Vector2d
          */
         //this.x = x;
 
@@ -65,7 +64,7 @@ class Vector2d {
          * @public
          * @type {number}
          * @name y
-         * @memberOf me.Vector2d
+         * @memberof me.Vector2d
          */
         //this.y = y;
 
@@ -75,7 +74,7 @@ class Vector2d {
     /**
      * set the Vector x and y properties to 0
      * @name setZero
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
@@ -86,7 +85,7 @@ class Vector2d {
     /**
      * set the Vector x and y properties using the passed vector
      * @name setV
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {me.Vector2d} Reference to this object for method chaining
@@ -98,7 +97,7 @@ class Vector2d {
     /**
      * Add the passed vector to this vector
      * @name add
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {me.Vector2d} Reference to this object for method chaining
@@ -110,7 +109,7 @@ class Vector2d {
     /**
      * Substract the passed vector to this vector
      * @name sub
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {me.Vector2d} Reference to this object for method chaining
@@ -122,7 +121,7 @@ class Vector2d {
     /**
      * Multiply this vector values by the given scalar
      * @name scale
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {number} x
      * @param {number} [y=x]
@@ -135,7 +134,7 @@ class Vector2d {
     /**
      * Convert this vector into isometric coordinate space
      * @name toIso
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
@@ -146,7 +145,7 @@ class Vector2d {
     /**
      * Convert this vector into 2d coordinate space
      * @name to2d
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
@@ -157,7 +156,7 @@ class Vector2d {
     /**
      * Multiply this vector values by the passed vector
      * @name scaleV
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {me.Vector2d} Reference to this object for method chaining
@@ -169,7 +168,7 @@ class Vector2d {
     /**
      * Divide this vector values by the passed value
      * @name div
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {number} n the value to divide the vector by
      * @returns {me.Vector2d} Reference to this object for method chaining
@@ -181,7 +180,7 @@ class Vector2d {
     /**
      * Update this vector values to absolute values
      * @name abs
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
@@ -192,7 +191,7 @@ class Vector2d {
     /**
      * Clamp the vector value within the specified value range
      * @name clamp
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {number} low
      * @param {number} high
@@ -205,7 +204,7 @@ class Vector2d {
     /**
      * Clamp this vector value within the specified value range
      * @name clampSelf
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {number} low
      * @param {number} high
@@ -218,7 +217,7 @@ class Vector2d {
     /**
      * Update this vector with the minimum value between this and the passed vector
      * @name minV
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {me.Vector2d} Reference to this object for method chaining
@@ -230,7 +229,7 @@ class Vector2d {
     /**
      * Update this vector with the maximum value between this and the passed vector
      * @name maxV
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {me.Vector2d} Reference to this object for method chaining
@@ -242,7 +241,7 @@ class Vector2d {
     /**
      * Floor the vector values
      * @name floor
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} new me.Vector2d
      */
@@ -253,7 +252,7 @@ class Vector2d {
     /**
      * Floor this vector values
      * @name floorSelf
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
@@ -264,7 +263,7 @@ class Vector2d {
     /**
      * Ceil the vector values
      * @name ceil
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} new me.Vector2d
      */
@@ -275,7 +274,7 @@ class Vector2d {
     /**
      * Ceil this vector values
      * @name ceilSelf
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
@@ -286,7 +285,7 @@ class Vector2d {
     /**
      * Negate the vector values
      * @name negate
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} new me.Vector2d
      */
@@ -297,7 +296,7 @@ class Vector2d {
     /**
      * Negate this vector values
      * @name negateSelf
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
@@ -308,7 +307,7 @@ class Vector2d {
     /**
      * Copy the x,y values of the passed vector to this one
      * @name copy
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {me.Vector2d} Reference to this object for method chaining
@@ -320,7 +319,7 @@ class Vector2d {
     /**
      * return true if the two vectors are the same
      * @name equals
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {boolean}
@@ -328,7 +327,7 @@ class Vector2d {
     /**
      * return true if this vector is equal to the given values
      * @name equals
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {number} x
      * @param {number} y
@@ -351,7 +350,7 @@ class Vector2d {
     /**
      * normalize this vector (scale the vector so that its magnitude is 1)
      * @name normalize
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
@@ -363,7 +362,7 @@ class Vector2d {
      * change this vector to be perpendicular to what it was before.<br>
      * (Effectively rotates it 90 degrees in a clockwise direction)
      * @name perp
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
@@ -374,7 +373,7 @@ class Vector2d {
     /**
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
@@ -400,31 +399,43 @@ class Vector2d {
 
     /**
      * return the dot product of this vector and the passed one
-     * @name dotProduct
-     * @memberOf me.Vector2d
+     * @name dot
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {number} The dot product.
      */
-    dotProduct(v) {
+    dot(v) {
         return this.x * v.x + this.y * v.y;
     }
 
+    /**
+     * return the cross product of this vector and the passed one
+     * @name cross
+     * @memberof me.Vector2d
+     * @function
+     * @param {me.Vector2d} v
+     * @returns {number} The cross product.
+     */
+    cross(v) {
+        return this.x * v.y - this.y * v.x;
+    }
+
    /**
     * return the square length of this vector
     * @name length2
-    * @memberOf me.Vector2d
+    * @memberof me.Vector2d
     * @function
     * @returns {number} The length^2 of this vector.
     */
     length2() {
-        return this.dotProduct(this);
+        return this.dot(this);
     }
 
     /**
      * return the length (magnitude) of this vector
      * @name length
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {number} the length of this vector
      */
@@ -435,7 +446,7 @@ class Vector2d {
     /**
      * Linearly interpolate between this vector and the given one.
      * @name lerp
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
@@ -450,7 +461,7 @@ class Vector2d {
     /**
      * return the distance between this vector and the passed one
      * @name distance
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {number}
@@ -463,44 +474,44 @@ class Vector2d {
     /**
      * return the angle between this vector and the passed one
      * @name angle
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v
      * @returns {number} angle in radians
      */
     angle(v) {
-        return Math.acos(clamp(this.dotProduct(v) / (this.length() * v.length()), -1, 1));
+        return Math.acos(clamp(this.dot(v) / (this.length() * v.length()), -1, 1));
     }
 
     /**
      * project this vector on to another vector.
      * @name project
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v The vector to project onto.
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
     project(v) {
-        return this.scale(this.dotProduct(v) / v.length2());
+        return this.scale(this.dot(v) / v.length2());
     }
 
     /**
      * 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 me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @param {me.Vector2d} v The unit vector to project onto.
      * @returns {me.Vector2d} Reference to this object for method chaining
      */
     projectN(v) {
-        return this.scale(this.dotProduct(v));
+        return this.scale(this.dot(v));
     }
 
     /**
      * return a clone copy of this vector
      * @name clone
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {me.Vector2d} new me.Vector2d
      */
@@ -511,7 +522,7 @@ class Vector2d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.Vector2d
+     * @memberof me.Vector2d
      * @function
      * @returns {string}
      */