@ue-too/board 0.12.0 → 0.13.0

package/input-interpretation/input-orchestrator.d.ts

@@ -101,6 +101,7 @@ export declare class InputOrchestrator {
      * ```
      */
     processInputEventOutput(output: any): void;
+    processInputEvent(input: OutputEvent): void;
     /**
      * Type guard to check if an output value is a valid OutputEvent.
      *

package/input-interpretation/input-state-machine/kmt-input-context.d.ts

@@ -116,6 +116,17 @@ export declare class CanvasCacheInWebWorker implements Canvas {
     setCursor(style: "grab" | "default" | "grabbing"): void;
     get detached(): boolean;
 }
+/**
+ * A proxy for the canvas element to prevent constant invoking of the getBoundingClientRect method.
+ * @remarks This is mainly used as a proxy to the canvas to prevent invoking the getBoundingClientRect method on the canvas every time a pointer event is triggered or a coordinate conversion is needed. Also to autoscale the canvas buffer depending on the device pixel ratio. It's important to note that in normal circumstances, you would not need to set the size of the canvas manually; you should use the css style width and height to set the size of the canvas.
+ * @category Input State Machine
+ * @see {@link Canvas} for the interface that this class implements
+ * @see {@link Observable} for the observable that this class emits
+ * @see {@link Observer} for the observer that can subscribe to the observable
+ * @see {@link SubscriptionOptions} for the options that can be passed to the subscribe method
+ * @see {@link SynchronousObservable} for the synchronous observable that this class emits
+ * @see {@link CanvasPositionDimensionPublisher} for the publisher that is used to publish the canvas dimensions
+ */
 export declare class CanvasProxy implements Canvas, Observable<[CanvasDimensions]> {
     private _width;
     private _height;
@@ -138,11 +149,13 @@ export declare class CanvasProxy implements Canvas, Observable<[CanvasDimensions
      * the width is synonymous with the canvas style width not the canvas width
      */
     setWidth(width: number): void;
+    setCanvasWidth(width: number): void;
     /**
      * set the height of the canvas
      * the height is synonymous with the canvas style height not the canvas height
      */
     setHeight(height: number): void;
+    setCanvasHeight(height: number): void;
     get height(): number;
     get position(): Point;
     setCursor(style: "grab" | "default" | "grabbing"): void;
@@ -231,7 +244,7 @@ export declare class WorkerRelayCanvas implements Canvas {
  * - `true`: Standard screen coordinates (Y increases downward)
  * - `false`: Inverted coordinates (Y increases upward)
  *
- * This interface extends BaseContext from the @ue-too/being state machine library,
+ * This interface extends BaseContext from the \@ue-too/being state machine library,
  * inheriting setup() and cleanup() lifecycle methods.
  *
  * @category Input State Machine
@@ -332,9 +345,11 @@ export declare class ObservableInputTracker implements KmtInputContext {
     private _initialCursorPosition;
     private _kmtTrackpadTrackScore;
     private _mode;
+    private _deciding;
     constructor(canvasOperator: Canvas);
     get mode(): 'kmt' | 'trackpad' | 'TBD';
     setMode(mode: 'kmt' | 'trackpad' | 'TBD'): void;
+    enableInputModeDetection(): void;
     get kmtTrackpadTrackScore(): number;
     subtractKmtTrackpadTrackScore(): void;
     addKmtTrackpadTrackScore(): void;

package/input-interpretation/input-state-machine/kmt-input-state-machine.d.ts

@@ -1,6 +1,6 @@
 import { EventReactions, EventGuards, Guard, TemplateState, TemplateStateMachine, EventArgs, EventResult, CreateStateType } from "@ue-too/being";
 import type { Point } from "@ue-too/math";
-import { CursorStyle, KmtInputContext } from "./kmt-input-context";
+import { Canvas, CursorStyle, KmtInputContext } from "./kmt-input-context";
 declare const KMT_INPUT_STATES: readonly ["IDLE", "READY_TO_PAN_VIA_SPACEBAR", "READY_TO_PAN_VIA_SCROLL_WHEEL", "PAN", "INITIAL_PAN", "PAN_VIA_SCROLL_WHEEL", "DISABLED"];
 /**
  * Possible states of the Keyboard/Mouse/Trackpad input state machine.
@@ -185,7 +185,6 @@ export declare class KmtIdleState extends TemplateState<KmtInputEventMapping, Km
     scrollZoom: (context: KmtInputContext, payload: ScrollWithCtrlEventPayload) => KmtOutputEvent;
     scrollHandler: (context: KmtInputContext, payload: ScrollWithCtrlEventPayload) => KmtOutputEvent;
     scrollWithCtrlHandler: (context: KmtInputContext, payload: ScrollWithCtrlEventPayload) => KmtOutputEvent;
-    get eventReactions(): EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
     protected _eventReactions: EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
     uponEnter(context: KmtInputContext): void;
     spacebarDownHandler(context: KmtInputContext, payload: EmptyPayload): number;
@@ -195,7 +194,7 @@ export declare class DisabledState extends TemplateState<KmtInputEventMapping, K
     constructor();
     uponEnter(context: KmtInputContext): void;
     beforeExit(context: KmtInputContext): void;
-    get eventReactions(): EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
+    protected _eventReactions: EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
 }
 /**
  * @description The ready to pan via space bar state of the keyboard mouse and trackpad input state machine.
@@ -206,7 +205,6 @@ export declare class ReadyToPanViaSpaceBarState extends TemplateState<KmtInputEv
     constructor();
     protected _eventReactions: EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
     uponEnter(context: KmtInputContext): void;
-    get eventReactions(): EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
     leftPointerDownHandler(context: KmtInputContext, payload: PointerEventPayload): void;
 }
 /**
@@ -217,7 +215,6 @@ export declare class ReadyToPanViaSpaceBarState extends TemplateState<KmtInputEv
 export declare class InitialPanState extends TemplateState<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping> {
     constructor();
     protected _eventReactions: EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
-    get eventReactions(): EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
     uponEnter(context: KmtInputContext): void;
     leftPointerMoveHandler(context: KmtInputContext, payload: PointerEventPayload): KmtOutputEvent;
 }
@@ -229,7 +226,6 @@ export declare class InitialPanState extends TemplateState<KmtInputEventMapping,
 export declare class ReadyToPanViaScrollWheelState extends TemplateState<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping> {
     constructor();
     protected _eventReactions: EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
-    get eventReactions(): EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
     uponEnter(context: KmtInputContext): void;
 }
 /**
@@ -240,7 +236,6 @@ export declare class ReadyToPanViaScrollWheelState extends TemplateState<KmtInpu
 export declare class PanState extends TemplateState<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping> {
     constructor();
     protected _eventReactions: EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
-    get eventReactions(): EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
     uponEnter(context: KmtInputContext): void;
     beforeExit(context: KmtInputContext): void;
     leftPointerMoveHandler(context: KmtInputContext, payload: PointerEventPayload): KmtOutputEvent;
@@ -252,13 +247,11 @@ export declare class PanState extends TemplateState<KmtInputEventMapping, KmtInp
  */
 export declare class PanViaScrollWheelState extends TemplateState<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping> {
     protected _eventReactions: EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
-    get eventReactions(): EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
     middlePointerMoveHandler(context: KmtInputContext, payload: PointerEventPayload): KmtOutputEvent;
     uponEnter(context: KmtInputContext): void;
 }
 export declare class KmtEmptyState extends TemplateState<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping> {
     constructor();
-    get eventReactions(): EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>;
 }
 /**
  * Type alias for the KMT input state machine.
@@ -313,6 +306,7 @@ export type KmtInputStateMachine = TemplateStateMachine<KmtInputEventMapping, Km
  * ```
  */
 export declare function createKmtInputStateMachine(context: KmtInputContext): KmtInputStateMachine;
+export declare function createKmtInputStateMachineWithCanvas(canvas: Canvas): KmtInputStateMachine;
 export declare class KmtInputStateMachineWebWorkerProxy extends TemplateStateMachine<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping> {
     private _webworker;
     constructor(webworker: Worker);

package/input-interpretation/input-state-machine/touch-input-state-machine.d.ts

@@ -99,10 +99,9 @@ export type TouchInputEventOutputMapping = {
  * @category Input State Machine - Touch
  */
 export declare class IdleState extends TemplateState<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping> {
-    private _eventReactions;
+    protected _eventReactions: EventReactions<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping>;
     protected _guards: Guard<TouchContext, "touchPointsCount">;
     protected _eventGuards: Partial<EventGuards<TouchEventMapping, TouchStates, TouchContext, typeof this._guards>>;
-    get eventReactions(): EventReactions<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping>;
     touchstart(context: TouchContext, payload: TouchEventPayload): void;
     touchend(context: TouchContext, payload: TouchEventPayload): void;
 }
@@ -112,8 +111,7 @@ export declare class IdleState extends TemplateState<TouchEventMapping, TouchCon
  * @category Input State Machine
  */
 export declare class PendingState extends TemplateState<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping> {
-    private _eventReactions;
-    get eventReactions(): EventReactions<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping>;
+    protected _eventReactions: EventReactions<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping>;
     touchstart(context: TouchContext, payload: TouchEventPayload): void;
     touchend(context: TouchContext, payload: TouchEventPayload): void;
     touchmove(context: TouchContext, payload: TouchEventPayload): TouchOutputEvent;
@@ -124,8 +122,7 @@ export declare class PendingState extends TemplateState<TouchEventMapping, Touch
  * @category Input State Machine
  */
 export declare class InProgressState extends TemplateState<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping> {
-    private _eventReactions;
-    get eventReactions(): EventReactions<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping>;
+    protected _eventReactions: EventReactions<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping>;
     touchmove(context: TouchContext, payload: TouchEventPayload): TouchOutputEvent;
     touchend(context: TouchContext, payload: TouchEventPayload): void;
 }

package/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.d.ts

@@ -19,10 +19,10 @@ export interface KMTEventParser {
     tearDown(): void;
     /** Attaches to a new canvas element */
     attach(canvas: HTMLCanvasElement): void;
-    /** The state machine that processes parsed events */
-    stateMachine: KmtInputStateMachine;
-    /** The orchestrator that handles state machine outputs */
-    orchestrator: InputOrchestrator;
+    /** Disables the parser; the event listeners are still attached just not processing any events*/
+    disable(): void;
+    /** Enables the parser */
+    enable(): void;
 }
 /**
  * Minimal pointer event interface for framework interoperability.
@@ -156,9 +156,8 @@ export declare class VanillaKMTEventParser implements KMTEventParser {
     private _canvas?;
     constructor(kmtInputStateMachine: KmtInputStateMachine, orchestrator: InputOrchestrator, canvas?: HTMLCanvasElement | SVGSVGElement);
     get disabled(): boolean;
-    set disabled(value: boolean);
-    get stateMachine(): KmtInputStateMachine;
-    get orchestrator(): InputOrchestrator;
+    disable(): void;
+    enable(): void;
     addEventListeners(signal: AbortSignal): void;
     setUp(): void;
     tearDown(): void;

package/input-interpretation/raw-input-parser/vanilla-touch-event-parser.d.ts

@@ -12,22 +12,16 @@ import type { InputOrchestrator } from "../input-orchestrator";
 export interface TouchEventParser {
     /** Whether all touch input is disabled */
     disabled: boolean;
-    /** Whether pan gestures are disabled */
-    panDisabled: boolean;
-    /** Whether zoom gestures are disabled */
-    zoomDisabled: boolean;
-    /** Whether rotation gestures are disabled (currently unused) */
-    rotateDisabled: boolean;
     /** Initializes event listeners */
     setUp(): void;
     /** Removes event listeners and cleans up */
     tearDown(): void;
     /** Attaches to a new canvas element */
     attach(canvas: HTMLCanvasElement): void;
-    /** The state machine that processes parsed events */
-    stateMachine: TouchInputStateMachine;
-    /** The orchestrator that handles state machine outputs */
-    orchestrator: InputOrchestrator;
+    /** Disables the parser; the event listeners are still attached just not processing any events*/
+    disable(): void;
+    /** Enables the parser */
+    enable(): void;
 }
 /**
  * DOM event parser for touch input.
@@ -88,22 +82,16 @@ export declare class VanillaTouchEventParser implements TouchEventParser {
     private _stateMachine;
     private _orchestrator;
     private _abortController;
-    constructor(touchInputStateMachine: TouchInputStateMachine, orchestrator: InputOrchestrator, canvas?: HTMLCanvasElement);
-    get stateMachine(): TouchInputStateMachine;
+    constructor(touchInputStateMachine: TouchInputStateMachine, orchestrator: InputOrchestrator, canvas?: HTMLCanvasElement | SVGSVGElement);
     get orchestrator(): InputOrchestrator;
-    get touchStateMachine(): TouchInputStateMachine;
     bindListeners(): void;
     enableStrategy(): void;
     disableStrategy(): void;
     setUp(): void;
     tearDown(): void;
     get disabled(): boolean;
-    get panDisabled(): boolean;
-    set panDisabled(panDisabled: boolean);
-    get zoomDisabled(): boolean;
-    set zoomDisabled(zoomDisabled: boolean);
-    get rotateDisabled(): boolean;
-    set rotateDisabled(rotateDisabled: boolean);
+    disable(): void;
+    enable(): void;
     private processEvent;
     touchstartHandler(e: TouchEvent): void;
     touchcancelHandler(e: TouchEvent): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ue-too/board",
   "type": "module",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "exports": {
     ".": {
       "types": "./index.d.ts",
@@ -14,8 +14,8 @@
   "types": "./index.d.ts",
   "module": "./index.js",
   "dependencies": {
-    "@ue-too/being": "^0.12.0",
-    "@ue-too/math": "^0.12.0"
+    "@ue-too/being": "^0.13.0",
+    "@ue-too/math": "^0.13.0"
   },
   "repository": {
     "type": "git",

package/utils/canvas-position-dimension.d.ts

@@ -143,6 +143,8 @@ export declare class CanvasPositionDimensionPublisher {
     private scrollHandler?;
     private resizeHandler?;
     private _observers;
+    private _abortController;
+    private _pixelRatioAbortController;
     /**
      * Creates a new Canvas position/dimension publisher.
      *