@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/geom/line.js

@@ -1,9 +1,3 @@
-/**
- * @module geom/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 { clone, intersectsPoints, reflect } from './util/line';
 import { wrap } from '../util/math';
@@ -23,30 +17,54 @@ export class Line {
     this.type = GEOM_LINE;
   }
 
+  /**
+   * TBD.
+   * @param {number} x1 - TBD.
+   * @param {number} y1 - TBD.
+   * @param {number} x2 - TBD.
+   * @param {number} y2 - TBD.
+   * @returns {Line} TBD.
+   */
   setTo(x1, y1, x2, y2) {
     this.start.setTo(x1, y1);
     this.end.setTo(x2, y2);
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {object} startSprite - TBD.
+   * @param {object} endSprite - TBD.
+   * @param {boolean} useCenter - TBD.
+   * @returns {Line} TBD.
+   */
   fromSprite(startSprite, endSprite, useCenter = false) {
     if (useCenter) {
-      return this.setTo(
-        startSprite.center.x,
-        startSprite.center.y,
-        endSprite.center.x,
-        endSprite.center.y
-      );
+      return this.setTo(startSprite.center.x, startSprite.center.y, endSprite.center.x, endSprite.center.y);
     }
     return this.setTo(startSprite.x, startSprite.y, endSprite.x, endSprite.y);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} angle - TBD.
+   * @param {number} length - TBD.
+   * @returns {Line} TBD.
+   */
   fromAngle(x, y, angle, length) {
     this.start.setTo(x, y);
     this.end.setTo(x + Math.cos(angle) * length, y + Math.sin(angle) * length);
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} angle - TBD.
+   * @param {boolean} asDegrees - TBD.
+   * @returns {Line} TBD.
+   */
   rotate(angle, asDegrees = false) {
     const cx = (this.start.x + this.end.x) / 2;
     const cy = (this.start.y + this.end.y) / 2;
@@ -55,20 +73,45 @@ export class Line {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} angle - TBD.
+   * @param {boolean} asDegrees - TBD.
+   * @returns {Line} TBD.
+   */
   rotateAround(x, y, angle, asDegrees = false) {
     this.start.rotate(x, y, angle, asDegrees);
     this.end.rotate(x, y, angle, asDegrees);
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {Line} line - TBD.
+   * @param {boolean} asSegment - TBD.
+   * @param {Point} result - TBD.
+   * @returns {Point} TBD.
+   */
   intersects(line, asSegment, result) {
     return intersectsPoints(this.start, this.end, line.start, line.end, asSegment, result);
   }
 
+  /**
+   * TBD.
+   * @param {Line} line - TBD.
+   * @returns {number} TBD.
+   */
   reflect(line) {
     return reflect(this, line);
   }
 
+  /**
+   * TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   midPoint(output = null) {
     const result = output || new Point();
     result.x = (this.start.x + this.end.x) / 2;
@@ -76,6 +119,11 @@ export class Line {
     return result;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   */
   centerOn(x, y) {
     const cx = (this.start.x + this.end.x) / 2;
     const cy = (this.start.y + this.end.y) / 2;
@@ -85,13 +133,22 @@ export class Line {
     this.end.add(tx, ty);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {boolean} TBD.
+   */
   pointOnLine(x, y) {
-    return (
-      (x - this.start.x) * (this.end.y - this.start.y) ===
-      (this.end.x - this.start.x) * (y - this.start.y)
-    );
+    return (x - this.start.x) * (this.end.y - this.start.y) === (this.end.x - this.start.x) * (y - this.start.y);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {boolean} TBD.
+   */
   pointOnSegment(x, y) {
     const xMin = Math.min(this.start.x, this.end.x);
     const xMax = Math.max(this.start.x, this.end.x);
@@ -100,6 +157,11 @@ export class Line {
     return this.pointOnLine(x, y) && x >= xMin && x <= xMax && y >= yMin && y <= yMax;
   }
 
+  /**
+   * TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   random(output = null) {
     const result = output || new Point();
     const t = Math.random();
@@ -108,6 +170,12 @@ export class Line {
     return result;
   }
 
+  /**
+   * TBD.
+   * @param {number} stepRate - TBD.
+   * @param {number[][]} results - TBD.
+   * @returns {number[][]} TBD.
+   */
   coordinatesOnLine(stepRate = 1, results = []) {
     let x1 = Math.round(this.start.x);
     let y1 = Math.round(this.start.y);
@@ -138,10 +206,18 @@ export class Line {
     return results;
   }
 
+  /**
+   * TBD.
+   * @returns {Line} TBD.
+   */
   clone() {
     return clone(this);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get length() {
     return Math.sqrt(
       (this.end.x - this.start.x) * (this.end.x - this.start.x) +
@@ -149,58 +225,114 @@ export class Line {
     );
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get angle() {
     return Math.atan2(this.end.y - this.start.y, this.end.x - this.start.x);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get slope() {
     return (this.end.y - this.start.y) / (this.end.x - this.start.x);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get perpSlope() {
     return -((this.end.x - this.start.x) / (this.end.y - this.start.y));
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get x() {
     return Math.min(this.start.x, this.end.x);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get y() {
     return Math.min(this.start.y, this.end.y);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get left() {
     return Math.min(this.start.x, this.end.x);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get right() {
     return Math.max(this.start.x, this.end.x);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get top() {
     return Math.min(this.start.y, this.end.y);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get bottom() {
     return Math.max(this.start.y, this.end.y);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get width() {
     return Math.abs(this.start.x - this.end.x);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get height() {
     return Math.abs(this.start.y - this.end.y);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get normalX() {
     return Math.cos(this.angle - 1.5707963267948966);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get normalY() {
     return Math.sin(this.angle - 1.5707963267948966);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get normalAngle() {
     return wrap(this.angle - 1.5707963267948966, -Math.PI, Math.PI);
   }

package/src/phaser/geom/matrix.js

@@ -1,9 +1,3 @@
-/**
- * @module geom/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>
- */
 import { Point } from './point';
 import { clone } from './util/matrix';
 import { GEOM_MATRIX } from '../core/const';
@@ -28,10 +22,25 @@ export class Matrix {
     this.type = GEOM_MATRIX;
   }
 
+  /**
+   * TBD.
+   * @param {number[]} array - TBD.
+   * @returns {Matrix} TBD.
+   */
   fromArray(array) {
     return this.setTo(array[0], array[1], array[3], array[4], array[2], array[5]);
   }
 
+  /**
+   * TBD.
+   * @param {number} a - TBD.
+   * @param {number} b - TBD.
+   * @param {number} c - TBD.
+   * @param {number} d - TBD.
+   * @param {number} tx - TBD.
+   * @param {number} ty - TBD.
+   * @returns {Matrix} TBD.
+   */
   setTo(a, b, c, d, tx, ty) {
     this.a = a;
     this.b = b;
@@ -42,15 +51,29 @@ export class Matrix {
     return this;
   }
 
+  /**
+   * TBD.
+   * @returns {Matrix} TBD.
+   */
   clone() {
     return clone(this);
   }
 
+  /**
+   * TBD.
+   * @param {Matrix} matrix - TBD.
+   * @returns {Matrix} TBD.
+   */
   copyTo(matrix) {
     matrix.copyFrom(this);
     return matrix;
   }
 
+  /**
+   * TBD.
+   * @param {Matrix} matrix - TBD.
+   * @returns {Matrix} TBD.
+   */
   copyFrom(matrix) {
     this.a = matrix.a;
     this.b = matrix.b;
@@ -61,6 +84,12 @@ export class Matrix {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {boolean} transpose - TBD.
+   * @param {Float32Array} output - TBD.
+   * @returns {Float32Array} TBD.
+   */
   toArray(transpose = false, output = null) {
     const result = output || new Float32Array(9);
     if (transpose) {
@@ -87,6 +116,12 @@ export class Matrix {
     return result;
   }
 
+  /**
+   * TBD.
+   * @param {Point} pos - TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   apply(pos, output = null) {
     const result = output || new Point();
     result.x = this.a * pos.x + this.c * pos.y + this.tx;
@@ -94,6 +129,12 @@ export class Matrix {
     return result;
   }
 
+  /**
+   * TBD.
+   * @param {Point} pos - TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   applyInverse(pos, output = null) {
     const result = output || new Point();
     const id = 1 / (this.a * this.d + this.c * -this.b);
@@ -104,12 +145,24 @@ export class Matrix {
     return result;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Matrix} TBD.
+   */
   translate(x, y) {
     this.tx += x;
     this.ty += y;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {Matrix} TBD.
+   */
   scale(x, y) {
     this.a *= x;
     this.d *= y;
@@ -120,6 +173,11 @@ export class Matrix {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} angle - TBD.
+   * @returns {Matrix} TBD.
+   */
   rotate(angle) {
     const cos = Math.cos(angle);
     const sin = Math.sin(angle);
@@ -135,6 +193,11 @@ export class Matrix {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {Matrix} matrix - TBD.
+   * @returns {Matrix} TBD.
+   */
   append(matrix) {
     const a1 = this.a;
     const b1 = this.b;
@@ -149,6 +212,10 @@ export class Matrix {
     return this;
   }
 
+  /**
+   * TBD.
+   * @returns {Matrix} TBD.
+   */
   identity() {
     return this.setTo(1, 0, 0, 1, 0, 0);
   }