melonjs 10.1.1 → 10.2.3

package/src/math/vector3.js

@@ -7,9 +7,9 @@ import pool from "./../system/pooling.js";
  * @class 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 {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
  */
 
 class Vector3d {
@@ -30,7 +30,8 @@ class Vector3d {
     }
 
     /**
-     * @ignore */
+     * @ignore
+     */
     _set(x, y, z = 0) {
         this.x = x;
         this.y = y;
@@ -43,10 +44,10 @@ class Vector3d {
      * @name set
      * @memberOf me.Vector3d
      * @function
-     * @param {Number} x
-     * @param {Number} y
-     * @param {Number} [z=0]
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} y
+     * @param {number} [z=0]
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     set(x, y, z) {
         if (x !== +x || y !== +y || (typeof z !== "undefined" && z !== +z)) {
@@ -58,7 +59,7 @@ class Vector3d {
         /**
          * x value of the vector
          * @public
-         * @type Number
+         * @type {number}
          * @name x
          * @memberOf me.Vector3d
          */
@@ -67,7 +68,7 @@ class Vector3d {
         /**
          * y value of the vector
          * @public
-         * @type Number
+         * @type {number}
          * @name y
          * @memberOf me.Vector3d
          */
@@ -76,7 +77,7 @@ class Vector3d {
         /**
          * z value of the vector
          * @public
-         * @type Number
+         * @type {number}
          * @name z
          * @memberOf me.Vector3d
          */
@@ -90,7 +91,7 @@ class Vector3d {
      * @name setZero
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     setZero() {
         return this.set(0, 0, 0);
@@ -102,7 +103,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     setV(v) {
         return this._set(v.x, v.y, v.z);
@@ -114,7 +115,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} 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));
@@ -126,7 +127,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} 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));
@@ -137,10 +138,10 @@ class Vector3d {
      * @name scale
      * @memberOf me.Vector3d
      * @function
-     * @param {Number} x
-     * @param {Number} [y=x]
-     * @param {Number} [z=1]
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} [y=x]
+     * @param {number} [z=1]
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     scale(x, y, z) {
         y = (typeof (y) !== "undefined" ? y : x);
@@ -153,7 +154,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y, v.z);
@@ -164,7 +165,7 @@ class Vector3d {
      * @name toIso
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     toIso() {
         return this._set(this.x - this.y, (this.x + this.y) * 0.5, this.z);
@@ -175,7 +176,7 @@ class Vector3d {
      * @name to2d
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     to2d() {
         return this._set(this.y + this.x / 2, this.y - this.x / 2, this.z);
@@ -186,8 +187,8 @@ class Vector3d {
      * @name div
      * @memberOf me.Vector3d
      * @function
-     * @param {Number} value
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @param {number} n the value to divide the vector by
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     div(n) {
         return this._set(this.x / n, this.y / n, this.z / n);
@@ -198,7 +199,7 @@ class Vector3d {
      * @name abs
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} 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, (this.z < 0) ? -this.z : this.z);
@@ -209,9 +210,9 @@ class Vector3d {
      * @name clamp
      * @memberOf me.Vector3d
      * @function
-     * @param {Number} low
-     * @param {Number} high
-     * @return {me.Vector3d} new me.Vector3d
+     * @param {number} low
+     * @param {number} high
+     * @returns {me.Vector3d} new me.Vector3d
      */
     clamp(low, high) {
         return new Vector3d(clamp(this.x, low, high), clamp(this.y, low, high), clamp(this.z, low, high));
@@ -222,9 +223,9 @@ class Vector3d {
      * @name clampSelf
      * @memberOf me.Vector3d
      * @function
-     * @param {Number} low
-     * @param {Number} high
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @param {number} low
+     * @param {number} high
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     clampSelf(low, high) {
         return this._set(clamp(this.x, low, high), clamp(this.y, low, high), clamp(this.z, low, high));
@@ -236,7 +237,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     minV(v) {
         var _vz = v.z || 0;
@@ -249,7 +250,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     maxV(v) {
         var _vz = v.z || 0;
@@ -261,7 +262,7 @@ class Vector3d {
      * @name floor
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} new me.Vector3d
+     * @returns {me.Vector3d} new me.Vector3d
      */
     floor() {
         return new Vector3d(Math.floor(this.x), Math.floor(this.y), Math.floor(this.z));
@@ -272,7 +273,7 @@ class Vector3d {
      * @name floorSelf
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     floorSelf() {
         return this._set(Math.floor(this.x), Math.floor(this.y), Math.floor(this.z));
@@ -283,7 +284,7 @@ class Vector3d {
      * @name ceil
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} new me.Vector3d
+     * @returns {me.Vector3d} new me.Vector3d
      */
     ceil() {
         return new Vector3d(Math.ceil(this.x), Math.ceil(this.y), Math.ceil(this.z));
@@ -294,7 +295,7 @@ class Vector3d {
      * @name ceilSelf
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     ceilSelf() {
         return this._set(Math.ceil(this.x), Math.ceil(this.y), Math.ceil(this.z));
@@ -305,7 +306,7 @@ class Vector3d {
      * @name negate
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} new me.Vector3d
+     * @returns {me.Vector3d} new me.Vector3d
      */
     negate() {
         return new Vector3d(-this.x, -this.y, -this.z);
@@ -316,7 +317,7 @@ class Vector3d {
      * @name negateSelf
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     negateSelf() {
         return this._set(-this.x, -this.y, -this.z);
@@ -328,7 +329,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     copy(v) {
         return this._set(v.x, v.y, v.z || 0);
@@ -340,17 +341,17 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {Boolean}
+     * @returns {boolean}
      */
     /**
      * return true if this vector is equal to the given values
      * @name equals
      * @memberOf me.Vector3d
      * @function
-     * @param {Number} x
-     * @param {Number} y
-     * @param {Number} [z]
-     * @return {Boolean}
+     * @param {number} x
+     * @param {number} y
+     * @param {number} [z]
+     * @returns {boolean}
      */
     equals() {
         var _x, _y, _z;
@@ -378,7 +379,7 @@ class Vector3d {
      * @name normalize
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     normalize() {
         return this.div(this.length() || 1);
@@ -390,7 +391,7 @@ class Vector3d {
      * @name perp
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     perp() {
         return this._set(this.y, -this.x, this.z);
@@ -403,7 +404,7 @@ class 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.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     rotate(angle, v) {
         var cx = 0;
@@ -430,19 +431,19 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {Number} The dot product.
+     * @returns {number} The dot product.
      */
     dotProduct(v) {
         return this.x * v.x + this.y * v.y + this.z * (typeof(v.z) !== "undefined" ? v.z : this.z);
     }
 
    /**
-     * return the square length of this vector
-     * @name length2
-     * @memberOf me.Vector3d
-     * @function
-     * @return {Number} The length^2 of this vector.
-     */
+    * return the square length of this vector
+    * @name length2
+    * @memberOf me.Vector3d
+    * @function
+    * @returns {number} The length^2 of this vector.
+    */
     length2() {
         return this.dotProduct(this);
     }
@@ -452,7 +453,7 @@ class Vector3d {
      * @name length
      * @memberOf me.Vector3d
      * @function
-     * @return {Number} the length of this vector
+     * @returns {number} the length of this vector
      */
     length() {
         return Math.sqrt(this.length2());
@@ -464,8 +465,8 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector3d} v
-     * @param {Number} alpha distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
-     * @return {me.Vector3d} 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.Vector3d} Reference to this object for method chaining
      */
     lerp(v, alpha) {
         this.x += ( v.x - this.x ) * alpha;
@@ -480,7 +481,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {Number}
+     * @returns {number}
      */
     distance(v) {
         var dx = this.x - v.x;
@@ -495,7 +496,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v
-     * @return {Number} angle in radians
+     * @returns {number} angle in radians
      */
     angle(v) {
         return Math.acos(clamp(this.dotProduct(v) / (this.length() * v.length()), -1, 1));
@@ -507,7 +508,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v The vector to project onto.
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     project(v) {
         var ratio = this.dotProduct(v) / v.length2();
@@ -521,7 +522,7 @@ class Vector3d {
      * @memberOf me.Vector3d
      * @function
      * @param {me.Vector2d|me.Vector3d} v The unit vector to project onto.
-     * @return {me.Vector3d} Reference to this object for method chaining
+     * @returns {me.Vector3d} Reference to this object for method chaining
      */
     projectN(v) {
         var ratio = this.dotProduct(v) / v.length2();
@@ -533,7 +534,7 @@ class Vector3d {
      * @name clone
      * @memberOf me.Vector3d
      * @function
-     * @return {me.Vector3d} new me.Vector3d
+     * @returns {me.Vector3d} new me.Vector3d
      */
     clone() {
         return pool.pull("Vector3d", this.x, this.y, this.z);
@@ -544,7 +545,7 @@ class Vector3d {
      * @name toString
      * @memberOf me.Vector3d
      * @function
-     * @return {String}
+     * @returns {string}
      */
     toString() {
         return "x:" + this.x + ",y:" + this.y + ",z:" + this.z;