@vpmedia/phaser 1.12.0 → 1.14.0

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

@@ -1,17 +1,19 @@
 /**
+ * @module geom/util/circle
+ * @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 Circle from '../circle';
-import Point from '../point';
+import { Circle } from  '../circle';
+import { Point } from '../point';
 import { degToRad, distance } from '../../util/math';
 
 /**
+ * TBD.
  *
- * @param {object} input TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Circle} input - TBD.
+ * @param {Circle} output - TBD.
+ * @returns {Circle} TBD.
  */
 export function clone(input, output = null) {
   const result = output || new Circle();
@@ -22,11 +24,12 @@ export function clone(input, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {number} x TBD
- * @param {number} y TBD
- * @returns {boolean} TBD
+ * @param {Circle} a - TBD.
+ * @param {number} x - TBD.
+ * @param {number} y - TBD.
+ * @returns {boolean} TBD.
  */
 export function contains(a, x, y) {
   if (a.radius > 0 && x >= a.left && x <= a.right && y >= a.top && y <= a.bottom) {
@@ -38,32 +41,35 @@ export function contains(a, x, y) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @returns {boolean} TBD
+ * @param {Circle} a - TBD.
+ * @param {Circle} b - TBD.
+ * @returns {boolean} TBD.
  */
 export function equals(a, b) {
   return a.x === b.x && a.y === b.y && a.diameter === b.diameter;
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @returns {boolean} TBD
+ * @param {Circle} a - TBD.
+ * @param {Circle} b - TBD.
+ * @returns {boolean} TBD.
  */
 export function intersects(a, b) {
   return distance(a.x, a.y, b.x, b.y) <= a.radius + b.radius;
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {number} angle TBD
- * @param {boolean} asDegrees TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Circle} a - TBD.
+ * @param {number} angle - TBD.
+ * @param {boolean} asDegrees - TBD.
+ * @param {Circle} output - TBD.
+ * @returns {Circle} TBD.
  */
 export function circumferencePoint(a, angle, asDegrees = false, output = null) {
   const result = output || new Point();
@@ -76,12 +82,13 @@ export function circumferencePoint(a, angle, asDegrees = false, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {number} angle TBD
- * @param {boolean} asDegrees TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Circle} a - TBD.
+ * @param {number} angle - TBD.
+ * @param {boolean} asDegrees - TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function intersectsPoint(a, angle, asDegrees = false, output = null) {
   const result = output || new Point();
@@ -94,10 +101,11 @@ export function intersectsPoint(a, angle, asDegrees = false, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} c TBD
- * @param {object} r TBD
- * @returns {boolean} TBD
+ * @param {Circle} c - TBD.
+ * @param {object} r - TBD.
+ * @returns {boolean} TBD.
  */
 export function intersectsRectangle(c, r) {
   const cx = Math.abs(c.x - r.x - r.halfWidth);

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

@@ -1,25 +1,17 @@
 /**
+ * @module geom/util/ellipse
+ * @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)
  */
 
 /**
- * TBD
- *
- * @deprecated
- * @returns {boolean} TBD
- */
-export default function () {
-  return true;
-}
-
-/**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {number} x TBD
- * @param {number} y TBD
- * @returns {boolean} TBD
+ * @param {object} 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) {

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

@@ -1,17 +1,19 @@
 /**
+ * @module geom/util/line
+ * @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 Line from '../line';
+import { Point } from '../point';
+import { Line } from  '../line';
 import { intersects as intersectsRect } from './rectangle';
 
 /**
+ * TBD.
  *
- * @param {object} input TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Line} input - TBD.
+ * @param {Line} output - TBD.
+ * @returns {Line} TBD.
  */
 export function clone(input, output = null) {
   const result = output || new Line();
@@ -23,14 +25,15 @@ export function clone(input, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {object} e TBD
- * @param {object} f TBD
- * @param {boolean} asSegment TBD
- * @param {object} output TBD
- * @returns {boolean} TBD
+ * @param {object} a - TBD.
+ * @param {object} b - TBD.
+ * @param {object} e - TBD.
+ * @param {object} f - TBD.
+ * @param {boolean} asSegment - TBD.
+ * @param {Point} output - TBD.
+ * @returns {boolean} TBD.
  */
 export function intersectsPoints(a, b, e, f, asSegment = true, output = null) {
   const result = output || new Point();
@@ -59,22 +62,24 @@ export function intersectsPoints(a, b, e, f, asSegment = true, output = null) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @param {boolean} asSegment TBD
- * @param {object} result TBD
- * @returns {boolean} TBD
+ * @param {object} a - TBD.
+ * @param {object} b - TBD.
+ * @param {boolean} asSegment - TBD.
+ * @param {object} result - TBD.
+ * @returns {boolean} TBD.
  */
 export function intersects(a, b, asSegment, result) {
   return intersectsPoints(a.start, a.end, b.start, b.end, asSegment, result);
 }
 
 /**
+ * TBD.
  *
- * @param {object} line TBD
- * @param {object} rect TBD
- * @returns {boolean} TBD
+ * @param {object} line - TBD.
+ * @param {object} rect - TBD.
+ * @returns {boolean} TBD.
  */
 export function intersectsRectangle(line, rect) {
   //  Quick bail out of the Line and Rect bounds don't intersect
@@ -128,10 +133,11 @@ export function intersectsRectangle(line, rect) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} a TBD
- * @param {object} b TBD
- * @returns {number} TBD
+ * @param {object} a - TBD.
+ * @param {object} b - TBD.
+ * @returns {number} TBD.
  */
 export function reflect(a, b) {
   return 2 * b.normalAngle - 3.141592653589793 - a.angle;

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

@@ -1,15 +1,17 @@
 /**
+ * @module geom/util/matrix
+ * @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 Matrix from '../matrix';
+import { Matrix } from  '../matrix';
 
 /**
+ * TBD.
  *
- * @param {object} input TBD
- * @param {object} output TBD
- * @returns {object} TBD
+ * @param {Matrix} input - TBD.
+ * @param {Matrix} output - TBD.
+ * @returns {Matrix} TBD.
  */
 export function clone(input, output = null) {
   const result = output || new Matrix();
@@ -23,9 +25,9 @@ export function clone(input, output = null) {
 }
 
 /**
- * TBD
+ * TBD.
  *
- * @returns {object} TBD
+ * @returns {Matrix} TBD.
  */
 export function getIdentityMatrix() {
   if (!window.PhaserRegistry) {
@@ -38,9 +40,9 @@ export function getIdentityMatrix() {
 }
 
 /**
- * TBD
+ * TBD.
  *
- * @returns {object} TBD
+ * @returns {Matrix} TBD.
  */
 export function getTempMatrix() {
   if (!window.PhaserRegistry) {

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;
 }
 
 /**
+ * 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();