@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/display/graphics.js

@@ -1,27 +1,18 @@
-/**
- * @module display/graphics
- * @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 { DisplayObject } from  './display_object';
+import { DisplayObject } from './display_object';
 import { Image } from './image';
-import { Game } from  '../core/game';
-import { Rectangle } from  '../geom/rectangle';
-import { RoundedRectangle } from  '../geom/rounded_rectangle';
-import { Polygon } from  '../geom/polygon';
-import { Circle } from  '../geom/circle';
-import { Ellipse } from  '../geom/ellipse';
+import { Game } from '../core/game';
+import { Rectangle } from '../geom/rectangle';
+import { RoundedRectangle } from '../geom/rounded_rectangle';
+import { Polygon } from '../geom/polygon';
+import { Circle } from '../geom/circle';
+import { Ellipse } from '../geom/ellipse';
 import { Point } from '../geom/point';
-import { GraphicsData } from  './graphics_data';
+import { GraphicsData } from './graphics_data';
 import { CanvasBuffer } from './canvas/buffer';
 import { textureFromCanvas } from './webgl/texture_util';
 import { renderGraphics as renderCanvasGraphics } from './canvas/graphics';
 import { renderGraphics as renderWebGLGraphics } from './webgl/graphics';
-import {
-  renderCanvas as renderSpriteCanvas,
-  renderWebGL as renderSpriteWebGL,
-} from './sprite_util';
+import { renderCanvas as renderSpriteCanvas, renderWebGL as renderSpriteWebGL } from './sprite_util';
 import { getEmptyRectangle } from '../geom/util/rectangle';
 import { getIdentityMatrix } from '../geom/util/matrix';
 import {
@@ -64,12 +55,21 @@ export class Graphics extends DisplayObject {
     this.cachedSpriteDirty = false;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     // TODO
     this.clear();
     super.destroy();
   }
 
+  /**
+   * TBD.
+   * @param lineWidth - TBD.
+   * @param color - TBD.
+   * @param alpha - TBD.
+   */
   lineStyle(lineWidth = 0, color = 0, alpha = 1) {
     this.lineWidth = lineWidth || 0;
     this.lineColor = color || 0;
@@ -88,11 +88,21 @@ export class Graphics extends DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   */
   moveTo(x, y) {
     this.drawShape(new Polygon([x, y]));
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   */
   lineTo(x, y) {
     if (!this.currentPath) {
       this.moveTo(0, 0);
@@ -103,6 +113,13 @@ export class Graphics extends DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param cpX - TBD.
+   * @param cpY - TBD.
+   * @param toX - TBD.
+   * @param toY - TBD.
+   */
   quadraticCurveTo(cpX, cpY, toX, toY) {
     if (this.currentPath) {
       if (this.currentPath.shape.points.length === 0) {
@@ -132,6 +149,15 @@ export class Graphics extends DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param cpX - TBD.
+   * @param cpY - TBD.
+   * @param cpX2 - TBD.
+   * @param cpY2 - TBD.
+   * @param toX - TBD.
+   * @param toY - TBD.
+   */
   bezierCurveTo(cpX, cpY, cpX2, cpY2, toX, toY) {
     if (this.currentPath) {
       if (this.currentPath.shape.points.length === 0) {
@@ -167,6 +193,14 @@ export class Graphics extends DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param x1 - TBD.
+   * @param y1 - TBD.
+   * @param x2 - TBD.
+   * @param y2 - TBD.
+   * @param radius - TBD.
+   */
   arcTo(x1, y1, x2, y2, radius) {
     if (this.currentPath) {
       if (this.currentPath.shape.points.length === 0) {
@@ -210,6 +244,16 @@ export class Graphics extends DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param cx - TBD.
+   * @param cy - TBD.
+   * @param radius - TBD.
+   * @param startAngle - TBD.
+   * @param endAngle - TBD.
+   * @param anticlockwise - TBD.
+   * @param segments - TBD.
+   */
   arc(cx, cy, radius, startAngle, endAngle, anticlockwise = false, segments = 40) {
     //  If we do this we can never draw a full circle
     if (startAngle === endAngle) {
@@ -246,16 +290,18 @@ export class Graphics extends DisplayObject {
       const angle = theta + startAngle + theta2 * real;
       const c = Math.cos(angle);
       const s = -Math.sin(angle);
-      points.push(
-        (cTheta * c + sTheta * s) * radius + cx,
-        (cTheta * -s + sTheta * c) * radius + cy
-      );
+      points.push((cTheta * c + sTheta * s) * radius + cx, (cTheta * -s + sTheta * c) * radius + cy);
     }
     this.dirty = true;
     this._boundsDirty = true;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param color - TBD.
+   * @param alpha - TBD.
+   */
   beginFill(color = 0, alpha = 1) {
     this.filling = true;
     this.fillColor = color || 0;
@@ -270,6 +316,9 @@ export class Graphics extends DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   */
   endFill() {
     this.filling = false;
     this.fillColor = null;
@@ -277,26 +326,58 @@ export class Graphics extends DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   drawRect(x, y, width, height) {
     this.drawShape(new Rectangle(x, y, width, height));
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   * @param radius - TBD.
+   */
   drawRoundedRect(x, y, width, height, radius) {
     this.drawShape(new RoundedRectangle(x, y, width, height, radius));
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param diameter - TBD.
+   */
   drawCircle(x, y, diameter) {
     this.drawShape(new Circle(x, y, diameter));
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   drawEllipse(x, y, width, height) {
     this.drawShape(new Ellipse(x, y, width, height));
     return this;
   }
 
+  /**
+   * TBD.
+   * @param path - TBD.
+   */
   drawPolygon(path) {
     let points;
     if (path instanceof Polygon) {
@@ -317,6 +398,9 @@ export class Graphics extends DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   */
   clear() {
     this.lineWidth = 0;
     this.filling = false;
@@ -328,11 +412,18 @@ export class Graphics extends DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   */
   generateTexture() {
     // TODO
     console.warn('graphics.generateTexture() is not implemented');
   }
 
+  /**
+   * TBD.
+   * @param renderSession - TBD.
+   */
   renderWebGL(renderSession) {
     // if the sprite is not visible or the alpha is 0 then no need to render this element
     if (this.visible === false || this.alpha === 0 || this.isMask === true) {
@@ -360,8 +451,7 @@ export class Graphics extends DisplayObject {
       // check blend mode
       if (this.blendMode !== renderSession.spriteBatch.currentBlendMode) {
         renderSession.spriteBatch.currentBlendMode = this.blendMode;
-        const blendModeWebGL =
-          window.PhaserRegistry.blendModesWebGL[renderSession.spriteBatch.currentBlendMode];
+        const blendModeWebGL = window.PhaserRegistry.blendModesWebGL[renderSession.spriteBatch.currentBlendMode];
         renderSession.spriteBatch.gl.blendFunc(blendModeWebGL[0], blendModeWebGL[1]);
       }
       // check if the webgl graphic needs to be updated
@@ -390,6 +480,10 @@ export class Graphics extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param renderSession - TBD.
+   */
   renderCanvas(renderSession) {
     // if the sprite is not visible or the alpha is 0 then no need to render this element
     if (this.visible === false || this.alpha === 0 || this.isMask === true) {
@@ -415,8 +509,7 @@ export class Graphics extends DisplayObject {
       const transform = this.worldTransform;
       if (this.blendMode !== renderSession.currentBlendMode) {
         renderSession.currentBlendMode = this.blendMode;
-        context.globalCompositeOperation =
-          window.PhaserRegistry.blendModesCanvas[renderSession.currentBlendMode];
+        context.globalCompositeOperation = window.PhaserRegistry.blendModesCanvas[renderSession.currentBlendMode];
       }
       if (this._mask) {
         renderSession.maskManager.pushMask(this._mask, renderSession);
@@ -443,6 +536,10 @@ export class Graphics extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param matrix - TBD.
+   */
   getBounds(matrix = null) {
     if (!this.renderable) {
       return getEmptyRectangle();
@@ -499,6 +596,9 @@ export class Graphics extends DisplayObject {
     return this.currentBounds;
   }
 
+  /**
+   * TBD.
+   */
   getLocalBounds() {
     const matrixCache = this.worldTransform;
     this.worldTransform = getIdentityMatrix();
@@ -513,6 +613,11 @@ export class Graphics extends DisplayObject {
     return bounds;
   }
 
+  /**
+   * TBD.
+   * @param point - TBD.
+   * @param tempPoint - TBD.
+   */
   containsPoint(point, tempPoint) {
     this.worldTransform.applyInverse(point, tempPoint);
     const graphicsData = this.graphicsData;
@@ -527,6 +632,9 @@ export class Graphics extends DisplayObject {
     return false;
   }
 
+  /**
+   * TBD.
+   */
   updateLocalBounds() {
     let minX = Infinity;
     let maxX = -Infinity;
@@ -605,6 +713,9 @@ export class Graphics extends DisplayObject {
     this._localBounds.height = maxY - minY + padding * 2;
   }
 
+  /**
+   * TBD.
+   */
   generateCachedSprite() {
     const bounds = this.getLocalBounds();
     if (!this._cachedSprite) {
@@ -628,6 +739,9 @@ export class Graphics extends DisplayObject {
     this._cachedSprite.alpha = this.alpha;
   }
 
+  /**
+   * TBD.
+   */
   updateCachedSpriteTexture() {
     const cachedSprite = this._cachedSprite;
     const texture = cachedSprite.texture;
@@ -644,6 +758,9 @@ export class Graphics extends DisplayObject {
     texture.baseTexture.dirty();
   }
 
+  /**
+   * TBD.
+   */
   destroyCachedSprite() {
     if (!this._cachedSprite) {
       return;
@@ -652,6 +769,10 @@ export class Graphics extends DisplayObject {
     this._cachedSprite = null;
   }
 
+  /**
+   * TBD.
+   * @param shape - TBD.
+   */
   drawShape(shape) {
     if (this.currentPath) {
       // check current path!
@@ -684,6 +805,9 @@ export class Graphics extends DisplayObject {
     return data;
   }
 
+  /**
+   * TBD.
+   */
   postUpdate() {
     if (this._boundsDirty) {
       this.updateLocalBounds();
@@ -694,6 +818,11 @@ export class Graphics extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param points - TBD.
+   * @param cull - TBD.
+   */
   drawTriangle(points, cull = false) {
     const triangle = new Polygon(points);
     if (cull) {
@@ -709,6 +838,12 @@ export class Graphics extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param vertices - TBD.
+   * @param indices - TBD.
+   * @param cull - TBD.
+   */
   drawTriangles(vertices, indices, cull = false) {
     const point1 = new Point();
     const point2 = new Point();

package/src/phaser/display/graphics_data.js

@@ -1,12 +1,16 @@
-/**
- * @module display/graphics_data
- * @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 './graphics_data_util';
 
 export class GraphicsData {
+  /**
+   * TBD.
+   * @param lineWidth - TBD.
+   * @param lineColor - TBD.
+   * @param lineAlpha - TBD.
+   * @param fillColor - TBD.
+   * @param fillAlpha - TBD.
+   * @param fill - TBD.
+   * @param shape - TBD.
+   */
   constructor(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) {
     this.lineWidth = lineWidth;
     this.lineColor = lineColor;
@@ -20,6 +24,10 @@ export class GraphicsData {
     this.type = shape.type;
   }
 
+  /**
+   * TBD.
+   * @returns {GraphicsData} TBD.
+   */
   clone() {
     return clone(this);
   }

package/src/phaser/display/graphics_data_util.js

@@ -1,15 +1,9 @@
-/**
- * @module display/graphics_data_util
- * @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 { GraphicsData } from  './graphics_data';
+import { GraphicsData } from './graphics_data';
 
 /**
  * TBD.
  * @param {object} source - TBD.
- * @returns {object} TBD.
+ * @returns {GraphicsData} TBD.
  */
 export function clone(source) {
   return new GraphicsData(

package/src/phaser/display/group.js

@@ -1,13 +1,7 @@
-/**
- * @module display/group
- * @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 { DisplayObject } from  './display_object';
+import { DisplayObject } from './display_object';
 import { Image } from './image';
-import { Signal } from  '../core/signal';
-import { Game } from  '../core/game';
+import { Signal } from '../core/signal';
+import { Game } from '../core/game';
 import { GROUP } from '../core/const';
 
 export const SORT_ASCENDING = -1;
@@ -51,6 +45,11 @@ export class Group extends DisplayObject {
     this._sortProperty = 'z';
   }
 
+  /**
+   * TBD.
+   * @param {boolean} destroyChildren - TBD.
+   * @param {boolean} soft - TBD.
+   */
   destroy(destroyChildren = true, soft = false) {
     if (this.game === null || this.ignoreDestroy) {
       return;
@@ -69,6 +68,13 @@ export class Group extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param {DisplayObject} child - TBD.
+   * @param {boolean} silent - TBD.
+   * @param {number} index - TBD.
+   * @returns {DisplayObject} TBD.
+   */
   add(child, silent = false, index = -1) {
     if (child.parent === this) {
       return child;
@@ -92,10 +98,21 @@ export class Group extends DisplayObject {
     return child;
   }
 
+  /**
+   * TBD.
+   * @param {DisplayObject} child - TBD.
+   * @param {number} index - TBD.
+   * @param {boolean} silent - TBD.
+   */
   addAt(child, index, silent) {
     this.add(child, silent, index);
   }
 
+  /**
+   * TBD.
+   * @param {number} index - TBD.
+   * @returns {DisplayObject} TBD.
+   */
   getAt(index) {
     if (index < 0 || index >= this.children.length) {
       return -1;
@@ -103,6 +120,9 @@ export class Group extends DisplayObject {
     return this.getChildAt(index);
   }
 
+  /**
+   * TBD.
+   */
   updateZ() {
     let i = this.children.length;
     while (i) {
@@ -111,6 +131,10 @@ export class Group extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {DisplayObject} TBD.
+   */
   next() {
     if (this.cursor) {
       //  Wrap the cursor?
@@ -125,6 +149,10 @@ export class Group extends DisplayObject {
     return null;
   }
 
+  /**
+   * TBD.
+   * @returns {DisplayObject} TBD.
+   */
   previous() {
     if (this.cursor) {
       //  Wrap the cursor?
@@ -139,11 +167,21 @@ export class Group extends DisplayObject {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {DisplayObject} child1 - TBD.
+   * @param {DisplayObject} child2 - TBD.
+   */
   swap(child1, child2) {
     this.swapChildren(child1, child2);
     this.updateZ();
   }
 
+  /**
+   * TBD.
+   * @param {DisplayObject} child - TBD.
+   * @returns {DisplayObject} TBD.
+   */
   bringToTop(child) {
     if (child.parent === this && this.getIndex(child) < this.children.length) {
       this.remove(child, false, true);
@@ -152,6 +190,11 @@ export class Group extends DisplayObject {
     return child;
   }
 
+  /**
+   * TBD.
+   * @param {DisplayObject} child - TBD.
+   * @returns {DisplayObject} TBD.
+   */
   sendToBack(child) {
     if (child.parent === this && this.getIndex(child) > 0) {
       this.remove(child, false, true);
@@ -160,15 +203,26 @@ export class Group extends DisplayObject {
     return child;
   }
 
+  /**
+   * TBD.
+   */
   reverse() {
     this.children.reverse();
     this.updateZ();
   }
 
+  /**
+   * TBD.
+   * @param {DisplayObject} child - TBD.
+   * @returns {number} TBD.
+   */
   getIndex(child) {
     return this.children.indexOf(child);
   }
 
+  /**
+   * TBD.
+   */
   preUpdate() {
     if (this.pendingDestroy) {
       this.destroy();
@@ -183,6 +237,9 @@ export class Group extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   update() {
     let i = this.children.length;
     while (i) {
@@ -191,12 +248,22 @@ export class Group extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   postUpdate() {
     for (let i = 0; i < this.children.length; i += 1) {
       this.children[i].postUpdate();
     }
   }
 
+  /**
+   * TBD.
+   * @param {DisplayObject} child - TBD.
+   * @param {boolean} destroy - TBD.
+   * @param {boolean} silent - TBD.
+   * @returns {boolean} TBD.
+   */
   remove(child, destroy = true, silent = false) {
     if (this.children.length === 0 || this.children.indexOf(child) === -1) {
       return false;
@@ -215,6 +282,12 @@ export class Group extends DisplayObject {
     return true;
   }
 
+  /**
+   * TBD.
+   * @param {boolean} destroy - TBD.
+   * @param {boolean} silent - TBD.
+   * @param {boolean} destroyTexture - TBD.
+   */
   removeAll(destroy = true, silent = false, destroyTexture = false) {
     if (this.children.length === 0) {
       return;