@vpmedia/phaser 1.0.2 → 1.0.4

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

@@ -9,8 +9,9 @@ import { degToRad, distance } from '../../util/math';
 
 /**
  *
- * @param input
- * @param output
+ * @param {object} input TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function clone(input, output = null) {
   const result = output || new Circle();
@@ -22,9 +23,10 @@ export function clone(input, output = null) {
 
 /**
  *
- * @param a
- * @param x
- * @param y
+ * @param {object} 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) {
@@ -37,8 +39,9 @@ export function contains(a, x, y) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function equals(a, b) {
   return (a.x === b.x && a.y === b.y && a.diameter === b.diameter);
@@ -46,8 +49,9 @@ export function equals(a, b) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function intersects(a, b) {
   return distance(a.x, a.y, b.x, b.y) <= (a.radius + b.radius);
@@ -55,10 +59,11 @@ export function intersects(a, b) {
 
 /**
  *
- * @param a
- * @param angle
- * @param asDegrees
- * @param output
+ * @param {object} a TBD
+ * @param {number} angle TBD
+ * @param {boolean} asDegrees TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function circumferencePoint(a, angle, asDegrees = false, output = null) {
   const result = output || new Point();
@@ -72,10 +77,11 @@ export function circumferencePoint(a, angle, asDegrees = false, output = null) {
 
 /**
  *
- * @param a
- * @param angle
- * @param asDegrees
- * @param output
+ * @param {object} a TBD
+ * @param {number} angle TBD
+ * @param {boolean} asDegrees TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function intersectsPoint(a, angle, asDegrees = false, output = null) {
   const result = output || new Point();
@@ -89,8 +95,9 @@ export function intersectsPoint(a, angle, asDegrees = false, output = null) {
 
 /**
  *
- * @param c
- * @param r
+ * @param {object} 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

@@ -5,7 +5,10 @@
  */
 
 /**
+ * TBD
  *
+ * @deprecated
+ * @returns {boolean} TBD
  */
 export default function () {
   return true;
@@ -13,9 +16,10 @@ export default function () {
 
 /**
  *
- * @param a
- * @param x
- * @param y
+ * @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

@@ -9,8 +9,9 @@ import { intersects as intersectsRect } from './rectangle';
 
 /**
  *
- * @param input
- * @param output
+ * @param {object} input TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function clone(input, output = null) {
   const result = output || new Line();
@@ -23,12 +24,13 @@ export function clone(input, output = null) {
 
 /**
  *
- * @param a
- * @param b
- * @param e
- * @param f
- * @param asSegment
- * @param output
+ * @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
  */
 export function intersectsPoints(a, b, e, f, asSegment = true, output = null) {
   const result = output || new Point();
@@ -58,10 +60,11 @@ export function intersectsPoints(a, b, e, f, asSegment = true, output = null) {
 
 /**
  *
- * @param a
- * @param b
- * @param asSegment
- * @param result
+ * @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);
@@ -69,8 +72,9 @@ export function intersects(a, b, asSegment, result) {
 
 /**
  *
- * @param line
- * @param rect
+ * @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
@@ -122,8 +126,9 @@ export function intersectsRectangle(line, rect) {
 
 /**
  *
- * @param a
- * @param b
+ * @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

@@ -7,8 +7,9 @@ import Matrix from '../matrix';
 
 /**
  *
- * @param input
- * @param output
+ * @param {object} input TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function clone(input, output = null) {
   const result = output || new Matrix();
@@ -22,7 +23,9 @@ export function clone(input, output = null) {
 }
 
 /**
+ * TBD
  *
+ * @returns {object} TBD
  */
 export function getIdentityMatrix() {
   if (!window.PhaserRegistry) {
@@ -35,7 +38,9 @@ export function getIdentityMatrix() {
 }
 
 /**
+ * TBD
  *
+ * @returns {object} TBD
  */
 export function getTempMatrix() {
   if (!window.PhaserRegistry) {

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

@@ -7,9 +7,10 @@ import Point from '../point';
 
 /**
  *
- * @param a
- * @param b
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function add(a, b, output = null) {
   const result = output || new Point();
@@ -20,9 +21,10 @@ export function add(a, b, output = null) {
 
 /**
  *
- * @param a
- * @param b
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function subtract(a, b, output = null) {
   const result = output || new Point();
@@ -33,9 +35,10 @@ export function subtract(a, b, output = null) {
 
 /**
  *
- * @param a
- * @param b
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function multiply(a, b, output = null) {
   const result = output || new Point();
@@ -46,9 +49,10 @@ export function multiply(a, b, output = null) {
 
 /**
  *
- * @param a
- * @param b
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function divide(a, b, output = null) {
   const result = output || new Point();
@@ -59,8 +63,9 @@ export function divide(a, b, output = null) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {boolean} TBD
  */
 export function equals(a, b) {
   return (a.x === b.x && a.y === b.y);
@@ -68,8 +73,9 @@ export function equals(a, b) {
 
 /**
  *
- * @param a
- * @param b
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @returns {number} TBD
  */
 export function angle(a, b) {
   return Math.atan2(a.y - b.y, a.x - b.x);
@@ -77,8 +83,9 @@ export function angle(a, b) {
 
 /**
  *
- * @param a
- * @param output
+ * @param {object} a TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function negative(a, output = null) {
   const result = output || new Point();
@@ -87,10 +94,11 @@ export function negative(a, output = null) {
 
 /**
  *
- * @param a
- * @param b
- * @param s
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {number} s TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function multiplyAdd(a, b, s, output = null) {
   const result = output || new Point();
@@ -99,10 +107,11 @@ export function multiplyAdd(a, b, s, output = null) {
 
 /**
  *
- * @param a
- * @param b
- * @param f
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {number} f TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function interpolate(a, b, f, output = null) {
   const result = output || new Point();
@@ -111,8 +120,9 @@ export function interpolate(a, b, f, output = null) {
 
 /**
  *
- * @param a
- * @param output
+ * @param {object} a TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function perp(a, output = null) {
   const result = output || new Point();
@@ -121,8 +131,9 @@ export function perp(a, output = null) {
 
 /**
  *
- * @param a
- * @param output
+ * @param {object} a TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function rperp(a, output = null) {
   const result = output || new Point();
@@ -131,9 +142,10 @@ export function rperp(a, output = null) {
 
 /**
  *
- * @param a
- * @param b
- * @param round
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {boolean} round TBD
+ * @returns {number} TBD
  */
 export function distance(a, b, round = false) {
   const dx = a.x - b.x;
@@ -144,9 +156,10 @@ export function distance(a, b, round = false) {
 
 /**
  *
- * @param a
- * @param b
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function project(a, b, output = null) {
   const result = output || new Point();
@@ -159,9 +172,10 @@ export function project(a, b, output = null) {
 
 /**
  *
- * @param a
- * @param b
- * @param output
+ * @param {object} a TBD
+ * @param {object} b TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function projectUnit(a, b, output = null) {
   const result = output || new Point();
@@ -174,8 +188,9 @@ export function projectUnit(a, b, output = null) {
 
 /**
  *
- * @param a
- * @param output
+ * @param {object} a TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function normalRightHand(a, output = null) {
   const result = output || new Point();
@@ -184,8 +199,9 @@ export function normalRightHand(a, output = null) {
 
 /**
  *
- * @param a
- * @param output
+ * @param {object} a TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function normalize(a, output = null) {
   const result = output || new Point();
@@ -198,12 +214,13 @@ export function normalize(a, output = null) {
 
 /**
  *
- * @param a
- * @param x
- * @param y
- * @param ang
- * @param asDegrees
- * @param dist
+ * @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
  */
 export function rotate(a, x, y, ang, asDegrees, dist) {
   if (asDegrees) {
@@ -227,8 +244,9 @@ export function rotate(a, x, y, ang, asDegrees, dist) {
 
 /**
  *
- * @param points
- * @param output
+ * @param {object[]} points TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function centroid(points, output = null) {
   const result = output || new Point();
@@ -249,9 +267,10 @@ export function centroid(points, output = null) {
 
 /**
  *
- * @param obj
- * @param xProp
- * @param yProp
+ * @param {object} obj TBD
+ * @param {string} xProp TBD
+ * @param {string} yProp TBD
+ * @returns {object} TBD
  */
 export function parse(obj, xProp = 'x', yProp = 'y') {
   const point = new Point();
@@ -266,8 +285,9 @@ export function parse(obj, xProp = 'x', yProp = 'y') {
 
 /**
  *
- * @param input
- * @param output
+ * @param {object} input TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function clone(input, output = null) {
   const result = output || new Point();

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

@@ -6,7 +6,10 @@
 import Polygon from '../polygon';
 
 /**
+ * TBD
  *
+ * @deprecated
+ * @returns {boolean} TBD
  */
 export default function () {
   return true;
@@ -14,8 +17,9 @@ export default function () {
 
 /**
  *
- * @param input
- * @param output
+ * @param {object} input TBD
+ * @param {object} output TBD
+ * @returns {object} TBD
  */
 export function clone(input, output = null) {
   const result = output || new Polygon();