melonjs 10.2.0 → 10.3.0

package/src/physics/body.js

@@ -1,7 +1,7 @@
 import Vector2d from "./../math/vector2.js";
-import Rect from "./../shapes/rectangle.js";
-import Ellipse from "./../shapes/ellipse.js";
-import Polygon from "./../shapes/poly.js";
+import Rect from "./../geometries/rectangle.js";
+import Ellipse from "./../geometries/ellipse.js";
+import Polygon from "./../geometries/poly.js";
 import Bounds from "./bounds.js";
 import collision from "./collision.js";
 import * as arrayUtil from "./../utils/array.js";
@@ -13,10 +13,9 @@ import { world } from "./../game.js";
 /**
  * a Generic Physic Body Object with some physic properties and behavior functionality, to as a member of a Renderable.
  * @class Body
- * @memberOf me
- * @constructor
+ * @memberof me
  * @param {me.Renderable} ancestor the parent object this body is attached to
- * @param {me.Rect|me.Rect[]|me.Polygon|me.Polygon[]|me.Line|me.Line[]|me.Ellipse|me.Ellipse[]|me.Bounds|me.Bounds[]|Object} [shapes] a initial shape, list of shapes, or JSON object defining the body
+ * @param {me.Rect|me.Rect[]|me.Polygon|me.Polygon[]|me.Line|me.Line[]|me.Ellipse|me.Ellipse[]|me.Bounds|me.Bounds[]|object} [shapes] a initial shape, list of shapes, or JSON object defining the body
  * @param {Function} [onBodyUpdate] callback for when the body is updated (e.g. add/remove shapes)
  */
 class Body {
@@ -27,7 +26,7 @@ class Body {
          * a reference to the parent object that contains this body,
          * or undefined if it has not been added to one.
          * @public
-         * @type me.Renderable
+         * @type {me.Renderable}
          * @default undefined
          * @name me.Body#ancestor
          */
@@ -38,7 +37,7 @@ class Body {
          * @public
          * @type {me.Bounds}
          * @name bounds
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         if (typeof this.bounds === "undefined") {
             this.bounds = new Bounds();
@@ -49,7 +48,7 @@ class Body {
          * @ignore
          * @type {me.Polygon[]|me.Line[]|me.Ellipse[]}
          * @name shapes
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         if (typeof this.shapes === "undefined") {
             this.shapes = [];
@@ -59,22 +58,22 @@ class Body {
          * The body collision mask, that defines what should collide with what.<br>
          * (by default will collide with all entities)
          * @ignore
-         * @type Number
+         * @type {number}
          * @default me.collision.types.ALL_OBJECT
          * @name collisionMask
          * @see me.collision.types
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.collisionMask = collision.types.ALL_OBJECT;
 
         /**
          * define the collision type of the body for collision filtering
          * @public
-         * @type Number
+         * @type {number}
          * @default me.collision.types.ENEMY_OBJECT
          * @name collisionType
          * @see me.collision.types
-         * @memberOf me.Body
+         * @memberof me.Body
          * @example
          * // set the body collision type
          * myEntity.body.collisionType = me.collision.types.PLAYER_OBJECT;
@@ -84,10 +83,10 @@ class Body {
         /**
          * body velocity
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0>
          * @name vel
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         if (typeof this.vel === "undefined") {
             this.vel = new Vector2d();
@@ -98,11 +97,11 @@ class Body {
          * body force or acceleration (automatically) applied to the body.
          * when defining a force, user should also define a max velocity
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0>
          * @name force
          * @see me.Body.setMaxVelocity
-         * @memberOf me.Body
+         * @memberof me.Body
          * @example
          * // define a default maximum acceleration, initial force and friction
          * this.body.force.set(0, 0);
@@ -129,10 +128,10 @@ class Body {
         /**
          * body friction
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <0,0>
          * @name friction
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         if (typeof this.friction === "undefined") {
             this.friction = new Vector2d();
@@ -143,30 +142,30 @@ class Body {
          * the body bouciness level when colliding with other solid bodies :
          * a value of 0 will not bounce, a value of 1 will fully rebound.
          * @public
-         * @type {Number}
+         * @type {number}
          * @default 0
          * @name bounce
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.bounce = 0;
 
         /**
          * the body mass
          * @public
-         * @type {Number}
+         * @type {number}
          * @default 1
          * @name mass
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.mass = 1;
 
         /**
          * max velocity (to limit body velocity)
          * @public
-         * @type me.Vector2d
+         * @type {me.Vector2d}
          * @default <490,490>
          * @name maxVel
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         if (typeof this.maxVel === "undefined") {
             this.maxVel = new Vector2d();
@@ -179,10 +178,10 @@ class Body {
          * either this body is a static body or not
          * @readonly
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name isStatic
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.isStatic = false;
 
@@ -191,10 +190,10 @@ class Body {
          * The degree to which this body is affected by the world gravity
          * @public
          * @see me.World.gravity
-         * @type Number
+         * @type {number}
          * @default 1.0
          * @name gravityScale
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.gravityScale = 1.0;
 
@@ -202,10 +201,10 @@ class Body {
          * If true this body won't be affected by the world gravity
          * @public
          * @see me.World.gravity
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name ignoreGravity
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.ignoreGravity = false;
 
@@ -215,10 +214,10 @@ class Body {
          * false if the object is standing on something<br>
          * @readonly
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name falling
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.falling = false;
 
@@ -227,10 +226,10 @@ class Body {
          * equal true if the body is jumping<br>
          * @readonly
          * @public
-         * @type Boolean
+         * @type {boolean}
          * @default false
          * @name jumping
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.jumping = false;
 
@@ -260,10 +259,10 @@ class Body {
      * set the body as a static body
      * static body do not move automatically and do not check againt collision with others
      * @name setStatic
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
-     * @param {Boolean} [isStatic=true]
+     * @param {boolean} [isStatic=true]
      */
     setStatic(isStatic = true) {
         this.isStatic = isStatic === true;
@@ -273,11 +272,11 @@ class Body {
      * add a collision shape to this body <br>
      * (note: me.Rect objects will be converted to me.Polygon before being added)
      * @name addShape
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
-     * @param {me.Rect|me.Polygon|me.Line|me.Ellipse|me.Bounds|Object} shape a shape or JSON object
-     * @return {Number} the shape array length
+     * @param {me.Rect|me.Polygon|me.Line|me.Ellipse|me.Bounds|object} shape a shape or JSON object
+     * @returns {number} the shape array length
      * @example
      * // add a rectangle shape
      * this.body.addShape(new me.Rect(0, 0, image.width, image.height));
@@ -327,11 +326,11 @@ class Body {
     /**
      * set the body vertices to the given one
      * @name setVertices
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
      * @param {me.Vector2d[]} vertices an array of me.Vector2d points defining a convex hull
-     * @param {Number} [index=0] the shape object for which to set the vertices
+     * @param {number} [index=0] the shape object for which to set the vertices
      * @param {boolean} [clear=true] either to reset the body definition before adding the new vertices
      */
     setVertices(vertices, index = 0, clear = true) {
@@ -354,11 +353,11 @@ class Body {
     /**
      * add the given vertices to the body shape
      * @name addVertices
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
      * @param {me.Vector2d[]} vertices an array of me.Vector2d points defining a convex hull
-     * @param {Number} [index=0] the shape object for which to set the vertices
+     * @param {number} [index=0] the shape object for which to set the vertices
      */
     addVertices(vertices, index = 0) {
         this.setVertices(vertices, index, false);
@@ -368,13 +367,13 @@ class Body {
      * add collision mesh based on a JSON object
      * (this will also apply any physic properties defined in the given JSON file)
      * @name fromJSON
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
-     * @param {Object} json a JSON object as exported from a Physics Editor tool
-     * @param {String} [id] an optional shape identifier within the given the json object
+     * @param {object} json a JSON object as exported from a Physics Editor tool
+     * @param {string} [id] an optional shape identifier within the given the json object
      * @see https://www.codeandweb.com/physicseditor
-     * @return {Number} how many shapes were added to the body
+     * @returns {number} how many shapes were added to the body
      * @example
      * // define the body based on the banana shape
      * this.body.fromJSON(me.loader.getJSON("shapesdef").banana);
@@ -412,11 +411,11 @@ class Body {
     /**
      * return the collision shape at the given index
      * @name getShape
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
-     * @param {Number} [index=0] the shape object at the specified index
-     * @return {me.Polygon|me.Line|me.Ellipse} shape a shape object if defined
+     * @param {number} [index=0] the shape object at the specified index
+     * @returns {me.Polygon|me.Line|me.Ellipse} shape a shape object if defined
      */
     getShape(index) {
         return this.shapes[index || 0];
@@ -425,9 +424,9 @@ class Body {
     /**
      * returns the AABB bounding box for this body
      * @name getBounds
-     * @memberOf me.Body
+     * @memberof me.Body
      * @function
-     * @return {me.Bounds} bounding box Rectangle object
+     * @returns {me.Bounds} bounding box Rectangle object
      */
     getBounds() {
         return this.bounds;
@@ -436,11 +435,11 @@ class Body {
     /**
      * remove the specified shape from the body shape list
      * @name removeShape
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
      * @param {me.Polygon|me.Line|me.Ellipse} shape a shape object
-     * @return {Number} the shape array length
+     * @returns {number} the shape array length
      */
     removeShape(shape) {
         // clear the current bounds
@@ -458,11 +457,11 @@ class Body {
     /**
      * remove the shape at the given index from the body shape list
      * @name removeShapeAt
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
-     * @param {Number} index the shape object at the specified index
-     * @return {Number} the shape array length
+     * @param {number} index the shape object at the specified index
+     * @returns {number} the shape array length
      */
     removeShapeAt(index) {
         return this.removeShape(this.getShape(index));
@@ -473,11 +472,11 @@ class Body {
      * but it's also possible to specify 'collision filters' to provide a finer <br>
      * control over which entities can collide with each other.
      * @name setCollisionMask
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
      * @see me.collision.types
-     * @param {Number} [bitmask = me.collision.types.ALL_OBJECT] the collision mask
+     * @param {number} [bitmask = me.collision.types.ALL_OBJECT] the collision mask
      * @example
      * // filter collision detection with collision shapes, enemies and collectables
      * myEntity.body.setCollisionMask(me.collision.types.WORLD_SHAPE | me.collision.types.ENEMY_OBJECT | me.collision.types.COLLECTABLE_OBJECT);
@@ -492,11 +491,11 @@ class Body {
     /**
      * define the collision type of the body for collision filtering
      * @name setCollisionType
-     * @memberOf me.Body
+     * @memberof me.Body
      * @public
      * @function
      * @see me.collision.types
-     * @param {Number} type the collision type
+     * @param {number} type the collision type
      * @example
      * // set the body collision type
      * myEntity.body.collisionType = me.collision.types.PLAYER_OBJECT;
@@ -515,7 +514,7 @@ class Body {
      * the built-in function to solve the collision response
      * @protected
      * @name respondToCollision
-     * @memberOf me.Body
+     * @memberof me.Body
      * @function
      * @param {me.collision.ResponseObject} response the collision response object
      */
@@ -555,10 +554,10 @@ class Body {
      *    - The index of element in the array. <br>
      *    - The array forEach() was called upon. <br>
      * @name forEach
-     * @memberOf me.Body.prototype
+     * @memberof me.Body.prototype
      * @function
      * @param {Function} callback fnction to execute on each element
-     * @param {Object} [thisArg] value to use as this(i.e reference Object) when executing callback.
+     * @param {object} [thisArg] value to use as this(i.e reference Object) when executing callback.
      * @example
      * // iterate through all shapes of the physic body
      * mySprite.body.forEach((shape) => {
@@ -592,20 +591,20 @@ class Body {
     /**
      * Returns true if the any of the shape composing the body contains the given point.
      * @name contains
-     * @memberOf me.Body
+     * @memberof me.Body
      * @function
      * @param  {me.Vector2d} point
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
      * Returns true if the any of the shape composing the body contains the given point.
      * @name contains
-     * @memberOf me.Body
+     * @memberof me.Body
      * @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
      */
     contains() {
         var _x, _y;
@@ -635,11 +634,11 @@ class Body {
      * Rotate this body (counter-clockwise) by the specified angle (in radians).
      * Unless specified the body will be rotated around its center point
      * @name rotate
-     * @memberOf me.Body
+     * @memberof me.Body
      * @function
-     * @param {Number} angle The angle to rotate (in radians)
+     * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v=me.Body.getBounds().center] an optional point to rotate around
-     * @return {me.Body} Reference to this object for method chaining
+     * @returns {me.Body} Reference to this object for method chaining
      */
     rotate(angle, v = this.getBounds().center) {
         this.bounds.clear();
@@ -662,10 +661,10 @@ class Body {
     /**
      * cap the body velocity (body.maxVel property) to the specified value<br>
      * @name setMaxVelocity
-     * @memberOf me.Body
+     * @memberof me.Body
      * @function
-     * @param {Number} x max velocity on x axis
-     * @param {Number} y max velocity on y axis
+     * @param {number} x max velocity on x axis
+     * @param {number} y max velocity on y axis
      * @protected
      */
     setMaxVelocity(x, y) {
@@ -676,10 +675,10 @@ class Body {
     /**
      * set the body default friction
      * @name setFriction
-     * @memberOf me.Body
+     * @memberof me.Body
      * @function
-     * @param {Number} x horizontal friction
-     * @param {Number} y vertical friction
+     * @param {number} x horizontal friction
+     * @param {number} y vertical friction
      * @protected
      */
     setFriction(x = 0, y = 0) {
@@ -763,10 +762,10 @@ class Body {
      * At this time a call to Body.Update does not call the onBodyUpdate callback that is listed in the constructor arguments.
      * @name update
      * @ignore
-     * @memberOf me.Body
+     * @memberof me.Body
      * @function
-     * @return {boolean} true if resulting velocity is different than 0
-     * @see source code for me.Body.computeVelocity (private member)
+     * @param {number} dt time since the last update in milliseconds.
+     * @returns {boolean} true if resulting velocity is different than 0
      */
     update(dt) {
         // update the velocity