Class AcceptingUserInputState

Hierarchy (View Summary)

TemplateState<PanEventPayloadMapping, PanContext, PanControlStates>
- AcceptingUserInputState

Index

Constructors

constructor

new AcceptingUserInputState(): AcceptingUserInputState
Returns AcceptingUserInputState
Overrides TemplateState.constructor
- Defined in control-center/pan-control-state-machine.ts:63

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        PanEventPayloadMapping,
        PanControlStates,
        PanContext,
        Guard<PanContext, string>,
    >,
> = {}

`Protected`_guards

_guards: Guard<PanContext> = {}

eventReactions

eventReactions: Partial<
EventAction<PanEventPayloadMapping, PanContext, PanControlStates>,
> = ...

Accessors

eventGuards

get eventGuards(): Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Returns Partial<
    EventGuards<
        EventPayloadMapping,
        States,
        Context,
        Guard<Context, string>,
    >,
>
Inherited from TemplateState.eventGuards
- Defined in being/interfaces.ts:115

guards

get guards(): Guard<Context>
Returns Guard<Context>
Inherited from TemplateState.guards
- Defined in being/interfaces.ts:111

Methods

handles

handles<K extends keyof PanEventPayloadMapping>(
    stateMachine: StateMachine<
        PanEventPayloadMapping,
        PanContext,
        PanControlStates,
    >,
    event: K,
    payload: PanEventPayloadMapping[K],
    context: PanContext,
): PanControlStates
Type Parameters
- K extends keyof PanEventPayloadMapping
Parameters
- stateMachine: StateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- event: K
- payload: PanEventPayloadMapping[K]
- context: PanContext
Returns PanControlStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:127

initateTransitionHandler

initateTransitionHandler(
    stateMachine: StateMachine<
        PanEventPayloadMapping,
        PanContext,
        PanControlStates,
    >,
    context: PanContext,
    payload: PanByInputEventPayload,
): PanControlStates
Parameters
- stateMachine: StateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- context: PanContext
- payload: PanByInputEventPayload
Returns PanControlStates
- Defined in control-center/pan-control-state-machine.ts:85

lockedOnObjectPanByInputHandler

lockedOnObjectPanByInputHandler(
    stateMachine: StateMachine<
        PanEventPayloadMapping,
        PanContext,
        PanControlStates,
    >,
    context: PanContext,
    payload: PanByInputEventPayload,
): PanControlStates
Parameters
- stateMachine: StateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- context: PanContext
- payload: PanByInputEventPayload
Returns PanControlStates
- Defined in control-center/pan-control-state-machine.ts:89

lockedOnObjectPanToInputHandler

lockedOnObjectPanToInputHandler(
    stateMachine: StateMachine<
        PanEventPayloadMapping,
        PanContext,
        PanControlStates,
    >,
    context: PanContext,
    payload: PanToInputEventPayload,
): PanControlStates
Parameters
- stateMachine: StateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- context: PanContext
- payload: PanToInputEventPayload
Returns PanControlStates
- Defined in control-center/pan-control-state-machine.ts:94

uponEnter

uponEnter(
    stateMachine: StateMachine<
        PanEventPayloadMapping,
        PanContext,
        PanControlStates,
    >,
    context: PanContext,
): void
Parameters
- stateMachine: StateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- context: PanContext
Returns void
Inherited from TemplateState.uponEnter
- Defined in being/interfaces.ts:119

uponLeave

uponLeave(
    stateMachine: StateMachine<
        PanEventPayloadMapping,
        PanContext,
        PanControlStates,
    >,
    context: PanContext,
): void
Parameters
- stateMachine: StateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- context: PanContext
Returns void
Inherited from TemplateState.uponLeave
- Defined in being/interfaces.ts:123

userPanByInputHandler

userPanByInputHandler(
    stateMachine: StateMachine<
        PanEventPayloadMapping,
        PanContext,
        PanControlStates,
    >,
    context: PanContext,
    payload: PanByInputEventPayload,
): PanControlStates
Parameters
- stateMachine: StateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- context: PanContext
- payload: PanByInputEventPayload
Returns PanControlStates
- Defined in control-center/pan-control-state-machine.ts:75

userPanToInputHandler

userPanToInputHandler(
    stateMachine: StateMachine<
        PanEventPayloadMapping,
        PanContext,
        PanControlStates,
    >,
    context: PanContext,
    payload: PanToInputEventPayload,
): PanControlStates
Parameters
- stateMachine: StateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- context: PanContext
- payload: PanToInputEventPayload
Returns PanControlStates
- Defined in control-center/pan-control-state-machine.ts:80

Class AcceptingUserInputState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AcceptingUserInputState

Properties

Protected_eventGuards

Protected_guards

eventReactions

Accessors

eventGuards

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

guards

Returns Guard<Context>

Methods

handles

Type Parameters

Parameters

Returns PanControlStates

initateTransitionHandler

Parameters

Returns PanControlStates

lockedOnObjectPanByInputHandler

Parameters

Returns PanControlStates

lockedOnObjectPanToInputHandler

Parameters

Returns PanControlStates

uponEnter

Parameters

Returns void

uponLeave

Parameters

Returns void

userPanByInputHandler

Parameters

Returns PanControlStates

userPanToInputHandler

Parameters

Returns PanControlStates

Settings

On This Page

`Protected`_eventGuards

`Protected`_guards

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