melonjs 10.2.0 → 10.3.0

package/src/math/matrix2.js

@@ -7,10 +7,9 @@ import Matrix3d from "./matrix3.js";
  * the identity matrix and parameters position : <br>
  * <img src="images/identity-matrix_2x.png"/>
  * @class Matrix2d
- * @memberOf me
- * @constructor
+ * @memberof me
  * @param {me.Matrix2d} [mat2d] An instance of me.Matrix2d to copy from
- * @param {Number[]} [arguments...] Matrix elements. See {@link me.Matrix2d.setTransform}
+ * @param {number[]} [arguments...] Matrix elements. See {@link me.Matrix2d.setTransform}
  */
 
 class Matrix2d {
@@ -45,11 +44,11 @@ class Matrix2d {
     /**
      * tx component of the matrix
      * @public
-     * @type {Number}
+     * @type {number}
      * @readonly
      * @see me.Matrix2d.translate
      * @name tx
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      */
     get tx() {
         return this.val[6];
@@ -58,11 +57,11 @@ class Matrix2d {
     /**
      * ty component of the matrix
      * @public
-     * @type {Number}
+     * @type {number}
      * @readonly
      * @see me.Matrix2d.translate
      * @name ty
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      */
     get ty() {
         return this.val[7];
@@ -73,9 +72,9 @@ class Matrix2d {
      * the identity matrix and parameters position : <br>
      * <img src="images/identity-matrix_2x.png"/>
      * @name identity
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     identity() {
         this.setTransform(
@@ -89,18 +88,18 @@ class Matrix2d {
     /**
      * set the matrix to the specified value
      * @name setTransform
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @param {Number} a
-     * @param {Number} b
-     * @param {Number} c
-     * @param {Number} d
-     * @param {Number} e
-     * @param {Number} f
-     * @param {Number} [g=0]
-     * @param {Number} [h=0]
-     * @param {Number} [i=1]
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} a
+     * @param {number} b
+     * @param {number} c
+     * @param {number} d
+     * @param {number} e
+     * @param {number} f
+     * @param {number} [g=0]
+     * @param {number} [h=0]
+     * @param {number} [i=1]
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     setTransform() {
         var a = this.val;
@@ -133,23 +132,23 @@ class Matrix2d {
     /**
      * Copies over the values from another me.Matrix2d.
      * @name copy
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Matrix2d} m the matrix object to copy from
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
-    copy(b) {
-        this.val.set(b.val);
+    copy(m) {
+        this.val.set(m.val);
         return this;
     }
 
     /**
      * Copies over the upper-left 3x3 values from the given me.Matrix3d
      * @name fromMat3d
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Matrix3d} m the matrix object to copy from
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     fromMat3d(m) {
         var b = m.val;
@@ -171,10 +170,10 @@ class Matrix2d {
     /**
      * multiply both matrix
      * @name multiply
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Matrix2d} m the other matrix
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     multiply(m) {
         var b = m.val;
@@ -203,9 +202,9 @@ class Matrix2d {
     /**
      * Transpose the value of this matrix.
      * @name transpose
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     transpose() {
         var a = this.val,
@@ -226,9 +225,9 @@ class Matrix2d {
     /**
      * invert this matrix, causing it to apply the opposite transformation.
      * @name invert
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     invert() {
         var val = this.val;
@@ -261,10 +260,10 @@ class Matrix2d {
    /**
     * apply the current transform to the given 2d vector
     * @name apply
-    * @memberOf me.Matrix2d
+    * @memberof me.Matrix2d
     * @function
-    * @param {me.Vector2d} vector the vector object to be transformed
-    * @return {me.Vector2d} result vector object.
+    * @param {me.Vector2d} v the vector object to be transformed
+    * @returns {me.Vector2d} result vector object.
     */
     apply(v) {
         var a = this.val,
@@ -280,10 +279,10 @@ class Matrix2d {
     /**
      * apply the inverted current transform to the given 2d vector
      * @name applyInverse
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @param {me.Vector2d} vector the vector object to be transformed
-     * @return {me.Vector2d} result vector object.
+     * @param {me.Vector2d} v the vector object to be transformed
+     * @returns {me.Vector2d} result vector object.
      */
     applyInverse(v) {
         var a = this.val,
@@ -301,11 +300,11 @@ class Matrix2d {
     /**
      * scale the matrix
      * @name scale
-     * @memberOf me.Matrix2d
+     * @memberof me.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.
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @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
      */
     scale(x, y) {
         var a = this.val,
@@ -323,10 +322,10 @@ class Matrix2d {
     /**
      * adds a 2D scaling transformation.
      * @name scaleV
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @param {me.Vector2d} vector scaling vector
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {me.Vector2d} v scaling vector
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y);
@@ -335,10 +334,10 @@ class Matrix2d {
     /**
      * specifies a 2D scale operation using the [sx, 1] scaling vector
      * @name scaleX
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @param {Number} x x scaling vector
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} x x scaling vector
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     scaleX(x) {
         return this.scale(x, 1);
@@ -347,10 +346,10 @@ class Matrix2d {
     /**
      * specifies a 2D scale operation using the [1,sy] scaling vector
      * @name scaleY
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @param {Number} y y scaling vector
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} y y scaling vector
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     scaleY(y) {
         return this.scale(1, y);
@@ -359,10 +358,10 @@ class Matrix2d {
     /**
      * rotate the matrix (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @param {Number} angle Rotation angle in radians.
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @param {number} angle Rotation angle in radians.
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     rotate(angle) {
         if (angle !== 0) {
@@ -390,19 +389,19 @@ class Matrix2d {
     /**
      * translate the matrix position on the horizontal and vertical axis
      * @name translate
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @param {Number} x the x coordindates to translate the matrix by
-     * @param {Number} y the y coordindates to translate the matrix by
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @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
      */
     /**
      * translate the matrix by a vector on the horizontal and vertical axis
      * @name translateV
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Vector2d} v the vector to translate the matrix by
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     translate() {
         var a = this.val;
@@ -427,10 +426,10 @@ class Matrix2d {
     /**
      * returns true if the matrix is an identity matrix.
      * @name isIdentity
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @return {Boolean}
-     **/
+     * @returns {boolean}
+     */
     isIdentity() {
         var a = this.val;
 
@@ -450,10 +449,10 @@ class Matrix2d {
     /**
      * return true if the two matrices are identical
      * @name equals
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
      * @param {me.Matrix2d} m the other matrix
-     * @return {Boolean} true if both are equals
+     * @returns {boolean} true if both are equals
      */
     equals(m) {
         var b = m.val;
@@ -475,9 +474,9 @@ class Matrix2d {
     /**
      * Clone the Matrix
      * @name clone
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @return {me.Matrix2d}
+     * @returns {me.Matrix2d}
      */
     clone() {
         return pool.pull("Matrix2d", this);
@@ -486,9 +485,9 @@ class Matrix2d {
     /**
      * return an array representation of this Matrix
      * @name toArray
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @return {Float32Array}
+     * @returns {Float32Array}
      */
     toArray() {
         return this.val;
@@ -497,9 +496,9 @@ class Matrix2d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.Matrix2d
+     * @memberof me.Matrix2d
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toString() {
         var a = this.val;