Class InputSource<T>`Alpha`

The base class for all input devices.

Template: T

The shape of the input source.

Type Parameters

T extends Record<string, number[]>
The shape of the input source.

Hierarchy (View Summary)

InputFrame
- InputSource

Index

Constructors

Properties

_element deltas

Methods

attach destroy detach fire off on read

Constructors

constructor

new InputSource<T extends Record<string, number[]>>(data: T): InputSource<T>
Alpha
Type Parameters
- T extends Record<string, number[]>
  The shape of the input source.
Parameters
- data: T
  The input frame data, where each key corresponds to an input delta.
Returns InputSource<T>
Inherited from InputFrame.constructor
- Defined in extras/input/input.js:112

Properties

`Protected` `Alpha`_element

_element: HTMLElement | null = null

`Alpha`deltas

deltas: { [K in string | number | symbol]: InputDelta } = ...

Methods

attach

attach(element: HTMLElement): void
Alpha
Parameters
- element: HTMLElement
  The element.
Returns void
- Defined in extras/input/input.js:188

destroy

destroy(): void
Alpha
Returns void
- Defined in extras/input/input.js:203

detach

detach(): void
Alpha
Returns void
- Defined in extras/input/input.js:195

fire

fire(event: string, ...args: any[]): void
Alpha
Fires an event with the given name and arguments.
Parameters
- event: string
  The event name to fire.
- ...args: any[]
  The arguments to pass to the event listeners.
Returns void
- Defined in extras/input/input.js:181

off

off(event: string, callback: HandleEventCallback): void
Alpha
Removes an event listener for the specified event.
Parameters
- event: string
  The event name to stop listening for.
- callback: HandleEventCallback
  The callback function to remove.
Returns void
- Defined in extras/input/input.js:171

on

on(event: string, callback: HandleEventCallback): void
Alpha
Adds an event listener for the specified event.
Parameters
- event: string
  The event name to listen for.
- callback: HandleEventCallback
  The callback function to execute when the event is triggered.
Returns void
- Defined in extras/input/input.js:161

read

read(): { [K in string | number | symbol]: number[] }
Alpha
Returns the current frame state and resets the deltas to zero.

Returns { [K in string | number | symbol]: number[] }
- The flushed input frame with current deltas.
Inherited from InputFrame.read
- Defined in extras/input/input.js:123