melonjs 10.3.0 → 10.4.0

package/src/math/math.js

@@ -1,7 +1,6 @@
 /**
  * a collection of math utility functions
  * @namespace Math
- * @memberof me
  */
 
 /**
@@ -9,7 +8,7 @@
  * @public
  * @type {number}
  * @name DEG_TO_RAD
- * @memberof me.Math
+ * @memberof Math
  */
 export const DEG_TO_RAD = Math.PI / 180.0;
 
@@ -18,7 +17,7 @@ export const DEG_TO_RAD = Math.PI / 180.0;
  * @public
  * @type {number}
  * @name RAD_TO_DEG
- * @memberof me.Math
+ * @memberof Math
  */
 export const RAD_TO_DEG = 180.0 / Math.PI;
 
@@ -27,7 +26,7 @@ export const RAD_TO_DEG = 180.0 / Math.PI;
  * @public
  * @type {number}
  * @name TAU
- * @memberof me.Math
+ * @memberof Math
  */
 export const TAU = Math.PI * 2;
 
@@ -36,7 +35,7 @@ export const TAU = Math.PI * 2;
  * @public
  * @type {number}
  * @name ETA
- * @memberof me.Math
+ * @memberof Math
  */
 export const ETA = Math.PI * 0.5;
 
@@ -45,7 +44,7 @@ export const ETA = Math.PI * 0.5;
  * @public
  * @type {number}
  * @name EPSILON
- * @memberof me.Math
+ * @memberof Math
  */
 export const EPSILON = 0.000001;
 
@@ -53,7 +52,7 @@ export const EPSILON = 0.000001;
  * returns true if the given value is a power of two
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name isPowerOfTwo
  * @param {number} val
  * @returns {boolean}
@@ -66,7 +65,7 @@ export function isPowerOfTwo(val) {
  * returns the next power of two for the given value
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name nextPowerOfTwo
  * @param {number} val
  * @returns {boolean}
@@ -86,7 +85,7 @@ export function nextPowerOfTwo(val) {
  * Converts an angle in degrees to an angle in radians
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name degToRad
  * @param {number} angle angle in degrees
  * @returns {number} corresponding angle in radians
@@ -102,7 +101,7 @@ export function degToRad(angle) {
  * Converts an angle in radians to an angle in degrees.
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name radToDeg
  * @param {number} radians angle in radians
  * @returns {number} corresponding angle in degrees
@@ -118,7 +117,7 @@ export function radToDeg(radians) {
  * clamp the given value
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name clamp
  * @param {number} val the value to clamp
  * @param {number} low lower limit
@@ -133,7 +132,7 @@ export function clamp(val, low, high) {
  * return a random integer between min (included) and max (excluded)
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name random
  * @param {number} min minimum value.
  * @param {number} max maximum value.
@@ -150,7 +149,7 @@ export function random(min, max) {
  * return a random float between min, max (exclusive)
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name randomFloat
  * @param {number} min minimum value.
  * @param {number} max maximum value.
@@ -167,7 +166,7 @@ export function randomFloat(min, max) {
  * return a weighted random between min, max (exclusive)
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name weightedRandom
  * @param {number} min minimum value.
  * @param {number} max maximum value.
@@ -184,7 +183,7 @@ export function weightedRandom(min, max) {
  * round a value to the specified number of digit
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name round
  * @param {number} num value to be rounded.
  * @param {number} [dec=0] number of decimal digit to be rounded to.
@@ -203,7 +202,7 @@ export function round(num, dec = 0) {
  * check if the given value is close to the expected one
  * @public
  * @function
- * @memberof me.Math
+ * @memberof Math
  * @name toBeCloseTo
  * @param {number} expected value to be compared with.
  * @param {number} actual actual value to compare

package/src/math/matrix2.js

@@ -6,14 +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
- * @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);
     }
@@ -45,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];
@@ -58,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];
@@ -72,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(
@@ -88,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
@@ -99,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;
@@ -132,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);
@@ -145,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;
@@ -170,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;
@@ -202,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,
@@ -225,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;
@@ -260,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,
@@ -279,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,
@@ -300,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,
@@ -322,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);
@@ -334,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);
@@ -346,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);
@@ -358,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) {
@@ -389,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;
@@ -426,7 +421,7 @@ class Matrix2d {
     /**
      * returns true if the matrix is an identity matrix.
      * @name isIdentity
-     * @memberof me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @returns {boolean}
      */
@@ -449,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) {
@@ -474,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);
@@ -485,7 +480,7 @@ class Matrix2d {
     /**
      * return an array representation of this Matrix
      * @name toArray
-     * @memberof me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @returns {Float32Array}
      */
@@ -496,7 +491,7 @@ class Matrix2d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberof me.Matrix2d
+     * @memberof Matrix2d
      * @function
      * @returns {string}
      */