@ue-too/board / index / InitialPanState
Class: InitialPanState
Defined in: packages/board/src/input-interpretation/input-state-machine/kmt-input-state-machine.ts:462
Description
The initial pan state of the keyboard mouse and trackpad input state machine.
Extends
TemplateState<KmtInputEventMapping,KmtInputContext,KmtInputStates,KmtInputEventOutputMapping>
Constructors
Constructor
new InitialPanState():
InitialPanState
Defined in: packages/board/src/input-interpretation/input-state-machine/kmt-input-state-machine.ts:468
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:581
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:580
Inherited from
TemplateState._delay
_eventGuards
protected_eventGuards:Partial<EventGuards<EventPayloadMapping,States,Context,Guard<Context>>>
Defined in: packages/being/dist/interface.d.ts:578
Inherited from
TemplateState._eventGuards
_eventPreconditions
protected_eventPreconditions:Partial<EventPreconditions<EventPayloadMapping,Context,Guard<Context>>>
Defined in: packages/being/dist/interface.d.ts:579
Inherited from
TemplateState._eventPreconditions
_eventReactions
protected_eventReactions:EventReactions<KmtInputEventMapping,KmtInputContext,KmtInputStates,KmtInputEventOutputMapping>
Defined in: packages/board/src/input-interpretation/input-state-machine/kmt-input-state-machine.ts:472
Overrides
TemplateState._eventReactions
_guards
protected_guards:Guard<Context>
Defined in: packages/being/dist/interface.d.ts:577
Inherited from
TemplateState._guards
Accessors
delay
Get Signature
get delay():
Delay<Context,EventPayloadMapping,States,EventOutputMapping> |undefined
Defined in: packages/being/dist/interface.d.ts:587
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:584
Returns
Partial<EventGuards<EventPayloadMapping, States, Context, Guard<Context>>>
Inherited from
TemplateState.eventGuards
eventPreconditions
Get Signature
get eventPreconditions():
Partial<EventPreconditions<EventPayloadMapping,Context,Guard<Context>>>
Defined in: packages/being/dist/interface.d.ts:585
Pre-action vetoes: named guards that must all pass before this state handles an event. Optional so existing State implementations remain valid; TemplateState always provides it.
Returns
Partial<EventPreconditions<EventPayloadMapping, Context, Guard<Context>>>
Inherited from
TemplateState.eventPreconditions
eventReactions
Get Signature
get eventReactions():
EventReactions<EventPayloadMapping,Context,States,EventOutputMapping>
Defined in: packages/being/dist/interface.d.ts:586
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:583
Returns
Guard<Context>
Inherited from
TemplateState.guards
handlingEvents
Get Signature
get handlingEvents(): keyof
EventPayloadMapping[]
Defined in: packages/being/dist/interface.d.ts:582
Returns
keyof EventPayloadMapping[]
Inherited from
TemplateState.handlingEvents
Methods
beforeExit()
beforeExit(
context,stateMachine,to):void
Defined in: packages/being/dist/interface.d.ts:589
Parameters
context
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",Kextends keyofKmtInputEventOutputMapping?KmtInputEventOutputMapping[K<K>] :void>
Defined in: packages/being/dist/interface.d.ts:590
Type Parameters
K
K extends string
Parameters
args
EventArgs<KmtInputEventMapping, K>
context
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:500
Parameters
context
payload
Returns
uponEnter()
uponEnter(
context):void
Defined in: packages/board/src/input-interpretation/input-state-machine/kmt-input-state-machine.ts:496
Parameters
context
Returns
void
Overrides
TemplateState.uponEnter