@vpmedia/phaser 1.103.0 → 1.105.0

package/src/phaser/display/display_object.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { Matrix } from '../geom/matrix.js';
 import { Point } from '../geom/point.js';
 import { Rectangle } from '../geom/rectangle.js';
@@ -7,11 +6,67 @@ import { PI_2 } from '../util/math.js';
 import { renderCanvas, renderWebGL } from './sprite_util.js';
 
 export class DisplayObject {
+  /** @type {boolean} */
+  exists = true;
+  /** @type {boolean} */
+  renderable = false;
+  /** @type {boolean} */
+  visible = true;
+  position!: Point;
+  scale!: Point;
+  pivot!: Point;
+  anchor!: Point;
+  /** @type {number} */
+  rotation = 0;
+  /** @type {number} */
+  alpha = 1;
+  /** @type {Rectangle} */
+  hitArea = null;
+  /** @type {DisplayObject} */
+  parent = null;
+  /** @type {number} */
+  worldAlpha = 1;
+  worldTransform!: Matrix;
+  worldScale!: Point;
+  /** @type {Rectangle} */
+  filterArea = null;
+  /** @type {number} */
+  _sr = 0;
+  /** @type {number} */
+  _cr = 1;
+  cachedBounds!: Rectangle;
+  /** @type {Rectangle} */
+  currentBounds = null;
+  /** @type {import('./graphics.js').Graphics} */
+  _mask = null;
+  /** @type {object[]} */
+  _filters = null;
+  /** @type {object} */
+  _filterBlock = null;
+  children!: any[];
+  /** @type {boolean} */
+  ignoreChildInput = false;
+  /** @type {string | null} */
+  name = null;
+  /** @type {object | null} */
+  data = null;
+  game!: import('../core/game.js').Game;
+  type!: number;
+  _cachedSprite!: any;
+  rotationCache!: any;
+  worldRotation!: any;
+  transformCallback!: any;
+  transformCallbackContext!: any;
+  _width!: any;
+  _height!: any;
+  z!: any;
+  events!: any;
+  renderOrderID!: any;
   /**
    * Creates a new DisplayObject instance.
    * @param {import('../core/game.js').Game} game - The game instance this display object belongs to.
    */
-  constructor(game) {
+  constructor(game: import('../core/game.js').Game) {
     /** @type {boolean} */
     this.exists = true;
     /** @type {boolean} */
@@ -38,10 +93,10 @@ export class DisplayObject {
     this.worldAlpha = 1;
     /** @type {Matrix} */
     this.worldTransform = new Matrix();
-    // this.worldPosition = new Point(0, 0);
+    // This.worldPosition = new Point(0, 0);
     /** @type {Point} */
     this.worldScale = new Point(1, 1);
-    // this.worldRotation = 0;
+    // This.worldRotation = 0;
     /** @type {Rectangle} */
     this.filterArea = null;
     /** @type {number} */
@@ -86,7 +141,7 @@ export class DisplayObject {
     this.visible = false;
     // TODO: investigate how to clean up properly object references without breaking delayed tween cleanups.
     /*
-    this.position = null;
+    This.position = null;
     this.scale = null;
     this.pivot = null;
     this.anchor = null;
@@ -94,7 +149,7 @@ export class DisplayObject {
     this.hitArea = null;
     this.parent = null;
     this.worldTransform = null;
-    // this.worldPosition = null;
+    // This.worldPosition = null;
     this.worldScale = null;
     this.filterArea = null;
     this.cachedBounds = null;
@@ -108,7 +163,7 @@ export class DisplayObject {
    * @param {DisplayObject} child - The child display object to add.
    * @returns {DisplayObject} The added child display object.
    */
-  addChild(child) {
+  addChild(child: DisplayObject) {
     return this.addChildAt(child, this.children.length);
   }
 
@@ -119,7 +174,7 @@ export class DisplayObject {
    * @returns {DisplayObject} The added child display object.
    * @throws {Error} If the index is out of bounds.
    */
-  addChildAt(child, index) {
+  addChildAt(child: DisplayObject, index: number) {
     if (index >= 0 && index <= this.children.length) {
       if (child.parent) {
         child.parent.removeChild(child);
@@ -137,7 +192,7 @@ export class DisplayObject {
    * @param {DisplayObject} child2 - The second child display object.
    * @throws {Error} If either child is not a child of this container.
    */
-  swapChildren(child, child2) {
+  swapChildren(child: DisplayObject, child2: DisplayObject) {
     if (child === child2) {
       return;
     }
@@ -156,7 +211,7 @@ export class DisplayObject {
    * @returns {number} The index of the child in the children list.
    * @throws {Error} If the child is not a child of this container.
    */
-  getChildIndex(child) {
+  getChildIndex(child: DisplayObject) {
     const index = this.children.indexOf(child);
     if (index === -1) {
       throw new Error('The supplied DisplayObject must be a child of the caller');
@@ -170,13 +225,13 @@ export class DisplayObject {
    * @param {number} index - The new index for the child.
    * @throws {Error} If the index is out of bounds.
    */
-  setChildIndex(child, index) {
+  setChildIndex(child: DisplayObject, index: number) {
     if (index < 0 || index >= this.children.length) {
       throw new Error('The supplied index is out of bounds');
     }
     const currentIndex = this.getChildIndex(child);
-    this.children.splice(currentIndex, 1); // remove from old position
-    this.children.splice(index, 0, child); // add at new position
+    this.children.splice(currentIndex, 1); // Remove from old position
+    this.children.splice(index, 0, child); // Add at new position
   }
 
   /**
@@ -185,7 +240,7 @@ export class DisplayObject {
    * @returns {DisplayObject} The child display object at the specified index.
    * @throws {Error} If the index is out of bounds.
    */
-  getChildAt(index) {
+  getChildAt(index: number) {
     if (index < 0 || index >= this.children.length) {
       throw new Error(
         `getChildAt: Supplied index ${
@@ -201,7 +256,7 @@ export class DisplayObject {
    * @param {DisplayObject} child - The child display object to remove.
    * @returns {DisplayObject} The removed child display object.
    */
-  removeChild(child) {
+  removeChild(child: DisplayObject) {
     const index = this.children.indexOf(child);
     if (index === -1) {
       return null;
@@ -214,7 +269,7 @@ export class DisplayObject {
    * @param {number} index - The index of the child to remove.
    * @returns {DisplayObject} The removed child display object.
    */
-  removeChildAt(index) {
+  removeChildAt(index: number) {
     const child = this.getChildAt(index);
     if (child) {
       child.parent = undefined;
@@ -230,7 +285,7 @@ export class DisplayObject {
    * @returns {DisplayObject[]} The array of removed child display objects.
    * @throws {Error} If the range is invalid.
    */
-  removeChildren(beginIndex, endIndex) {
+  removeChildren(beginIndex: number, endIndex: number) {
     if (beginIndex === undefined) {
       beginIndex = 0;
     }
@@ -257,7 +312,7 @@ export class DisplayObject {
    * @param {DisplayObject | null | undefined} parent - The parent display object to use for the world transform calculation.
    * @returns {DisplayObject} This DisplayObject instance for chaining.
    */
-  updateTransform(parent = null) {
+  updateTransform(parent: DisplayObject | null | undefined = null) {
     if (!parent && !this.parent) {
       return this;
     }
@@ -270,37 +325,37 @@ export class DisplayObject {
     } else if (!this.parent) {
       p = this.game.world;
     }
-    // create some matrix refs for easy access
+    // Create some matrix refs for easy access
     const pt = p.worldTransform;
     const wt = this.worldTransform;
-    // temporary matrix variables
+    // Temporary matrix variables
     let a;
     let b;
     let c;
     let d;
     let tx;
     let ty;
-    // so if rotation is between 0 then we can simplify the multiplication process..
+    // So if rotation is between 0 then we can simplify the multiplication process..
     if (this.rotation % PI_2) {
-      // check to see if the rotation is the same as the previous render. This means we only need to use sin and cos when rotation actually changes
+      // Check to see if the rotation is the same as the previous render. This means we only need to use sin and cos when rotation actually changes
       if (this.rotation !== this.rotationCache) {
         this.rotationCache = this.rotation;
         this._sr = Math.sin(this.rotation);
         this._cr = Math.cos(this.rotation);
       }
-      // get the matrix values of the displayobject based on its transform properties..
+      // Get the matrix values of the displayobject based on its transform properties..
       a = this._cr * this.scale.x;
       b = this._sr * this.scale.x;
       c = -this._sr * this.scale.y;
       d = this._cr * this.scale.y;
       tx = this.position.x;
       ty = this.position.y;
-      // check for pivot.. not often used so geared towards that fact!
+      // Check for pivot.. not often used so geared towards that fact!
       if (this.pivot.x || this.pivot.y) {
         tx -= this.pivot.x * a + this.pivot.y * c;
         ty -= this.pivot.x * b + this.pivot.y * d;
       }
-      // concat the parent matrix with the objects transform.
+      // Concat the parent matrix with the objects transform.
       wt.a = a * pt.a + b * pt.c;
       wt.b = a * pt.b + b * pt.d;
       wt.c = c * pt.a + d * pt.c;
@@ -308,7 +363,7 @@ export class DisplayObject {
       wt.tx = tx * pt.a + ty * pt.c + pt.tx;
       wt.ty = tx * pt.b + ty * pt.d + pt.ty;
     } else {
-      // lets do the fast version as we know there is no rotation..
+      // Lets do the fast version as we know there is no rotation..
       a = this.scale.x;
       d = this.scale.y;
       tx = this.position.x - this.pivot.x * a;
@@ -322,13 +377,13 @@ export class DisplayObject {
     }
     //  Set the World values
     this.worldAlpha = this.alpha * p.worldAlpha;
-    // this.worldPosition.setTo(wt.tx, wt.ty);
+    // This.worldPosition.setTo(wt.tx, wt.ty);
     this.worldScale.setTo(
       this.scale.x * Math.sqrt(wt.a * wt.a + wt.c * wt.c),
       this.scale.y * Math.sqrt(wt.b * wt.b + wt.d * wt.d)
     );
     this.worldRotation = Math.atan2(-wt.c, wt.d);
-    // reset the bounds each time this is called!
+    // Reset the bounds each time this is called!
     this.currentBounds = null;
     //  Custom callback?
     if (this.transformCallback) {
@@ -345,7 +400,7 @@ export class DisplayObject {
    * @param {DisplayObject} targetCoordinateSpace - The coordinate space to calculate bounds in.
    * @returns {Rectangle} The bounds rectangle of this display object.
    */
-  getBounds(targetCoordinateSpace) {
+  getBounds(targetCoordinateSpace?: any) {
     const isTargetCoordinateSpaceDisplayObject = targetCoordinateSpace && targetCoordinateSpace.contains !== undefined;
     let isTargetCoordinateSpaceThisOrParent = true;
     if (!isTargetCoordinateSpaceDisplayObject) {
@@ -392,13 +447,13 @@ export class DisplayObject {
       const w1 = bounds.width + bounds.x;
       const h0 = bounds.y;
       const h1 = bounds.height + bounds.y;
-      const worldTransform = this.worldTransform;
-      const a = worldTransform.a;
-      const b = worldTransform.b;
-      const c = worldTransform.c;
-      const d = worldTransform.d;
-      const tx = worldTransform.tx;
-      const ty = worldTransform.ty;
+      const { worldTransform } = this;
+      const { a } = worldTransform;
+      const { b } = worldTransform;
+      const { c } = worldTransform;
+      const { d } = worldTransform;
+      const { tx } = worldTransform;
+      const { ty } = worldTransform;
       const x1 = a * w1 + c * h1 + tx;
       const y1 = d * h1 + b * w1 + ty;
       const x2 = a * w0 + c * h1 + tx;
@@ -455,7 +510,7 @@ export class DisplayObject {
    * @param {DisplayObject} child - The child display object to check.
    * @returns {boolean} True if the child is contained within this container, false otherwise.
    */
-  contains(child) {
+  contains(child: DisplayObject) {
     if (!child) {
       return false;
     }
@@ -469,13 +524,13 @@ export class DisplayObject {
    * Renders this display object using WebGL.
    * @param {object} renderSession - The WebGL rendering session.
    */
-  renderWebGL(renderSession) {
+  renderWebGL(renderSession: any) {
     if (!this.visible || this.alpha <= 0) {
       return;
     }
     let i;
     if (this._mask || this._filters) {
-      // push filter first as we need to ensure the stencil buffer is correct for any masking
+      // Push filter first as we need to ensure the stencil buffer is correct for any masking
       if (this._filters) {
         renderSession.spriteBatch.flush();
         renderSession.filterManager.pushFilter(this._filterBlock);
@@ -489,8 +544,12 @@ export class DisplayObject {
         this.children[i].renderWebGL(renderSession);
       }
       renderSession.spriteBatch.stop();
-      if (this._mask) renderSession.maskManager.popMask(this._mask, renderSession);
-      if (this._filters) renderSession.filterManager.popFilter();
+      if (this._mask) {
+        renderSession.maskManager.popMask(this._mask, renderSession);
+      }
+      if (this._filters) {
+        renderSession.filterManager.popFilter();
+      }
       renderSession.spriteBatch.start();
     } else {
       for (i = 0; i < this.children.length; i += 1) {
@@ -503,7 +562,7 @@ export class DisplayObject {
    * Renders this display object using Canvas.
    * @param {object} renderSession - The Canvas rendering session.
    */
-  renderCanvas(renderSession) {
+  renderCanvas(renderSession: any) {
     if (!this.visible || this.alpha <= 0) {
       return;
     }
@@ -522,21 +581,21 @@ export class DisplayObject {
    * Called before the update cycle for this display object.
    */
   preUpdate() {
-    // override
+    // Override
   }
 
   /**
    * Called during the update cycle for this display object.
    */
   update() {
-    // override
+    // Override
   }
 
   /**
    * Called after the update cycle for this display object.
    */
   postUpdate() {
-    // override
+    // Override
   }
 
   /**
@@ -553,7 +612,7 @@ export class DisplayObject {
    * @param {Point} position - The local position to convert.
    * @returns {Point} The converted global position.
    */
-  toGlobal(position) {
+  toGlobal(position: Point) {
     this.updateTransform();
     return this.worldTransform.apply(position);
   }
@@ -564,7 +623,7 @@ export class DisplayObject {
    * @param {DisplayObject} from - The display object to convert from (defaults to this).
    * @returns {Point} The converted local position.
    */
-  toLocal(position, from) {
+  toLocal(position: Point, from: DisplayObject) {
     if (from) {
       position = from.toGlobal(position);
     }
@@ -576,7 +635,7 @@ export class DisplayObject {
    * Renders a cached sprite for this display object.
    * @param {object} renderSession - The rendering session.
    */
-  renderCachedSprite(renderSession) {
+  renderCachedSprite(renderSession: any) {
     if (!this._cachedSprite) {
       return;
     }
@@ -620,8 +679,8 @@ export class DisplayObject {
    * Sets the width of this display object.
    * @param {number} value - The new width in pixels.
    */
-  set width(value) {
-    const width = this.getLocalBounds().width;
+  set width(value: number) {
+    const { width } = this.getLocalBounds();
     if (width !== 0) {
       this.scale.x = value / width;
     } else {
@@ -642,8 +701,8 @@ export class DisplayObject {
    * Sets the height of this display object.
    * @param {number} value - The new height in pixels.
    */
-  set height(value) {
-    const height = this.getLocalBounds().height;
+  set height(value: number) {
+    const { height } = this.getLocalBounds();
     if (height !== 0) {
       this.scale.y = value / height;
     } else {
@@ -664,7 +723,7 @@ export class DisplayObject {
    * Sets the x position of this display object.
    * @param {number} value - The new x position in pixels.
    */
-  set x(value) {
+  set x(value: number) {
     this.position.x = value;
   }
 
@@ -680,7 +739,7 @@ export class DisplayObject {
    * Sets the y position of this display object.
    * @param {number} value - The new y position in pixels.
    */
-  set y(value) {
+  set y(value: number) {
     this.position.y = value;
   }
 
@@ -719,7 +778,7 @@ export class DisplayObject {
    * Sets the mask for this display object.
    * @param {import('./graphics.js').Graphics} value - The mask object to set, or null to remove the mask.
    */
-  set mask(value) {
+  set mask(value: import('./graphics.js').Graphics) {
     if (this._mask) {
       this._mask.isMask = false;
     }
@@ -759,7 +818,7 @@ export class DisplayObject {
    * Sets the center x position of this display object.
    * @param {number} value - The new center x position in pixels.
    */
-  set centerX(value) {
+  set centerX(value: number) {
     this.x = value + this.offsetX - this.width * 0.5;
   }
 
@@ -775,7 +834,7 @@ export class DisplayObject {
    * Sets the center y position of this display object.
    * @param {number} value - The new center y position in pixels.
    */
-  set centerY(value) {
+  set centerY(value: number) {
     this.y = value + this.offsetY - this.height * 0.5;
   }
 
@@ -791,7 +850,7 @@ export class DisplayObject {
    * Sets the left x position of this display object.
    * @param {number} value - The new left x position in pixels.
    */
-  set left(value) {
+  set left(value: number) {
     this.x = value + this.offsetX;
   }
 
@@ -807,7 +866,7 @@ export class DisplayObject {
    * Sets the right x position of this display object.
    * @param {number} value - The new right x position in pixels.
    */
-  set right(value) {
+  set right(value: number) {
     this.x = value - this.width + this.offsetX;
   }
 
@@ -823,7 +882,7 @@ export class DisplayObject {
    * Sets the top y position of this display object.
    * @param {number} value - The new top y position in pixels.
    */
-  set top(value) {
+  set top(value: number) {
     this.y = value + this.offsetY;
   }
 
@@ -839,7 +898,7 @@ export class DisplayObject {
    * Sets the bottom y position of this display object.
    * @param {number} value - The new bottom y position in pixels.
    */
-  set bottom(value) {
+  set bottom(value: number) {
     this.y = value - this.height + this.offsetY;
   }
 }