uē-tôo

Appearance

@ue-too/board / InitialPanState

Class: InitialPanState ​

Defined in: packages/board/src/input-interpretation/input-state-machine/kmt-input-state-machine.ts:453

Description ​

The initial pan state of the keyboard mouse and trackpad input state machine.

Extends ​

Constructors ​

Constructor ​

new InitialPanState(): InitialPanState

Defined in: packages/board/src/input-interpretation/input-state-machine/kmt-input-state-machine.ts:459

Returns ​

InitialPanState

Overrides ​

TemplateState< KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping >.constructor

Properties ​

_defer ​

protected _defer: Defer<KmtInputContext, KmtInputEventMapping, "IDLE" | "READY_TO_PAN_VIA_SPACEBAR" | "READY_TO_PAN_VIA_SCROLL_WHEEL" | "PAN" | "INITIAL_PAN" | "PAN_VIA_SCROLL_WHEEL" | "DISABLED", KmtInputEventOutputMapping> | undefined

Defined in: packages/being/dist/interface.d.ts:492

Inherited from ​

TemplateState._defer

_delay ​

protected _delay: Delay<KmtInputContext, KmtInputEventMapping, "IDLE" | "READY_TO_PAN_VIA_SPACEBAR" | "READY_TO_PAN_VIA_SCROLL_WHEEL" | "PAN" | "INITIAL_PAN" | "PAN_VIA_SCROLL_WHEEL" | "DISABLED", KmtInputEventOutputMapping> | undefined

Defined in: packages/being/dist/interface.d.ts:491

Inherited from ​

TemplateState._delay

_eventGuards ​

protected _eventGuards: Partial<EventGuards<EventPayloadMapping, States, Context, Guard<Context>>>

Defined in: packages/being/dist/interface.d.ts:490

Inherited from ​

TemplateState._eventGuards

_eventReactions ​

protected _eventReactions: EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates, KmtInputEventOutputMapping>

Defined in: packages/board/src/input-interpretation/input-state-machine/kmt-input-state-machine.ts:463

Overrides ​

TemplateState._eventReactions

_guards ​

protected _guards: Guard<Context>

Defined in: packages/being/dist/interface.d.ts:489

Inherited from ​

TemplateState._guards

Accessors ​

delay ​

Get Signature ​

get delay(): Delay<Context, EventPayloadMapping, States, EventOutputMapping> | undefined

Defined in: packages/being/dist/interface.d.ts:497

Returns ​

Delay<Context, EventPayloadMapping, States, EventOutputMapping> | undefined

Inherited from ​

TemplateState.delay

eventGuards ​

Get Signature ​

get eventGuards(): Partial<EventGuards<EventPayloadMapping, States, Context, Guard<Context>>>

Defined in: packages/being/dist/interface.d.ts:495

Returns ​

Partial<EventGuards<EventPayloadMapping, States, Context, Guard<Context>>>

Inherited from ​

TemplateState.eventGuards

eventReactions ​

Get Signature ​

get eventReactions(): EventReactions<EventPayloadMapping, Context, States, EventOutputMapping>

Defined in: packages/being/dist/interface.d.ts:496

Returns ​

EventReactions<EventPayloadMapping, Context, States, EventOutputMapping>

Inherited from ​

TemplateState.eventReactions

guards ​

Get Signature ​

get guards(): Guard<Context>

Defined in: packages/being/dist/interface.d.ts:494

Returns ​

Guard<Context>

Inherited from ​

TemplateState.guards

handlingEvents ​

Get Signature ​

get handlingEvents(): keyof EventPayloadMapping[]

Defined in: packages/being/dist/interface.d.ts:493

Returns ​

keyof EventPayloadMapping[]

Inherited from ​

TemplateState.handlingEvents

Methods ​

beforeExit() ​

beforeExit(context, stateMachine, to): void

Defined in: packages/being/dist/interface.d.ts:499

Parameters ​

context ​

KmtInputContext

stateMachine ​

StateMachine<KmtInputEventMapping, KmtInputContext, "IDLE" | "READY_TO_PAN_VIA_SPACEBAR" | "READY_TO_PAN_VIA_SCROLL_WHEEL" | "PAN" | "INITIAL_PAN" | "PAN_VIA_SCROLL_WHEEL" | "DISABLED", KmtInputEventOutputMapping>

to ​

"TERMINAL" | "IDLE" | "READY_TO_PAN_VIA_SPACEBAR" | "READY_TO_PAN_VIA_SCROLL_WHEEL" | "PAN" | "INITIAL_PAN" | "PAN_VIA_SCROLL_WHEEL" | "DISABLED"

Returns ​

void

Inherited from ​

TemplateState.beforeExit

handles() ​

handles<K>(args, context, stateMachine): EventResult<"IDLE" | "READY_TO_PAN_VIA_SPACEBAR" | "READY_TO_PAN_VIA_SCROLL_WHEEL" | "PAN" | "INITIAL_PAN" | "PAN_VIA_SCROLL_WHEEL" | "DISABLED", K extends keyof KmtInputEventOutputMapping ? KmtInputEventOutputMapping[K<K>] : void>

Defined in: packages/being/dist/interface.d.ts:500

Type Parameters ​

K ​

K extends string

Parameters ​

args ​

EventArgs<KmtInputEventMapping, K>

context ​

KmtInputContext

stateMachine ​

StateMachine<KmtInputEventMapping, KmtInputContext, "IDLE" | "READY_TO_PAN_VIA_SPACEBAR" | "READY_TO_PAN_VIA_SCROLL_WHEEL" | "PAN" | "INITIAL_PAN" | "PAN_VIA_SCROLL_WHEEL" | "DISABLED", KmtInputEventOutputMapping>

Returns ​

EventResult<"IDLE" | "READY_TO_PAN_VIA_SPACEBAR" | "READY_TO_PAN_VIA_SCROLL_WHEEL" | "PAN" | "INITIAL_PAN" | "PAN_VIA_SCROLL_WHEEL" | "DISABLED", K extends keyof KmtInputEventOutputMapping ? KmtInputEventOutputMapping[K<K>] : void>

Inherited from ​

TemplateState.handles

leftPointerMoveHandler() ​

leftPointerMoveHandler(context, payload): KmtOutputEvent

Defined in: packages/board/src/input-interpretation/input-state-machine/kmt-input-state-machine.ts:491

Parameters ​

context ​

KmtInputContext

payload ​

PointerEventPayload

Returns ​

KmtOutputEvent

uponEnter() ​

uponEnter(context): void

Defined in: packages/board/src/input-interpretation/input-state-machine/kmt-input-state-machine.ts:487

Parameters ​

context ​

KmtInputContext

Returns ​

void

Overrides ​

TemplateState.uponEnter