melonjs 10.2.0 → 10.3.0

package/src/math/matrix3.js

@@ -5,10 +5,9 @@ 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}
+ * @param {number[]} [arguments...] Matrix elements. See {@link me.Matrix3d.setTransform}
  */
 
 class Matrix3d {
@@ -39,10 +38,10 @@ class Matrix3d {
     /**
      * tx component of the matrix
      * @public
-     * @type {Number}
+     * @type {number}
      * @readonly
      * @name tx
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      */
     get tx() {
         return this.val[12];
@@ -51,10 +50,10 @@ class Matrix3d {
     /**
      * ty component of the matrix
      * @public
-     * @type {Number}
+     * @type {number}
      * @readonly
      * @name ty
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      */
     get ty() {
         return this.val[13];
@@ -63,10 +62,10 @@ class Matrix3d {
     /**
      * ty component of the matrix
      * @public
-     * @type {Number}
+     * @type {number}
      * @readonly
      * @name tz
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      */
     get tz() {
         return this.val[14];
@@ -77,9 +76,9 @@ 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
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @returns {me.Matrix3d} Reference to this object for method chaining
      */
     identity() {
         return this.setTransform(
@@ -93,25 +92,25 @@ class Matrix3d {
     /**
      * set the matrix to the specified value
      * @name setTransform
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
-     * @param {Number} m00
-     * @param {Number} m01
-     * @param {Number} m02
-     * @param {Number} m03
-     * @param {Number} m10
-     * @param {Number} m11
-     * @param {Number} m12
-     * @param {Number} m13
-     * @param {Number} m20
-     * @param {Number} m21
-     * @param {Number} m22
-     * @param {Number} m23
-     * @param {Number} m30
-     * @param {Number} m31
-     * @param {Number} m32
-     * @param {Number} m33
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @param {number} m00
+     * @param {number} m01
+     * @param {number} m02
+     * @param {number} m03
+     * @param {number} m10
+     * @param {number} m11
+     * @param {number} m12
+     * @param {number} m13
+     * @param {number} m20
+     * @param {number} m21
+     * @param {number} m22
+     * @param {number} m23
+     * @param {number} m30
+     * @param {number} m31
+     * @param {number} m32
+     * @param {number} m33
+     * @returns {me.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,23 +138,23 @@ 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
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @returns {me.Matrix3d} 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 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
-     * @return {me.Matrix2d} Reference to this object for method chaining
+     * @returns {me.Matrix2d} Reference to this object for method chaining
      */
     fromMat2d(m) {
         var b = m.val;
@@ -171,10 +170,10 @@ class Matrix3d {
     /**
      * multiply both matrix
      * @name multiply
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
      * @param {me.Matrix3d} m Other matrix
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @returns {me.Matrix3d} Reference to this object for method chaining
      */
     multiply(m) {
         var a = this.val;
@@ -227,9 +226,9 @@ class Matrix3d {
     /**
      * Transpose the value of this matrix.
      * @name transpose
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @returns {me.Matrix3d} Reference to this object for method chaining
      */
     transpose() {
         var a = this.val,
@@ -259,9 +258,9 @@ class Matrix3d {
     /**
      * invert this matrix, causing it to apply the opposite transformation.
      * @name invert
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @returns {me.Matrix3d} Reference to this object for method chaining
      */
     invert() {
          var a = this.val;
@@ -319,10 +318,10 @@ 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} vector the vector object to be transformed
-     * @return {me.Vector2d|me.Vector3d} result vector object.
+     * @param {me.Vector2d|me.Vector3d} v the vector object to be transformed
+     * @returns {me.Vector2d|me.Vector3d} result vector object.
      */
      apply(v) {
         var a = this.val,
@@ -345,10 +344,10 @@ 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} vector the vector object to be transformed
-      * @return {me.Vector2d|me.Vector3d} result vector object.
+      * @param {me.Vector2d|me.Vector3d} v the vector object to be transformed
+      * @returns {me.Vector2d|me.Vector3d} result vector object.
       */
      applyInverse(v) {
          // invert the current matrix
@@ -366,15 +365,15 @@ 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
-     * @param {Number} bottom farthest down on the y-axis
-     * @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
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @param {number} left farthest left on the x-axis
+     * @param {number} right farthest right on the x-axis
+     * @param {number} bottom farthest down on the y-axis
+     * @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
      */
     ortho(left, right, bottom, top, near, far) {
         var a = this.val;
@@ -405,12 +404,12 @@ 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.
-     * @param {Number} [z=0] a number representing the depth vector
-     * @return {me.Matrix3d} 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.
+     * @param {number} [z=0] a number representing the depth vector
+     * @returns {me.Matrix3d} Reference to this object for method chaining
      */
     scale(x, y, z) {
         var a = this.val,
@@ -439,10 +438,10 @@ class Matrix3d {
     /**
      * adds a 2D scaling transformation.
      * @name scaleV
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
-     * @param {me.Vector2d|me.Vector3d} vector scaling vector
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @param {me.Vector2d|me.Vector3d} v scaling vector
+     * @returns {me.Matrix3d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y, v.z);
@@ -451,10 +450,10 @@ 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
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @param {number} x x scaling vector
+     * @returns {me.Matrix3d} Reference to this object for method chaining
      */
     scaleX(x) {
         return this.scale(x, 1);
@@ -463,10 +462,10 @@ 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
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @param {number} y y scaling vector
+     * @returns {me.Matrix3d} Reference to this object for method chaining
      */
     scaleY(y) {
         return this.scale(1, y);
@@ -475,11 +474,11 @@ 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} axis the axis to rotate around
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @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
      */
     rotate(angle, v) {
         var a = this.val,
@@ -554,20 +553,20 @@ 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.
-     * @param {Number} [z=0] a number representing the depth of the vector
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @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
      */
     /**
      * 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
-     * @return {me.Matrix3d} Reference to this object for method chaining
+     * @returns {me.Matrix3d} Reference to this object for method chaining
      */
     translate() {
         var a = this.val;
@@ -596,10 +595,10 @@ class Matrix3d {
     /**
      * returns true if the matrix is an identity matrix.
      * @name isIdentity
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
-     * @return {Boolean}
-     **/
+     * @returns {boolean}
+     */
     isIdentity() {
         var a = this.val;
 
@@ -626,10 +625,10 @@ 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
-     * @return {Boolean} true if both are equals
+     * @returns {boolean} true if both are equals
      */
     equals(m) {
         var b = m.val;
@@ -658,9 +657,9 @@ class Matrix3d {
     /**
      * Clone the Matrix
      * @name clone
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
-     * @return {me.Matrix3d}
+     * @returns {me.Matrix3d}
      */
     clone() {
         return pool.pull("Matrix3d", this);
@@ -669,9 +668,9 @@ class Matrix3d {
     /**
      * return an array representation of this Matrix
      * @name toArray
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
-     * @return {Float32Array}
+     * @returns {Float32Array}
      */
     toArray() {
         return this.val;
@@ -680,9 +679,9 @@ class Matrix3d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.Matrix3d
+     * @memberof me.Matrix3d
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toString() {
         var a = this.val;