@vpmedia/phaser 1.11.0 → 1.13.0

package/src/phaser/geom/util/point.js

@@ -1,16 +1,18 @@
 /**
+ * @module geom/util/point
+ * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  * @author       Andras Csizmadia <andras@vpmedia.hu>
  * @author       Richard Davey <rich@photonstorm.com>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import Point from '../point';
+import { Point } from '../point';
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function add(a, b, output = null) {
   const result = output || new Point();
@@ -20,11 +22,12 @@ export function add(a, b, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function subtract(a, b, output = null) {
   const result = output || new Point();
@@ -34,11 +37,12 @@ export function subtract(a, b, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function multiply(a, b, output = null) {
   const result = output || new Point();
@@ -48,11 +52,12 @@ export function multiply(a, b, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function divide(a, b, output = null) {
   const result = output || new Point();
@@ -62,30 +67,33 @@ export function divide(a, b, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @returns {boolean} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @returns {boolean} TBD.
  */
 export function equals(a, b) {
-  return (a.x === b.x && a.y === b.y);
+  return a.x === b.x && a.y === b.y;
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @returns {number} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @returns {number} TBD.
  */
 export function angle(a, b) {
   return Math.atan2(a.y - b.y, a.x - b.x);
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function negative(a, output = null) {
   const result = output || new Point();
@@ -93,12 +101,13 @@ export function negative(a, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {number} s TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @param {number} s - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function multiplyAdd(a, b, s, output = null) {
   const result = output || new Point();
@@ -106,12 +115,13 @@ export function multiplyAdd(a, b, s, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {number} f TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @param {number} f - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function interpolate(a, b, f, output = null) {
   const result = output || new Point();
@@ -119,10 +129,11 @@ export function interpolate(a, b, f, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function perp(a, output = null) {
   const result = output || new Point();
@@ -130,10 +141,11 @@ export function perp(a, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function rperp(a, output = null) {
   const result = output || new Point();
@@ -141,11 +153,12 @@ export function rperp(a, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {boolean} round TBD
- * @returns {number} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @param {boolean} round - TBD.
+ * @returns {number} TBD.
  */
 export function distance(a, b, round = false) {
   const dx = a.x - b.x;
@@ -155,11 +168,12 @@ export function distance(a, b, round = false) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function project(a, b, output = null) {
   const result = output || new Point();
@@ -171,11 +185,12 @@ export function project(a, b, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} b - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function projectUnit(a, b, output = null) {
   const result = output || new Point();
@@ -187,10 +202,11 @@ export function projectUnit(a, b, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function normalRightHand(a, output = null) {
   const result = output || new Point();
@@ -198,10 +214,11 @@ export function normalRightHand(a, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function normalize(a, output = null) {
   const result = output || new Point();
@@ -213,14 +230,15 @@ export function normalize(a, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {number} x TBD
- * @param {number} y TBD
- * @param {number} ang TBD
- * @param {boolean} asDegrees TBD
- * @param {number} dist TBD
- * @returns {object} TBD
+ * @param {Point} a - TBD.
+ * @param {number} x - TBD.
+ * @param {number} y - TBD.
+ * @param {number} ang - TBD.
+ * @param {boolean} asDegrees - TBD.
+ * @param {number} dist - TBD.
+ * @returns {object} TBD.
  */
 export function rotate(a, x, y, ang, asDegrees, dist) {
   if (asDegrees) {
@@ -243,10 +261,12 @@ export function rotate(a, x, y, ang, asDegrees, dist) {
 }
 
 /**
+ * TBD.
  *
- * @param {object[]} points TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point[]} points - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
+ * @throws Error TBD.
  */
 export function centroid(points, output = null) {
   const result = output || new Point();
@@ -266,11 +286,12 @@ export function centroid(points, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} obj TBD
- * @param {string} xProp TBD
- * @param {string} yProp TBD
- * @returns {object} TBD
+ * @param {object} obj - TBD.
+ * @param {string} xProp - TBD.
+ * @param {string} yProp - TBD.
+ * @returns {Point} TBD.
  */
 export function parse(obj, xProp = 'x', yProp = 'y') {
   const point = new Point();
@@ -284,10 +305,11 @@ export function parse(obj, xProp = 'x', yProp = 'y') {
 }
 
 /**
+ * TBD.
  *
- * @param {object} input TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point} input - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function clone(input, output = null) {
   const result = output || new Point();

package/src/phaser/geom/util/polygon.js

@@ -1,25 +1,17 @@
 /**
+ * @module geom/util/polygon
+ * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  * @author       Andras Csizmadia <andras@vpmedia.hu>
  * @author       Richard Davey <rich@photonstorm.com>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import Polygon from '../polygon';
-
-/**
- * TBD
- *
- * @deprecated
- * @returns {boolean} TBD
- */
-export default function () {
-  return true;
-}
+import { Polygon } from  '../polygon';
 
 /**
+ * TBD.
  *
- * @param {object} input TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Polygon} input - TBD.
+ * @param {Polygon} output - TBD.
+ * @returns {Polygon} TBD.
  */
 export function clone(input, output = null) {
   const result = output || new Polygon();

package/src/phaser/geom/util/rectangle.js

@@ -1,17 +1,19 @@
 /**
+ * @module geom/util/rectangle
+ * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  * @author       Andras Csizmadia <andras@vpmedia.hu>
  * @author       Richard Davey <rich@photonstorm.com>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import Rectangle from '../rectangle';
-import Point from '../point';
+import { Rectangle } from  '../rectangle';
+import { Point } from '../point';
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {number} dx TBD
- * @param {number} dy TBD
- * @returns {object} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {number} dx - TBD.
+ * @param {number} dy - TBD.
+ * @returns {Rectangle} TBD.
  */
 export function inflate(a, dx, dy) {
   a.x -= dx;
@@ -22,20 +24,22 @@ export function inflate(a, dx, dy) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} point TBD
- * @returns {object} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {object} point - TBD.
+ * @returns {Rectangle} TBD.
  */
 export function inflatePoint(a, point) {
   return inflate(a, point.x, point.y);
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function size(a, output = null) {
   const result = output || new Point();
@@ -44,10 +48,11 @@ export function size(a, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} input TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Rectangle} input - TBD.
+ * @param {Rectangle} output - TBD.
+ * @returns {Rectangle} TBD.
  */
 export function clone(input, output = null) {
   const result = output || new Rectangle();
@@ -56,81 +61,88 @@ export function clone(input, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {number} x TBD
- * @param {number} y TBD
- * @returns {boolean} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {number} x - TBD.
+ * @param {number} y - TBD.
+ * @returns {boolean} TBD.
  */
 export function contains(a, x, y) {
   if (a.width <= 0 || a.height <= 0) {
     return false;
   }
-  return (x >= a.x && x < a.right && y >= a.y && y < a.bottom);
+  return x >= a.x && x < a.right && y >= a.y && y < a.bottom;
 }
 
 /**
+ * TBD.
  *
- * @param {number} rx TBD
- * @param {number} ry TBD
- * @param {number} rw TBD
- * @param {number} rh TBD
- * @param {number} x TBD
- * @param {number} y TBD
- * @returns {boolean} TBD
+ * @param {number} rx - TBD.
+ * @param {number} ry - TBD.
+ * @param {number} rw - TBD.
+ * @param {number} rh - TBD.
+ * @param {number} x - TBD.
+ * @param {number} y - TBD.
+ * @returns {boolean} TBD.
  */
 export function containsRaw(rx, ry, rw, rh, x, y) {
-  return (x >= rx && x < (rx + rw) && y >= ry && y < (ry + rh));
+  return x >= rx && x < rx + rw && y >= ry && y < ry + rh;
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} point TBD
- * @returns {boolean} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {Point} point - TBD.
+ * @returns {boolean} TBD.
  */
 export function containsPoint(a, point) {
   return contains(a, point.x, point.y);
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @returns {boolean} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {Rectangle} b - TBD.
+ * @returns {boolean} TBD.
  */
 export function containsRect(a, b) {
   if (a.volume > b.volume) {
     return false;
   }
-  return (a.x >= b.x && a.y >= b.y && a.right < b.right && a.bottom < b.bottom);
+  return a.x >= b.x && a.y >= b.y && a.right < b.right && a.bottom < b.bottom;
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @returns {boolean} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {Rectangle} b - TBD.
+ * @returns {boolean} TBD.
  */
 export function equals(a, b) {
-  return (a.x === b.x && a.y === b.y && a.width === b.width && a.height === b.height);
+  return a.x === b.x && a.y === b.y && a.width === b.width && a.height === b.height;
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @returns {boolean} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {Rectangle} b - TBD.
+ * @returns {boolean} TBD.
  */
 export function sameDimensions(a, b) {
-  return (a.width === b.width && a.height === b.height);
+  return a.width === b.width && a.height === b.height;
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @returns {boolean} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {Rectangle} b - TBD.
+ * @returns {boolean} TBD.
  */
 export function intersects(a, b) {
   if (a.width <= 0 || a.height <= 0 || b.width <= 0 || b.height <= 0) {
@@ -140,11 +152,12 @@ export function intersects(a, b) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {Rectangle} b - TBD.
+ * @param {Rectangle} output - TBD.
+ * @returns {Rectangle} TBD.
  */
 export function intersection(a, b, output = null) {
   const result = output || new Rectangle();
@@ -158,36 +171,49 @@ export function intersection(a, b, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {number} left TBD
- * @param {number} right TBD
- * @param {number} top TBD
- * @param {number} bottom TBD
- * @param {number} tolerance TBD
- * @returns {boolean} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {number} left - TBD.
+ * @param {number} right - TBD.
+ * @param {number} top - TBD.
+ * @param {number} bottom - TBD.
+ * @param {number} tolerance - TBD.
+ * @returns {boolean} TBD.
  */
 export function intersectsRaw(a, left, right, top, bottom, tolerance = 0) {
-  return !(left > a.right + tolerance || right < a.left - tolerance || top > a.bottom + tolerance || bottom < a.top - tolerance);
+  return !(
+    left > a.right + tolerance ||
+    right < a.left - tolerance ||
+    top > a.bottom + tolerance ||
+    bottom < a.top - tolerance
+  );
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Rectangle} a - TBD.
+ * @param {Rectangle} b - TBD.
+ * @param {Rectangle} output - TBD.
+ * @returns {Rectangle} TBD.
  */
 export function union(a, b, output = null) {
   const result = output || new Rectangle();
-  return result.setTo(Math.min(a.x, b.x), Math.min(a.y, b.y), Math.max(a.right, b.right) - Math.min(a.left, b.left), Math.max(a.bottom, b.bottom) - Math.min(a.top, b.top));
+  return result.setTo(
+    Math.min(a.x, b.x),
+    Math.min(a.y, b.y),
+    Math.max(a.right, b.right) - Math.min(a.left, b.left),
+    Math.max(a.bottom, b.bottom) - Math.min(a.top, b.top)
+  );
 }
 
 /**
+ * TBD.
  *
- * @param {object[]} points TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Point[]} points - TBD.
+ * @param {Rectangle} output - TBD.
+ * @returns {Rectangle} TBD.
  */
 export function aabb(points, output = null) {
   const result = output || new Rectangle();
@@ -214,9 +240,9 @@ export function aabb(points, output = null) {
 }
 
 /**
- * TBD
+ * TBD.
  *
- * @returns {object} TBD
+ * @returns {Rectangle} TBD.
  */
 export function getEmptyRectangle() {
   if (!window.PhaserRegistry) {

package/src/phaser/geom/util/rounded_rectangle.js

@@ -1,25 +1,17 @@
 /**
+ * @module geom/util/rounded_rectangle
+ * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  * @author       Andras Csizmadia <andras@vpmedia.hu>
  * @author       Richard Davey <rich@photonstorm.com>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import RoundedRectangle from '../rounded_rectangle';
-
-/**
- * TBD
- *
- * @deprecated
- * @returns {boolean} TBD
- */
-export default function () {
-  return true;
-}
+import { RoundedRectangle } from  '../rounded_rectangle';
 
 /**
+ * TBD.
  *
- * @param {object} input TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {RoundedRectangle} input - TBD.
+ * @param {RoundedRectangle} output - TBD.
+ * @returns {RoundedRectangle} TBD.
  */
 export function clone(input, output = null) {
   const result = output || new RoundedRectangle();