Class ReadyToSelectState

The ready to select state of the keyboard mouse and trackpad input state machine.

Hierarchy (View Summary)

TemplateState<
    KmtInputEventMapping,
    SelectionContext,
    ReadyToSelectStatePossibleTargetStates,
>
- ReadyToSelectState

Index

Constructors

Properties

_eventGuards _guards leftPointerMove

Accessors

eventGuards eventReactions guards

Methods

handles uponEnter uponLeave

Constructors

constructor

new ReadyToSelectState(): ReadyToSelectState
Returns ReadyToSelectState
Overrides TemplateState.constructor
- Defined in input-state-machine/kmt-input-state-machine.ts:185

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        KmtInputEventMapping,
        ReadyToSelectStatePossibleTargetStates,
        SelectionContext,
        Guard<SelectionContext, string>,
    >,
> = {}

`Protected`_guards

_guards: Guard<SelectionContext> = {}

leftPointerMove

leftPointerMove: any = ...

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:240

eventReactions

get eventReactions(): EventReactions<
    KmtInputEventMapping,
    SelectionContext,
    ReadyToSelectStatePossibleTargetStates,
>
Returns EventReactions<
    KmtInputEventMapping,
    SelectionContext,
    ReadyToSelectStatePossibleTargetStates,
>
Overrides TemplateState.eventReactions
- Defined in input-state-machine/kmt-input-state-machine.ts:206

guards

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

Methods

handles

handles<K extends keyof KmtInputEventMapping>(
    event: K,
    payload: KmtInputEventMapping[K],
    context: SelectionContext,
): ReadyToSelectStatePossibleTargetStates
Type Parameters
- K extends keyof KmtInputEventMapping
Parameters
- event: K
- payload: KmtInputEventMapping[K]
- context: SelectionContext
Returns ReadyToSelectStatePossibleTargetStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:252

uponEnter

uponEnter(context: SelectionContext): void
Parameters
- context: SelectionContext
Returns void
Inherited from TemplateState.uponEnter
- Defined in being/interfaces.ts:244

uponLeave

uponLeave(context: SelectionContext): void
Parameters
- context: SelectionContext
Returns void
Inherited from TemplateState.uponLeave
- Defined in being/interfaces.ts:248