melonjs 10.2.2 → 10.4.0

package/src/math/matrix2.js

@@ -6,15 +6,11 @@ import Matrix3d from "./matrix3.js";
  * a Matrix2d Object.<br>
  * the identity matrix and parameters position : <br>
  * <img src="images/identity-matrix_2x.png"/>
- * @class Matrix2d
- * @memberOf me
- * @constructor
- * @param {me.Matrix2d} [mat2d] An instance of me.Matrix2d to copy from
- * @param {number[]} [arguments...] Matrix elements. See {@link me.Matrix2d.setTransform}
  */
-
 class Matrix2d {
-
+    /**
+     * @param {(Matrix2d|Matrix3d|...number)} args an instance of me.Matrix2d or me.Matrix3d to copy from, or individual matrix components (See {@link Matrix2d.setTransform}). If not arguments are given, the matrix will be set to Identity. 
+     */
     constructor(...args) {
         this.onResetEvent(...args);
     }
@@ -46,10 +42,9 @@ class Matrix2d {
      * tx component of the matrix
      * @public
      * @type {number}
-     * @readonly
-     * @see me.Matrix2d.translate
+     * @see Matrix2d.translate
      * @name tx
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      */
     get tx() {
         return this.val[6];
@@ -59,10 +54,9 @@ class Matrix2d {
      * ty component of the matrix
      * @public
      * @type {number}
-     * @readonly
-     * @see me.Matrix2d.translate
+     * @see Matrix2d.translate
      * @name ty
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      */
     get ty() {
         return this.val[7];
@@ -73,9 +67,9 @@ class Matrix2d {
      * the identity matrix and parameters position : <br>
      * <img src="images/identity-matrix_2x.png"/>
      * @name identity
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     identity() {
         this.setTransform(
@@ -89,7 +83,7 @@ class Matrix2d {
     /**
      * set the matrix to the specified value
      * @name setTransform
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @param {number} a
      * @param {number} b
@@ -100,7 +94,7 @@ class Matrix2d {
      * @param {number} [g=0]
      * @param {number} [h=0]
      * @param {number} [i=1]
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     setTransform() {
         var a = this.val;
@@ -133,10 +127,10 @@ class Matrix2d {
     /**
      * Copies over the values from another me.Matrix2d.
      * @name copy
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @param {me.Matrix2d} m the matrix object to copy from
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @param {Matrix2d} m the matrix object to copy from
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     copy(m) {
         this.val.set(m.val);
@@ -146,10 +140,10 @@ class Matrix2d {
     /**
      * Copies over the upper-left 3x3 values from the given me.Matrix3d
      * @name fromMat3d
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @param {me.Matrix3d} m the matrix object to copy from
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @param {Matrix3d} m the matrix object to copy from
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     fromMat3d(m) {
         var b = m.val;
@@ -171,10 +165,10 @@ class Matrix2d {
     /**
      * multiply both matrix
      * @name multiply
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @param {me.Matrix2d} m the other matrix
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @param {Matrix2d} m the other matrix
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     multiply(m) {
         var b = m.val;
@@ -203,9 +197,9 @@ class Matrix2d {
     /**
      * Transpose the value of this matrix.
      * @name transpose
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     transpose() {
         var a = this.val,
@@ -226,9 +220,9 @@ class Matrix2d {
     /**
      * invert this matrix, causing it to apply the opposite transformation.
      * @name invert
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     invert() {
         var val = this.val;
@@ -261,10 +255,10 @@ class Matrix2d {
    /**
     * apply the current transform to the given 2d vector
     * @name apply
-    * @memberOf me.Matrix2d
+    * @memberof Matrix2d
     * @function
-    * @param {me.Vector2d} v the vector object to be transformed
-    * @returns {me.Vector2d} result vector object.
+    * @param {Vector2d} v the vector object to be transformed
+    * @returns {Vector2d} result vector object.
     */
     apply(v) {
         var a = this.val,
@@ -280,10 +274,10 @@ class Matrix2d {
     /**
      * apply the inverted current transform to the given 2d vector
      * @name applyInverse
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @param {me.Vector2d} v the vector object to be transformed
-     * @returns {me.Vector2d} result vector object.
+     * @param {Vector2d} v the vector object to be transformed
+     * @returns {Vector2d} result vector object.
      */
     applyInverse(v) {
         var a = this.val,
@@ -301,11 +295,11 @@ class Matrix2d {
     /**
      * scale the matrix
      * @name scale
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @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.
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     scale(x, y) {
         var a = this.val,
@@ -323,10 +317,10 @@ class Matrix2d {
     /**
      * adds a 2D scaling transformation.
      * @name scaleV
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @param {me.Vector2d} v scaling vector
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @param {Vector2d} v scaling vector
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y);
@@ -335,10 +329,10 @@ class Matrix2d {
     /**
      * specifies a 2D scale operation using the [sx, 1] scaling vector
      * @name scaleX
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @param {number} x x scaling vector
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     scaleX(x) {
         return this.scale(x, 1);
@@ -347,10 +341,10 @@ class Matrix2d {
     /**
      * specifies a 2D scale operation using the [1,sy] scaling vector
      * @name scaleY
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @param {number} y y scaling vector
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     scaleY(y) {
         return this.scale(1, y);
@@ -359,10 +353,10 @@ class Matrix2d {
     /**
      * rotate the matrix (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @param {number} angle Rotation angle in radians.
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     rotate(angle) {
         if (angle !== 0) {
@@ -390,19 +384,19 @@ class Matrix2d {
     /**
      * translate the matrix position on the horizontal and vertical axis
      * @name translate
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @param {number} x the x coordindates to translate the matrix by
      * @param {number} y the y coordindates to translate the matrix by
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     /**
      * translate the matrix by a vector on the horizontal and vertical axis
      * @name translateV
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @param {me.Vector2d} v the vector to translate the matrix by
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @param {Vector2d} v the vector to translate the matrix by
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     translate() {
         var a = this.val;
@@ -427,7 +421,7 @@ class Matrix2d {
     /**
      * returns true if the matrix is an identity matrix.
      * @name isIdentity
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @returns {boolean}
      */
@@ -450,9 +444,9 @@ class Matrix2d {
     /**
      * return true if the two matrices are identical
      * @name equals
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @param {me.Matrix2d} m the other matrix
+     * @param {Matrix2d} m the other matrix
      * @returns {boolean} true if both are equals
      */
     equals(m) {
@@ -475,9 +469,9 @@ class Matrix2d {
     /**
      * Clone the Matrix
      * @name clone
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
-     * @returns {me.Matrix2d}
+     * @returns {Matrix2d}
      */
     clone() {
         return pool.pull("Matrix2d", this);
@@ -486,7 +480,7 @@ class Matrix2d {
     /**
      * return an array representation of this Matrix
      * @name toArray
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @returns {Float32Array}
      */
@@ -497,7 +491,7 @@ class Matrix2d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @returns {string}
      */

package/src/math/matrix3.js

@@ -3,16 +3,12 @@ import { EPSILON } from "./math.js";
 
 /**
  * @classdesc
- * a 4x4 Matrix3d Object<br>
- * @class Matrix3d
- * @memberOf me
- * @constructor
- * @param {me.Matrix3d} [mat3d] An instance of me.Matrix3d to copy from
- * @param {number[]} [arguments...] Matrix elements. See {@link me.Matrix3d.setTransform}
+ * a 4x4 Matrix3d Object
  */
-
 class Matrix3d {
-
+    /**
+     * @param {(Matrix3d|...number)} args An instance of me.Matrix3d to copy from, or individual Matrix components (See {@link Matrix3d.setTransform}). If not arguments are given, the matrix will be set to Identity.
+     */
     constructor(...args) {
         this.onResetEvent(...args);
     }
@@ -40,9 +36,8 @@ class Matrix3d {
      * tx component of the matrix
      * @public
      * @type {number}
-     * @readonly
      * @name tx
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      */
     get tx() {
         return this.val[12];
@@ -52,9 +47,8 @@ class Matrix3d {
      * ty component of the matrix
      * @public
      * @type {number}
-     * @readonly
      * @name ty
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      */
     get ty() {
         return this.val[13];
@@ -64,9 +58,8 @@ class Matrix3d {
      * ty component of the matrix
      * @public
      * @type {number}
-     * @readonly
      * @name tz
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      */
     get tz() {
         return this.val[14];
@@ -77,9 +70,9 @@ class Matrix3d {
      * the identity matrix and parameters position : <br>
      * <img src="images/identity-matrix_2x.png"/>
      * @name identity
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     identity() {
         return this.setTransform(
@@ -93,7 +86,7 @@ class Matrix3d {
     /**
      * set the matrix to the specified value
      * @name setTransform
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
      * @param {number} m00
      * @param {number} m01
@@ -111,7 +104,7 @@ class Matrix3d {
      * @param {number} m31
      * @param {number} m32
      * @param {number} m33
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     setTransform(m00, m01, m02, m03, m10, m11, m12, m13, m20, m21, m22, m23, m30, m31, m32, m33) {
         var a = this.val;
@@ -139,10 +132,10 @@ class Matrix3d {
     /**
      * Copies over the values from another me.Matrix3d.
      * @name copy
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @param {me.Matrix3d} m the matrix object to copy from
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @param {Matrix3d} m the matrix object to copy from
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     copy(m) {
         this.val.set(m.val);
@@ -152,10 +145,10 @@ class Matrix3d {
     /**
      * Copies over the upper-left 2x2 values from the given me.Matrix2d
      * @name fromMat2d
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @param {me.Matrix2d} m the matrix object to copy from
-     * @returns {me.Matrix2d} Reference to this object for method chaining
+     * @param {Matrix2d} m the matrix object to copy from
+     * @returns {Matrix2d} Reference to this object for method chaining
      */
     fromMat2d(m) {
         var b = m.val;
@@ -171,10 +164,10 @@ class Matrix3d {
     /**
      * multiply both matrix
      * @name multiply
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @param {me.Matrix3d} m Other matrix
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @param {Matrix3d} m Other matrix
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     multiply(m) {
         var a = this.val;
@@ -227,9 +220,9 @@ class Matrix3d {
     /**
      * Transpose the value of this matrix.
      * @name transpose
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     transpose() {
         var a = this.val,
@@ -259,9 +252,9 @@ class Matrix3d {
     /**
      * invert this matrix, causing it to apply the opposite transformation.
      * @name invert
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     invert() {
          var a = this.val;
@@ -319,10 +312,10 @@ class Matrix3d {
     /**
      * apply the current transform to the given 2d or 3d vector
      * @name apply
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @param {me.Vector2d|me.Vector3d} v the vector object to be transformed
-     * @returns {me.Vector2d|me.Vector3d} result vector object.
+     * @param {Vector2d|Vector3d} v the vector object to be transformed
+     * @returns {Vector2d|Vector3d} result vector object.
      */
      apply(v) {
         var a = this.val,
@@ -345,10 +338,10 @@ class Matrix3d {
      /**
       * apply the inverted current transform to the given 2d or 3d vector
       * @name applyInverse
-      * @memberOf me.Matrix3d
+      * @memberof Matrix3d
       * @function
-      * @param {me.Vector2d|me.Vector3d} v the vector object to be transformed
-      * @returns {me.Vector2d|me.Vector3d} result vector object.
+      * @param {Vector2d|Vector3d} v the vector object to be transformed
+      * @returns {Vector2d|Vector3d} result vector object.
       */
      applyInverse(v) {
          // invert the current matrix
@@ -366,7 +359,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 Matrix3d
      * @function
      * @param {number} left farthest left on the x-axis
      * @param {number} right farthest right on the x-axis
@@ -374,7 +367,7 @@ class Matrix3d {
      * @param {number} top farthest up on the y-axis
      * @param {number} near distance to the near clipping plane along the -Z axis
      * @param {number} far distance to the far clipping plane along the -Z axis
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     ortho(left, right, bottom, top, near, far) {
         var a = this.val;
@@ -405,12 +398,12 @@ class Matrix3d {
     /**
      * scale the matrix
      * @name scale
-     * @memberOf me.Matrix3d
+     * @memberof 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.
      * @param {number} [z=0] a number representing the depth vector
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     scale(x, y, z) {
         var a = this.val,
@@ -439,10 +432,10 @@ class Matrix3d {
     /**
      * adds a 2D scaling transformation.
      * @name scaleV
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @param {me.Vector2d|me.Vector3d} v scaling vector
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @param {Vector2d|Vector3d} v scaling vector
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y, v.z);
@@ -451,10 +444,10 @@ class Matrix3d {
     /**
      * specifies a 2D scale operation using the [sx, 1] scaling vector
      * @name scaleX
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
      * @param {number} x x scaling vector
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     scaleX(x) {
         return this.scale(x, 1);
@@ -463,10 +456,10 @@ class Matrix3d {
     /**
      * specifies a 2D scale operation using the [1,sy] scaling vector
      * @name scaleY
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
      * @param {number} y y scaling vector
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     scaleY(y) {
         return this.scale(1, y);
@@ -475,11 +468,11 @@ class Matrix3d {
     /**
      * rotate this matrix (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
      * @param {number} angle Rotation angle in radians.
-     * @param {me.Vector3d} v the axis to rotate around
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @param {Vector3d} v the axis to rotate around
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     rotate(angle, v) {
         var a = this.val,
@@ -554,20 +547,20 @@ class Matrix3d {
     /**
      * translate the matrix position using the given vector
      * @name translate
-     * @memberOf me.Matrix3d
+     * @memberof 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.
      * @param {number} [z=0] a number representing the depth of the vector
-     * @returns {me.Matrix3d} Reference to this object for method chaining
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     /**
      * translate the matrix by a vector on the horizontal and vertical axis
      * @name translateV
-     * @memberOf me.Matrix3d
+     * @memberof 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
+     * @param {Vector2d|Vector3d} v the vector to translate the matrix by
+     * @returns {Matrix3d} Reference to this object for method chaining
      */
     translate() {
         var a = this.val;
@@ -596,7 +589,7 @@ class Matrix3d {
     /**
      * returns true if the matrix is an identity matrix.
      * @name isIdentity
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
      * @returns {boolean}
      */
@@ -626,9 +619,9 @@ class Matrix3d {
     /**
      * return true if the two matrices are identical
      * @name equals
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @param {me.Matrix3d} m the other matrix
+     * @param {Matrix3d} m the other matrix
      * @returns {boolean} true if both are equals
      */
     equals(m) {
@@ -658,9 +651,9 @@ class Matrix3d {
     /**
      * Clone the Matrix
      * @name clone
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
-     * @returns {me.Matrix3d}
+     * @returns {Matrix3d}
      */
     clone() {
         return pool.pull("Matrix3d", this);
@@ -669,7 +662,7 @@ class Matrix3d {
     /**
      * return an array representation of this Matrix
      * @name toArray
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
      * @returns {Float32Array}
      */
@@ -680,7 +673,7 @@ class Matrix3d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.Matrix3d
+     * @memberof Matrix3d
      * @function
      * @returns {string}
      */