@vpmedia/phaser 1.14.0 → 1.16.0

package/src/phaser/geom/rectangle.js

@@ -1,9 +1,3 @@
-/**
- * @module geom/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>
- */
 import { Point } from './point';
 import {
   inflate,
@@ -33,7 +27,6 @@ import {
 export class Rectangle {
   /**
    * TBD.
-   *
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {number} width - TBD.
@@ -47,16 +40,35 @@ export class Rectangle {
     this.type = GEOM_RECTANGLE;
   }
 
+  /**
+   * TBD.
+   * @param {number} dx - TBD.
+   * @param {number} dy - TBD.
+   * @returns {Rectangle} TBD.
+   */
   offset(dx, dy) {
     this.x += dx;
     this.y += dy;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {Point} point - TBD.
+   * @returns {Rectangle} TBD.
+   */
   offsetPoint(point) {
     return this.offset(point.x, point.y);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   * @returns {Rectangle} TBD.
+   */
   setTo(x, y, width, height) {
     this.x = x;
     this.y = y;
@@ -65,6 +77,12 @@ export class Rectangle {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Rectangle} TBD.
+   */
   scale(x, y) {
     if (y === undefined) {
       y = x;
@@ -74,17 +92,29 @@ export class Rectangle {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Rectangle} TBD.
+   */
   centerOn(x, y) {
     this.centerX = x;
     this.centerY = y;
     return this;
   }
 
+  /**
+   * TBD.
+   */
   floor() {
     this.x = Math.floor(this.x);
     this.y = Math.floor(this.y);
   }
 
+  /**
+   * TBD.
+   */
   floorAll() {
     this.x = Math.floor(this.x);
     this.y = Math.floor(this.y);
@@ -92,11 +122,17 @@ export class Rectangle {
     this.height = Math.floor(this.height);
   }
 
+  /**
+   * TBD.
+   */
   ceil() {
     this.x = Math.ceil(this.x);
     this.y = Math.ceil(this.y);
   }
 
+  /**
+   * TBD.
+   */
   ceilAll() {
     this.x = Math.ceil(this.x);
     this.y = Math.ceil(this.y);
@@ -104,10 +140,20 @@ export class Rectangle {
     this.height = Math.ceil(this.height);
   }
 
+  /**
+   * TBD.
+   * @param {Rectangle} source - TBD.
+   * @returns {Rectangle} TBD.
+   */
   copyFrom(source) {
     return this.setTo(source.x, source.y, source.width, source.height);
   }
 
+  /**
+   * TBD.
+   * @param {Rectangle} dest - TBD.
+   * @returns {Rectangle} TBD.
+   */
   copyTo(dest) {
     dest.x = this.x;
     dest.y = this.y;
@@ -116,52 +162,121 @@ export class Rectangle {
     return dest;
   }
 
+  /**
+   * TBD.
+   * @param {number} dx - TBD.
+   * @param {number} dy - TBD.
+   * @returns {Rectangle} TBD.
+   */
   inflate(dx, dy) {
     return inflate(this, dx, dy);
   }
 
+  /**
+   * TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   size(output) {
     return size(this, output);
   }
 
+  /**
+   * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   * @returns {Rectangle} TBD.
+   */
   resize(width, height) {
     this.width = width;
     this.height = height;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {Rectangle} output - TBD.
+   * @returns {Rectangle} TBD.
+   */
   clone(output) {
     return clone(this, output);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {boolean} TBD.
+   */
   contains(x, y) {
     return contains(this, x, y);
   }
 
+  /**
+   * TBD.
+   * @param {Rectangle} b - TBD.
+   * @returns {boolean} TBD.
+   */
   containsRect(b) {
     return containsRect(b, this);
   }
 
+  /**
+   * TBD.
+   * @param {Rectangle} b - TBD.
+   * @returns {boolean} TBD.
+   */
   equals(b) {
     return equals(this, b);
   }
 
+  /**
+   * TBD.
+   * @param {Rectangle} b - TBD.
+   * @param {Rectangle} out - TBD.
+   * @returns {Rectangle} TBD.
+   */
   intersection(b, out) {
     return intersection(this, b, out);
   }
 
+  /**
+   * TBD.
+   * @param {Rectangle} b - TBD.
+   * @returns {boolean} TBD.
+   */
   intersects(b) {
     return intersects(this, b);
   }
 
+  /**
+   * TBD.
+   * @param {number} left - TBD.
+   * @param {number} right - TBD.
+   * @param {number} top - TBD.
+   * @param {number} bottom - TBD.
+   * @param {number} tolerance - TBD.
+   * @returns {boolean} TBD.
+   */
   intersectsRaw(left, right, top, bottom, tolerance) {
     return intersectsRaw(this, left, right, top, bottom, tolerance);
   }
 
+  /**
+   * TBD.
+   * @param {Rectangle} b - TBD.
+   * @param {Rectangle} out - TBD.
+   * @returns {Rectangle} TBD.
+   */
   union(b, out) {
     return union(this, b, out);
   }
 
+  /**
+   * TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   random(output = null) {
     const result = output || new Point();
     result.x = this.randomX;
@@ -169,6 +284,12 @@ export class Rectangle {
     return result;
   }
 
+  /**
+   * TBD.
+   * @param {number} position - TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   getPoint(position, output = null) {
     const result = output || new Point();
     switch (position) {
@@ -195,6 +316,10 @@ export class Rectangle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   toString() {
     return (
       '[{Rectangle (x=' +
@@ -211,18 +336,33 @@ export class Rectangle {
     );
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get halfWidth() {
     return Math.round(this.width / 2);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get halfHeight() {
     return Math.round(this.height / 2);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get top() {
     return this.y;
   }
 
+  /**
+   * TBD.
+   */
   set top(value) {
     if (value >= this.bottom) {
       this.height = 0;
@@ -232,28 +372,49 @@ export class Rectangle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   get topLeft() {
     return new Point(this.x, this.y);
   }
 
+  /**
+   * TBD.
+   */
   set topLeft(value) {
     this.x = value.x;
     this.y = value.y;
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   get topRight() {
     return new Point(this.x + this.width, this.y);
   }
 
+  /**
+   * TBD.
+   */
   set topRight(value) {
     this.right = value.x;
     this.y = value.y;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get bottom() {
     return this.y + this.height;
   }
 
+  /**
+   * TBD.
+   */
   set bottom(value) {
     if (value <= this.y) {
       this.height = 0;
@@ -262,28 +423,49 @@ export class Rectangle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   get bottomLeft() {
     return new Point(this.x, this.bottom);
   }
 
+  /**
+   * TBD.
+   */
   set bottomLeft(value) {
     this.x = value.x;
     this.bottom = value.y;
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   get bottomRight() {
     return new Point(this.right, this.bottom);
   }
 
+  /**
+   * TBD.
+   */
   set bottomRight(value) {
     this.right = value.x;
     this.bottom = value.y;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get left() {
     return this.x;
   }
 
+  /**
+   * TBD.
+   */
   set left(value) {
     if (value >= this.right) {
       this.width = 0;
@@ -293,10 +475,17 @@ export class Rectangle {
     this.x = value;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get right() {
     return this.x + this.width;
   }
 
+  /**
+   * TBD.
+   */
   set right(value) {
     if (value <= this.x) {
       this.width = 0;
@@ -305,42 +494,79 @@ export class Rectangle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get volume() {
     return this.width * this.height;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get perimeter() {
     return this.width * 2 + this.height * 2;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get centerX() {
     return this.x + this.halfWidth;
   }
 
+  /**
+   * TBD.
+   */
   set centerX(value) {
     this.x = value - this.halfWidth;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get centerY() {
     return this.y + this.halfHeight;
   }
 
+  /**
+   * TBD.
+   */
   set centerY(value) {
     this.y = value - this.halfHeight;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get randomX() {
     return this.x + Math.random() * this.width;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get randomY() {
     return this.y + Math.random() * this.height;
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get empty() {
     return !this.width || !this.height;
   }
 
+  /**
+   * TBD.
+   */
   set empty(value) {
     if (value === true) {
       this.setTo(0, 0, 0, 0);

package/src/phaser/geom/rounded_rectangle.js

@@ -1,16 +1,9 @@
-/**
- * @module geom/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>
- */
 import { clone } from './util/rounded_rectangle';
 import { GEOM_ROUNDED_RECTANGLE } from '../core/const';
 
 export class RoundedRectangle {
   /**
    * TBD.
-   *
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {number} width - TBD.
@@ -26,6 +19,12 @@ export class RoundedRectangle {
     this.type = GEOM_ROUNDED_RECTANGLE;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {boolean} TBD.
+   */
   contains(x, y) {
     if (this.width <= 0 || this.height <= 0) {
       return false;
@@ -38,6 +37,10 @@ export class RoundedRectangle {
     return false;
   }
 
+  /**
+   * TBD.
+   * @returns {RoundedRectangle} TBD.
+   */
   clone() {
     return clone(this);
   }

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

@@ -1,16 +1,9 @@
-/**
- * @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>
- */
-import { Circle } from  '../circle';
+import { Circle } from '../circle';
 import { Point } from '../point';
 import { degToRad, distance } from '../../util/math';
 
 /**
  * TBD.
- *
  * @param {Circle} input - TBD.
  * @param {Circle} output - TBD.
  * @returns {Circle} TBD.
@@ -25,7 +18,6 @@ export function clone(input, output = null) {
 
 /**
  * TBD.
- *
  * @param {Circle} a - TBD.
  * @param {number} x - TBD.
  * @param {number} y - TBD.
@@ -42,7 +34,6 @@ export function contains(a, x, y) {
 
 /**
  * TBD.
- *
  * @param {Circle} a - TBD.
  * @param {Circle} b - TBD.
  * @returns {boolean} TBD.
@@ -53,7 +44,6 @@ export function equals(a, b) {
 
 /**
  * TBD.
- *
  * @param {Circle} a - TBD.
  * @param {Circle} b - TBD.
  * @returns {boolean} TBD.
@@ -64,12 +54,11 @@ export function intersects(a, b) {
 
 /**
  * TBD.
- *
  * @param {Circle} a - TBD.
  * @param {number} angle - TBD.
  * @param {boolean} asDegrees - TBD.
- * @param {Circle} output - TBD.
- * @returns {Circle} TBD.
+ * @param {Point} output - TBD.
+ * @returns {Point} TBD.
  */
 export function circumferencePoint(a, angle, asDegrees = false, output = null) {
   const result = output || new Point();
@@ -83,7 +72,6 @@ export function circumferencePoint(a, angle, asDegrees = false, output = null) {
 
 /**
  * TBD.
- *
  * @param {Circle} a - TBD.
  * @param {number} angle - TBD.
  * @param {boolean} asDegrees - TBD.
@@ -102,7 +90,6 @@ export function intersectsPoint(a, angle, asDegrees = false, output = null) {
 
 /**
  * TBD.
- *
  * @param {Circle} c - TBD.
  * @param {object} r - TBD.
  * @returns {boolean} TBD.

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

@@ -1,13 +1,5 @@
-/**
- * @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>
- */
-
 /**
  * TBD.
- *
  * @param {object} a - TBD.
  * @param {number} x - TBD.
  * @param {number} y - TBD.

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

@@ -1,16 +1,9 @@
-/**
- * @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>
- */
 import { Point } from '../point';
-import { Line } from  '../line';
+import { Line } from '../line';
 import { intersects as intersectsRect } from './rectangle';
 
 /**
  * TBD.
- *
  * @param {Line} input - TBD.
  * @param {Line} output - TBD.
  * @returns {Line} TBD.
@@ -26,14 +19,13 @@ 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 {Point} output - TBD.
- * @returns {boolean} TBD.
+ * @returns {Point} TBD.
  */
 export function intersectsPoints(a, b, e, f, asSegment = true, output = null) {
   const result = output || new Point();
@@ -63,12 +55,11 @@ 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 {Point} result - TBD.
+ * @returns {Point} TBD.
  */
 export function intersects(a, b, asSegment, result) {
   return intersectsPoints(a.start, a.end, b.start, b.end, asSegment, result);
@@ -76,7 +67,6 @@ export function intersects(a, b, asSegment, result) {
 
 /**
  * TBD.
- *
  * @param {object} line - TBD.
  * @param {object} rect - TBD.
  * @returns {boolean} TBD.
@@ -97,10 +87,7 @@ 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) {
@@ -134,7 +121,6 @@ export function intersectsRectangle(line, rect) {
 
 /**
  * TBD.
- *
  * @param {object} a - TBD.
  * @param {object} b - TBD.
  * @returns {number} TBD.