@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/display/webgl/texture.js

@@ -1,13 +1,9 @@
-/**
- * @module display/webgl/texture
- * @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>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
-import { Rectangle } from  '../../geom/rectangle';
+import { Rectangle } from '../../geom/rectangle';
 
 export class TextureUvs {
+  /**
+   * TBD.
+   */
   constructor() {
     this.x0 = 0;
     this.y0 = 0;
@@ -21,6 +17,13 @@ export class TextureUvs {
 }
 
 export class Texture {
+  /**
+   * TBD.
+   * @param baseTexture - TBD.
+   * @param frame - TBD.
+   * @param crop - TBD.
+   * @param trim - TBD.
+   */
   constructor(baseTexture, frame, crop, trim) {
     this.noFrame = false;
     if (!frame) {
@@ -49,6 +52,9 @@ export class Texture {
     }
   }
 
+  /**
+   * TBD.
+   */
   onBaseTextureLoaded() {
     if (this.noFrame) {
       this.frame = new Rectangle(0, 0, this.baseTexture.width, this.baseTexture.height);
@@ -56,6 +62,10 @@ export class Texture {
     this.setFrame(this.frame);
   }
 
+  /**
+   * TBD.
+   * @param destroyBase - TBD.
+   */
   destroy(destroyBase = false) {
     if (destroyBase) {
       this.baseTexture.destroy();
@@ -63,6 +73,10 @@ export class Texture {
     this.valid = false;
   }
 
+  /**
+   * TBD.
+   * @param frame - TBD.
+   */
   setFrame(frame) {
     this.noFrame = false;
     this.frame = frame;
@@ -74,23 +88,19 @@ export class Texture {
     this.crop.height = frame.height;
     if (
       !this.trim &&
-      (frame.x + frame.width > this.baseTexture.width ||
-        frame.y + frame.height > this.baseTexture.height)
+      (frame.x + frame.width > this.baseTexture.width || frame.y + frame.height > this.baseTexture.height)
     ) {
       // If `true` then `PIXI.Texture.setFrame` will no longer throw an error if the texture dimensions are incorrect.
       // Instead `Texture.valid` will be set to `false` (#1556)
       // TODO: make this configurable
       const isTextureSilentFail = true;
       if (!isTextureSilentFail) {
-        throw new Error(
-          'Texture Error: frame does not fit inside the base Texture dimensions ' + this
-        );
+        throw new Error('Texture Error: frame does not fit inside the base Texture dimensions ' + this);
       }
       this.valid = false;
       return;
     }
-    this.valid =
-      frame && frame.width && frame.height && this.baseTexture.source && this.baseTexture.hasLoaded;
+    this.valid = frame && frame.width && frame.height && this.baseTexture.source && this.baseTexture.hasLoaded;
     if (this.trim) {
       this.width = this.trim.width;
       this.height = this.trim.height;
@@ -102,6 +112,9 @@ export class Texture {
     }
   }
 
+  /**
+   * TBD.
+   */
   _updateUvs() {
     if (!this._uvs) {
       this._uvs = new TextureUvs();

package/src/phaser/display/webgl/texture_util.js

@@ -1,9 +1,3 @@
-/**
- * @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>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
 import { BaseTexture } from './base_texture';
 import { Texture } from './texture';
 

package/src/phaser/display/webgl/util.js

@@ -1,10 +1,3 @@
-/**
- * @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>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
-
 /**
  * TBD.
  */

package/src/phaser/geom/circle.js

@@ -1,11 +1,5 @@
-/**
- * @module geom/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 { Point } from './point';
-import { Rectangle } from  './rectangle';
+import { Rectangle } from './rectangle';
 import { distance } from '../util/math';
 import { clone, contains, circumferencePoint } from './util/circle';
 import { GEOM_CIRCLE } from '../core/const';
@@ -28,10 +22,19 @@ export class Circle {
     this.type = GEOM_CIRCLE;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   circumference() {
     return 2 * (Math.PI * this._radius);
   }
 
+  /**
+   * TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   random(output = null) {
     const result = output || new Point();
     const t = 2 * Math.PI * Math.random();
@@ -44,10 +47,21 @@ export class Circle {
     return result;
   }
 
+  /**
+   * TBD.
+   * @returns {Rectangle} TBD.
+   */
   getBounds() {
     return new Rectangle(this.x - this.radius, this.y - this.radius, this.diameter, this.diameter);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} diameter - TBD.
+   * @returns {Circle} TBD.
+   */
   setTo(x, y, diameter) {
     this.x = x;
     this.y = y;
@@ -56,10 +70,20 @@ export class Circle {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {Circle} source - TBD.
+   * @returns {Circle} TBD.
+   */
   copyFrom(source) {
     return this.setTo(source.x, source.y, source.diameter);
   }
 
+  /**
+   * TBD.
+   * @param {Circle} dest - TBD.
+   * @returns {Circle} TBD.
+   */
   copyTo(dest) {
     dest.x = this.x;
     dest.y = this.y;
@@ -67,51 +91,86 @@ export class Circle {
     return dest;
   }
 
+  /**
+   * TBD.
+   * @param {Circle} dest - TBD.
+   * @param {boolean} round - TBD.
+   * @returns {number} TBD.
+   */
   distance(dest, round = false) {
     const d = distance(this.x, this.y, dest.x, dest.y);
     return round ? Math.round(d) : d;
   }
 
+  /**
+   * TBD.
+   * @returns {Circle} TBD.
+   */
   clone() {
     return clone(this);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {boolean} TBD.
+   */
   contains(x, y) {
     return contains(this, x, y);
   }
 
+  /**
+   * TBD.
+   * @param {number} angle - TBD.
+   * @param {boolean} asDegrees - TBD.
+   * @param {Point} out - TBD.
+   * @returns {Point} TBD.
+   */
   circumferencePoint(angle, asDegrees, out) {
     return circumferencePoint(this, angle, asDegrees, out);
   }
 
+  /**
+   * TBD.
+   * @param {number} dx - TBD.
+   * @param {number} dy - TBD.
+   * @returns {Circle} TBD.
+   */
   offset(dx, dy) {
     this.x += dx;
     this.y += dy;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {Point} point - TBD.
+   * @returns {Circle} TBD.
+   */
   offsetPoint(point) {
     return this.offset(point.x, point.y);
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   toString() {
-    return (
-      '[{Circle (x=' +
-      this.x +
-      ' y=' +
-      this.y +
-      ' diameter=' +
-      this.diameter +
-      ' radius=' +
-      this.radius +
-      ')}]'
-    );
+    return '[{Circle (x=' + this.x + ' y=' + this.y + ' diameter=' + this.diameter + ' radius=' + this.radius + ')}]';
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get diameter() {
     return this._diameter;
   }
 
+  /**
+   * TBD.
+   */
   set diameter(value) {
     if (value > 0) {
       this._diameter = value;
@@ -119,10 +178,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get radius() {
     return this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set radius(value) {
     if (value > 0) {
       this._radius = value;
@@ -130,10 +196,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get left() {
     return this.x - this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set left(value) {
     if (value > this.x) {
       this._radius = 0;
@@ -143,10 +216,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get right() {
     return this.x + this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set right(value) {
     if (value < this.x) {
       this._radius = 0;
@@ -156,10 +236,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get top() {
     return this.y - this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set top(value) {
     if (value > this.y) {
       this._radius = 0;
@@ -169,10 +256,17 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get bottom() {
     return this.y + this._radius;
   }
 
+  /**
+   * TBD.
+   */
   set bottom(value) {
     if (value < this.y) {
       this._radius = 0;
@@ -182,6 +276,10 @@ export class Circle {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get area() {
     if (this._radius > 0) {
       return Math.PI * this._radius * this._radius;
@@ -189,10 +287,17 @@ export class Circle {
     return 0;
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get empty() {
     return this._diameter === 0;
   }
 
+  /**
+   * TBD.
+   */
   set empty(value) {
     if (value === true) {
       this.setTo(0, 0, 0);

package/src/phaser/geom/ellipse.js

@@ -1,11 +1,5 @@
-/**
- * @module geom/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>
- */
 import { Point } from './point';
-import { Rectangle } from  './rectangle';
+import { Rectangle } from './rectangle';
 import { contains } from './util/ellipse';
 import { GEOM_ELLIPSE } from '../core/const';
 
@@ -25,6 +19,14 @@ export class Ellipse {
     this.type = GEOM_ELLIPSE;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   * @returns {Ellipse} TBD.
+   */
   setTo(x, y, width, height) {
     this.x = x;
     this.y = y;
@@ -33,14 +35,28 @@ export class Ellipse {
     return this;
   }
 
+  /**
+   * TBD.
+   * @returns {Rectangle} TBD.
+   */
   getBounds() {
     return new Rectangle(this.x - this.width, this.y - this.height, this.width, this.height);
   }
 
+  /**
+   * TBD.
+   * @param {Ellipse} source - TBD.
+   * @returns {Ellipse} TBD.
+   */
   copyFrom(source) {
     return this.setTo(source.x, source.y, source.width, source.height);
   }
 
+  /**
+   * TBD.
+   * @param {Ellipse} dest - TBD.
+   * @returns {Ellipse} TBD.
+   */
   copyTo(dest) {
     dest.x = this.x;
     dest.y = this.y;
@@ -49,10 +65,21 @@ export class Ellipse {
     return dest;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @returns {boolean} TBD.
+   */
   contains(x, y) {
     return contains(this, x, y);
   }
 
+  /**
+   * TBD.
+   * @param {Point} output - TBD.
+   * @returns {Point} TBD.
+   */
   random(output = null) {
     const result = output || new Point();
     const p = Math.random() * Math.PI * 2;
@@ -64,17 +91,11 @@ export class Ellipse {
     return result;
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   toString() {
-    return (
-      '[{Ellipse (x=' +
-      this.x +
-      ' y=' +
-      this.y +
-      ' width=' +
-      this.width +
-      ' height=' +
-      this.height +
-      ')}]'
-    );
+    return '[{Ellipse (x=' + this.x + ' y=' + this.y + ' width=' + this.width + ' height=' + this.height + ')}]';
   }
 }