@vpmedia/phaser 1.11.0 → 1.13.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,48 +24,52 @@ 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) {
     const dx = (a.x - x) * (a.x - x);
     const dy = (a.y - y) * (a.y - y);
-    return (dx + dy) <= (a.radius * a.radius);
+    return dx + dy <= a.radius * a.radius;
   }
   return false;
 }
 
 /**
+ * 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);
+  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);
+  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,34 +1,26 @@
 /**
+ * @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) {
     return false;
   }
   //  Normalize the coords to an ellipse with center 0,0 and a radius of 0.5
-  let normx = ((x - a.x) / a.width) - 0.5;
-  let normy = ((y - a.y) / a.height) - 0.5;
+  let normx = (x - a.x) / a.width - 0.5;
+  let normy = (y - a.y) / a.height - 0.5;
   normx *= normx;
   normy *= normy;
-  return (normx + normy < 0.25);
+  return normx + normy < 0.25;
 }

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();
@@ -38,18 +41,18 @@ export function intersectsPoints(a, b, e, f, asSegment = true, output = null) {
   const a2 = f.y - e.y;
   const b1 = a.x - b.x;
   const b2 = e.x - f.x;
-  const c1 = (b.x * a.y) - (a.x * b.y);
-  const c2 = (f.x * e.y) - (e.x * f.y);
-  const denom = (a1 * b2) - (a2 * b1);
+  const c1 = b.x * a.y - a.x * b.y;
+  const c2 = f.x * e.y - e.x * f.y;
+  const denom = a1 * b2 - a2 * b1;
   if (denom === 0) {
     return null;
   }
-  result.x = ((b1 * c2) - (b2 * c1)) / denom;
-  result.y = ((a2 * c1) - (a1 * c2)) / denom;
+  result.x = (b1 * c2 - b2 * c1) / denom;
+  result.y = (a2 * c1 - a1 * c2) / denom;
   if (asSegment) {
-    const uc = ((f.y - e.y) * (b.x - a.x) - (f.x - e.x) * (b.y - a.y));
-    const ua = (((f.x - e.x) * (a.y - e.y)) - (f.y - e.y) * (a.x - e.x)) / uc;
-    const ub = (((b.x - a.x) * (a.y - e.y)) - ((b.y - a.y) * (a.x - e.x))) / uc;
+    const uc = (f.y - e.y) * (b.x - a.x) - (f.x - e.x) * (b.y - a.y);
+    const ua = ((f.x - e.x) * (a.y - e.y) - (f.y - e.y) * (a.x - e.x)) / uc;
+    const ub = ((b.x - a.x) * (a.y - e.y) - (b.y - a.y) * (a.x - e.x)) / uc;
     if (ua >= 0 && ua <= 1 && ub >= 0 && ub <= 1) {
       return result;
     }
@@ -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
@@ -92,31 +97,34 @@ export function intersectsRectangle(line, rect) {
   let t = 0;
   //  If the start or end of the line is inside the rect then we assume
   //  collision, as rects are solid for our use-case.
-  if ((x1 >= bx1 && x1 <= bx2 && y1 >= by1 && y1 <= by2) || (x2 >= bx1 && x2 <= bx2 && y2 >= by1 && y2 <= by2)) {
+  if (
+    (x1 >= bx1 && x1 <= bx2 && y1 >= by1 && y1 <= by2) ||
+    (x2 >= bx1 && x2 <= bx2 && y2 >= by1 && y2 <= by2)
+  ) {
     return true;
   }
   if (x1 < bx1 && x2 >= bx1) {
     //  Left edge
-    t = y1 + (y2 - y1) * (bx1 - x1) / (x2 - x1);
+    t = y1 + ((y2 - y1) * (bx1 - x1)) / (x2 - x1);
     if (t > by1 && t <= by2) {
       return true;
     }
   } else if (x1 > bx2 && x2 <= bx2) {
     //  Right edge
-    t = y1 + (y2 - y1) * (bx2 - x1) / (x2 - x1);
+    t = y1 + ((y2 - y1) * (bx2 - x1)) / (x2 - x1);
     if (t >= by1 && t <= by2) {
       return true;
     }
   }
   if (y1 < by1 && y2 >= by1) {
     //  Top edge
-    t = x1 + (x2 - x1) * (by1 - y1) / (y2 - y1);
+    t = x1 + ((x2 - x1) * (by1 - y1)) / (y2 - y1);
     if (t >= bx1 && t <= bx2) {
       return true;
     }
   } else if (y1 > by2 && y2 <= by2) {
     //  Bottom edge
-    t = x1 + (x2 - x1) * (by2 - y1) / (y2 - y1);
+    t = x1 + ((x2 - x1) * (by2 - y1)) / (y2 - y1);
     if (t >= bx1 && t <= bx2) {
       return true;
     }
@@ -125,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) {