melonjs 10.2.3 → 10.3.0

package/src/math/matrix3.js

@@ -5,8 +5,7 @@ import { EPSILON } from "./math.js";
  * @classdesc
  * a 4x4 Matrix3d Object<br>
  * @class Matrix3d
- * @memberOf me
- * @constructor
+ * @memberof me
  * @param {me.Matrix3d} [mat3d] An instance of me.Matrix3d to copy from
  * @param {number[]} [arguments...] Matrix elements. See {@link me.Matrix3d.setTransform}
  */
@@ -42,7 +41,7 @@ class Matrix3d {
      * @type {number}
      * @readonly
      * @name tx
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      */
     get tx() {
         return this.val[12];
@@ -54,7 +53,7 @@ class Matrix3d {
      * @type {number}
      * @readonly
      * @name ty
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      */
     get ty() {
         return this.val[13];
@@ -66,7 +65,7 @@ class Matrix3d {
      * @type {number}
      * @readonly
      * @name tz
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      */
     get tz() {
         return this.val[14];
@@ -77,7 +76,7 @@ class Matrix3d {
      * the identity matrix and parameters position : <br>
      * <img src="images/identity-matrix_2x.png"/>
      * @name identity
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @returns {me.Matrix3d} Reference to this object for method chaining
      */
@@ -93,7 +92,7 @@ class Matrix3d {
     /**
      * set the matrix to the specified value
      * @name setTransform
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {number} m00
      * @param {number} m01
@@ -139,7 +138,7 @@ class Matrix3d {
     /**
      * Copies over the values from another me.Matrix3d.
      * @name copy
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {me.Matrix3d} m the matrix object to copy from
      * @returns {me.Matrix3d} Reference to this object for method chaining
@@ -152,7 +151,7 @@ class Matrix3d {
     /**
      * Copies over the upper-left 2x2 values from the given me.Matrix2d
      * @name fromMat2d
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {me.Matrix2d} m the matrix object to copy from
      * @returns {me.Matrix2d} Reference to this object for method chaining
@@ -171,7 +170,7 @@ class Matrix3d {
     /**
      * multiply both matrix
      * @name multiply
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {me.Matrix3d} m Other matrix
      * @returns {me.Matrix3d} Reference to this object for method chaining
@@ -227,7 +226,7 @@ class Matrix3d {
     /**
      * Transpose the value of this matrix.
      * @name transpose
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @returns {me.Matrix3d} Reference to this object for method chaining
      */
@@ -259,7 +258,7 @@ class Matrix3d {
     /**
      * invert this matrix, causing it to apply the opposite transformation.
      * @name invert
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @returns {me.Matrix3d} Reference to this object for method chaining
      */
@@ -319,7 +318,7 @@ class Matrix3d {
     /**
      * apply the current transform to the given 2d or 3d vector
      * @name apply
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v the vector object to be transformed
      * @returns {me.Vector2d|me.Vector3d} result vector object.
@@ -345,7 +344,7 @@ class Matrix3d {
      /**
       * apply the inverted current transform to the given 2d or 3d vector
       * @name applyInverse
-      * @memberOf me.Matrix3d
+      * @memberof me.Matrix3d
       * @function
       * @param {me.Vector2d|me.Vector3d} v the vector object to be transformed
       * @returns {me.Vector2d|me.Vector3d} result vector object.
@@ -366,7 +365,7 @@ class Matrix3d {
      * generate an orthogonal projection matrix, with the result replacing the current matrix
      * <img src="images/glOrtho.gif"/><br>
      * @name ortho
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {number} left farthest left on the x-axis
      * @param {number} right farthest right on the x-axis
@@ -405,7 +404,7 @@ class Matrix3d {
     /**
      * scale the matrix
      * @name scale
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {number} x a number representing the abscissa of the scaling vector.
      * @param {number} [y=x] a number representing the ordinate of the scaling vector.
@@ -439,7 +438,7 @@ class Matrix3d {
     /**
      * adds a 2D scaling transformation.
      * @name scaleV
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v scaling vector
      * @returns {me.Matrix3d} Reference to this object for method chaining
@@ -451,7 +450,7 @@ class Matrix3d {
     /**
      * specifies a 2D scale operation using the [sx, 1] scaling vector
      * @name scaleX
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {number} x x scaling vector
      * @returns {me.Matrix3d} Reference to this object for method chaining
@@ -463,7 +462,7 @@ class Matrix3d {
     /**
      * specifies a 2D scale operation using the [1,sy] scaling vector
      * @name scaleY
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {number} y y scaling vector
      * @returns {me.Matrix3d} Reference to this object for method chaining
@@ -475,7 +474,7 @@ class Matrix3d {
     /**
      * rotate this matrix (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {number} angle Rotation angle in radians.
      * @param {me.Vector3d} v the axis to rotate around
@@ -554,7 +553,7 @@ class Matrix3d {
     /**
      * translate the matrix position using the given vector
      * @name translate
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {number} x a number representing the abscissa of the vector.
      * @param {number} [y=x] a number representing the ordinate of the vector.
@@ -564,7 +563,7 @@ class Matrix3d {
     /**
      * translate the matrix by a vector on the horizontal and vertical axis
      * @name translateV
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v the vector to translate the matrix by
      * @returns {me.Matrix3d} Reference to this object for method chaining
@@ -596,7 +595,7 @@ class Matrix3d {
     /**
      * returns true if the matrix is an identity matrix.
      * @name isIdentity
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @returns {boolean}
      */
@@ -626,7 +625,7 @@ class Matrix3d {
     /**
      * return true if the two matrices are identical
      * @name equals
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {me.Matrix3d} m the other matrix
      * @returns {boolean} true if both are equals
@@ -658,7 +657,7 @@ class Matrix3d {
     /**
      * Clone the Matrix
      * @name clone
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @returns {me.Matrix3d}
      */
@@ -669,7 +668,7 @@ class Matrix3d {
     /**
      * return an array representation of this Matrix
      * @name toArray
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @returns {Float32Array}
      */
@@ -680,7 +679,7 @@ class Matrix3d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @returns {string}
      */

package/src/math/observable_vector2.js

@@ -6,9 +6,8 @@ import {clamp} from "./math.js";
  * @classdesc
  * A Vector2d object that provide notification by executing the given callback when the vector is changed.
  * @class ObservableVector2d
- * @extends me.Vector2d
- * @memberOf me
- * @constructor
+ * @augments me.Vector2d
+ * @memberof me
  * @param {number} [x=0] x value of the vector
  * @param {number} [y=0] y value of the vector
  * @param {object} settings additional required parameters
@@ -44,7 +43,7 @@ class ObservableVector2d extends Vector2d {
      * @public
      * @type {number}
      * @name x
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      */
 
     get x() {
@@ -66,7 +65,7 @@ class ObservableVector2d extends Vector2d {
      * @public
      * @type {number}
      * @name y
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      */
 
     get y() {
@@ -98,7 +97,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * set the vector value without triggering the callback
      * @name setMuted
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {number} x x value of the vector
      * @param {number} y y value of the vector
@@ -113,7 +112,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * set the callback to be executed when the vector is changed
      * @name setCallback
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {Function} fn callback
      * @param {Function} [scope=null] scope
@@ -133,7 +132,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Add the passed vector to this vector
      * @name add
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
@@ -145,7 +144,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Substract the passed vector to this vector
      * @name sub
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
@@ -157,7 +156,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Multiply this vector values by the given scalar
      * @name scale
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {number} x
      * @param {number} [y=x]
@@ -170,7 +169,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Multiply this vector values by the passed vector
      * @name scaleV
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
@@ -182,7 +181,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Divide this vector values by the passed value
      * @name div
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {number} n the value to divide the vector by
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
@@ -194,7 +193,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Update this vector values to absolute values
      * @name abs
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
@@ -205,7 +204,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Clamp the vector value within the specified value range
      * @name clamp
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {number} low
      * @param {number} high
@@ -218,7 +217,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Clamp this vector value within the specified value range
      * @name clampSelf
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {number} low
      * @param {number} high
@@ -231,7 +230,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Update this vector with the minimum value between this and the passed vector
      * @name minV
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
@@ -243,7 +242,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Update this vector with the maximum value between this and the passed vector
      * @name maxV
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
@@ -255,7 +254,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Floor the vector values
      * @name floor
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.ObservableVector2d} new me.ObservableVector2d
      */
@@ -266,7 +265,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Floor this vector values
      * @name floorSelf
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
@@ -277,7 +276,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Ceil the vector values
      * @name ceil
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.ObservableVector2d} new me.ObservableVector2d
      */
@@ -288,7 +287,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Ceil this vector values
      * @name ceilSelf
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
@@ -299,7 +298,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Negate the vector values
      * @name negate
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.ObservableVector2d} new me.ObservableVector2d
      */
@@ -310,7 +309,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Negate this vector values
      * @name negateSelf
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
@@ -321,7 +320,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Copy the x,y values of the passed vector to this one
      * @name copy
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
@@ -333,7 +332,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * return true if the two vectors are the same
      * @name equals
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
      * @returns {boolean}
@@ -346,7 +345,7 @@ class ObservableVector2d extends 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.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
@@ -357,7 +356,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
@@ -383,20 +382,32 @@ class ObservableVector2d extends Vector2d {
 
     /**
      * return the dot product of this vector and the passed one
-     * @name dotProduct
-     * @memberOf me.ObservableVector2d
+     * @name dot
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.Vector2d|me.ObservableVector2d} 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.ObservableVector2d
+     * @function
+     * @param {me.Vector2d|me.ObservableVector2d} v
+     * @returns {number} The cross product.
+     */
+    cross(v) {
+        return this._x * v.y - this._y * v.x;
+    }
+
     /**
      * Linearly interpolate between this vector and the given one.
      * @name lerp
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.Vector2d|me.ObservableVector2d} v
      * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
@@ -411,7 +422,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * return the distance between this vector and the passed one
      * @name distance
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
      * @returns {number}
@@ -423,7 +434,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * return a clone copy of this vector
      * @name clone
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.ObservableVector2d} new me.ObservableVector2d
      */
@@ -434,7 +445,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * return a `me.Vector2d` copy of this `me.ObservableVector2d` object
      * @name toVector2d
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {me.Vector2d} new me.Vector2d
      */
@@ -445,7 +456,7 @@ class ObservableVector2d extends Vector2d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @returns {string}
      */