melonjs 10.2.0 → 10.3.0

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

@@ -5,11 +5,10 @@ import Polygon from "./poly.js";
  * @classdesc
  * a line segment Object
  * @class Line
- * @extends me.Polygon
- * @memberOf me
- * @constructor
- * @param {Number} x origin point of the Line
- * @param {Number} y origin point of the Line
+ * @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,20 +17,20 @@ 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
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
      * 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
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
     contains() {
         var _x, _y;
@@ -61,8 +60,9 @@ 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
      */
     recalc() {
         var edges = this.edges;
@@ -96,9 +96,9 @@ class Line extends Polygon {
     /**
      * clone this line segment
      * @name clone
-     * @memberOf me.Line.prototype
+     * @memberof me.Line.prototype
      * @function
-     * @return {me.Line} new Line
+     * @returns {me.Line} new Line
      */
     clone() {
         var copy = [];

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

@@ -11,10 +11,9 @@ 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
- * @param {Number} x origin point of the Polygon
- * @param {Number} y origin point of the Polygon
+ * @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,11 +83,12 @@ 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
-     * @param {me.Vector2d[]|Number[]} points array of vector or vertice defining the Polygon
+     * @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
      */
     setShape(x, y, points) {
         this.pos.set(x, y);
@@ -99,9 +99,10 @@ class Polygon {
     /**
      * set the vertices defining this Polygon
      * @name setVertices
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
-     * @param {me.Vector2d[]} points array of vector or vertice defining the Polygon
+     * @param {me.Vector2d[]} vertices array of vector or vertice defining the Polygon
+     * @returns {me.Polygon} this instance for objecf chaining
      */
     setVertices(vertices) {
 
@@ -138,10 +139,10 @@ class Polygon {
     /**
      * apply the given transformation matrix to this Polygon
      * @name transform
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
-     * @param {me.Matrix2d} matrix the transformation matrix
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @param {me.Matrix2d} m the transformation matrix
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     transform(m) {
         var points = this.points;
@@ -157,9 +158,9 @@ class Polygon {
     /**
      * apply an isometric projection to this shape
      * @name toIso
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     toIso() {
         return this.rotate(Math.PI / 4).scale(Math.SQRT2, Math.SQRT1_2);
@@ -168,9 +169,9 @@ class Polygon {
     /**
      * apply a 2d projection to this shape
      * @name to2d
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     to2d() {
         return this.scale(Math.SQRT1_2, Math.SQRT2).rotate(-Math.PI / 4);
@@ -179,11 +180,11 @@ 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 {number} angle The angle to rotate (in radians)
      * @param {me.Vector2d|me.ObservableVector2d} [v] an optional point to rotate around
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     rotate(angle, v) {
         if (angle !== 0) {
@@ -201,11 +202,11 @@ 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]
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @param {number} x
+     * @param {number} [y=x]
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     scale(x, y) {
         y = typeof (y) !== "undefined" ? y : x;
@@ -223,10 +224,10 @@ class Polygon {
     /**
      * Scale this Polygon by the given vector
      * @name scaleV
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
      * @param {me.Vector2d} v
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     scaleV(v) {
         return this.scale(v.x, v.y);
@@ -236,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 me.Polygon.prototype
      * @function
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     recalc() {
         var i;
@@ -276,12 +277,13 @@ 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
-     * @return {Array} an array of vertex indices for all triangles forming this polygon.
+     * @returns {Array} an array of vertex indices for all triangles forming this polygon.
      */
     getIndices() {
         if (this.indices.length === 0) {
@@ -290,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 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
-     * @return {me.Polygon} this Polygon
+     * @param {number} x x offset
+     * @param {number} y y offset
+     * @returns {me.Polygon} this 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
-     * @return {me.Polygon} Reference to this object for method chaining
+     * @returns {me.Polygon} Reference to this object for method chaining
      */
     translate() {
         var _x, _y;
@@ -330,17 +379,17 @@ 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
+     * @param {number} x
+     * @param {number} y
      */
     shift() {
         var _x, _y;
@@ -363,10 +412,10 @@ 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
-     * @return {boolean} true if contains
+     * @returns {boolean} true if contains
      */
 
     /**
@@ -374,11 +423,11 @@ 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
-     * @return {boolean} true if contains
+     * @param  {number} x x coordinate
+     * @param  {number} y y coordinate
+     * @returns {boolean} true if contains
      */
     contains() {
         var _x, _y;
@@ -412,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 me.Polygon.prototype
      * @function
-     * @return {me.Bounds} this shape bounding box Rectangle object
+     * @returns {me.Bounds} this shape bounding box Rectangle object
      */
     getBounds() {
         if (typeof this._bounds === "undefined") {
@@ -427,9 +476,9 @@ class Polygon {
      * update the bounding box for this shape.
      * @ignore
      * @name updateBounds
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
-     * @return {me.Bounds} this shape bounding box Rectangle object
+     * @returns {me.Bounds} this shape bounding box Rectangle object
      */
     updateBounds() {
         var bounds = this.getBounds();
@@ -443,9 +492,9 @@ class Polygon {
     /**
      * clone this Polygon
      * @name clone
-     * @memberOf me.Polygon.prototype
+     * @memberof me.Polygon.prototype
      * @function
-     * @return {me.Polygon} new Polygon
+     * @returns {me.Polygon} new Polygon
      */
     clone() {
         var copy = [];