Class TouchInputStateMachine

The touch input state machine.

Hierarchy (View Summary)

TemplateStateMachine<TouchEventMapping, TouchContext, TouchStates>
- TouchInputStateMachine

Index

Constructors

Properties

_context _currentState _happensCallbacks _stateChangeCallbacks _states _statesArray

Accessors

currentState possibleStates states

Methods

happens onHappens onStateChange setContext switchTo

Constructors

constructor

new TouchInputStateMachine(context: TouchContext): TouchInputStateMachine
Parameters
- context: TouchContext
Returns TouchInputStateMachine
Overrides TemplateStateMachine.constructor
- Defined in input-state-machine/touch-input-state-machine.ts:220

Properties

`Protected`_context

_context: TouchContext

`Protected`_currentState

_currentState: TouchStates

`Protected`_happensCallbacks

_happensCallbacks: (
    event: keyof TouchEventMapping,
    payload: TouchEventPayload,
    context: TouchContext,
) => void[]

`Protected`_stateChangeCallbacks

_stateChangeCallbacks: StateChangeCallback<TouchStates>[]

`Protected`_states

_states: Record<
TouchStates,
State<TouchEventMapping, TouchContext, TouchStates>,
>

`Protected`_statesArray

_statesArray: TouchStates[]

Accessors

currentState

get currentState(): States
Returns States
Inherited from TemplateStateMachine.currentState
- Defined in being/interfaces.ts:203

possibleStates

get possibleStates(): States[]
Returns States[]
Inherited from TemplateStateMachine.possibleStates
- Defined in being/interfaces.ts:211

states

get states(): Record<States, State<EventPayloadMapping, Context, States>>
Returns Record<States, State<EventPayloadMapping, Context, States>>
Inherited from TemplateStateMachine.states
- Defined in being/interfaces.ts:215

Methods

happens

happens<K extends keyof TouchEventMapping>(
    event: K,
    payload: TouchEventMapping[K],
    context: TouchContext,
): TouchStates
Type Parameters
- K extends keyof TouchEventMapping
Parameters
- event: K
- payload: TouchEventMapping[K]
- context: TouchContext
Returns TouchStates
Inherited from TemplateStateMachine.happens
- Defined in being/interfaces.ts:182

onHappens

onHappens(
    callback: (
        event: keyof TouchEventMapping,
        payload: TouchEventPayload,
        context: TouchContext,
    ) => void,
): void
Parameters
- callback: (
      event: keyof TouchEventMapping,
      payload: TouchEventPayload,
      context: TouchContext,
  ) => void
Returns void
Inherited from TemplateStateMachine.onHappens
- Defined in being/interfaces.ts:199

onStateChange

onStateChange(callback: StateChangeCallback<TouchStates>): void
Parameters
- callback: StateChangeCallback<TouchStates>
Returns void
Inherited from TemplateStateMachine.onStateChange
- Defined in being/interfaces.ts:195

setContext

setContext(context: TouchContext): void
Parameters
- context: TouchContext
Returns void
Inherited from TemplateStateMachine.setContext
- Defined in being/interfaces.ts:207

switchTo

switchTo(state: TouchStates): void
Parameters
- state: TouchStates
Returns void
Inherited from TemplateStateMachine.switchTo
- Defined in being/interfaces.ts:178