Class PanState

The pan state of the keyboard mouse and trackpad input state machine.

Hierarchy (View Summary)

TemplateState<KmtInputEventMapping, KmtInputContext, KmtInputStates>
- PanState

Index

Constructors

Properties

_eventGuards _guards

Accessors

eventGuards eventReactions guards

Methods

handles leftPointerMoveHandler leftPointerUpHandler spacebarUpHandler uponEnter uponLeave

Constructors

constructor

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

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        KmtInputEventMapping,
        KmtInputStates,
        KmtInputContext,
        Guard<KmtInputContext, string>,
    >,
> = {}

`Protected`_guards

_guards: Guard<KmtInputContext> = {}

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,
    KmtInputContext,
    KmtInputStates,
>
Returns EventReactions<KmtInputEventMapping, KmtInputContext, KmtInputStates>
Overrides TemplateState.eventReactions
- Defined in input-state-machine/kmt-input-state-machine.ts:361

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: KmtInputContext,
): KmtInputStates
Type Parameters
- K extends keyof KmtInputEventMapping
Parameters
- event: K
- payload: KmtInputEventMapping[K]
- context: KmtInputContext
Returns KmtInputStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:252

leftPointerMoveHandler

leftPointerMoveHandler(
context: KmtInputContext,
payload: PointerEventPayload,
): void
Parameters
- context: KmtInputContext
- payload: PointerEventPayload
Returns void
- Defined in input-state-machine/kmt-input-state-machine.ts:365

leftPointerUpHandler

leftPointerUpHandler(
context: KmtInputContext,
payload: PointerEventPayload,
): void
Parameters
- context: KmtInputContext
- payload: PointerEventPayload
Returns void
- Defined in input-state-machine/kmt-input-state-machine.ts:381

spacebarUpHandler

spacebarUpHandler(context: KmtInputContext, payload: EmptyPayload): void
Parameters
- context: KmtInputContext
- payload: EmptyPayload
Returns void
- Defined in input-state-machine/kmt-input-state-machine.ts:377

uponEnter

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

uponLeave

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