melonjs 10.9.0 → 10.12.0

package/src/math/matrix3.js

@@ -71,7 +71,6 @@ class Matrix3d {
      * <img src="images/identity-matrix_2x.png"/>
      * @name identity
      * @memberof Matrix3d
-     * @function
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     identity() {
@@ -87,7 +86,6 @@ class Matrix3d {
      * set the matrix to the specified value
      * @name setTransform
      * @memberof Matrix3d
-     * @function
      * @param {number} m00
      * @param {number} m01
      * @param {number} m02
@@ -133,7 +131,6 @@ class Matrix3d {
      * Copies over the values from another me.Matrix3d.
      * @name copy
      * @memberof Matrix3d
-     * @function
      * @param {Matrix3d} m the matrix object to copy from
      * @returns {Matrix3d} Reference to this object for method chaining
      */
@@ -146,7 +143,6 @@ class Matrix3d {
      * Copies over the upper-left 2x2 values from the given me.Matrix2d
      * @name fromMat2d
      * @memberof Matrix3d
-     * @function
      * @param {Matrix2d} m the matrix object to copy from
      * @returns {Matrix2d} Reference to this object for method chaining
      */
@@ -165,7 +161,6 @@ class Matrix3d {
      * multiply both matrix
      * @name multiply
      * @memberof Matrix3d
-     * @function
      * @param {Matrix3d} m Other matrix
      * @returns {Matrix3d} Reference to this object for method chaining
      */
@@ -221,7 +216,6 @@ class Matrix3d {
      * Transpose the value of this matrix.
      * @name transpose
      * @memberof Matrix3d
-     * @function
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     transpose() {
@@ -253,7 +247,6 @@ class Matrix3d {
      * invert this matrix, causing it to apply the opposite transformation.
      * @name invert
      * @memberof Matrix3d
-     * @function
      * @returns {Matrix3d} Reference to this object for method chaining
      */
     invert() {
@@ -313,7 +306,6 @@ class Matrix3d {
      * apply the current transform to the given 2d or 3d vector
      * @name apply
      * @memberof Matrix3d
-     * @function
      * @param {Vector2d|Vector3d} v the vector object to be transformed
      * @returns {Vector2d|Vector3d} result vector object.
      */
@@ -339,7 +331,6 @@ class Matrix3d {
       * apply the inverted current transform to the given 2d or 3d vector
       * @name applyInverse
       * @memberof Matrix3d
-      * @function
       * @param {Vector2d|Vector3d} v the vector object to be transformed
       * @returns {Vector2d|Vector3d} result vector object.
       */
@@ -360,7 +351,6 @@ class Matrix3d {
      * <img src="images/glOrtho.gif"/><br>
      * @name ortho
      * @memberof 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
@@ -399,7 +389,6 @@ class Matrix3d {
      * scale the matrix
      * @name scale
      * @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
@@ -433,7 +422,6 @@ class Matrix3d {
      * adds a 2D scaling transformation.
      * @name scaleV
      * @memberof Matrix3d
-     * @function
      * @param {Vector2d|Vector3d} v scaling vector
      * @returns {Matrix3d} Reference to this object for method chaining
      */
@@ -445,7 +433,6 @@ class Matrix3d {
      * specifies a 2D scale operation using the [sx, 1] scaling vector
      * @name scaleX
      * @memberof Matrix3d
-     * @function
      * @param {number} x x scaling vector
      * @returns {Matrix3d} Reference to this object for method chaining
      */
@@ -457,7 +444,6 @@ class Matrix3d {
      * specifies a 2D scale operation using the [1,sy] scaling vector
      * @name scaleY
      * @memberof Matrix3d
-     * @function
      * @param {number} y y scaling vector
      * @returns {Matrix3d} Reference to this object for method chaining
      */
@@ -469,7 +455,6 @@ class Matrix3d {
      * rotate this matrix (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof Matrix3d
-     * @function
      * @param {number} angle Rotation angle in radians.
      * @param {Vector3d} v the axis to rotate around
      * @returns {Matrix3d} Reference to this object for method chaining
@@ -549,7 +534,7 @@ class Matrix3d {
      * translate the matrix position using the given vector
      * @name translate
      * @memberof Matrix3d
-     * @function
+     * @method
      * @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
@@ -559,7 +544,6 @@ class Matrix3d {
      * translate the matrix by a vector on the horizontal and vertical axis
      * @name translateV
      * @memberof Matrix3d
-     * @function
      * @param {Vector2d|Vector3d} v the vector to translate the matrix by
      * @returns {Matrix3d} Reference to this object for method chaining
      */
@@ -591,7 +575,6 @@ class Matrix3d {
      * returns true if the matrix is an identity matrix.
      * @name isIdentity
      * @memberof Matrix3d
-     * @function
      * @returns {boolean}
      */
     isIdentity() {
@@ -621,7 +604,6 @@ class Matrix3d {
      * return true if the two matrices are identical
      * @name equals
      * @memberof Matrix3d
-     * @function
      * @param {Matrix3d} m the other matrix
      * @returns {boolean} true if both are equals
      */
@@ -653,7 +635,6 @@ class Matrix3d {
      * Clone the Matrix
      * @name clone
      * @memberof Matrix3d
-     * @function
      * @returns {Matrix3d}
      */
     clone() {
@@ -664,7 +645,6 @@ class Matrix3d {
      * return an array representation of this Matrix
      * @name toArray
      * @memberof Matrix3d
-     * @function
      * @returns {Float32Array}
      */
     toArray() {
@@ -675,7 +655,6 @@ class Matrix3d {
      * convert the object to a string representation
      * @name toString
      * @memberof Matrix3d
-     * @function
      * @returns {string}
      */
     toString() {

package/src/math/observable_vector2.js

@@ -97,7 +97,6 @@ class ObservableVector2d extends Vector2d {
      * set the vector value without triggering the callback
      * @name setMuted
      * @memberof ObservableVector2d
-     * @function
      * @param {number} x x value of the vector
      * @param {number} y y value of the vector
      * @returns {ObservableVector2d} Reference to this object for method chaining
@@ -112,7 +111,6 @@ class ObservableVector2d extends Vector2d {
      * set the callback to be executed when the vector is changed
      * @name setCallback
      * @memberof ObservableVector2d
-     * @function
      * @param {Function} fn callback
      * @param {Function} [scope=null] scope
      * @returns {ObservableVector2d} Reference to this object for method chaining
@@ -132,7 +130,6 @@ class ObservableVector2d extends Vector2d {
      * Add the passed vector to this vector
      * @name add
      * @memberof ObservableVector2d
-     * @function
      * @param {ObservableVector2d} v
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
@@ -144,7 +141,6 @@ class ObservableVector2d extends Vector2d {
      * Substract the passed vector to this vector
      * @name sub
      * @memberof ObservableVector2d
-     * @function
      * @param {ObservableVector2d} v
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
@@ -156,7 +152,6 @@ class ObservableVector2d extends Vector2d {
      * Multiply this vector values by the given scalar
      * @name scale
      * @memberof ObservableVector2d
-     * @function
      * @param {number} x
      * @param {number} [y=x]
      * @returns {ObservableVector2d} Reference to this object for method chaining
@@ -169,7 +164,6 @@ class ObservableVector2d extends Vector2d {
      * Multiply this vector values by the passed vector
      * @name scaleV
      * @memberof ObservableVector2d
-     * @function
      * @param {ObservableVector2d} v
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
@@ -181,7 +175,6 @@ class ObservableVector2d extends Vector2d {
      * Divide this vector values by the passed value
      * @name div
      * @memberof ObservableVector2d
-     * @function
      * @param {number} n the value to divide the vector by
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
@@ -193,7 +186,6 @@ class ObservableVector2d extends Vector2d {
      * Update this vector values to absolute values
      * @name abs
      * @memberof ObservableVector2d
-     * @function
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     abs() {
@@ -204,7 +196,6 @@ class ObservableVector2d extends Vector2d {
      * Clamp the vector value within the specified value range
      * @name clamp
      * @memberof ObservableVector2d
-     * @function
      * @param {number} low
      * @param {number} high
      * @returns {ObservableVector2d} new me.ObservableVector2d
@@ -217,7 +208,6 @@ class ObservableVector2d extends Vector2d {
      * Clamp this vector value within the specified value range
      * @name clampSelf
      * @memberof ObservableVector2d
-     * @function
      * @param {number} low
      * @param {number} high
      * @returns {ObservableVector2d} Reference to this object for method chaining
@@ -230,7 +220,6 @@ class ObservableVector2d extends Vector2d {
      * Update this vector with the minimum value between this and the passed vector
      * @name minV
      * @memberof ObservableVector2d
-     * @function
      * @param {ObservableVector2d} v
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
@@ -242,7 +231,6 @@ class ObservableVector2d extends Vector2d {
      * Update this vector with the maximum value between this and the passed vector
      * @name maxV
      * @memberof ObservableVector2d
-     * @function
      * @param {ObservableVector2d} v
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
@@ -254,7 +242,6 @@ class ObservableVector2d extends Vector2d {
      * Floor the vector values
      * @name floor
      * @memberof ObservableVector2d
-     * @function
      * @returns {ObservableVector2d} new me.ObservableVector2d
      */
     floor() {
@@ -265,7 +252,6 @@ class ObservableVector2d extends Vector2d {
      * Floor this vector values
      * @name floorSelf
      * @memberof ObservableVector2d
-     * @function
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     floorSelf() {
@@ -276,7 +262,6 @@ class ObservableVector2d extends Vector2d {
      * Ceil the vector values
      * @name ceil
      * @memberof ObservableVector2d
-     * @function
      * @returns {ObservableVector2d} new me.ObservableVector2d
      */
     ceil() {
@@ -287,7 +272,6 @@ class ObservableVector2d extends Vector2d {
      * Ceil this vector values
      * @name ceilSelf
      * @memberof ObservableVector2d
-     * @function
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     ceilSelf() {
@@ -298,7 +282,6 @@ class ObservableVector2d extends Vector2d {
      * Negate the vector values
      * @name negate
      * @memberof ObservableVector2d
-     * @function
      * @returns {ObservableVector2d} new me.ObservableVector2d
      */
     negate() {
@@ -309,7 +292,6 @@ class ObservableVector2d extends Vector2d {
      * Negate this vector values
      * @name negateSelf
      * @memberof ObservableVector2d
-     * @function
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     negateSelf() {
@@ -320,7 +302,6 @@ class ObservableVector2d extends Vector2d {
      * Copy the x,y values of the passed vector to this one
      * @name copy
      * @memberof ObservableVector2d
-     * @function
      * @param {ObservableVector2d} v
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
@@ -332,7 +313,6 @@ class ObservableVector2d extends Vector2d {
      * return true if the two vectors are the same
      * @name equals
      * @memberof ObservableVector2d
-     * @function
      * @param {ObservableVector2d} v
      * @returns {boolean}
      */
@@ -345,7 +325,6 @@ class ObservableVector2d extends Vector2d {
      * (Effectively rotates it 90 degrees in a clockwise direction)
      * @name perp
      * @memberof ObservableVector2d
-     * @function
      * @returns {ObservableVector2d} Reference to this object for method chaining
      */
     perp() {
@@ -356,7 +335,6 @@ class ObservableVector2d extends Vector2d {
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof ObservableVector2d
-     * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
      * @returns {ObservableVector2d} Reference to this object for method chaining
@@ -383,7 +361,6 @@ class ObservableVector2d extends Vector2d {
      * return the dot product of this vector and the passed one
      * @name dot
      * @memberof ObservableVector2d
-     * @function
      * @param {Vector2d|ObservableVector2d} v
      * @returns {number} The dot product.
      */
@@ -395,7 +372,6 @@ class ObservableVector2d extends Vector2d {
      * return the cross product of this vector and the passed one
      * @name cross
      * @memberof ObservableVector2d
-     * @function
      * @param {Vector2d|ObservableVector2d} v
      * @returns {number} The cross product.
      */
@@ -407,7 +383,6 @@ class ObservableVector2d extends Vector2d {
      * Linearly interpolate between this vector and the given one.
      * @name lerp
      * @memberof ObservableVector2d
-     * @function
      * @param {Vector2d|ObservableVector2d} v
      * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
      * @returns {ObservableVector2d} Reference to this object for method chaining
@@ -422,7 +397,6 @@ class ObservableVector2d extends Vector2d {
      * return the distance between this vector and the passed one
      * @name distance
      * @memberof ObservableVector2d
-     * @function
      * @param {ObservableVector2d} v
      * @returns {number}
      */
@@ -434,7 +408,6 @@ class ObservableVector2d extends Vector2d {
      * return a clone copy of this vector
      * @name clone
      * @memberof ObservableVector2d
-     * @function
      * @returns {ObservableVector2d} new me.ObservableVector2d
      */
     clone() {
@@ -445,7 +418,6 @@ class ObservableVector2d extends Vector2d {
      * return a `me.Vector2d` copy of this `me.ObservableVector2d` object
      * @name toVector2d
      * @memberof ObservableVector2d
-     * @function
      * @returns {Vector2d} new me.Vector2d
      */
     toVector2d() {
@@ -456,7 +428,6 @@ class ObservableVector2d extends Vector2d {
      * convert the object to a string representation
      * @name toString
      * @memberof ObservableVector2d
-     * @function
      * @returns {string}
      */
     toString() {

package/src/math/observable_vector3.js

@@ -124,7 +124,6 @@ class ObservableVector3d extends Vector3d {
      * set the vector value without triggering the callback
      * @name setMuted
      * @memberof ObservableVector3d
-     * @function
      * @param {number} x x value of the vector
      * @param {number} y y value of the vector
      * @param {number} [z=0] z value of the vector
@@ -141,7 +140,6 @@ class ObservableVector3d extends Vector3d {
      * set the callback to be executed when the vector is changed
      * @name setCallback
      * @memberof ObservableVector3d
-     * @function
      * @param {Function} fn callback
      * @param {Function} [scope=null] scope
      * @returns {ObservableVector3d} Reference to this object for method chaining
@@ -161,7 +159,6 @@ class ObservableVector3d extends Vector3d {
      * Add the passed vector to this vector
      * @name add
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
@@ -173,7 +170,6 @@ class ObservableVector3d extends Vector3d {
      * Substract the passed vector to this vector
      * @name sub
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
@@ -185,7 +181,6 @@ class ObservableVector3d extends Vector3d {
      * Multiply this vector values by the given scalar
      * @name scale
      * @memberof ObservableVector3d
-     * @function
      * @param {number} x
      * @param {number} [y=x]
      * @param {number} [z=1]
@@ -200,7 +195,6 @@ class ObservableVector3d extends Vector3d {
      * Multiply this vector values by the passed vector
      * @name scaleV
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
@@ -212,7 +206,6 @@ class ObservableVector3d extends Vector3d {
      * Divide this vector values by the passed value
      * @name div
      * @memberof ObservableVector3d
-     * @function
      * @param {number} n the value to divide the vector by
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
@@ -224,7 +217,6 @@ class ObservableVector3d extends Vector3d {
      * Update this vector values to absolute values
      * @name abs
      * @memberof ObservableVector3d
-     * @function
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     abs() {
@@ -239,7 +231,6 @@ class ObservableVector3d extends Vector3d {
      * Clamp the vector value within the specified value range
      * @name clamp
      * @memberof ObservableVector3d
-     * @function
      * @param {number} low
      * @param {number} high
      * @returns {ObservableVector3d} new me.ObservableVector3d
@@ -257,7 +248,6 @@ class ObservableVector3d extends Vector3d {
      * Clamp this vector value within the specified value range
      * @name clampSelf
      * @memberof ObservableVector3d
-     * @function
      * @param {number} low
      * @param {number} high
      * @returns {ObservableVector3d} Reference to this object for method chaining
@@ -274,7 +264,6 @@ class ObservableVector3d extends Vector3d {
      * Update this vector with the minimum value between this and the passed vector
      * @name minV
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
@@ -291,7 +280,6 @@ class ObservableVector3d extends Vector3d {
      * Update this vector with the maximum value between this and the passed vector
      * @name maxV
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
@@ -308,7 +296,6 @@ class ObservableVector3d extends Vector3d {
      * Floor the vector values
      * @name floor
      * @memberof ObservableVector3d
-     * @function
      * @returns {ObservableVector3d} new me.ObservableVector3d
      */
     floor() {
@@ -324,7 +311,6 @@ class ObservableVector3d extends Vector3d {
      * Floor this vector values
      * @name floorSelf
      * @memberof ObservableVector3d
-     * @function
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     floorSelf() {
@@ -335,7 +321,6 @@ class ObservableVector3d extends Vector3d {
      * Ceil the vector values
      * @name ceil
      * @memberof ObservableVector3d
-     * @function
      * @returns {ObservableVector3d} new me.ObservableVector3d
      */
     ceil() {
@@ -351,7 +336,6 @@ class ObservableVector3d extends Vector3d {
      * Ceil this vector values
      * @name ceilSelf
      * @memberof ObservableVector3d
-     * @function
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     ceilSelf() {
@@ -362,7 +346,6 @@ class ObservableVector3d extends Vector3d {
      * Negate the vector values
      * @name negate
      * @memberof ObservableVector3d
-     * @function
      * @returns {ObservableVector3d} new me.ObservableVector3d
      */
     negate() {
@@ -378,7 +361,6 @@ class ObservableVector3d extends Vector3d {
      * Negate this vector values
      * @name negateSelf
      * @memberof ObservableVector3d
-     * @function
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     negateSelf() {
@@ -389,7 +371,6 @@ class ObservableVector3d extends Vector3d {
      * Copy the components of the given vector into this one
      * @name copy
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
@@ -401,7 +382,6 @@ class ObservableVector3d extends Vector3d {
      * return true if the two vectors are the same
      * @name equals
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {boolean}
      */
@@ -414,7 +394,6 @@ class ObservableVector3d extends Vector3d {
      * (Effectively rotates it 90 degrees in a clockwise direction)
      * @name perp
      * @memberof ObservableVector3d
-     * @function
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
     perp() {
@@ -425,7 +404,6 @@ class ObservableVector3d extends Vector3d {
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
      * @memberof ObservableVector3d
-     * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around (on the same z axis)
      * @returns {ObservableVector3d} Reference to this object for method chaining
@@ -453,7 +431,6 @@ class ObservableVector3d extends Vector3d {
      * return the dot product of this vector and the passed one
      * @name dot
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {number} The dot product.
      */
@@ -465,7 +442,6 @@ class ObservableVector3d extends Vector3d {
      * calculate the cross product of this vector and the passed one
      * @name cross
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector3d|ObservableVector3d} v
      * @returns {ObservableVector3d} Reference to this object for method chaining
      */
@@ -484,7 +460,6 @@ class ObservableVector3d extends Vector3d {
      * Linearly interpolate between this vector and the given one.
      * @name lerp
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector3d|ObservableVector3d} v
      * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
      * @returns {ObservableVector3d} Reference to this object for method chaining
@@ -500,7 +475,6 @@ class ObservableVector3d extends Vector3d {
      * return the distance between this vector and the passed one
      * @name distance
      * @memberof ObservableVector3d
-     * @function
      * @param {Vector2d|Vector3d|ObservableVector2d|ObservableVector3d} v
      * @returns {number}
      */
@@ -515,7 +489,6 @@ class ObservableVector3d extends Vector3d {
      * return a clone copy of this vector
      * @name clone
      * @memberof ObservableVector3d
-     * @function
      * @returns {ObservableVector3d} new me.ObservableVector3d
      */
     clone() {
@@ -531,7 +504,6 @@ class ObservableVector3d extends Vector3d {
      * return a `me.Vector3d` copy of this `me.ObservableVector3d` object
      * @name toVector3d
      * @memberof ObservableVector3d
-     * @function
      * @returns {Vector3d} new me.Vector3d
      */
     toVector3d() {
@@ -542,7 +514,6 @@ class ObservableVector3d extends Vector3d {
      * convert the object to a string representation
      * @name toString
      * @memberof ObservableVector3d
-     * @function
      * @returns {string}
      */
     toString() {