@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/display/display_object.js

@@ -1,12 +1,6 @@
-/**
- * @module display/display_object
- * @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 '../geom/point';
-import { Rectangle } from  '../geom/rectangle';
-import { Matrix } from  '../geom/matrix';
+import { Rectangle } from '../geom/rectangle';
+import { Matrix } from '../geom/matrix';
 import { getIdentityMatrix } from '../geom/util/matrix';
 import { PI_2 } from '../util/math';
 import { renderCanvas, renderWebGL } from './sprite_util';
@@ -42,6 +36,9 @@ export class DisplayObject {
     this.ignoreChildInput = false;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     if (this.children) {
       let i = this.children.length;
@@ -73,10 +70,19 @@ export class DisplayObject {
     this.destroyCachedSprite();
   }
 
+  /**
+   * TBD.
+   * @param child - TBD.
+   */
   addChild(child) {
     return this.addChildAt(child, this.children.length);
   }
 
+  /**
+   * TBD.
+   * @param child - TBD.
+   * @param {number} index - TBD.
+   */
   addChildAt(child, index) {
     if (index >= 0 && index <= this.children.length) {
       if (child.parent) {
@@ -86,15 +92,14 @@ export class DisplayObject {
       this.children.splice(index, 0, child);
       return child;
     }
-    throw new Error(
-      child +
-        'addChildAt: The index ' +
-        index +
-        ' supplied is out of bounds ' +
-        this.children.length
-    );
+    throw new Error(child + 'addChildAt: The index ' + index + ' supplied is out of bounds ' + this.children.length);
   }
 
+  /**
+   * TBD.
+   * @param child - TBD.
+   * @param child2 - TBD.
+   */
   swapChildren(child, child2) {
     if (child === child2) {
       return;
@@ -102,14 +107,16 @@ export class DisplayObject {
     const index1 = this.getChildIndex(child);
     const index2 = this.getChildIndex(child2);
     if (index1 < 0 || index2 < 0) {
-      throw new Error(
-        'swapChildren: Both the supplied DisplayObjects must be a child of the caller.'
-      );
+      throw new Error('swapChildren: Both the supplied DisplayObjects must be a child of the caller.');
     }
     this.children[index1] = child2;
     this.children[index2] = child;
   }
 
+  /**
+   * TBD.
+   * @param child - TBD.
+   */
   getChildIndex(child) {
     const index = this.children.indexOf(child);
     if (index === -1) {
@@ -118,6 +125,11 @@ export class DisplayObject {
     return index;
   }
 
+  /**
+   * TBD.
+   * @param child - TBD.
+   * @param {number} index - TBD.
+   */
   setChildIndex(child, index) {
     if (index < 0 || index >= this.children.length) {
       throw new Error('The supplied index is out of bounds');
@@ -127,6 +139,10 @@ export class DisplayObject {
     this.children.splice(index, 0, child); // add at new position
   }
 
+  /**
+   * TBD.
+   * @param {number} index - TBD.
+   */
   getChildAt(index) {
     if (index < 0 || index >= this.children.length) {
       throw new Error(
@@ -138,6 +154,10 @@ export class DisplayObject {
     return this.children[index];
   }
 
+  /**
+   * TBD.
+   * @param child - TBD.
+   */
   removeChild(child) {
     const index = this.children.indexOf(child);
     if (index === -1) {
@@ -146,6 +166,10 @@ export class DisplayObject {
     return this.removeChildAt(index);
   }
 
+  /**
+   * TBD.
+   * @param {number} index - TBD.
+   */
   removeChildAt(index) {
     const child = this.getChildAt(index);
     if (child) {
@@ -155,6 +179,11 @@ export class DisplayObject {
     return child;
   }
 
+  /**
+   * TBD.
+   * @param {number} beginIndex - TBD.
+   * @param {number} endIndex - TBD.
+   */
   removeChildren(beginIndex, endIndex) {
     if (beginIndex === undefined) {
       beginIndex = 0;
@@ -177,6 +206,10 @@ export class DisplayObject {
     throw new Error('removeChildren: Range Error, numeric values are outside the acceptable range');
   }
 
+  /**
+   * TBD.
+   * @param parent - TBD.
+   */
   updateTransform(parent) {
     if (!parent && !this.parent) {
       return this;
@@ -260,9 +293,12 @@ export class DisplayObject {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param targetCoordinateSpace - TBD.
+   */
   getBounds(targetCoordinateSpace) {
-    const isTargetCoordinateSpaceDisplayObject =
-      targetCoordinateSpace && targetCoordinateSpace.contains !== undefined;
+    const isTargetCoordinateSpaceDisplayObject = targetCoordinateSpace && targetCoordinateSpace.contains !== undefined;
     let isTargetCoordinateSpaceThisOrParent = true;
     if (!isTargetCoordinateSpaceDisplayObject) {
       targetCoordinateSpace = this;
@@ -358,10 +394,19 @@ export class DisplayObject {
     return bounds;
   }
 
+  /**
+   * TBD.
+   * @returns {Rectangle} TBD.
+   */
   getLocalBounds() {
     return this.getBounds(this);
   }
 
+  /**
+   * TBD.
+   * @param child - TBD.
+   * @returns {boolean} TBD.
+   */
   contains(child) {
     if (!child) {
       return false;
@@ -372,6 +417,10 @@ export class DisplayObject {
     return this.contains(child.parent);
   }
 
+  /**
+   * TBD.
+   * @param renderSession - TBD.
+   */
   renderWebGL(renderSession) {
     if (!this.visible || this.alpha <= 0) {
       return;
@@ -402,6 +451,10 @@ export class DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param renderSession - TBD.
+   */
   renderCanvas(renderSession) {
     if (!this.visible || this.alpha <= 0) {
       return;
@@ -417,28 +470,49 @@ export class DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   preUpdate() {
     // override
   }
 
+  /**
+   * TBD.
+   */
   update() {
     // override
   }
 
+  /**
+   * TBD.
+   */
   postUpdate() {
     // override
   }
 
+  /**
+   * TBD.
+   */
   generateTexture() {
     // TODO
     console.warn('display_object.generateTexture() is not implemented');
   }
 
+  /**
+   * TBD.
+   * @param position - TBD.
+   */
   toGlobal(position) {
     this.updateTransform();
     return this.worldTransform.apply(position);
   }
 
+  /**
+   * TBD.
+   * @param position - TBD.
+   * @param from - TBD.
+   */
   toLocal(position, from) {
     if (from) {
       position = from.toGlobal(position);
@@ -447,6 +521,10 @@ export class DisplayObject {
     return this.worldTransform.applyInverse(position);
   }
 
+  /**
+   * TBD.
+   * @param renderSession - TBD.
+   */
   renderCachedSprite(renderSession) {
     if (!this._cachedSprite) {
       return;
@@ -459,10 +537,16 @@ export class DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   generateCachedSprite() {
     // TODO
   }
 
+  /**
+   * TBD.
+   */
   destroyCachedSprite() {
     if (!this._cachedSprite) {
       return;
@@ -473,10 +557,17 @@ export class DisplayObject {
 
   // GETTER SETTER
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get width() {
     return this.getLocalBounds().width * this.scale.x;
   }
 
+  /**
+   * TBD.
+   */
   set width(value) {
     const width = this.getLocalBounds().width;
     if (width !== 0) {
@@ -487,10 +578,17 @@ export class DisplayObject {
     this._width = value;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get height() {
     return this.getLocalBounds().height * this.scale.y;
   }
 
+  /**
+   * TBD.
+   */
   set height(value) {
     const height = this.getLocalBounds().height;
     if (height !== 0) {
@@ -501,22 +599,40 @@ export class DisplayObject {
     this._height = value;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get x() {
     return this.position.x;
   }
 
+  /**
+   * TBD.
+   */
   set x(value) {
     this.position.x = value;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get y() {
     return this.position.y;
   }
 
+  /**
+   * TBD.
+   */
   set y(value) {
     this.position.y = value;
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get worldVisible() {
     if (!this.visible) {
       return false;
@@ -536,10 +652,16 @@ export class DisplayObject {
 
   // MASK
 
+  /**
+   * TBD.
+   */
   get mask() {
     return this._mask;
   }
 
+  /**
+   * TBD.
+   */
   set mask(value) {
     if (this._mask) {
       this._mask.isMask = false;
@@ -552,58 +674,108 @@ export class DisplayObject {
 
   // BOUNDS
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get offsetX() {
     return this.anchor.x * this.width;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get offsetY() {
     return this.anchor.y * this.height;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get centerX() {
     return this.x - this.offsetX + this.width * 0.5;
   }
 
+  /**
+   * TBD.
+   */
   set centerX(value) {
     this.x = value + this.offsetX - this.width * 0.5;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get centerY() {
     return this.y - this.offsetY + this.height * 0.5;
   }
 
+  /**
+   * TBD.
+   */
   set centerY(value) {
     this.y = value + this.offsetY - this.height * 0.5;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get left() {
     return this.x - this.offsetX;
   }
 
+  /**
+   * TBD.
+   */
   set left(value) {
     this.x = value + this.offsetX;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get right() {
     return this.x + this.width - this.offsetX;
   }
 
+  /**
+   * TBD.
+   */
   set right(value) {
     this.x = value - this.width + this.offsetX;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get top() {
     return this.y - this.offsetY;
   }
 
+  /**
+   * TBD.
+   */
   set top(value) {
     this.y = value + this.offsetY;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get bottom() {
     return this.y + this.height - this.offsetY;
   }
 
+  /**
+   * TBD.
+   */
   set bottom(value) {
     this.y = value - this.height + this.offsetY;
   }