Class PanControlStateMachine

The pan control state machine. It's not created directly using the TemplateStateMachine class. A few helper functions are in place to make it easier to use. (user don't have to memorize the event names)

Hierarchy (View Summary)

TemplateStateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- PanControlStateMachine

Index

Input Flow Control

initateTransition notifyPanInput notifyPanToAnimationInput

Other

constructor _context _currentState _happensCallbacks _stateChangeCallbacks _states _statesArray currentState limitEntireViewPort possibleStates states happens onHappens onStateChange setContext switchTo

Input Flow Control

initateTransition

initateTransition(): void
Initate the transition.

Returns void
- Defined in input-flow-control/pan-control-state-machine.ts:98

notifyPanInput

notifyPanInput(diff: Point): void
Notify the pan input event.
Parameters
- diff: Point
Returns void
- Defined in input-flow-control/pan-control-state-machine.ts:80

notifyPanToAnimationInput

notifyPanToAnimationInput(target: Point): void
Notify the pan to animation input event.
Parameters
- target: Point
Returns void
- Defined in input-flow-control/pan-control-state-machine.ts:89

Other

`Protected`_happensCallbacks

_happensCallbacks: (
    event: keyof PanEventPayloadMapping,
    payload: PanByInputEventPayload | PanToInputEventPayload | EmptyPayload,
    context: PanContext,
) => void[]

`Protected`_stateChangeCallbacks

_stateChangeCallbacks: StateChangeCallback<PanControlStates>[]

`Protected`_states

_states: Record<
PanControlStates,
State<PanEventPayloadMapping, PanContext, PanControlStates>,
>

`Protected`_statesArray

_statesArray: PanControlStates[]

currentState

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

limitEntireViewPort

get limitEntireViewPort(): boolean
Returns boolean
- Defined in input-flow-control/pan-control-state-machine.ts:106
set limitEntireViewPort(limit: boolean): void
Parameters
- limit: boolean
Returns void
- Defined in input-flow-control/pan-control-state-machine.ts:102

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

happens

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

onHappens

onHappens(
    callback: (
        event: keyof PanEventPayloadMapping,
        payload: PanByInputEventPayload | PanToInputEventPayload | EmptyPayload,
        context: PanContext,
    ) => void,
): void
Parameters
- callback: (
      event: keyof PanEventPayloadMapping,
      payload: PanByInputEventPayload | PanToInputEventPayload | EmptyPayload,
      context: PanContext,
  ) => void
Returns void
Inherited from TemplateStateMachine.onHappens
- Defined in being/interfaces.ts:199

onStateChange

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

setContext

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

switchTo

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

Class PanControlStateMachine

Hierarchy (View Summary)

Index

Input Flow Control

Other

Input Flow Control

initateTransition

Returns void

notifyPanInput

Parameters

Returns void

notifyPanToAnimationInput

Parameters

Returns void

Other

constructor

Parameters

Returns PanControlStateMachine

Protected_context

Protected_currentState

Protected_happensCallbacks

Protected_stateChangeCallbacks

Protected_states

Protected_statesArray

currentState

Returns States

limitEntireViewPort

Returns boolean

Parameters

Returns void

possibleStates

Returns States[]

states

Returns Record<States, State<EventPayloadMapping, Context, States>>

happens

Type Parameters

Parameters

Returns PanControlStates

onHappens

Parameters

Returns void

onStateChange

Parameters

Returns void

setContext

Parameters

Returns void

switchTo

Parameters

Returns void

Settings

On This Page

`Protected`_context

`Protected`_currentState

`Protected`_happensCallbacks

`Protected`_stateChangeCallbacks

`Protected`_states

`Protected`_statesArray