melonjs 10.2.3 → 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,8 +13,7 @@ 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 {Function} [onBodyUpdate] callback for when the body is updated (e.g. add/remove shapes)
@@ -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 = [];
@@ -63,7 +62,7 @@ class Body {
          * @default me.collision.types.ALL_OBJECT
          * @name collisionMask
          * @see me.collision.types
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.collisionMask = collision.types.ALL_OBJECT;
 
@@ -74,7 +73,7 @@ class Body {
          * @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;
@@ -87,7 +86,7 @@ class Body {
          * @type {me.Vector2d}
          * @default <0,0>
          * @name vel
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         if (typeof this.vel === "undefined") {
             this.vel = new Vector2d();
@@ -102,7 +101,7 @@ class Body {
          * @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);
@@ -132,7 +131,7 @@ class Body {
          * @type {me.Vector2d}
          * @default <0,0>
          * @name friction
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         if (typeof this.friction === "undefined") {
             this.friction = new Vector2d();
@@ -146,7 +145,7 @@ class Body {
          * @type {number}
          * @default 0
          * @name bounce
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.bounce = 0;
 
@@ -156,7 +155,7 @@ class Body {
          * @type {number}
          * @default 1
          * @name mass
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.mass = 1;
 
@@ -166,7 +165,7 @@ class Body {
          * @type {me.Vector2d}
          * @default <490,490>
          * @name maxVel
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         if (typeof this.maxVel === "undefined") {
             this.maxVel = new Vector2d();
@@ -182,7 +181,7 @@ class Body {
          * @type {boolean}
          * @default false
          * @name isStatic
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.isStatic = false;
 
@@ -194,7 +193,7 @@ class Body {
          * @type {number}
          * @default 1.0
          * @name gravityScale
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.gravityScale = 1.0;
 
@@ -205,7 +204,7 @@ class Body {
          * @type {boolean}
          * @default false
          * @name ignoreGravity
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.ignoreGravity = false;
 
@@ -218,7 +217,7 @@ class Body {
          * @type {boolean}
          * @default false
          * @name falling
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.falling = false;
 
@@ -230,7 +229,7 @@ class Body {
          * @type {boolean}
          * @default false
          * @name jumping
-         * @memberOf me.Body
+         * @memberof me.Body
          */
         this.jumping = false;
 
@@ -260,7 +259,7 @@ 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]
@@ -273,7 +272,7 @@ 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
@@ -327,7 +326,7 @@ 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
@@ -354,7 +353,7 @@ 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
@@ -368,7 +367,7 @@ 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
@@ -412,7 +411,7 @@ 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
@@ -425,7 +424,7 @@ class Body {
     /**
      * returns the AABB bounding box for this body
      * @name getBounds
-     * @memberOf me.Body
+     * @memberof me.Body
      * @function
      * @returns {me.Bounds} bounding box Rectangle object
      */
@@ -436,7 +435,7 @@ 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
@@ -458,7 +457,7 @@ 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
@@ -473,7 +472,7 @@ 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
@@ -492,7 +491,7 @@ 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
@@ -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,7 +554,7 @@ 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.
@@ -592,7 +591,7 @@ 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
      * @returns {boolean} true if contains
@@ -601,7 +600,7 @@ 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  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -635,7 +634,7 @@ 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 {me.Vector2d|me.ObservableVector2d} [v=me.Body.getBounds().center] an optional point to rotate around
@@ -662,7 +661,7 @@ 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
@@ -676,7 +675,7 @@ 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
@@ -763,7 +762,7 @@ 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
      * @param {number} dt time since the last update in milliseconds.
      * @returns {boolean} true if resulting velocity is different than 0

package/src/physics/bounds.js

@@ -1,13 +1,11 @@
 import Vector2d from "./../math/vector2.js";
-import Polygon from "./../shapes/poly.js";
+import Polygon from "./../geometries/poly.js";
 
 /**
  * @classdesc
  * a bound object contains methods for creating and manipulating axis-aligned bounding boxes (AABB).
  * @class Bounds
- * @memberOf me
- * @constructor
- * @memberOf me
+ * @memberof me
  * @param {me.Vector2d[]} [vertices] an array of me.Vector2d points
  * @returns {me.Bounds} A new bounds object
  */
@@ -36,7 +34,7 @@ class Bounds {
     /**
      * reset the bound
      * @name clear
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      */
     clear() {
@@ -47,7 +45,7 @@ class Bounds {
     /**
      * sets the bounds to the given min and max value
      * @name setMinMax
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {number} minX
      * @param {number} minY
@@ -67,7 +65,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name x
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get x() {
         return this.min.x;
@@ -84,7 +82,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name y
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get y() {
         return this.min.y;
@@ -102,7 +100,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name width
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get width() {
         return this.max.x - this.min.x;
@@ -117,7 +115,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name width
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get height() {
         return this.max.y - this.min.y;
@@ -132,7 +130,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name left
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get left() {
         return this.min.x;
@@ -143,7 +141,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name right
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get right() {
         return this.max.x;
@@ -154,7 +152,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name top
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get top() {
         return this.min.y;
@@ -165,7 +163,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name bottom
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get bottom() {
         return this.max.y;
@@ -176,7 +174,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name centerX
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get centerX() {
         return this.min.x + (this.width / 2);
@@ -187,7 +185,7 @@ class Bounds {
      * @public
      * @type {number}
      * @name centerY
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get centerY() {
         return this.min.y + (this.height / 2);
@@ -198,7 +196,7 @@ class Bounds {
      * @public
      * @type {me.Vector2d}
      * @name center
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      */
     get center() {
         return this._center.set(this.centerX, this.centerY);
@@ -207,7 +205,7 @@ class Bounds {
     /**
      * Updates bounds using the given vertices
      * @name update
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {me.Vector2d[]} vertices an array of me.Vector2d points
      */
@@ -218,7 +216,7 @@ class Bounds {
     /**
      * add the given vertices to the bounds definition.
      * @name add
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {me.Vector2d[]} vertices an array of me.Vector2d points
      * @param {boolean} [clear=false] either to reset the bounds before adding the new vertices
@@ -239,7 +237,7 @@ class Bounds {
     /**
      * add the given bounds to the bounds definition.
      * @name addBounds
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {me.Bounds} bounds
      * @param {boolean} [clear=false] either to reset the bounds before adding the new vertices
@@ -258,7 +256,7 @@ class Bounds {
     /**
      * add the given point to the bounds definition.
      * @name addPoint
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {me.Vector2d} v
      * @param {me.Matrix2d} [m] an optional transform to apply to the given point
@@ -276,7 +274,7 @@ class Bounds {
     /**
      * add the given quad coordinates to this bound definition, multiplied by the given matrix
      * @name addFrame
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {number} x0 - left X coordinates of the quad
      * @param {number} y0 - top Y coordinates of the quad
@@ -299,7 +297,7 @@ class Bounds {
     /**
      * Returns true if the bounds contains the given point.
      * @name contains
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {me.Vector2d} point
      * @returns {boolean} True if the bounds contain the point, otherwise false
@@ -307,7 +305,7 @@ class Bounds {
     /**
      * Returns true if the bounds contains the given point.
      * @name contains
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {number} x
      * @param {number} y
@@ -341,7 +339,7 @@ class Bounds {
     /**
      * Returns true if the two bounds intersect.
      * @name overlaps
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {me.Bounds|me.Rect} bounds
      * @returns {boolean} True if the bounds overlap, otherwise false
@@ -354,7 +352,7 @@ class Bounds {
     /**
      * determines whether all coordinates of this bounds are finite numbers.
      * @name isFinite
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
@@ -365,14 +363,14 @@ class Bounds {
     /**
      * Translates the bounds by the given vector.
      * @name translate
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {me.Vector2d} vector
      */
     /**
      * Translates the bounds by x on the x axis, and y on the y axis
      * @name translate
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {number} x
      * @param {number} y
@@ -397,14 +395,14 @@ class Bounds {
     /**
      * Shifts the bounds to the given position vector.
      * @name shift
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {me.Vector2d} position
      */
     /**
      * Shifts the bounds to the given x, y position.
      * @name shift
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @param {number} x
      * @param {number} y
@@ -434,7 +432,7 @@ class Bounds {
     /**
      * clone this bounds
      * @name clone
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @returns {me.Bounds}
      */
@@ -447,7 +445,7 @@ class Bounds {
     /**
      * Returns a polygon whose edges are the same as this bounds.
      * @name toPolygon
-     * @memberOf me.Bounds
+     * @memberof me.Bounds
      * @function
      * @returns {me.Polygon} a new Polygon that represents this bounds.
      */

package/src/physics/collision.js

@@ -4,7 +4,7 @@ import { rayCast, globalResponse } from "./detector.js";
  * Collision detection (and projection-based collision response) of 2D shapes.<br>
  * Based on the Separating Axis Theorem and supports detecting collisions between simple Axis-Aligned Boxes, convex polygons and circles based shapes.
  * @namespace collision
- * @memberOf me
+ * @memberof me
  */
 
 var collision = {
@@ -12,7 +12,7 @@ var collision = {
      /**
       * The maximum number of children that a quadtree node can contain before it is split into sub-nodes.
       * @name maxChildren
-      * @memberOf me.collision
+      * @memberof me.collision
       * @public
       * @type {number}
       * @default 8
@@ -23,7 +23,7 @@ var collision = {
      /**
       * The maximum number of levels that the quadtree will create.
       * @name maxDepth
-      * @memberOf me.collision
+      * @memberof me.collision
       * @public
       * @type {number}
       * @default 4
@@ -46,7 +46,7 @@ var collision = {
      * @readonly
      * @enum {number}
      * @name types
-     * @memberOf me.collision
+     * @memberof me.collision
      * @see me.body.setCollisionMask
      * @see me.body.collisionType
      * @example
@@ -97,7 +97,7 @@ var collision = {
      * a global instance of a response object used for collision detection <br>
      * this object will be reused amongst collision detection call if not user-defined response is specified
      * @name response
-     * @memberOf me.collision
+     * @memberof me.collision
      * @public
      * @type {me.collision.ResponseObject}
      */
@@ -106,7 +106,7 @@ var collision = {
     /**
      * Checks for object colliding with the given line
      * @name rayCast
-     * @memberOf me.collision
+     * @memberof me.collision
      * @public
      * @function
      * @param {me.Line} line line to be tested for collision

package/src/physics/detector.js

@@ -17,7 +17,7 @@ var dummyObj = {
  * a function used to determine if two objects should collide (based on both respective objects collision mask and type).<br>
  * you can redefine this function if you need any specific rules over what should collide with what.
  * @name shouldCollide
- * @memberOf me.collision
+ * @memberof me.collision
  * @ignore
  * @function
  * @param {me.Renderable} a a reference to the object A.
@@ -46,7 +46,7 @@ function shouldCollide(a, b) {
  * @property {number} indexShapeA The index of the colliding shape for the object a body
  * @property {number} indexShapeB The index of the colliding shape for the object b body
  * @name ResponseObject
- * @memberOf me.collision
+ * @memberof me.collision
  * @public
  */
 class ResponseObject {
@@ -68,7 +68,7 @@ class ResponseObject {
      * Response object for multiple intersection tests <br>
      * (recommended as it will avoid allocating extra memory) <br>
      * @name clear
-     * @memberOf me.collision.ResponseObject
+     * @memberof me.collision.ResponseObject
      * @public
      * @function
      * @returns {object} this object for chaining