melonjs 10.1.1 → 10.2.3

package/src/math/observable_vector3.js

@@ -9,12 +9,12 @@ import pool from "./../system/pooling.js";
  * @extends me.Vector3d
  * @memberOf me
  * @constructor
- * @param {Number} [x=0] x value of the vector
- * @param {Number} [y=0] y value of the vector
- * @param {Number} [z=0] z value of the vector
- * @param {Object} settings additional required parameters
+ * @param {number} [x=0] x value of the vector
+ * @param {number} [y=0] y value of the vector
+ * @param {number} [z=0] z 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 {Object} [settings.scope] the value to use as this when calling onUpdate
+ * @param {object} [settings.scope] the value to use as this when calling onUpdate
  */
 class ObservableVector3d extends Vector3d {
 
@@ -43,20 +43,15 @@ class ObservableVector3d extends Vector3d {
     /**
      * x value of the vector
      * @public
-     * @type Number
+     * @type {number}
      * @name x
      * @memberOf me.ObservableVector3d
      */
 
-    /**
-     * @ignore
-     */
     get x() {
         return this._x;
     }
-    /**
-     * @ignore
-     */
+
     set x(value) {
         var ret = this.onUpdate.call(this.scope, value, this._y, this._z, this._x, this._y, this._z);
         if (ret && "x" in ret) {
@@ -69,20 +64,15 @@ class ObservableVector3d extends Vector3d {
     /**
      * y value of the vector
      * @public
-     * @type Number
+     * @type {number}
      * @name y
      * @memberOf me.ObservableVector3d
      */
 
-    /**
-     * @ignore
-     */
     get y() {
         return this._y;
     }
-    /**
-     * @ignore
-     */
+
     set y(value) {
         var ret = this.onUpdate.call(this.scope, this._x, value, this._z, this._x, this._y, this._z);
         if (ret && "y" in ret) {
@@ -96,20 +86,16 @@ class ObservableVector3d extends Vector3d {
     /**
      * z value of the vector
      * @public
-     * @type Number
+     * @type {number}
      * @name z
      * @memberOf me.ObservableVector3d
      */
 
-    /**
-     * @ignore
-     */
+
     get z() {
         return this._z;
     }
-    /**
-     * @ignore
-     */
+
     set z(value) {
         var ret = this.onUpdate.call(this.scope, this._x, this._y, value, this._x, this._y, this._z);
         if (ret && "z" in ret) {
@@ -119,9 +105,9 @@ class ObservableVector3d extends Vector3d {
         }
     }
 
-
     /**
-     * @ignore */
+     * @ignore
+     */
     _set(x, y, z) {
         var ret = this.onUpdate.call(this.scope, x, y, z, this._x, this._y, this._z);
         if (ret && "x" in ret && "y" in ret && "z" in ret) {
@@ -141,10 +127,10 @@ class ObservableVector3d extends Vector3d {
      * @name setMuted
      * @memberOf me.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
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @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
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     setMuted(x, y, z) {
         this._x = x;
@@ -158,9 +144,9 @@ class ObservableVector3d extends Vector3d {
      * @name setCallback
      * @memberOf me.ObservableVector3d
      * @function
-     * @param {function} onUpdate callback
-     * @param {function} [scope=null] scope
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {Function} fn callback
+     * @param {Function} [scope=null] scope
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     setCallback(fn, scope = null) {
         if (typeof(fn) !== "function") {
@@ -179,7 +165,7 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     add(v) {
         return this._set(this._x + v.x, this._y + v.y, this._z + (v.z || 0));
@@ -191,7 +177,7 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     sub(v) {
         return this._set(this._x - v.x, this._y - v.y, this._z - (v.z || 0));
@@ -202,10 +188,10 @@ class ObservableVector3d extends Vector3d {
      * @name scale
      * @memberOf me.ObservableVector3d
      * @function
-     * @param {Number} x
-     * @param {Number} [y=x]
-     * @param {Number} [z=1]
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} [y=x]
+     * @param {number} [z=1]
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     scale(x, y, z) {
         y = (typeof (y) !== "undefined" ? y : x);
@@ -218,7 +204,7 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this._set(this._x * v.x, this._y * v.y, this._z * (v.z || 1));
@@ -229,8 +215,8 @@ class ObservableVector3d extends Vector3d {
      * @name div
      * @memberOf me.ObservableVector3d
      * @function
-     * @param {Number} value
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {number} n the value to divide the vector by
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     div(n) {
         return this._set(this._x / n, this._y / n, this._z / n);
@@ -241,7 +227,7 @@ class ObservableVector3d extends Vector3d {
      * @name abs
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     abs() {
         return this._set(
@@ -256,9 +242,9 @@ class ObservableVector3d extends Vector3d {
      * @name clamp
      * @memberOf me.ObservableVector3d
      * @function
-     * @param {Number} low
-     * @param {Number} high
-     * @return {me.ObservableVector3d} new me.ObservableVector3d
+     * @param {number} low
+     * @param {number} high
+     * @returns {me.ObservableVector3d} new me.ObservableVector3d
      */
     clamp(low, high) {
         return new ObservableVector3d(
@@ -274,9 +260,9 @@ class ObservableVector3d extends Vector3d {
      * @name clampSelf
      * @memberOf me.ObservableVector3d
      * @function
-     * @param {Number} low
-     * @param {Number} high
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @param {number} low
+     * @param {number} high
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     clampSelf(low, high) {
         return this._set(
@@ -292,7 +278,7 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     minV(v) {
         var _vz = v.z || 0;
@@ -309,7 +295,7 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     maxV(v) {
         var _vz = v.z || 0;
@@ -325,7 +311,7 @@ class ObservableVector3d extends Vector3d {
      * @name floor
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.ObservableVector3d} new me.ObservableVector3d
+     * @returns {me.ObservableVector3d} new me.ObservableVector3d
      */
     floor() {
         return new ObservableVector3d(
@@ -341,7 +327,7 @@ class ObservableVector3d extends Vector3d {
      * @name floorSelf
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     floorSelf() {
         return this._set(Math.floor(this._x), Math.floor(this._y), Math.floor(this._z));
@@ -352,7 +338,7 @@ class ObservableVector3d extends Vector3d {
      * @name ceil
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.ObservableVector3d} new me.ObservableVector3d
+     * @returns {me.ObservableVector3d} new me.ObservableVector3d
      */
     ceil() {
         return new ObservableVector3d(
@@ -368,7 +354,7 @@ class ObservableVector3d extends Vector3d {
      * @name ceilSelf
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     ceilSelf() {
         return this._set(Math.ceil(this._x), Math.ceil(this._y), Math.ceil(this._z));
@@ -379,7 +365,7 @@ class ObservableVector3d extends Vector3d {
      * @name negate
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.ObservableVector3d} new me.ObservableVector3d
+     * @returns {me.ObservableVector3d} new me.ObservableVector3d
      */
     negate() {
         return new ObservableVector3d(
@@ -395,7 +381,7 @@ class ObservableVector3d extends Vector3d {
      * @name negateSelf
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     negateSelf() {
         return this._set(-this._x, -this._y, -this._z);
@@ -407,7 +393,7 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     copy(v) {
         return this._set(v.x, v.y, v.z || 0);
@@ -419,7 +405,7 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @return {Boolean}
+     * @returns {boolean}
      */
     equals(v) {
         return ((this._x === v.x) && (this._y === v.y) && (this._z === (v.z || this._z)));
@@ -431,7 +417,7 @@ class ObservableVector3d extends Vector3d {
      * @name perp
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     perp() {
         return this._set(this._y, -this._x, this._z);
@@ -444,7 +430,7 @@ class ObservableVector3d extends Vector3d {
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around (on the same z axis)
-     * @return {me.ObservableVector3d} Reference to this object for method chaining
+     * @returns {me.ObservableVector3d} Reference to this object for method chaining
      */
     rotate(angle, v) {
         var cx = 0;
@@ -471,7 +457,7 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @return {Number} The dot product.
+     * @returns {number} The dot product.
      */
     dotProduct(v) {
         return this._x * v.x + this._y * v.y + this._z * (v.z || 1);
@@ -483,8 +469,8 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector3d|me.ObservableVector3d} v
-     * @param {Number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
-     * @return {me.ObservableVector3d} 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.ObservableVector3d} Reference to this object for method chaining
      */
     lerp(v, alpha) {
         this._x += ( v.x - this._x ) * alpha;
@@ -499,7 +485,7 @@ class ObservableVector3d extends Vector3d {
      * @memberOf me.ObservableVector3d
      * @function
      * @param {me.Vector2d|me.Vector3d|me.ObservableVector2d|me.ObservableVector3d} v
-     * @return {Number}
+     * @returns {number}
      */
     distance(v) {
         var dx = this._x - v.x;
@@ -513,7 +499,7 @@ class ObservableVector3d extends Vector3d {
      * @name clone
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.ObservableVector3d} new me.ObservableVector3d
+     * @returns {me.ObservableVector3d} new me.ObservableVector3d
      */
     clone() {
         return pool.pull("ObservableVector3d",
@@ -529,7 +515,7 @@ class ObservableVector3d extends Vector3d {
      * @name toVector3d
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {me.Vector3d} new me.Vector3d
+     * @returns {me.Vector3d} new me.Vector3d
      */
     toVector3d() {
         return pool.pull("Vector3d", this._x, this._y, this._z);
@@ -540,7 +526,7 @@ class ObservableVector3d extends Vector3d {
      * @name toString
      * @memberOf me.ObservableVector3d
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toString() {
         return "x:" + this._x + ",y:" + this._y + ",z:" + this._z;