@ue-too/board / index / IdleState
Class: IdleState
Defined in: packages/board/src/input-interpretation/input-state-machine/touch-input-state-machine.ts:112
IDLE state - waiting for two-finger touch.
Remarks
This state handles touch lifecycle but only transitions to PENDING when exactly two touches are active. Single touches and three+ touches are ignored.
Guard Condition: Transitions to PENDING only when getCurrentTouchPointsCount() === 2. This ensures the state machine only handles two-finger gestures.
Extends
TemplateState<TouchEventMapping,TouchContext,TouchStates,TouchInputEventOutputMapping>
Constructors
Constructor
new IdleState():
IdleState
Returns
IdleState
Inherited from
TemplateState< TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping >.constructor
Properties
_defer
protected_defer:Defer<TouchContext,TouchEventMapping,TouchStates,TouchInputEventOutputMapping> |undefined
Defined in: packages/being/dist/interface.d.ts:581
Inherited from
TemplateState._defer
_delay
protected_delay:Delay<TouchContext,TouchEventMapping,TouchStates,TouchInputEventOutputMapping> |undefined
Defined in: packages/being/dist/interface.d.ts:580
Inherited from
TemplateState._delay
_eventGuards
protected_eventGuards:Partial<EventGuards<TouchEventMapping,TouchStates,TouchContext, typeof_guards>>
Defined in: packages/board/src/input-interpretation/input-state-machine/touch-input-state-machine.ts:140
Overrides
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<TouchEventMapping,TouchContext,TouchStates,TouchInputEventOutputMapping>
Defined in: packages/board/src/input-interpretation/input-state-machine/touch-input-state-machine.ts:118
Overrides
TemplateState._eventReactions
_guards
protected_guards:Guard<TouchContext,"touchPointsCount">
Defined in: packages/board/src/input-interpretation/input-state-machine/touch-input-state-machine.ts:134
Overrides
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<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping>
to
"TERMINAL" | TouchStates
Returns
void
Inherited from
TemplateState.beforeExit
handles()
handles<
K>(args,context,stateMachine):EventResult<TouchStates,Kextends"touchmove"?TouchInputEventOutputMapping[K<K>] :void>
Defined in: packages/being/dist/interface.d.ts:590
Type Parameters
K
K extends string
Parameters
args
EventArgs<TouchEventMapping, K>
context
stateMachine
StateMachine<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping>
Returns
EventResult<TouchStates, K extends "touchmove" ? TouchInputEventOutputMapping[K<K>] : void>
Inherited from
TemplateState.handles
touchend()
touchend(
context,payload):void
Defined in: packages/board/src/input-interpretation/input-state-machine/touch-input-state-machine.ts:166
Parameters
context
payload
Returns
void
touchstart()
touchstart(
context,payload):void
Defined in: packages/board/src/input-interpretation/input-state-machine/touch-input-state-machine.ts:162
Parameters
context
payload
Returns
void
uponEnter()
uponEnter(
context,stateMachine,from):void
Defined in: packages/being/dist/interface.d.ts:588
Parameters
context
stateMachine
StateMachine<TouchEventMapping, TouchContext, TouchStates, TouchInputEventOutputMapping>
from
"INITIAL" | TouchStates
Returns
void
Inherited from
TemplateState.uponEnter