melonjs 10.2.3 → 10.3.0

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

@@ -5,9 +5,8 @@ import pool from "./../system/pooling.js";
  * @classdesc
  * an ellipse Object
  * @class Ellipse
- * @extends me.Object
- * @memberOf me
- * @constructor
+ * @augments me.Object
+ * @memberof me
  * @param {number} x the center x coordinate of the ellipse
  * @param {number} y the center y coordinate of the ellipse
  * @param {number} w width (diameter) of the ellipse
@@ -22,7 +21,7 @@ class Ellipse {
          * @public
          * @type {me.Vector2d}
          * @name pos
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this.pos = new Vector2d();
 
@@ -31,7 +30,7 @@ class Ellipse {
          * @private
          * @type {me.Bounds}
          * @name _bounds
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this._bounds = undefined;
 
@@ -40,7 +39,7 @@ class Ellipse {
          * @public
          * @type {number}
          * @name radius
-         * @memberOf me.Ellipse
+         * @memberof me.Ellipse
          */
         this.radius = NaN;
 
@@ -49,7 +48,7 @@ class Ellipse {
          * @public
          * @type {me.Vector2d}
          * @name radiusV
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this.radiusV = new Vector2d();
 
@@ -58,7 +57,7 @@ class Ellipse {
          * @public
          * @type {me.Vector2d}
          * @name radiusSq
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this.radiusSq = new Vector2d();
 
@@ -67,7 +66,7 @@ class Ellipse {
          * @public
          * @type {me.Vector2d}
          * @name ratio
-         * @memberOf me.Ellipse#
+         * @memberof me.Ellipse#
          */
         this.ratio = new Vector2d();
 
@@ -84,7 +83,7 @@ class Ellipse {
     /**
      * set new value to the Ellipse shape
      * @name setShape
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {number} x the center x coordinate of the ellipse
      * @param {number} y the center y coordinate of the ellipse
@@ -114,7 +113,7 @@ class Ellipse {
     /**
      * Rotate this Ellipse (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
@@ -131,7 +130,7 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified scalar.
      * @name scale
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {number} x
      * @param {number} [y=x]
@@ -150,7 +149,7 @@ class Ellipse {
     /**
      * Scale this Ellipse by the specified vector.
      * @name scale
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {me.Vector2d} v
      * @returns {me.Ellipse} Reference to this object for method chaining
@@ -162,7 +161,7 @@ class Ellipse {
     /**
      * apply the given transformation matrix to this ellipse
      * @name transform
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {me.Matrix2d} matrix the transformation matrix
      * @returns {me.Polygon} Reference to this object for method chaining
@@ -175,7 +174,7 @@ class Ellipse {
     /**
      * translate the circle/ellipse by the specified offset
      * @name translate
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {number} x x offset
      * @param {number} y y offset
@@ -184,7 +183,7 @@ class Ellipse {
     /**
      * translate the circle/ellipse by the specified vector
      * @name translate
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param {me.Vector2d} v vector offset
      * @returns {me.Ellipse} this ellipse
@@ -212,7 +211,7 @@ class Ellipse {
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param  {me.Vector2d} point
      * @returns {boolean} true if contains
@@ -221,7 +220,7 @@ class Ellipse {
     /**
      * check if this circle/ellipse contains the specified point
      * @name contains
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -253,7 +252,7 @@ class Ellipse {
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
      * @name getBounds
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @returns {me.Bounds} this shape bounding box Rectangle object
      */
@@ -267,7 +266,7 @@ class Ellipse {
     /**
      * clone this Ellipse
      * @name clone
-     * @memberOf me.Ellipse.prototype
+     * @memberof me.Ellipse.prototype
      * @function
      * @returns {me.Ellipse} new Ellipse
      */

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

@@ -5,9 +5,8 @@ import Polygon from "./poly.js";
  * @classdesc
  * a line segment Object
  * @class Line
- * @extends me.Polygon
- * @memberOf me
- * @constructor
+ * @augments me.Polygon
+ * @memberof me
  * @param {number} x origin point of the Line
  * @param {number} y origin point of the Line
  * @param {me.Vector2d[]} points array of vectors defining the Line
@@ -18,7 +17,7 @@ class Line extends Polygon {
     /**
      * Returns true if the Line contains the given point
      * @name contains
-     * @memberOf me.Line.prototype
+     * @memberof me.Line.prototype
      * @function
      * @param  {me.Vector2d} point
      * @returns {boolean} true if contains
@@ -27,7 +26,7 @@ class Line extends Polygon {
     /**
      * Returns true if the Line contains the given point
      * @name contains
-     * @memberOf me.Line.prototype
+     * @memberof me.Line.prototype
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -61,7 +60,7 @@ class Line extends Polygon {
      * Computes the calculated collision edges and normals.
      * This **must** be called if the `points` array, `angle`, or `offset` is modified manually.
      * @name recalc
-     * @memberOf me.Line.prototype
+     * @memberof me.Line.prototype
      * @function
      * @returns {me.Line} this instance for objecf chaining
      */
@@ -97,7 +96,7 @@ class Line extends Polygon {
     /**
      * clone this line segment
      * @name clone
-     * @memberOf me.Line.prototype
+     * @memberof me.Line.prototype
      * @function
      * @returns {me.Line} new Line
      */

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

@@ -11,8 +11,7 @@ import pool from "./../system/pooling.js";
  * <center><img src="images/convex_polygon.png"/></center><br>
  * A polygon's `winding` is clockwise iff its vertices (points) are declared turning to the right. The image above shows COUNTERCLOCKWISE winding.
  * @class Polygon
- * @memberOf me
- * @constructor
+ * @memberof me
  * @param {number} x origin point of the Polygon
  * @param {number} y origin point of the Polygon
  * @param {me.Vector2d[]} points array of vector defining the Polygon
@@ -35,7 +34,7 @@ class Polygon {
          * @ignore
          * @type {me.Bounds}
          * @name _bounds
-         * @memberOf me.Polygon#
+         * @memberof me.Polygon#
          */
         this._bounds;
 
@@ -45,7 +44,7 @@ class Polygon {
          * @public
          * @type {me.Vector2d[]}
          * @name points
-         * @memberOf me.Polygon#
+         * @memberof me.Polygon#
          */
         this.points = [];
 
@@ -84,7 +83,7 @@ class Polygon {
     /**
      * set new value to the Polygon
      * @name setShape
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param {number} x position of the Polygon
      * @param {number} y position of the Polygon
@@ -100,7 +99,7 @@ class Polygon {
     /**
      * set the vertices defining this Polygon
      * @name setVertices
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param {me.Vector2d[]} vertices array of vector or vertice defining the Polygon
      * @returns {me.Polygon} this instance for objecf chaining
@@ -140,7 +139,7 @@ class Polygon {
     /**
      * apply the given transformation matrix to this Polygon
      * @name transform
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param {me.Matrix2d} m the transformation matrix
      * @returns {me.Polygon} Reference to this object for method chaining
@@ -159,7 +158,7 @@ class Polygon {
     /**
      * apply an isometric projection to this shape
      * @name toIso
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @returns {me.Polygon} Reference to this object for method chaining
      */
@@ -170,7 +169,7 @@ class Polygon {
     /**
      * apply a 2d projection to this shape
      * @name to2d
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @returns {me.Polygon} Reference to this object for method chaining
      */
@@ -181,7 +180,7 @@ class Polygon {
     /**
      * Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
@@ -203,7 +202,7 @@ class Polygon {
     /**
      * Scale this Polygon by the given scalar.
      * @name scale
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param {number} x
      * @param {number} [y=x]
@@ -225,7 +224,7 @@ class Polygon {
     /**
      * Scale this Polygon by the given vector
      * @name scaleV
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param {me.Vector2d} v
      * @returns {me.Polygon} Reference to this object for method chaining
@@ -238,7 +237,7 @@ class Polygon {
      * Computes the calculated collision polygon.
      * This **must** be called if the `points` array, `angle`, or `offset` is modified manually.
      * @name recalc
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @returns {me.Polygon} Reference to this object for method chaining
      */
@@ -278,10 +277,11 @@ class Polygon {
         return this;
     }
 
+
     /**
      * returns a list of indices for all triangles defined in this polygon
      * @name getIndices
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @returns {Array} an array of vertex indices for all triangles forming this polygon.
      */
@@ -292,10 +292,57 @@ class Polygon {
         return this.indices;
     }
 
+    /**
+     * Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
+     * @name isConvex
+     * @memberof me.Polygon.prototype
+     * @function
+     * @returns {boolean} true if the vertices are convex, false if not, null if not computable
+     */
+    isConvex() {
+        // http://paulbourke.net/geometry/polygonmesh/
+        // Copyright (c) Paul Bourke (use permitted)
+
+        var flag = 0,
+            vertices = this.points,
+            n = vertices.length,
+            i,
+            j,
+            k,
+            z;
+
+        if (n < 3) {
+            return null;
+        }
+
+        for (i = 0; i < n; i++) {
+            j = (i + 1) % n;
+            k = (i + 2) % n;
+            z = (vertices[j].x - vertices[i].x) * (vertices[k].y - vertices[j].y);
+            z -= (vertices[j].y - vertices[i].y) * (vertices[k].x - vertices[j].x);
+
+            if (z < 0) {
+                flag |= 1;
+            } else if (z > 0) {
+                flag |= 2;
+            }
+
+            if (flag === 3) {
+                return false;
+            }
+        }
+
+        if (flag !== 0) {
+            return true;
+        } else {
+            return null;
+        }
+    }
+
     /**
      * translate the Polygon by the specified offset
      * @name translate
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param {number} x x offset
      * @param {number} y y offset
@@ -304,7 +351,7 @@ class Polygon {
     /**
      * translate the Polygon by the specified vector
      * @name translate
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param {me.Vector2d} v vector offset
      * @returns {me.Polygon} Reference to this object for method chaining
@@ -332,14 +379,14 @@ class Polygon {
     /**
      * Shifts the Polygon to the given position vector.
      * @name shift
-     * @memberOf me.Polygon
+     * @memberof me.Polygon
      * @function
      * @param {me.Vector2d} position
      */
     /**
      * Shifts the Polygon to the given x, y position.
      * @name shift
-     * @memberOf me.Polygon
+     * @memberof me.Polygon
      * @function
      * @param {number} x
      * @param {number} y
@@ -365,7 +412,7 @@ class Polygon {
      * (Note: it is highly recommended to first do a hit test on the corresponding <br>
      *  bounding rect, as the function can be highly consuming with complex shapes)
      * @name contains
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param  {me.Vector2d} point
      * @returns {boolean} true if contains
@@ -376,7 +423,7 @@ class Polygon {
      * (Note: it is highly recommended to first do a hit test on the corresponding <br>
      *  bounding rect, as the function can be highly consuming with complex shapes)
      * @name contains
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -414,7 +461,7 @@ class Polygon {
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
      * @name getBounds
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @returns {me.Bounds} this shape bounding box Rectangle object
      */
@@ -429,7 +476,7 @@ class Polygon {
      * update the bounding box for this shape.
      * @ignore
      * @name updateBounds
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @returns {me.Bounds} this shape bounding box Rectangle object
      */
@@ -445,7 +492,7 @@ class Polygon {
     /**
      * clone this Polygon
      * @name clone
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @returns {me.Polygon} new Polygon
      */

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

@@ -5,9 +5,8 @@ import Polygon from "./poly.js";
  * @classdesc
  * a rectangle Object
  * @class Rect
- * @extends me.Polygon
- * @memberOf me
- * @constructor
+ * @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
@@ -35,7 +34,7 @@ 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
@@ -66,7 +65,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name left
-     * @memberOf me.Rect
+     * @memberof me.Rect
      */
     get left() {
         return this.pos.x;
@@ -77,7 +76,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name right
-     * @memberOf me.Rect
+     * @memberof me.Rect
      */
     get right() {
         var w = this.width;
@@ -89,7 +88,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name top
-     * @memberOf me.Rect
+     * @memberof me.Rect
      */
     get top() {
         return this.pos.y;
@@ -100,7 +99,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name bottom
-     * @memberOf me.Rect
+     * @memberof me.Rect
      */
     get bottom() {
         var h = this.height;
@@ -112,7 +111,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name width
-     * @memberOf me.Rect
+     * @memberof me.Rect
      */
     get width() {
         return this.points[2].x;
@@ -128,7 +127,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name height
-     * @memberOf me.Rect
+     * @memberof me.Rect
      */
     get height() {
         return this.points[2].y;
@@ -144,7 +143,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name centerX
-     * @memberOf me.Rect
+     * @memberof me.Rect
      */
     get centerX() {
         if (isFinite(this.width)) {
@@ -162,7 +161,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name centerY
-     * @memberOf me.Rect
+     * @memberof me.Rect
      */
     get centerY() {
         if (isFinite(this.height)) {
@@ -178,7 +177,7 @@ 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
@@ -193,7 +192,7 @@ 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.
@@ -208,7 +207,7 @@ class Rect extends Polygon {
     /**
      * clone this rectangle
      * @name clone
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
      * @returns {me.Rect} new rectangle
      */
@@ -219,7 +218,7 @@ 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
      * @returns {me.Rect} new rectangle
@@ -231,7 +230,7 @@ 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
      * @returns {me.Rect} the union(ed) rectangle
@@ -253,7 +252,7 @@ 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
      * @returns {boolean} true if overlaps
@@ -270,7 +269,7 @@ class Rect extends Polygon {
     /**
      * Returns true if the rectangle contains the given rectangle
      * @name contains
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
      * @param {me.Rect} rect
      * @returns {boolean} true if contains
@@ -279,7 +278,7 @@ class Rect extends Polygon {
     /**
      * 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
@@ -289,7 +288,7 @@ class Rect extends Polygon {
     /**
      * Returns true if the rectangle contains the given point
      * @name contains
-     * @memberOf me.Rect
+     * @memberof me.Rect
      * @function
      * @param {me.Vector2d} point
      * @returns {boolean} true if contains
@@ -325,7 +324,7 @@ 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
      * @returns {boolean} true if equals
@@ -342,7 +341,7 @@ class Rect extends Polygon {
     /**
      * determines whether all coordinates of this rectangle are finite numbers.
      * @name isFinite
-     * @memberOf me.Rect.prototype
+     * @memberof me.Rect.prototype
      * @function
      * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
@@ -353,7 +352,7 @@ 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
      * @returns {me.Polygon} a new Polygon that represents this rectangle.
      */

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";
@@ -173,8 +173,7 @@ 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
 };
@@ -185,7 +184,7 @@ export {
  * @type {boolean}
  * @default false
  * @readonly
- * @memberOf me
+ * @memberof me
  */
 export var initialized = false;
 
@@ -194,7 +193,7 @@ export var initialized = false;
  * @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