melonjs 10.2.0 → 10.3.0

package/src/{shapes → geometries}/rectangle.js

@@ -5,13 +5,12 @@ import Polygon from "./poly.js";
  * @classdesc
  * a rectangle Object
  * @class Rect
- * @extends me.Polygon
- * @memberOf me
- * @constructor
- * @param {Number} x position of the Rectangle
- * @param {Number} y position of the Rectangle
- * @param {Number} w width of the rectangle
- * @param {Number} h height of the rectangle
+ * @augments me.Polygon
+ * @memberof me
+ * @param {number} x position of the Rectangle
+ * @param {number} y position of the Rectangle
+ * @param {number} w width of the rectangle
+ * @param {number} h height of the rectangle
  */
 
 class Rect extends Polygon {
@@ -35,13 +34,13 @@ class Rect extends Polygon {
     /**
      * set new value to the rectangle shape
      * @name setShape
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
-     * @param {Number} x position of the Rectangle
-     * @param {Number} y position of the Rectangle
-     * @param {Number|Array} w|points width of the rectangle, or an array of vector defining the rectangle
-     * @param {Number} [h] height of the rectangle, if a numeral width parameter is specified
-     * @return {me.Rect} this rectangle
+     * @param {number} x position of the Rectangle
+     * @param {number} y position of the Rectangle
+     * @param {number|me.Vector2d[]} w width of the rectangle, or an array of vector defining the rectangle
+     * @param {number} [h] height of the rectangle, if a numeral width parameter is specified
+     * @returns {me.Rect} this rectangle
      */
     setShape(x, y, w, h) {
         var points = w; // assume w is an array by default
@@ -64,13 +63,9 @@ class Rect extends Polygon {
     /**
      * left coordinate of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name left
-     * @memberOf me.Rect
-     */
-
-    /**
-     * @ignore
+     * @memberof me.Rect
      */
     get left() {
         return this.pos.x;
@@ -79,13 +74,9 @@ class Rect extends Polygon {
     /**
      * right coordinate of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name right
-     * @memberOf me.Rect
-     */
-
-    /**
-     * @ignore
+     * @memberof me.Rect
      */
     get right() {
         var w = this.width;
@@ -95,13 +86,9 @@ class Rect extends Polygon {
     /**
      * top coordinate of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name top
-     * @memberOf me.Rect
-     */
-
-    /**
-     * @ignore
+     * @memberof me.Rect
      */
     get top() {
         return this.pos.y;
@@ -110,13 +97,9 @@ class Rect extends Polygon {
     /**
      * bottom coordinate of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name bottom
-     * @memberOf me.Rect
-     */
-
-    /**
-     * @ignore
+     * @memberof me.Rect
      */
     get bottom() {
         var h = this.height;
@@ -126,20 +109,13 @@ class Rect extends Polygon {
     /**
      * width of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name width
-     * @memberOf me.Rect
-     */
-
-    /**
-     * @ignore
+     * @memberof me.Rect
      */
     get width() {
         return this.points[2].x;
     }
-    /**
-     * @ignore
-     */
     set width(value) {
         this.points[1].x = this.points[2].x = value;
         this.recalc();
@@ -149,20 +125,13 @@ class Rect extends Polygon {
     /**
      * height of the Rectangle
      * @public
-     * @type {Number}
+     * @type {number}
      * @name height
-     * @memberOf me.Rect
-     */
-
-    /**
-     * @ignore
+     * @memberof me.Rect
      */
     get height() {
         return this.points[2].y;
     }
-    /**
-     * @ignore
-     */
     set height(value) {
         this.points[2].y = this.points[3].y = value;
         this.recalc();
@@ -172,13 +141,9 @@ class Rect extends Polygon {
     /**
      * absolute center of this rectangle on the horizontal axis
      * @public
-     * @type {Number}
+     * @type {number}
      * @name centerX
-     * @memberOf me.Rect
-     */
-
-    /**
-     * @ignore
+     * @memberof me.Rect
      */
     get centerX() {
         if (isFinite(this.width)) {
@@ -187,10 +152,6 @@ class Rect extends Polygon {
             return this.width;
         }
     }
-
-    /**
-     * @ignore
-     */
     set centerX (value) {
         this.pos.x = value - (this.width / 2);
     }
@@ -198,13 +159,9 @@ class Rect extends Polygon {
     /**
      * absolute center of this rectangle on the vertical axis
      * @public
-     * @type {Number}
+     * @type {number}
      * @name centerY
-     * @memberOf me.Rect
-     */
-
-    /**
-     * @ignore
+     * @memberof me.Rect
      */
     get centerY() {
         if (isFinite(this.height)) {
@@ -213,10 +170,6 @@ class Rect extends Polygon {
             return this.height;
         }
     }
-
-    /**
-     * @ignore
-     */
     set centerY(value) {
         this.pos.y = value - (this.height / 2);
     }
@@ -224,11 +177,11 @@ class Rect extends Polygon {
     /**
      * resize the rectangle
      * @name resize
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
-     * @param {Number} w new width of the rectangle
-     * @param {Number} h new height of the rectangle
-     * @return {me.Rect} this rectangle
+     * @param {number} w new width of the rectangle
+     * @param {number} h new height of the rectangle
+     * @returns {me.Rect} this rectangle
      */
     resize(w, h) {
         this.width = w;
@@ -239,11 +192,11 @@ class Rect extends Polygon {
     /**
      * scale the rectangle
      * @name scale
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @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.
-     * @return {me.Rect} this rectangle
+     * @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.
+     * @returns {me.Rect} this rectangle
      */
     scale(x, y = x) {
         this.width *= x;
@@ -254,9 +207,9 @@ class Rect extends Polygon {
     /**
      * clone this rectangle
      * @name clone
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
-     * @return {me.Rect} new rectangle
+     * @returns {me.Rect} new rectangle
      */
     clone() {
         return new Rect(this.pos.x, this.pos.y, this.width, this.height);
@@ -265,10 +218,10 @@ class Rect extends Polygon {
     /**
      * copy the position and size of the given rectangle into this one
      * @name copy
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
      * @param {me.Rect} rect Source rectangle
-     * @return {me.Rect} new rectangle
+     * @returns {me.Rect} new rectangle
      */
     copy(rect) {
         return this.setShape(rect.pos.x, rect.pos.y, rect.width, rect.height);
@@ -277,18 +230,18 @@ class Rect extends Polygon {
     /**
      * merge this rectangle with another one
      * @name union
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
      * @param {me.Rect} rect other rectangle to union with
-     * @return {me.Rect} the union(ed) rectangle
+     * @returns {me.Rect} the union(ed) rectangle
      */
-    union(/** {me.Rect} */ r) {
-        var x1 = Math.min(this.left, r.left);
-        var y1 = Math.min(this.top, r.top);
+    union(rect) {
+        var x1 = Math.min(this.left, rect.left);
+        var y1 = Math.min(this.top, rect.top);
 
         this.resize(
-            Math.max(this.right, r.right) - x1,
-            Math.max(this.bottom, r.bottom) - y1
+            Math.max(this.right, rect.right) - x1,
+            Math.max(this.bottom, rect.bottom) - y1
         );
 
         this.pos.set(x1, y1);
@@ -299,46 +252,46 @@ class Rect extends Polygon {
     /**
      * check if this rectangle is intersecting with the specified one
      * @name overlaps
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
      * @param  {me.Rect} rect
-     * @return {boolean} true if overlaps
+     * @returns {boolean} true if overlaps
      */
-    overlaps(r) {
+    overlaps(rect) {
         return (
-            this.left < r.right &&
-            r.left < this.right &&
-            this.top < r.bottom &&
-            r.top < this.bottom
+            this.left < rect.right &&
+            rect.left < this.right &&
+            this.top < rect.bottom &&
+            rect.top < this.bottom
         );
     }
 
     /**
      * Returns true if the rectangle contains the given rectangle
      * @name contains
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
      * @param {me.Rect} rect
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
      * Returns true if the rectangle contains the given point
      * @name contains
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
-     * @param  {Number} x x coordinate
-     * @param  {Number} y y coordinate
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
 
     /**
      * Returns true if the rectangle contains the given point
      * @name contains
-     * @memberOf me.Rect
+     * @memberof me.Rect
      * @function
      * @param {me.Vector2d} point
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
     contains() {
         var arg0 = arguments[0];
@@ -371,26 +324,26 @@ class Rect extends Polygon {
     /**
      * check if this rectangle is identical to the specified one
      * @name equals
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
      * @param  {me.Rect} rect
-     * @return {boolean} true if equals
+     * @returns {boolean} true if equals
      */
-    equals(r) {
+    equals(rect) {
         return (
-            r.left === this.left &&
-            r.right === this.right &&
-            r.top === this.top &&
-            r.bottom === this.bottom
+            rect.left === this.left &&
+            rect.right === this.right &&
+            rect.top === this.top &&
+            rect.bottom === this.bottom
         );
     }
 
     /**
      * determines whether all coordinates of this rectangle are finite numbers.
      * @name isFinite
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
-     * @return {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
+     * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
     isFinite() {
         return (isFinite(this.pos.x) && isFinite(this.pos.y) && isFinite(this.width) && isFinite(this.height));
@@ -399,9 +352,9 @@ class Rect extends Polygon {
     /**
      * Returns a polygon whose edges are the same as this box.
      * @name toPolygon
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
-     * @return {me.Polygon} a new Polygon that represents this rectangle.
+     * @returns {me.Polygon} a new Polygon that represents this rectangle.
      */
     toPolygon() {
         return new Polygon(

package/src/index.js

@@ -28,10 +28,10 @@ import ObservableVector2d from "./math/observable_vector2.js";
 import ObservableVector3d from "./math/observable_vector3.js";
 import Matrix2d from "./math/matrix2.js";
 import Matrix3d from "./math/matrix3.js";
-import Polygon from "./shapes/poly.js";
-import Line from "./shapes/line.js";
-import Ellipse from "./shapes/ellipse.js";
-import Rect from "./shapes/rectangle.js";
+import Polygon from "./geometries/poly.js";
+import Line from "./geometries/line.js";
+import Ellipse from "./geometries/ellipse.js";
+import Rect from "./geometries/rectangle.js";
 import QuadTree from "./physics/quadtree.js";
 import Body from "./physics/body.js";
 import Bounds from "./physics/bounds.js";
@@ -79,10 +79,10 @@ import DroptargetEntity from "./entity/droptarget.js";
 import * as deprecated from "./lang/deprecated.js";
 
 /**
-* (<b>m</b>)elonJS (<b>e</b>)ngine : All melonJS functions are defined inside this namespace.
-* You generally should not add new properties to this namespace as it may be overwritten in future versions.
-* @namespace me
-*/
+ * (<b>m</b>)elonJS (<b>e</b>)ngine : All melonJS functions are defined inside this namespace.
+ * You generally should not add new properties to this namespace as it may be overwritten in future versions.
+ * @namespace me
+ */
 
 /**
  * current melonJS version
@@ -173,28 +173,27 @@ export {
     DroptargetEntity
 };
 
-// Backward compatibility for deprecated method or properties are
-// automatically applied when generating the UMD module through rollup
+// Backward compatibility for deprecated method or properties
 export {
     deprecated
 };
 
 
 /**
-* a flag indicating that melonJS is fully initialized
-* @type {Boolean}
-* @default false
-* @readonly
-* @memberOf me
-*/
+ * a flag indicating that melonJS is fully initialized
+ * @type {boolean}
+ * @default false
+ * @readonly
+ * @memberof me
+ */
 export var initialized = false;
 
 /**
  * disable melonJS auto-initialization
- * @type {Boolean}
+ * @type {boolean}
  * @default false
  * @see me.boot
- * @memberOf me
+ * @memberof me
  */
 export var skipAutoInit = false;
 
@@ -203,7 +202,7 @@ export var skipAutoInit = false;
  * this is automatically called unless me.skipAutoInit is set to true,
  * to allow asynchronous loaders to work.
  * @name boot
- * @memberOf me
+ * @memberof me
  * @see me.skipAutoInit
  * @public
  * @function

package/src/input/gamepad.js

@@ -284,7 +284,7 @@ window.addEventListener("gamepaddisconnected", function (e) {
  * Namespace for standard gamepad mapping constants
  * @public
  * @namespace GAMEPAD
- * @memberOf me.input
+ * @memberof me.input
  */
 export var GAMEPAD = {
     /**
@@ -296,8 +296,8 @@ export var GAMEPAD = {
      * </ul>
      * @public
      * @name AXES
-     * @enum {Number}
-     * @memberOf me.input.GAMEPAD
+     * @enum {number}
+     * @memberof me.input.GAMEPAD
      * @see https://w3c.github.io/gamepad/#remapping
      */
     "AXES" : {
@@ -323,8 +323,8 @@ export var GAMEPAD = {
      * </ul>
      * @public
      * @name BUTTONS
-     * @enum {Number}
-     * @memberOf me.input.GAMEPAD
+     * @enum {number}
+     * @memberof me.input.GAMEPAD
      * @see https://w3c.github.io/gamepad/#remapping
      */
     "BUTTONS" : {
@@ -357,14 +357,14 @@ export var GAMEPAD = {
 /**
  * Associate a gamepad event to a keycode
  * @name bindGamepad
- * @memberOf me.input
+ * @memberof me.input
  * @public
  * @function
- * @param {Number} index Gamepad index
- * @param {Object} button Button/Axis definition
- * @param {String} button.type "buttons" or "axes"
+ * @param {number} index Gamepad index
+ * @param {object} button Button/Axis definition
+ * @param {string} button.type "buttons" or "axes"
  * @param {me.input.GAMEPAD.BUTTONS|me.input.GAMEPAD.AXES} button.code button or axis code id
- * @param {Number} [button.threshold=1] value indicating when the axis should trigger the keycode (e.g. -0.5 or 0.5)
+ * @param {number} [button.threshold=1] value indicating when the axis should trigger the keycode (e.g. -0.5 or 0.5)
  * @param {me.input.KEY} keyCode
  * @example
  * // enable the keyboard
@@ -432,10 +432,10 @@ export function bindGamepad(index, button, keyCode) {
 /**
  * unbind the defined keycode
  * @name unbindGamepad
- * @memberOf me.input
+ * @memberof me.input
  * @public
  * @function
- * @param {Number} index Gamepad index
+ * @param {number} index Gamepad index
  * @param {me.input.GAMEPAD.BUTTONS} button
  * @example
  * me.input.unbindGamepad(0, me.input.GAMEPAD.BUTTONS.FACE_1);
@@ -451,10 +451,10 @@ export function unbindGamepad(index, button) {
  * Set deadzone for analog gamepad inputs<br>
  * The default deadzone is 0.1 (10%) Analog values less than this will be ignored
  * @name setGamepadDeadzone
- * @memberOf me.input
+ * @memberof me.input
  * @public
  * @function
- * @param {Number} value Deadzone value
+ * @param {number} value Deadzone value
  */
 export function setGamepadDeadzone(value) {
     deadzone = value;
@@ -465,14 +465,14 @@ export function setGamepadDeadzone(value) {
  * see below for the default mapping : <br>
  * <center><img src="images/gamepad_diagram.png"/></center><br>
  * @name setGamepadMapping
- * @memberOf me.input
+ * @memberof me.input
  * @public
  * @function
- * @param {String} id Gamepad id string
- * @param {Object} mapping A hash table
- * @param {Number[]} mapping.axes Standard analog control stick axis locations
- * @param {Number[]} mapping.buttons Standard digital button locations
- * @param {Number[]} [mapping.analog] Analog axis locations for buttons
+ * @param {string} id Gamepad id string
+ * @param {object} mapping A hash table
+ * @param {number[]} mapping.axes Standard analog control stick axis locations
+ * @param {number[]} mapping.buttons Standard digital button locations
+ * @param {number[]} [mapping.analog] Analog axis locations for buttons
  * @param {Function} [mapping.normalize_fn] a function that returns a normalized value in range [-1.0..1.0] for the given value, axis and button
  * @example
  * // A weird controller that has its axis mappings reversed

package/src/input/input.js

@@ -1,15 +1,15 @@
 /**
  * @namespace me.input
- * @memberOf me
+ * @memberof me
  */
 
 /**
  * specify if melonJS should prevent all default browser action on registered events.
  * @public
- * @type Boolean
+ * @type {boolean}
  * @default true
  * @name preventDefault
- * @memberOf me.input
+ * @memberof me.input
  */
 export var preventDefault = true;