@vpmedia/phaser 1.14.0 → 1.16.0

package/src/phaser/geom/point.js

@@ -1,16 +1,9 @@
-/**
- * @module geom/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>
- */
 import { distance, rotate, clone } from './util/point';
 import { GEOM_POINT } from '../core/const';
 
 export class Point {
   /**
    * TBD.
-   *
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */
@@ -20,20 +13,41 @@ export class Point {
     this.type = GEOM_POINT;
   }
 
+  /**
+   * TBD.
+   * @param {Point} source - TBD.
+   * @returns {Point} TBD.
+   */
   copyFrom(source) {
     return this.setTo(source.x, source.y);
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   invert() {
     return this.setTo(this.y, this.x);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Point} TBD.
+   */
   setTo(x, y) {
     this.x = x || 0;
     this.y = y || (y !== 0 ? this.x : 0);
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Point} TBD.
+   */
   set(x, y) {
     // deprecated, use setTo(x, y)
     this.x = x || 0;
@@ -41,64 +55,131 @@ export class Point {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Point} TBD.
+   */
   add(x, y) {
     this.x += x;
     this.y += y;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Point} TBD.
+   */
   subtract(x, y) {
     this.x -= x;
     this.y -= y;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Point} TBD.
+   */
   multiply(x, y) {
     this.x *= x;
     this.y *= y;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Point} TBD.
+   */
   divide(x, y) {
     this.x /= x;
     this.y /= y;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} min - TBD.
+   * @param {number} max - TBD.
+   * @returns {Point} TBD.
+   */
   clampX(min, max) {
     this.x = Math.max(min, Math.min(max, this.x));
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} min - TBD.
+   * @param {number} max - TBD.
+   * @returns {Point} TBD.
+   */
   clampY(min, max) {
     this.y = Math.max(min, Math.min(max, this.y));
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} min - TBD.
+   * @param {number} max - TBD.
+   * @returns {Point} TBD.
+   */
   clamp(min, max) {
     this.x = Math.max(min, Math.min(max, this.x));
     this.y = Math.max(min, Math.min(max, this.y));
     return this;
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   clone() {
     return clone(this);
   }
 
+  /**
+   * TBD.
+   * @param {Point} dest - TBD.
+   * @returns {Point} TBD.
+   */
   copyTo(dest) {
     dest.x = this.x;
     dest.y = this.y;
     return dest;
   }
 
+  /**
+   * TBD.
+   * @param {Point} b - TBD.
+   * @returns {number} TBD.
+   */
   distance(b) {
     return distance(this, b);
   }
 
+  /**
+   * TBD.
+   * @param {Point} a - TBD.
+   * @returns {boolean} TBD.
+   */
   equals(a) {
     return a.x === this.x && a.y === this.y;
   }
 
+  /**
+   * TBD.
+   * @param {Point} a - TBD.
+   * @param {boolean} asDegrees - TBD.
+   * @returns {number} TBD.
+   */
   angle(a, asDegrees = false) {
     if (asDegrees) {
       return (180 / Math.PI) * Math.atan2(a.y - this.y, a.x - this.x);
@@ -106,22 +187,48 @@ export class Point {
     return Math.atan2(a.y - this.y, a.x - this.x);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} angle - TBD.
+   * @param {boolean} asDegrees - TBD.
+   * @param {number} dist - TBD.
+   * @returns {Point} TBD.
+   */
   rotate(x, y, angle, asDegrees, dist) {
     return rotate(this, x, y, angle, asDegrees, dist);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   getMagnitude() {
     return Math.sqrt(this.x * this.x + this.y * this.y);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   getMagnitudeSq() {
     return this.x * this.x + this.y * this.y;
   }
 
+  /**
+   * TBD.
+   * @param {number} magnitude - TBD.
+   * @returns {Point} TBD.
+   */
   setMagnitude(magnitude) {
     return this.normalize().multiply(magnitude, magnitude);
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   normalize() {
     if (!this.isZero()) {
       const m = this.getMagnitude();
@@ -131,38 +238,76 @@ export class Point {
     return this;
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   isZero() {
     return this.x === 0 && this.y === 0;
   }
 
+  /**
+   * TBD.
+   * @param {Point} a - TBD.
+   * @returns {number} TBD.
+   */
   dot(a) {
     return this.x * a.x + this.y * a.y;
   }
 
+  /**
+   * TBD.
+   * @param {Point} a - TBD.
+   * @returns {number} TBD.
+   */
   cross(a) {
     return this.x * a.y - this.y * a.x;
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   perp() {
     return this.setTo(-this.y, this.x);
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   rperp() {
     return this.setTo(this.y, -this.x);
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   normalRightHand() {
     return this.setTo(this.y * -1, this.x);
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   floor() {
     return this.setTo(Math.floor(this.x), Math.floor(this.y));
   }
 
+  /**
+   * TBD.
+   * @returns {Point} TBD.
+   */
   ceil() {
     return this.setTo(Math.ceil(this.x), Math.ceil(this.y));
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   toString() {
     return '[{Point (x=' + this.x + ' y=' + this.y + ')}]';
   }

package/src/phaser/geom/polygon.js

@@ -1,14 +1,12 @@
-/**
- * @module geom/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>
- */
 import { Point } from './point';
 import { clone } from './util/polygon';
 import { GEOM_POLYGON } from '../core/const';
 
 export class Polygon {
+  /**
+   * TBD.
+   * @param {object[]} points - TBD.
+   */
   constructor(points = null) {
     this.area = 0;
     this._points = [];
@@ -20,6 +18,11 @@ export class Polygon {
     }
   }
 
+  /**
+   * TBD.
+   * @param {number[]} output - TBD.
+   * @returns {number[]} TBD.
+   */
   toNumberArray(output = []) {
     for (let i = 0; i < this._points.length; i += 1) {
       if (typeof this._points[i] === 'number') {
@@ -34,16 +37,30 @@ export class Polygon {
     return output;
   }
 
+  /**
+   * TBD.
+   * @returns {Polygon} TBD.
+   */
   flatten() {
     this._points = this.toNumberArray();
     this.flattened = true;
     return this;
   }
 
+  /**
+   * TBD.
+   * @returns {Polygon} TBD.
+   */
   clone() {
     return clone(this);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {boolean} TBD.
+   */
   contains(x, y) {
     //  Adapted from http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html by Jonas Raoni Soares Silva
     let inside = false;
@@ -53,10 +70,7 @@ export class Polygon {
         const iy = this._points[i + 1];
         const jx = this._points[j];
         const jy = this._points[j + 1];
-        if (
-          ((iy <= y && y < jy) || (jy <= y && y < iy)) &&
-          x < ((jx - ix) * (y - iy)) / (jy - iy) + ix
-        ) {
+        if (((iy <= y && y < jy) || (jy <= y && y < iy)) && x < ((jx - ix) * (y - iy)) / (jy - iy) + ix) {
           inside = !inside;
         }
       }
@@ -66,10 +80,7 @@ export class Polygon {
         const iy = this._points[i].y;
         const jx = this._points[j].x;
         const jy = this._points[j].y;
-        if (
-          ((iy <= y && y < jy) || (jy <= y && y < iy)) &&
-          x < ((jx - ix) * (y - iy)) / (jy - iy) + ix
-        ) {
+        if (((iy <= y && y < jy) || (jy <= y && y < iy)) && x < ((jx - ix) * (y - iy)) / (jy - iy) + ix) {
           inside = !inside;
         }
       }
@@ -77,6 +88,11 @@ export class Polygon {
     return inside;
   }
 
+  /**
+   * TBD.
+   * @param {object[]} points - TBD.
+   * @returns {Polygon} TBD.
+   */
   setTo(points) {
     this.area = 0;
     this._points = [];
@@ -111,6 +127,11 @@ export class Polygon {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} y0 - TBD.
+   * @returns {number} TBD.
+   */
   calculateArea(y0) {
     let p1;
     let p2;
@@ -130,10 +151,17 @@ export class Polygon {
     return this.area;
   }
 
+  /**
+   * TBD.
+   * @returns {object[]} TBD.
+   */
   get points() {
     return this._points;
   }
 
+  /**
+   * TBD.
+   */
   set points(value) {
     if (value !== null) {
       this.setTo(value);