@woosh/meep-engine 2.109.26 → 2.110.0

package/src/engine/input/devices/PointerDevice.js

@@ -3,88 +3,12 @@ import Signal from "../../../core/events/signal/Signal.js";
 import Vector2 from "../../../core/geom/Vector2.js";
 import Vector3 from "../../../core/geom/Vector3.js";
 import { sign } from "../../../core/math/sign.js";
-import { eventToSourceIdentifier } from "./events/eventToSourceIdentifier.js";
+import { current_time_in_seconds } from "../../../core/time/current_time_in_seconds.js";
 import { MouseEvents } from "./events/MouseEvents.js";
-import { TouchEvents } from "./events/TouchEvents.js";
+import { PointerEvents } from "./events/PointerEvents.js";
 import { InputDeviceSwitch } from "./InputDeviceSwitch.js";
 import { LocationalInteractionMetadata } from "./LocationalInteractionMetadata.js";
-
-/**
- * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
- * @see https://w3c.github.io/uievents/#widl-MouseEvent-buttons
- *
- * @param {Number} value
- * @return {boolean[]} array of booleans, boolean is true if mouse button is pressed, false otherwise
- */
-export function decodeMouseEventButtons(value) {
-    const result = [];
-
-    for (let i = 0; i < 32; i++) {
-
-        const shiftedValue = value >> i;
-
-        result[i] = (shiftedValue & 1) !== 0;
-    }
-
-    return result;
-}
-
-/**
- * Prevent default context menu from showing up
- * @param {Event} event
- */
-function supressContextMenu(event) {
-    event.preventDefault();
-    event.stopPropagation();
-
-    return false;
-}
-
-/**
- *
- * @param {TouchList} touchList
- * @param {function(Touch,number)} callback
- */
-function forEachTouch(touchList, callback) {
-    const length = touchList.length;
-    for (let i = 0; i < length; i++) {
-        const touch = touchList.item(i);
-        callback(touch, i);
-    }
-}
-
-/**
- *
- * @param {TouchList} touchList
- * @param {Vector2} result
- */
-function getTouchCenter(touchList, result) {
-    const length = touchList.length;
-
-    let x = 0, y = 0;
-
-    if (length > 0) {
-
-        for (let i = 0; i < length; i++) {
-            const touch = touchList.item(i);
-
-            if (touch === null) {
-                continue;
-            }
-
-            x += touch.clientX;
-            y += touch.clientY;
-        }
-
-        // average to get center
-        x /= length;
-        y /= length;
-
-    }
-
-    result.set(x, y);
-
-}
+import { suppressContextMenu } from "./mouse/suppressContextMenu.js";
 
 
 /**
@@ -92,16 +16,18 @@ function getTouchCenter(touchList, result) {
  * @param {Signal} up
  * @param {Signal} down
  * @param {Signal} move
- * @param {number} maxDistance
+ * @param {number} [maxDistance] in pixels
+ * @param {number} [maxDelay] Maximum delay between down and up events in seconds
  * @param {Signal} signal
  */
-function observeTap(
-    up,
-    down,
-    move,
-    maxDistance,
-    signal
-) {
+function observeTap({
+                        up,
+                        down,
+                        move = new Signal(),
+                        maxDistance = 10,
+                        maxDelay = 1,
+                        signal
+                    }) {
 
     /**
      *
@@ -116,7 +42,8 @@ function observeTap(
     function reset(id) {
         assert.isNonNegativeInteger(id, 'id');
 
-        if (active.delete(id)) {
+        const deleted = active.delete(id);
+        if (deleted) {
             up.remove(handleUp);
             move.remove(handleMove);
         }
@@ -125,10 +52,10 @@ function observeTap(
     /**
      *
      * @param {Vector2} position
-     * @param {MouseEvent|TouchEvent} event
+     * @param {PointerEvent} event
      */
     function handleUp(position, event) {
-        const id = eventToSourceIdentifier(event);
+        const id = event.pointerId;
 
         const meta = active.get(id);
 
@@ -140,16 +67,25 @@ function observeTap(
 
         reset(id);
 
+        const time_now = current_time_in_seconds();
+
+        const delay = time_now - meta.timestamp;
+
+        if (delay > maxDelay) {
+            // too much time has passed, swallow event
+            return;
+        }
+
         signal.send2(position, event);
     }
 
     /**
      *
      * @param {Vector2} position
-     * @param {MouseEvent|TouchEvent} event
+     * @param {PointerEvent} event
      */
     function handleMove(position, event) {
-        const id = eventToSourceIdentifier(event);
+        const id = event.pointerId;
 
         const meta = active.get(id);
 
@@ -172,10 +108,10 @@ function observeTap(
     /**
      *
      * @param {Vector2} position
-     * @param {TouchEvent|MouseEvent} event
+     * @param {PointerEvent} event
      */
     function handleDown(position, event) {
-        const id = eventToSourceIdentifier(event);
+        const id = event.pointerId;
 
         // make sure to cancel previous pending resolution
         reset(id);
@@ -191,119 +127,6 @@ function observeTap(
     down.add(handleDown);
 }
 
-/**
- *
- * @param {Signal} touchStart
- * @param {Signal} touchEnd
- * @param {Signal} touchMove
- * @param {Signal} pinch
- * @param {Signal} pinchStart
- * @param {Signal} pinchEnd
- * @param {PointerDevice} device
- */
-function observePinch({
-                          touchStart,
-                          touchEnd,
-                          touchMove,
-                          pinch,
-                          pinchStart,
-                          pinchEnd,
-                          device
-                      }) {
-    const center = new Vector2();
-
-    const v2 = new Vector2();
-
-    const pinchBox0 = new Vector2();
-    const pinchBox1 = new Vector2();
-
-    let pinchActive = false;
-    let touchCount = 0;
-
-
-    /**
-     *
-     * @param {TouchList} touchList
-     * @param {Vector2} pinchDimensions
-     */
-    function computeTouchRadius(touchList, pinchDimensions) {
-        getTouchCenter(touchList, center);
-
-        const length = touchList.length;
-
-        pinchDimensions.set(0, 0);
-
-        for (let i = 0; i < length; i++) {
-            const touch = touchList.item(i);
-
-            device.readPointerPositionFromEvent(v2, touch);
-
-            v2.sub(center);
-            v2.abs();
-
-            pinchDimensions.add(v2);
-        }
-
-        return pinchDimensions.multiplyScalar(1 / length);
-    }
-
-    function touchRemoved(touch, event) {
-        touchCount--;
-        if (touchCount < 2 && pinchActive) {
-            handlePinchEnd(event);
-        }
-    }
-
-    function touchAdded(touch, event) {
-        touchCount++;
-        if (touchCount > 1 && !pinchActive) {
-            handlePinchStart(event);
-        }
-    }
-
-    function handlePinchStart(event) {
-        pinchActive = true;
-
-        computeTouchRadius(event.touches, pinchBox0);
-
-        touchMove.add(handleMove);
-
-        pinchStart.send1(pinchBox0);
-    }
-
-    /**
-     *
-     * @param {TouchEvent} event
-     */
-    function handlePinchEnd(event) {
-        pinchActive = false;
-
-        touchMove.remove(handleMove);
-
-        pinchEnd.send0();
-    }
-
-    function handleDown(position, event) {
-        forEachTouch(event.changedTouches, function (touch) {
-            touchAdded(touch, event);
-        });
-    }
-
-    function handleUp(position, event) {
-        forEachTouch(event.changedTouches, function (touch) {
-            touchRemoved(touch, event);
-        });
-    }
-
-    function handleMove(position, event) {
-        computeTouchRadius(event.touches, pinchBox1);
-        pinch.send2(pinchBox1, pinchBox0);
-    }
-
-    touchEnd.add(handleUp);
-    touchStart.add(handleDown);
-}
-
 /**
  *
  * @param {Signal} up
@@ -395,18 +218,8 @@ export class PointerDevice {
      */
     position = new Vector2();
 
-    /**
-     * @readonly
-     * @type {Vector2}
-     */
-    #anchor_touch_last = new Vector2();
-
     #globalUp = new Signal();
 
-    #touchStart = new Signal();
-    #touchEnd = new Signal();
-    #touchMove = new Signal();
-
     /**
      * @readonly
      */
@@ -497,41 +310,18 @@ export class PointerDevice {
         this.#domElement = domElement;
 
 
-        this.#touchStart.add(this.on.down.send3, this.on.down);
-
-        this.#touchEnd.add(this.on.up.send3, this.on.up);
-
-        this.#touchMove.add(this.on.move.send3, this.on.move);
-
         //constructed events
-        observeTap(this.on.up, this.on.down, this.on.move, 10, this.on.tap);
+        observeTap({ up: this.on.up, down: this.on.down, move: this.on.move, maxDistance: 10, signal: this.on.tap });
         observeDrag(this.#globalUp, this.on.down, this.on.move, this.on.dragStart, this.on.dragEnd, this.on.drag);
-        observePinch({
-            touchStart: this.#touchStart,
-            touchEnd: this.#touchEnd,
-            touchMove: this.#touchMove,
-            pinch: this.on.pinch,
-            pinchStart: this.on.pinchStart,
-            pinchEnd: this.on.pinchEnd,
-            device: this
-        });
-    }
-
 
-    /**
-     *
-     * @param {TouchEvent} event
-     */
-    #eventHandlerGlobalTouchEnd = (event) => {
-        getTouchCenter(event.touches, this.position);
-        this.#globalUp.send2(this.position, event);
     }
 
+
     /**
      *
-     * @param {MouseEvent} event
+     * @param {PointerEvent} event
      */
-    #eventHandlerMouseDown = (event) => {
+    #eventHandlerPointerDown = (event) => {
         this.readPointerPositionFromEvent(this.position, event);
         this.on.down.send2(this.position, event);
 
@@ -545,9 +335,9 @@ export class PointerDevice {
 
     /**
      *
-     * @param {MouseEvent} event
+     * @param {PointerEvent} event
      */
-    #eventHandlerMouseUp = (event) => {
+    #eventHandlerPointerUp = (event) => {
         this.readPointerPositionFromEvent(this.position, event);
         this.on.up.send2(this.position, event);
     }
@@ -556,7 +346,7 @@ export class PointerDevice {
      *
      * @param {MouseEvent} event
      */
-    #eventHandlerGlobalMouseUp = (event) => {
+    #eventHandlerGlobalPointerUp = (event) => {
         this.readPointerPositionFromEvent(this.position, event);
         this.#globalUp.send2(this.position, event);
 
@@ -568,32 +358,6 @@ export class PointerDevice {
         button?.release();
     }
 
-    /**
-     *
-     * @param {TouchEvent} event
-     */
-    #eventHandlerTouchEnd = (event) => {
-        getTouchCenter(event.touches, this.position);
-        this.#touchEnd.send2(this.position, event);
-    }
-
-    /**
-     *
-     * @param {TouchEvent} event
-     */
-    #eventHandlerTouchMove = (event) => {
-        event.preventDefault();
-
-        getTouchCenter(event.touches, this.position);
-
-        const delta = new Vector2();
-
-        delta.subVectors(this.position, this.#anchor_touch_last);
-
-        this.#touchMove.send3(this.position, event, delta);
-
-        this.#anchor_touch_last.copy(this.position);
-    }
 
     /**
      *
@@ -617,20 +381,9 @@ export class PointerDevice {
 
     /**
      *
-     * @param {TouchEvent} event
+     * @param {PointerEvent} event
      */
-    #eventHandlerTouchStart = (event) => {
-        getTouchCenter(event.touches, this.position);
-        this.#touchStart.send2(this.position, event);
-
-        this.#anchor_touch_last.copy(this.position);
-    }
-
-    /**
-     *
-     * @param {MouseEvent} event
-     */
-    #eventHandlerMouseMove = (event) => {
+    #eventHandlerPointerMove = (event) => {
         event.preventDefault();
 
         this.#target = event.target;
@@ -704,16 +457,11 @@ export class PointerDevice {
         assert.notEqual(domElement, null, "domElement is null");
         assert.notEqual(domElement, undefined, "domElement is undefined");
 
-        domElement.addEventListener(MouseEvents.Move, this.#eventHandlerMouseMove);
-        domElement.addEventListener(MouseEvents.Up, this.#eventHandlerMouseUp);
-        domElement.addEventListener(MouseEvents.Down, this.#eventHandlerMouseDown);
+        domElement.addEventListener(PointerEvents.Move, this.#eventHandlerPointerMove);
+        domElement.addEventListener(PointerEvents.Up, this.#eventHandlerPointerUp);
+        domElement.addEventListener(PointerEvents.Down, this.#eventHandlerPointerDown);
 
-        domElement.addEventListener(TouchEvents.Start, this.#eventHandlerTouchStart);
-        domElement.addEventListener(TouchEvents.End, this.#eventHandlerTouchEnd);
-        domElement.addEventListener(TouchEvents.Move, this.#eventHandlerTouchMove);
-
-        window.addEventListener(MouseEvents.Up, this.#eventHandlerGlobalMouseUp);
-        window.addEventListener(TouchEvents.End, this.#eventHandlerGlobalTouchEnd);
+        window.addEventListener(PointerEvents.Up, this.#eventHandlerGlobalPointerUp);
 
         /*
         In some cases wheel event gets registered as "passive" by default. This interferes with "preventDefault()"
@@ -722,7 +470,7 @@ export class PointerDevice {
         domElement.addEventListener(MouseEvents.Wheel, this.#eventHandlerWheel, { passive: false });
 
 
-        domElement.addEventListener("contextmenu", supressContextMenu);
+        domElement.addEventListener("contextmenu", suppressContextMenu);
     }
 
     stop() {
@@ -737,20 +485,15 @@ export class PointerDevice {
 
         const domElement = this.domElement;
 
-        domElement.removeEventListener(MouseEvents.Move, this.#eventHandlerMouseMove);
-        domElement.removeEventListener(MouseEvents.Up, this.#eventHandlerMouseUp);
-        domElement.removeEventListener(MouseEvents.Down, this.#eventHandlerMouseDown);
-
-        domElement.removeEventListener(TouchEvents.Start, this.#eventHandlerTouchStart);
-        domElement.removeEventListener(TouchEvents.End, this.#eventHandlerTouchEnd);
-        domElement.removeEventListener(TouchEvents.Move, this.#eventHandlerTouchMove);
+        domElement.removeEventListener(PointerEvents.Move, this.#eventHandlerPointerMove);
+        domElement.removeEventListener(PointerEvents.Up, this.#eventHandlerPointerUp);
+        domElement.removeEventListener(PointerEvents.Down, this.#eventHandlerPointerDown);
 
-        window.removeEventListener(MouseEvents.Up, this.#eventHandlerGlobalMouseUp);
-        window.removeEventListener(TouchEvents.End, this.#eventHandlerGlobalTouchEnd);
+        window.removeEventListener(PointerEvents.Up, this.#eventHandlerGlobalPointerUp);
 
         domElement.removeEventListener(MouseEvents.Wheel, this.#eventHandlerWheel);
 
 
-        domElement.removeEventListener("contextmenu", supressContextMenu);
+        domElement.removeEventListener("contextmenu", suppressContextMenu);
     }
 }

package/src/engine/input/devices/events/PointerEvents.d.ts

@@ -0,0 +1,14 @@
+export type PointerEvents = string;
+export namespace PointerEvents {
+    let Up: string;
+    let Down: string;
+    let Move: string;
+    let Over: string;
+    let Out: string;
+    let Enter: string;
+    let Leave: string;
+    let Cancel: string;
+    let GotCapture: string;
+    let LostCapture: string;
+}
+//# sourceMappingURL=PointerEvents.d.ts.map

package/src/engine/input/devices/events/PointerEvents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PointerEvents.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/input/devices/events/PointerEvents.js"],"names":[],"mappings":"4BAEU,MAAM"}

package/src/engine/input/devices/events/PointerEvents.js

@@ -0,0 +1,16 @@
+/**
+ *
+ * @enum {string}
+ */
+export const PointerEvents = {
+    Up: "pointerup",
+    Down: "pointerdown",
+    Move: "pointermove",
+    Over: "pointerover",
+    Out: "pointerout",
+    Enter: "pointerenter",
+    Leave: "pointerleave",
+    Cancel: "pointercancel",
+    GotCapture: "gotpointercapture",
+    LostCapture: "lostpointercapture"
+};

package/src/engine/input/devices/mouse/decodeMouseEventButtons.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
+ * @see https://w3c.github.io/uievents/#widl-MouseEvent-buttons
+ *
+ * @param {Number} value
+ * @param {boolean[]} [result]
+ * @return {boolean[]} array of booleans, boolean is true if mouse button is pressed, false otherwise
+ */
+export function decodeMouseEventButtons(value: number, result?: boolean[]): boolean[];
+//# sourceMappingURL=decodeMouseEventButtons.d.ts.map

package/src/engine/input/devices/mouse/decodeMouseEventButtons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decodeMouseEventButtons.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/input/devices/mouse/decodeMouseEventButtons.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,gEAHW,OAAO,EAAE,GACR,OAAO,EAAE,CAYpB"}

package/src/engine/input/devices/mouse/decodeMouseEventButtons.js

@@ -0,0 +1,19 @@
+/**
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
+ * @see https://w3c.github.io/uievents/#widl-MouseEvent-buttons
+ *
+ * @param {Number} value
+ * @param {boolean[]} [result]
+ * @return {boolean[]} array of booleans, boolean is true if mouse button is pressed, false otherwise
+ */
+export function decodeMouseEventButtons(value, result = []) {
+
+    for (let i = 0; i < 32; i++) {
+
+        const shiftedValue = value >> i;
+
+        result[i] = (shiftedValue & 1) !== 0;
+    }
+
+    return result;
+}

package/src/engine/input/devices/mouse/suppressContextMenu.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Prevent default context menu from showing up
+ * @param {Event} event
+ * @returns {boolean}
+ */
+export function suppressContextMenu(event: Event): boolean;
+//# sourceMappingURL=suppressContextMenu.d.ts.map

package/src/engine/input/devices/mouse/suppressContextMenu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suppressContextMenu.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/input/devices/mouse/suppressContextMenu.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,2CAHW,KAAK,GACH,OAAO,CAOnB"}

package/src/engine/input/devices/mouse/suppressContextMenu.js

@@ -0,0 +1,11 @@
+/**
+ * Prevent default context menu from showing up
+ * @param {Event} event
+ * @returns {boolean}
+ */
+export function suppressContextMenu(event) {
+    event.preventDefault();
+    event.stopPropagation();
+
+    return false;
+}

package/src/engine/input/devices/touch/TouchDevice.d.ts

@@ -0,0 +1,20 @@
+export class TouchDevice {
+    /**
+     * Current live position of the pointer
+     * @readonly
+     * @type {Vector2}
+     */
+    readonly position: Vector2;
+    /**
+     * @readonly
+     */
+    readonly on: {
+        pinch: Signal<any, any, any, any, any, any, any, any>;
+        pinchStart: Signal<any, any, any, any, any, any, any, any>;
+        pinchEnd: Signal<any, any, any, any, any, any, any, any>;
+    };
+    #private;
+}
+import Vector2 from "../../../../core/geom/Vector2.js";
+import Signal from "../../../../core/events/signal/Signal.js";
+//# sourceMappingURL=TouchDevice.d.ts.map

package/src/engine/input/devices/touch/TouchDevice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TouchDevice.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/input/devices/touch/TouchDevice.js"],"names":[],"mappings":"AAKA;IAEI;;;;OAIG;IACH,mBAFU,OAAO,CAEQ;IAezB;;OAEG;IACH;;;;MAIE;;CA4DL;oBA7FmB,kCAAkC;mBADnC,0CAA0C"}