melonjs 10.2.0 → 10.3.0

package/src/math/observable_vector2.js

@@ -6,12 +6,11 @@ import {clamp} from "./math.js";
  * @classdesc
  * A Vector2d object that provide notification by executing the given callback when the vector is changed.
  * @class ObservableVector2d
- * @extends me.Vector2d
- * @memberOf me
- * @constructor
- * @param {Number} [x=0] x value of the vector
- * @param {Number} [y=0] y value of the vector
- * @param {Object} settings additional required parameters
+ * @augments me.Vector2d
+ * @memberof me
+ * @param {number} [x=0] x value of the vector
+ * @param {number} [y=0] y value of the vector
+ * @param {object} settings additional required parameters
  * @param {Function} settings.onUpdate the callback to be executed when the vector is changed
  * @param {Function} [settings.scope] the value to use as this when calling onUpdate
  */
@@ -42,21 +41,15 @@ class ObservableVector2d extends Vector2d {
     /**
      * x value of the vector
      * @public
-     * @type Number
+     * @type {number}
      * @name x
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      */
 
-    /**
-     * @ignore
-     */
     get x() {
         return this._x;
     }
 
-    /**
-     * @ignore
-     */
     set x(value) {
         var ret = this.onUpdate.call(this.scope, value, this._y, this._x, this._y);
         if (ret && "x" in ret) {
@@ -70,21 +63,15 @@ class ObservableVector2d extends Vector2d {
     /**
      * y value of the vector
      * @public
-     * @type Number
+     * @type {number}
      * @name y
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      */
 
-    /**
-     * @ignore
-     */
     get y() {
         return this._y;
     }
 
-    /**
-     * @ignore
-     */
     set y(value) {
         var ret = this.onUpdate.call(this.scope, this._x, value, this._x, this._y);
         if (ret && "y" in ret) {
@@ -110,11 +97,11 @@ class ObservableVector2d extends Vector2d {
     /**
      * set the vector value without triggering the callback
      * @name setMuted
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @param {Number} x x value of the vector
-     * @param {Number} y y value of the vector
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @param {number} x x value of the vector
+     * @param {number} y y value of the vector
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     setMuted(x, y) {
         this._x = x;
@@ -125,11 +112,11 @@ class ObservableVector2d extends Vector2d {
     /**
      * set the callback to be executed when the vector is changed
      * @name setCallback
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @param {function} onUpdate callback
-     * @param {function} [scope=null] scope
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @param {Function} fn callback
+     * @param {Function} [scope=null] scope
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     setCallback(fn, scope = null) {
         if (typeof(fn) !== "function") {
@@ -145,10 +132,10 @@ class ObservableVector2d extends Vector2d {
     /**
      * Add the passed vector to this vector
      * @name add
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     add(v) {
         return this._set(this._x + v.x, this._y + v.y);
@@ -157,10 +144,10 @@ class ObservableVector2d extends Vector2d {
     /**
      * Substract the passed vector to this vector
      * @name sub
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     sub(v) {
         return this._set(this._x - v.x, this._y - v.y);
@@ -169,11 +156,11 @@ class ObservableVector2d extends Vector2d {
     /**
      * Multiply this vector values by the given scalar
      * @name scale
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @param {Number} x
-     * @param {Number} [y=x]
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} [y=x]
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     scale(x, y) {
         return this._set(this._x * x, this._y * (typeof (y) !== "undefined" ? y : x));
@@ -182,10 +169,10 @@ class ObservableVector2d extends Vector2d {
     /**
      * Multiply this vector values by the passed vector
      * @name scaleV
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this._set(this._x * v.x, this._y * v.y);
@@ -194,10 +181,10 @@ class ObservableVector2d extends Vector2d {
     /**
      * Divide this vector values by the passed value
      * @name div
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @param {Number} value
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @param {number} n the value to divide the vector by
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     div(n) {
         return this._set(this._x / n, this._y / n);
@@ -206,9 +193,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * Update this vector values to absolute values
      * @name abs
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     abs() {
         return this._set((this._x < 0) ? -this._x : this._x, (this._y < 0) ? -this._y : this._y);
@@ -217,11 +204,11 @@ class ObservableVector2d extends Vector2d {
     /**
      * Clamp the vector value within the specified value range
      * @name clamp
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @param {Number} low
-     * @param {Number} high
-     * @return {me.ObservableVector2d} new me.ObservableVector2d
+     * @param {number} low
+     * @param {number} high
+     * @returns {me.ObservableVector2d} new me.ObservableVector2d
      */
     clamp(low, high) {
         return new ObservableVector2d(clamp(this.x, low, high), clamp(this.y, low, high), {onUpdate: this.onUpdate, scope: this.scope});
@@ -230,11 +217,11 @@ class ObservableVector2d extends Vector2d {
     /**
      * Clamp this vector value within the specified value range
      * @name clampSelf
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @param {Number} low
-     * @param {Number} high
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @param {number} low
+     * @param {number} high
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     clampSelf(low, high) {
         return this._set(clamp(this._x, low, high), clamp(this._y, low, high));
@@ -243,10 +230,10 @@ class ObservableVector2d extends Vector2d {
     /**
      * Update this vector with the minimum value between this and the passed vector
      * @name minV
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     minV(v) {
         return this._set((this._x < v.x) ? this._x : v.x, (this._y < v.y) ? this._y : v.y);
@@ -255,10 +242,10 @@ class ObservableVector2d extends Vector2d {
     /**
      * Update this vector with the maximum value between this and the passed vector
      * @name maxV
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     maxV(v) {
         return this._set((this._x > v.x) ? this._x : v.x, (this._y > v.y) ? this._y : v.y);
@@ -267,9 +254,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * Floor the vector values
      * @name floor
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.ObservableVector2d} new me.ObservableVector2d
+     * @returns {me.ObservableVector2d} new me.ObservableVector2d
      */
     floor() {
         return new ObservableVector2d(Math.floor(this._x), Math.floor(this._y), {onUpdate: this.onUpdate, scope: this.scope});
@@ -278,9 +265,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * Floor this vector values
      * @name floorSelf
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     floorSelf() {
         return this._set(Math.floor(this._x), Math.floor(this._y));
@@ -289,9 +276,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * Ceil the vector values
      * @name ceil
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.ObservableVector2d} new me.ObservableVector2d
+     * @returns {me.ObservableVector2d} new me.ObservableVector2d
      */
     ceil() {
         return new ObservableVector2d(Math.ceil(this._x), Math.ceil(this._y), {onUpdate: this.onUpdate, scope: this.scope});
@@ -300,9 +287,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * Ceil this vector values
      * @name ceilSelf
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     ceilSelf() {
         return this._set(Math.ceil(this._x), Math.ceil(this._y));
@@ -311,9 +298,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * Negate the vector values
      * @name negate
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.ObservableVector2d} new me.ObservableVector2d
+     * @returns {me.ObservableVector2d} new me.ObservableVector2d
      */
     negate() {
         return new ObservableVector2d(-this._x, -this._y, {onUpdate: this.onUpdate, scope: this.scope});
@@ -322,9 +309,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * Negate this vector values
      * @name negateSelf
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     negateSelf() {
         return this._set(-this._x, -this._y);
@@ -333,10 +320,10 @@ class ObservableVector2d extends Vector2d {
     /**
      * Copy the x,y values of the passed vector to this one
      * @name copy
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     copy(v) {
         return this._set(v.x, v.y);
@@ -345,10 +332,10 @@ class ObservableVector2d extends Vector2d {
     /**
      * return true if the two vectors are the same
      * @name equals
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
-     * @return {Boolean}
+     * @returns {boolean}
      */
     equals(v) {
         return ((this._x === v.x) && (this._y === v.y));
@@ -358,9 +345,9 @@ class ObservableVector2d extends Vector2d {
      * change this vector to be perpendicular to what it was before.<br>
      * (Effectively rotates it 90 degrees in a clockwise direction)
      * @name perp
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     perp() {
         return this._set(this._y, -this._x);
@@ -369,11 +356,11 @@ class ObservableVector2d extends Vector2d {
     /**
      * Rotate this vector (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     rotate(angle, v) {
         var cx = 0;
@@ -395,24 +382,36 @@ class ObservableVector2d extends Vector2d {
 
     /**
      * return the dot product of this vector and the passed one
-     * @name dotProduct
-     * @memberOf me.ObservableVector2d
+     * @name dot
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.Vector2d|me.ObservableVector2d} v
-     * @return {Number} The dot product.
+     * @returns {number} The dot product.
      */
-    dotProduct(v) {
+    dot(v) {
         return this._x * v.x + this._y * v.y;
     }
 
+    /**
+     * return the cross product of this vector and the passed one
+     * @name cross
+     * @memberof me.ObservableVector2d
+     * @function
+     * @param {me.Vector2d|me.ObservableVector2d} v
+     * @returns {number} The cross product.
+     */
+    cross(v) {
+        return this._x * v.y - this._y * v.x;
+    }
+
     /**
      * Linearly interpolate between this vector and the given one.
      * @name lerp
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.Vector2d|me.ObservableVector2d} v
-     * @param {Number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
-     * @return {me.ObservableVector2d} Reference to this object for method chaining
+     * @param {number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
+     * @returns {me.ObservableVector2d} Reference to this object for method chaining
      */
     lerp(v, alpha) {
         this._x += ( v.x - this._x ) * alpha;
@@ -423,10 +422,10 @@ class ObservableVector2d extends Vector2d {
     /**
      * return the distance between this vector and the passed one
      * @name distance
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
      * @param {me.ObservableVector2d} v
-     * @return {Number}
+     * @returns {number}
      */
     distance(v) {
         return Math.sqrt((this._x - v.x) * (this._x - v.x) + (this._y - v.y) * (this._y - v.y));
@@ -435,9 +434,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * return a clone copy of this vector
      * @name clone
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.ObservableVector2d} new me.ObservableVector2d
+     * @returns {me.ObservableVector2d} new me.ObservableVector2d
      */
     clone() {
         return pool.pull("ObservableVector2d", this._x, this._y, {onUpdate: this.onUpdate, scope: this.scope});
@@ -446,9 +445,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * return a `me.Vector2d` copy of this `me.ObservableVector2d` object
      * @name toVector2d
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {me.Vector2d} new me.Vector2d
+     * @returns {me.Vector2d} new me.Vector2d
      */
     toVector2d() {
         return pool.pull("Vector2d", this._x, this._y);
@@ -457,9 +456,9 @@ class ObservableVector2d extends Vector2d {
     /**
      * convert the object to a string representation
      * @name toString
-     * @memberOf me.ObservableVector2d
+     * @memberof me.ObservableVector2d
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toString() {
         return "x:" + this._x + ",y:" + this._y;