melonjs 10.2.3 → 10.5.0

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

@@ -10,32 +10,31 @@ import pool from "./../system/pooling.js";
  * (which means that all angles are less than 180 degrees), as described here below : <br>
  * <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
- * @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
  */
 
 class Polygon {
 
+    /**
+     * @param {number} x origin point of the Polygon
+     * @param {number} y origin point of the Polygon
+     * @param {Vector2d[]} points array of vector defining the Polygon
+     */
     constructor(x, y, points) {
         /**
          * origin point of the Polygon
          * @public
-         * @type {me.Vector2d}
+         * @type {Vector2d}
          * @name pos
-         * @memberof me.Polygon#
+         * @memberof Polygon#
          */
         this.pos = new Vector2d();
 
         /**
          * The bounding rectangle for this shape
          * @ignore
-         * @type {me.Bounds}
+         * @type {Bounds}
          * @name _bounds
-         * @memberOf me.Polygon#
+         * @memberof Polygon#
          */
         this._bounds;
 
@@ -43,9 +42,9 @@ class Polygon {
          * Array of points defining the Polygon <br>
          * Note: If you manually change `points`, you **must** call `recalc`afterwards so that the changes get applied correctly.
          * @public
-         * @type {me.Vector2d[]}
+         * @type {Vector2d[]}
          * @name points
-         * @memberOf me.Polygon#
+         * @memberof Polygon#
          */
         this.points = [];
 
@@ -84,12 +83,12 @@ class Polygon {
     /**
      * set new value to the Polygon
      * @name setShape
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
      * @param {number} x position of the Polygon
      * @param {number} y position of the Polygon
-     * @param {me.Vector2d[]|number[]} points array of vector or vertice defining the Polygon
-     * @returns {me.Polygon} this instance for objecf chaining
+     * @param {Vector2d[]|number[]} points array of vector or vertice defining the Polygon
+     * @returns {Polygon} this instance for objecf chaining
      */
     setShape(x, y, points) {
         this.pos.set(x, y);
@@ -100,10 +99,10 @@ class Polygon {
     /**
      * set the vertices defining this Polygon
      * @name setVertices
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
-     * @param {me.Vector2d[]} vertices array of vector or vertice defining the Polygon
-     * @returns {me.Polygon} this instance for objecf chaining
+     * @param {Vector2d[]} vertices array of vector or vertice defining the Polygon
+     * @returns {Polygon} this instance for objecf chaining
      */
     setVertices(vertices) {
 
@@ -140,10 +139,10 @@ class Polygon {
     /**
      * apply the given transformation matrix to this Polygon
      * @name transform
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
-     * @param {me.Matrix2d} m the transformation matrix
-     * @returns {me.Polygon} Reference to this object for method chaining
+     * @param {Matrix2d} m the transformation matrix
+     * @returns {Polygon} Reference to this object for method chaining
      */
     transform(m) {
         var points = this.points;
@@ -159,9 +158,9 @@ class Polygon {
     /**
      * apply an isometric projection to this shape
      * @name toIso
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
-     * @returns {me.Polygon} Reference to this object for method chaining
+     * @returns {Polygon} Reference to this object for method chaining
      */
     toIso() {
         return this.rotate(Math.PI / 4).scale(Math.SQRT2, Math.SQRT1_2);
@@ -170,9 +169,9 @@ class Polygon {
     /**
      * apply a 2d projection to this shape
      * @name to2d
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
-     * @returns {me.Polygon} Reference to this object for method chaining
+     * @returns {Polygon} Reference to this object for method chaining
      */
     to2d() {
         return this.scale(Math.SQRT1_2, Math.SQRT2).rotate(-Math.PI / 4);
@@ -181,11 +180,11 @@ class Polygon {
     /**
      * Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
      * @name rotate
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
      * @param {number} angle The angle to rotate (in radians)
-     * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
-     * @returns {me.Polygon} Reference to this object for method chaining
+     * @param {Vector2d|ObservableVector2d} [v] an optional point to rotate around
+     * @returns {Polygon} Reference to this object for method chaining
      */
     rotate(angle, v) {
         if (angle !== 0) {
@@ -203,11 +202,11 @@ class Polygon {
     /**
      * Scale this Polygon by the given scalar.
      * @name scale
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
      * @param {number} x
      * @param {number} [y=x]
-     * @returns {me.Polygon} Reference to this object for method chaining
+     * @returns {Polygon} Reference to this object for method chaining
      */
     scale(x, y) {
         y = typeof (y) !== "undefined" ? y : x;
@@ -225,10 +224,10 @@ class Polygon {
     /**
      * Scale this Polygon by the given vector
      * @name scaleV
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
-     * @param {me.Vector2d} v
-     * @returns {me.Polygon} Reference to this object for method chaining
+     * @param {Vector2d} v
+     * @returns {Polygon} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y);
@@ -238,9 +237,9 @@ 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 Polygon.prototype
      * @function
-     * @returns {me.Polygon} Reference to this object for method chaining
+     * @returns {Polygon} Reference to this object for method chaining
      */
     recalc() {
         var i;
@@ -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 Polygon.prototype
      * @function
      * @returns {Array} an array of vertex indices for all triangles forming this polygon.
      */
@@ -292,22 +292,69 @@ 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 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 Polygon.prototype
      * @function
      * @param {number} x x offset
      * @param {number} y y offset
-     * @returns {me.Polygon} this Polygon
+     * @returns {Polygon} this Polygon
      */
     /**
      * translate the Polygon by the specified vector
      * @name translate
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
-     * @param {me.Vector2d} v vector offset
-     * @returns {me.Polygon} Reference to this object for method chaining
+     * @param {Vector2d} v vector offset
+     * @returns {Polygon} Reference to this object for method chaining
      */
     translate() {
         var _x, _y;
@@ -332,14 +379,14 @@ class Polygon {
     /**
      * Shifts the Polygon to the given position vector.
      * @name shift
-     * @memberOf me.Polygon
+     * @memberof Polygon
      * @function
-     * @param {me.Vector2d} position
+     * @param {Vector2d} position
      */
     /**
      * Shifts the Polygon to the given x, y position.
      * @name shift
-     * @memberOf me.Polygon
+     * @memberof Polygon
      * @function
      * @param {number} x
      * @param {number} y
@@ -365,9 +412,9 @@ 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 Polygon.prototype
      * @function
-     * @param  {me.Vector2d} point
+     * @param {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 Polygon.prototype
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -414,9 +461,9 @@ class Polygon {
     /**
      * returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
      * @name getBounds
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
-     * @returns {me.Bounds} this shape bounding box Rectangle object
+     * @returns {Bounds} this shape bounding box Rectangle object
      */
     getBounds() {
         if (typeof this._bounds === "undefined") {
@@ -429,9 +476,9 @@ class Polygon {
      * update the bounding box for this shape.
      * @ignore
      * @name updateBounds
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
-     * @returns {me.Bounds} this shape bounding box Rectangle object
+     * @returns {Bounds} this shape bounding box Rectangle object
      */
     updateBounds() {
         var bounds = this.getBounds();
@@ -445,9 +492,9 @@ class Polygon {
     /**
      * clone this Polygon
      * @name clone
-     * @memberOf me.Polygon.prototype
+     * @memberof Polygon.prototype
      * @function
-     * @returns {me.Polygon} new Polygon
+     * @returns {Polygon} new Polygon
      */
     clone() {
         var copy = [];

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

@@ -4,18 +4,15 @@ 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 Polygon
  */
-
 class Rect extends Polygon {
-
+    /**
+     * @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
+     */
     constructor(x, y, w, h) {
         // parent constructor
         super(x, y, [
@@ -35,13 +32,13 @@ class Rect extends Polygon {
     /**
      * set new value to the rectangle shape
      * @name setShape
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
      * @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|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
+     * @returns {Rect} this rectangle
      */
     setShape(x, y, w, h) {
         var points = w; // assume w is an array by default
@@ -66,7 +63,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name left
-     * @memberOf me.Rect
+     * @memberof Rect
      */
     get left() {
         return this.pos.x;
@@ -77,7 +74,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name right
-     * @memberOf me.Rect
+     * @memberof Rect
      */
     get right() {
         var w = this.width;
@@ -89,7 +86,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name top
-     * @memberOf me.Rect
+     * @memberof Rect
      */
     get top() {
         return this.pos.y;
@@ -100,7 +97,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name bottom
-     * @memberOf me.Rect
+     * @memberof Rect
      */
     get bottom() {
         var h = this.height;
@@ -112,7 +109,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name width
-     * @memberOf me.Rect
+     * @memberof Rect
      */
     get width() {
         return this.points[2].x;
@@ -128,7 +125,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name height
-     * @memberOf me.Rect
+     * @memberof Rect
      */
     get height() {
         return this.points[2].y;
@@ -144,7 +141,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name centerX
-     * @memberOf me.Rect
+     * @memberof Rect
      */
     get centerX() {
         if (isFinite(this.width)) {
@@ -162,7 +159,7 @@ class Rect extends Polygon {
      * @public
      * @type {number}
      * @name centerY
-     * @memberOf me.Rect
+     * @memberof Rect
      */
     get centerY() {
         if (isFinite(this.height)) {
@@ -178,11 +175,11 @@ class Rect extends Polygon {
     /**
      * resize the rectangle
      * @name resize
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
      * @param {number} w new width of the rectangle
      * @param {number} h new height of the rectangle
-     * @returns {me.Rect} this rectangle
+     * @returns {Rect} this rectangle
      */
     resize(w, h) {
         this.width = w;
@@ -193,11 +190,11 @@ class Rect extends Polygon {
     /**
      * scale the rectangle
      * @name scale
-     * @memberOf me.Rect.prototype
+     * @memberof 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.
-     * @returns {me.Rect} this rectangle
+     * @returns {Rect} this rectangle
      */
     scale(x, y = x) {
         this.width *= x;
@@ -208,9 +205,9 @@ class Rect extends Polygon {
     /**
      * clone this rectangle
      * @name clone
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
-     * @returns {me.Rect} new rectangle
+     * @returns {Rect} new rectangle
      */
     clone() {
         return new Rect(this.pos.x, this.pos.y, this.width, this.height);
@@ -219,10 +216,10 @@ class Rect extends Polygon {
     /**
      * copy the position and size of the given rectangle into this one
      * @name copy
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
-     * @param {me.Rect} rect Source rectangle
-     * @returns {me.Rect} new rectangle
+     * @param {Rect} rect Source rectangle
+     * @returns {Rect} new rectangle
      */
     copy(rect) {
         return this.setShape(rect.pos.x, rect.pos.y, rect.width, rect.height);
@@ -231,10 +228,10 @@ class Rect extends Polygon {
     /**
      * merge this rectangle with another one
      * @name union
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
-     * @param {me.Rect} rect other rectangle to union with
-     * @returns {me.Rect} the union(ed) rectangle
+     * @param {Rect} rect other rectangle to union with
+     * @returns {Rect} the union(ed) rectangle
      */
     union(rect) {
         var x1 = Math.min(this.left, rect.left);
@@ -253,9 +250,9 @@ class Rect extends Polygon {
     /**
      * check if this rectangle is intersecting with the specified one
      * @name overlaps
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
-     * @param  {me.Rect} rect
+     * @param {Rect} rect
      * @returns {boolean} true if overlaps
      */
     overlaps(rect) {
@@ -270,16 +267,16 @@ class Rect extends Polygon {
     /**
      * Returns true if the rectangle contains the given rectangle
      * @name contains
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
-     * @param {me.Rect} rect
+     * @param {Rect} rect
      * @returns {boolean} true if contains
      */
 
     /**
      * Returns true if the rectangle contains the given point
      * @name contains
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
      * @param  {number} x x coordinate
      * @param  {number} y y coordinate
@@ -289,9 +286,9 @@ class Rect extends Polygon {
     /**
      * Returns true if the rectangle contains the given point
      * @name contains
-     * @memberOf me.Rect
+     * @memberof Rect
      * @function
-     * @param {me.Vector2d} point
+     * @param {Vector2d} point
      * @returns {boolean} true if contains
      */
     contains() {
@@ -325,9 +322,9 @@ class Rect extends Polygon {
     /**
      * check if this rectangle is identical to the specified one
      * @name equals
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
-     * @param  {me.Rect} rect
+     * @param {Rect} rect
      * @returns {boolean} true if equals
      */
     equals(rect) {
@@ -342,7 +339,7 @@ class Rect extends Polygon {
     /**
      * determines whether all coordinates of this rectangle are finite numbers.
      * @name isFinite
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
      * @returns {boolean} false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
      */
@@ -353,9 +350,9 @@ class Rect extends Polygon {
     /**
      * Returns a polygon whose edges are the same as this box.
      * @name toPolygon
-     * @memberOf me.Rect.prototype
+     * @memberof Rect.prototype
      * @function
-     * @returns {me.Polygon} a new Polygon that represents this rectangle.
+     * @returns {Polygon} a new Polygon that represents this rectangle.
      */
     toPolygon() {
         return new Polygon(