@ue-too/board / index / VanillaKMTEventParser

Class: VanillaKMTEventParser

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:174

Interface for KMT (Keyboard/Mouse/Trackpad) event parsers.

Remarks

Event parsers bridge the gap between DOM events and the state machine. They listen for raw DOM events, convert them to state machine events, and coordinate with the orchestrator for output processing.

Implements

• KMTEventParser

Constructors

Constructor

new VanillaKMTEventParser(kmtInputStateMachine, orchestrator, canvas?): VanillaKMTEventParser

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:182

Parameters

kmtInputStateMachine

StateMachine

orchestrator

InputOrchestrator

canvas?

HTMLCanvasElement | SVGSVGElement

Returns

VanillaKMTEventParser

Properties

_canvas?

protected optional _canvas: HTMLCanvasElement | SVGSVGElement

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:180

Accessors

disabled

Get Signature

get disabled(): boolean

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:195

Whether the parser is currently disabled

Returns

boolean

Whether the parser is currently disabled

Implementation of

KMTEventParser.disabled

---

stateMachine

Get Signature

get stateMachine(): StateMachine

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:394

The state machine this parser dispatches into, when the implementation exposes one. Optional so existing external parser implementations remain valid — typed to the minimal { happens } contract this parser itself needs, so an external implementation satisfies this member without providing a full being StateMachine. Intended for tooling/introspection — dispatch through the parser, not through this reference.

Returns

StateMachine

Set Signature

set stateMachine(stateMachine): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:398

The state machine this parser dispatches into, when the implementation exposes one. Optional so existing external parser implementations remain valid — typed to the minimal { happens } contract this parser itself needs, so an external implementation satisfies this member without providing a full being StateMachine. Intended for tooling/introspection — dispatch through the parser, not through this reference.

Parameters

stateMachine

StateMachine

Returns

void

The state machine this parser dispatches into, when the implementation exposes one. Optional so existing external parser implementations remain valid — typed to the minimal { happens } contract this parser itself needs, so an external implementation satisfies this member without providing a full being StateMachine. Intended for tooling/introspection — dispatch through the parser, not through this reference.

Implementation of

KMTEventParser.stateMachine

Methods

addEventListeners()

addEventListeners(signal): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:207

Parameters

signal

AbortSignal

Returns

void

---

attach()

attach(canvas): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:388

Attaches to a new canvas element

Parameters

canvas

HTMLCanvasElement

Returns

void

Implementation of

KMTEventParser.attach

---

bindFunctions()

bindFunctions(): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:248

Returns

void

---

disable()

disable(): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:199

Disables the parser; the event listeners are still attached just not processing any events

Returns

void

Implementation of

KMTEventParser.disable

---

enable()

enable(): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:203

Enables the parser

Returns

void

Implementation of

KMTEventParser.enable

---

keypressHandler()

keypressHandler(e): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:348

Parameters

e

KeyboardEvent

Returns

void

---

keyupHandler()

keyupHandler(e): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:379

Parameters

e

KeyboardEvent

Returns

void

---

pointerDownHandler()

pointerDownHandler(e): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:270

Parameters

e

PointerEvent

Returns

void

---

pointerMoveHandler()

pointerMoveHandler(e): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:307

Parameters

e

PointerEvent

Returns

void

---

pointerUpHandler()

pointerUpHandler(e): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:290

Parameters

e

PointerEvent

Returns

void

---

processEvent()

protected processEvent<K>(...args): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:257

Type Parameters

K

K extends keyof KmtInputEventMapping

Parameters

args

...EventArgs<KmtInputEventMapping, K>

Returns

void

---

scrollHandler()

scrollHandler(e): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:328

Parameters

e

WheelEvent

Returns

void

---

setUp()

setUp(): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:235

Initializes event listeners

Returns

void

Implementation of

KMTEventParser.setUp

---

tearDown()

tearDown(): void

Defined in: packages/board/src/input-interpretation/raw-input-parser/vanilla-kmt-event-parser.ts:242

Removes event listeners and cleans up

Returns

void

Implementation of

KMTEventParser.tearDown