@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/input_handler.js

@@ -1,13 +1,15 @@
-/**
- * @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 { GROUP } from './const';
 import { distance } from '../util/math';
+import { Pointer } from './input_pointer';
+import { Rectangle } from '../geom/rectangle';
+import { DisplayObject } from '../display/display_object';
 
 export class InputHandler {
+  /**
+   * TBD.
+   * @param sprite
+   */
   constructor(sprite) {
     this.sprite = sprite;
     this.game = sprite.game;
@@ -69,6 +71,12 @@ export class InputHandler {
     });
   }
 
+  /**
+   * TBD.
+   * @param {number} priority - TBD.
+   * @param {boolean} useHandCursor - TBD.
+   * @returns {DisplayObject} TBD.
+   */
   start(priority = 0, useHandCursor = false) {
     //  Turning on
     if (this.enabled === false) {
@@ -102,6 +110,9 @@ export class InputHandler {
     return this.sprite;
   }
 
+  /**
+   * TBD.
+   */
   addedToGroup() {
     if (this._dragPhase) {
       return;
@@ -111,6 +122,9 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   */
   removedFromGroup() {
     if (this._dragPhase) {
       return;
@@ -123,6 +137,9 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   */
   reset() {
     this.enabled = false;
     for (let i = 0; i < 10; i += 1) {
@@ -144,6 +161,9 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   */
   stop() {
     if (this.enabled) {
       this.enabled = false;
@@ -151,6 +171,9 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     if (this.sprite) {
       if (this._setHandCursor) {
@@ -166,6 +189,13 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   * @param {number} highestID - TBD.
+   * @param {number} highestRenderID - TBD.
+   * @param {boolean} includePixelPerfect - TBD.
+   * @returns {boolean} TBD.
+   */
   validForInput(highestID, highestRenderID, includePixelPerfect = true) {
     if (
       !this.enabled ||
@@ -180,43 +210,79 @@ export class InputHandler {
     if (!includePixelPerfect && (this.pixelPerfectClick || this.pixelPerfectOver)) {
       return false;
     }
-    if (
-      this.priorityID > highestID ||
-      (this.priorityID === highestID && this.sprite.renderOrderID > highestRenderID)
-    ) {
+    if (this.priorityID > highestID || (this.priorityID === highestID && this.sprite.renderOrderID > highestRenderID)) {
       return true;
     }
     return false;
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   isPixelPerfect() {
     return this.pixelPerfectClick || this.pixelPerfectOver;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {number} TBD.
+   */
   pointerX(pointerId = 0) {
     return this._pointerData[pointerId].x;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {number} TBD.
+   */
   pointerY(pointerId = 0) {
     return this._pointerData[pointerId].y;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {boolean} TBD.
+   */
   pointerDown(pointerId = 0) {
     return this._pointerData[pointerId].isDown;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {boolean} TBD.
+   */
   pointerUp(pointerId = 0) {
     return this._pointerData[pointerId].isUp;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {number} TBD.
+   */
   pointerTimeDown(pointerId = 0) {
     return this._pointerData[pointerId].timeDown;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {number} TBD.
+   */
   pointerTimeUp(pointerId = 0) {
     return this._pointerData[pointerId].timeUp;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {boolean} TBD.
+   */
   pointerOver(pointerId) {
     if (!this.enabled) {
       return false;
@@ -232,6 +298,11 @@ export class InputHandler {
     return this._pointerData[pointerId].isOver;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {boolean} TBD.
+   */
   pointerOut(pointerId) {
     if (!this.enabled) {
       return false;
@@ -246,19 +317,40 @@ export class InputHandler {
     return this._pointerData[pointerId].isOut;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {number} TBD.
+   */
   pointerTimeOver(pointerId = 0) {
     return this._pointerData[pointerId].timeOver;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {number} TBD.
+   */
   pointerTimeOut(pointerId = 0) {
     return this._pointerData[pointerId].timeOut;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {boolean} TBD.
+   */
   pointerDragged(pointerId = 0) {
     return this._pointerData[pointerId].isDragged;
   }
 
-  checkPointerDown(pointer = 0, fastTest = false) {
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {boolean} fastTest - TBD.
+   * @returns {boolean} TBD.
+   */
+  checkPointerDown(pointer, fastTest = false) {
     if (
       !pointer.isDown ||
       !this.enabled ||
@@ -281,7 +373,13 @@ export class InputHandler {
     return false;
   }
 
-  checkPointerOver(pointer = 0, fastTest = false) {
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {boolean} fastTest - TBD.
+   * @returns {boolean} TBD.
+   */
+  checkPointerOver(pointer, fastTest = false) {
     if (
       !this.enabled ||
       !this.sprite ||
@@ -303,6 +401,13 @@ export class InputHandler {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {Pointer} pointer - TBD.
+   * @returns {boolean} TBD.
+   */
   checkPixel(x, y, pointer) {
     //  Grab a pixel from our image into the hitCanvas and then test it
     if (this.sprite.texture.baseTexture.source) {
@@ -338,17 +443,7 @@ export class InputHandler {
       this._dx = x;
       this._dy = y;
       this.game.input.hitContext.clearRect(0, 0, 1, 1);
-      this.game.input.hitContext.drawImage(
-        this.sprite.texture.baseTexture.source,
-        x,
-        y,
-        1,
-        1,
-        0,
-        0,
-        1,
-        1
-      );
+      this.game.input.hitContext.drawImage(this.sprite.texture.baseTexture.source, x, y, 1, 1, 0, 0, 1, 1);
       const rgb = this.game.input.hitContext.getImageData(0, 0, 1, 1);
       if (rgb.data[3] >= this.pixelPerfectAlpha) {
         return true;
@@ -357,6 +452,11 @@ export class InputHandler {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   * @returns {boolean} TBD.
+   */
   update(pointer) {
     if (this.sprite === null || this.sprite.parent === undefined) {
       // Abort. We've been destroyed.
@@ -369,8 +469,7 @@ export class InputHandler {
     if (this._pendingDrag) {
       if (!this._dragDistancePass) {
         this._dragDistancePass =
-          distance(pointer.x, pointer.y, this.downPoint.x, this.downPoint.y) >=
-          this.dragDistanceThreshold;
+          distance(pointer.x, pointer.y, this.downPoint.x, this.downPoint.y) >= this.dragDistanceThreshold;
       }
       if (this._dragDistancePass && this._dragTimePass) {
         this.startDrag(pointer);
@@ -390,6 +489,11 @@ export class InputHandler {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {boolean} silent - TBD.
+   */
   _pointerOverHandler(pointer, silent) {
     if (this.sprite === null) {
       // Abort. We've been destroyed.
@@ -416,7 +520,12 @@ export class InputHandler {
     }
   }
 
-  _pointerOutHandler(pointer, silent) {
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {boolean} silent - TBD.
+   */
+  _pointerOutHandler(pointer, silent = false) {
     if (this.sprite === null) {
       // Abort. We've been destroyed.
       return;
@@ -437,6 +546,10 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   */
   _touchedHandler(pointer) {
     if (this.sprite === null) {
       // Abort. We've been destroyed.
@@ -485,6 +598,10 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   */
   dragTimeElapsed(pointer) {
     this._dragTimePass = true;
     if (this._pendingDrag && this.sprite) {
@@ -494,6 +611,10 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   */
   _releasedHandler(pointer) {
     if (this.sprite === null) {
       // Abort. We've been destroyed.
@@ -511,8 +632,7 @@ export class InputHandler {
       if (this.sprite && this.sprite.events) {
         if (
           !this.dragStopBlocksInputUp ||
-          (this.dragStopBlocksInputUp &&
-            !(this.draggable && this.isDragged && this._draggedPointerID === pointer.id))
+          (this.dragStopBlocksInputUp && !(this.draggable && this.isDragged && this._draggedPointerID === pointer.id))
         ) {
           this.sprite.events.onInputUp$dispatch(this.sprite, pointer, isOver);
         }
@@ -539,6 +659,12 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {boolean} fromStart - TBD.
+   * @returns {boolean} TBD.
+   */
   updateDrag(pointer, fromStart = false) {
     if (pointer.isUp) {
       this.stopDrag(pointer);
@@ -569,39 +695,55 @@ export class InputHandler {
         (this.snapOffsetY % this.snapY);
       this.snapPoint.set(this.sprite.x, this.sprite.y);
     }
-    this.sprite.events.onDragUpdate.dispatch(
-      this.sprite,
-      pointer,
-      px,
-      py,
-      this.snapPoint,
-      fromStart
-    );
+    this.sprite.events.onDragUpdate.dispatch(this.sprite, pointer, px, py, this.snapPoint, fromStart);
     return true;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @param {number} delay - TBD.
+   * @returns {boolean} TBD.
+   */
   justOver(pointerId = 0, delay = 500) {
     return this._pointerData[pointerId].isOver && this.overDuration(pointerId) < delay;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @param {number} delay - TBD.
+   * @returns {boolean} TBD.
+   */
   justOut(pointerId = 0, delay = 500) {
-    return (
-      this._pointerData[pointerId].isOut &&
-      this.game.time.time - this._pointerData[pointerId].timeOut < delay
-    );
+    return this._pointerData[pointerId].isOut && this.game.time.time - this._pointerData[pointerId].timeOut < delay;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @param {number} delay - TBD.
+   * @returns {boolean} TBD.
+   */
   justPressed(pointerId = 0, delay = 500) {
     return this._pointerData[pointerId].isDown && this.downDuration(pointerId) < delay;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @param {number} delay - TBD.
+   * @returns {boolean} TBD.
+   */
   justReleased(pointerId = 0, delay = 500) {
-    return (
-      this._pointerData[pointerId].isUp &&
-      this.game.time.time - this._pointerData[pointerId].timeUp < delay
-    );
+    return this._pointerData[pointerId].isUp && this.game.time.time - this._pointerData[pointerId].timeUp < delay;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {number} TBD.
+   */
   overDuration(pointerId = 0) {
     if (this._pointerData[pointerId].isOver) {
       return this.game.time.time - this._pointerData[pointerId].timeOver;
@@ -609,6 +751,11 @@ export class InputHandler {
     return -1;
   }
 
+  /**
+   * TBD.
+   * @param {number} pointerId - TBD.
+   * @returns {number} TBD.
+   */
   downDuration(pointerId = 0) {
     if (this._pointerData[pointerId].isDown) {
       return this.game.time.time - this._pointerData[pointerId].timeDown;
@@ -616,6 +763,15 @@ export class InputHandler {
     return -1;
   }
 
+  /**
+   * TBD.
+   * @param {boolean} lockCenter - TBD.
+   * @param {boolean} bringToTop - TBD.
+   * @param {boolean} pixelPerfect - TBD.
+   * @param {number} alphaThreshold - TBD.
+   * @param {Rectangle} boundsRect - TBD.
+   * @param {DisplayObject} boundsSprite - TBD.
+   */
   enableDrag(
     lockCenter = false,
     bringToTop = false,
@@ -639,6 +795,9 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   */
   disableDrag() {
     if (this._pointerData) {
       for (let i = 0; i < 10; i += 1) {
@@ -651,6 +810,10 @@ export class InputHandler {
     this._pendingDrag = false;
   }
 
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   */
   startDrag(pointer) {
     const x = this.sprite.x;
     const y = this.sprite.y;
@@ -678,6 +841,11 @@ export class InputHandler {
     this._pendingDrag = false;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @returns {number} TBD.
+   */
   globalToLocalX(x) {
     if (this.scaleLayer) {
       x -= this.game.scale.grid.boundsFluid.x;
@@ -686,6 +854,11 @@ export class InputHandler {
     return x;
   }
 
+  /**
+   * TBD.
+   * @param {number} y - TBD.
+   * @returns {number} TBD.
+   */
   globalToLocalY(y) {
     if (this.scaleLayer) {
       y -= this.game.scale.grid.boundsFluid.y;
@@ -694,6 +867,10 @@ export class InputHandler {
     return y;
   }
 
+  /**
+   * TBD.
+   * @param {Pointer} pointer - TBD.
+   */
   stopDrag(pointer) {
     this.isDragged = false;
     this._draggedPointerID = -1;
@@ -714,11 +891,25 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   * @param {boolean} allowHorizontal - TBD.
+   * @param {boolean} allowVertical - TBD.
+   */
   setDragLock(allowHorizontal = true, allowVertical = true) {
     this.allowHorizontalDrag = allowHorizontal;
     this.allowVerticalDrag = allowVertical;
   }
 
+  /**
+   * TBD.
+   * @param {number} snapX - TBD.
+   * @param {number} snapY - TBD.
+   * @param {boolean} onDrag - TBD.
+   * @param {boolean} onRelease - TBD.
+   * @param {number} snapOffsetX - TBD.
+   * @param {number} snapOffsetY - TBD.
+   */
   enableSnap(snapX, snapY, onDrag = true, onRelease = false, snapOffsetX = 0, snapOffsetY = 0) {
     this.snapX = snapX;
     this.snapY = snapY;
@@ -728,11 +919,17 @@ export class InputHandler {
     this.snapOnRelease = onRelease;
   }
 
+  /**
+   * TBD.
+   */
   disableSnap() {
     this.snapOnDrag = false;
     this.snapOnRelease = false;
   }
 
+  /**
+   * TBD.
+   */
   checkBoundsRect() {
     if (this.sprite.left < this.boundsRect.left) {
       this.sprite.x = this.boundsRect.x + this.sprite.offsetX;
@@ -746,6 +943,9 @@ export class InputHandler {
     }
   }
 
+  /**
+   * TBD.
+   */
   checkBoundsSprite() {
     if (this.sprite.left < this.boundsSprite.left) {
       this.sprite.x = this.boundsSprite.left + this.sprite.offsetX;