Class IdleState

Hierarchy (View Summary)

TemplateState<TouchEventMapping, TouchContext, TouchStates>
- IdleState

Index

Constructors

constructor

new IdleState(): IdleState
Returns IdleState
Inherited from TemplateState.constructor

Properties

`Protected`_eventGuards

_eventGuards: Partial<
    EventGuards<
        TouchEventMapping,
        TouchStates,
        TouchContext,
        Guard<TouchContext, "touchPointsCount">,
    >,
> = { touchstart: [{ guard: "touchPointsCount", target: "PENDING", }], touchend: [{ guard: "touchPointsCount", target: "PENDING", }], }

`Protected`_guards

_guards: Guard<TouchContext, "touchPointsCount"> = { touchPointsCount: ((context: TouchContext) => { return context.getCurrentTouchPointsCount() === 2; }).bind(this) }

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

eventReactions

get eventReactions(): Partial<
EventAction<TouchEventMapping, TouchContext, TouchStates>,
>
Returns Partial<EventAction<TouchEventMapping, TouchContext, TouchStates>>
Overrides TemplateState.eventReactions
- Defined in input-state-machine/touch-input-state-machine.ts:57

guards

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

Methods

handles

handles<K extends keyof TouchEventMapping>(
    stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>,
    event: K,
    payload: TouchEventMapping[K],
    context: TouchContext,
): TouchStates
Type Parameters
- K extends keyof TouchEventMapping
Parameters
- stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>
- event: K
- payload: TouchEventMapping[K]
- context: TouchContext
Returns TouchStates
Inherited from TemplateState.handles
- Defined in being/interfaces.ts:147

touchend

touchend(
    stateMachine: TouchStateMachine,
    context: TouchContext,
    payload: TouchEventPayload,
): "IDLE" | "PENDING"
Parameters
- stateMachine: TouchStateMachine
- context: TouchContext
- payload: TouchEventPayload
Returns "IDLE" | "PENDING"
- Defined in input-state-machine/touch-input-state-machine.ts:66

touchstart

touchstart(
    stateMachine: TouchStateMachine,
    context: TouchContext,
    payload: TouchEventPayload,
): TouchStates
Parameters
- stateMachine: TouchStateMachine
- context: TouchContext
- payload: TouchEventPayload
Returns TouchStates
- Defined in input-state-machine/touch-input-state-machine.ts:61

uponEnter

uponEnter(
stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>,
context: TouchContext,
): void
Parameters
- stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>
- context: TouchContext
Returns void
Inherited from TemplateState.uponEnter
- Defined in being/interfaces.ts:139

uponLeave

uponLeave(
stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>,
context: TouchContext,
): void
Parameters
- stateMachine: StateMachine<TouchEventMapping, TouchContext, TouchStates>
- context: TouchContext
Returns void
Inherited from TemplateState.uponLeave
- Defined in being/interfaces.ts:143

Class IdleState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns IdleState

Properties

`Protected`_eventGuards

`Protected`_guards

Accessors

eventGuards

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

eventReactions

Returns Partial<EventAction<TouchEventMapping, TouchContext, TouchStates>>

guards

Returns Guard<Context>

Methods

handles

Type Parameters

Parameters

Returns TouchStates

touchend

Parameters

Returns "IDLE" | "PENDING"

touchstart

Parameters

Returns TouchStates

uponEnter

Parameters

Returns void

uponLeave

Parameters

Returns void

Settings

On This Page

Class IdleState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns IdleState

Properties

Protected_eventGuards

Protected_guards

Accessors

eventGuards

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

eventReactions

Returns Partial<EventAction<TouchEventMapping, TouchContext, TouchStates>>

guards

Returns Guard<Context>

Methods

handles

Type Parameters

Parameters

Returns TouchStates

touchend

Parameters

Returns "IDLE" | "PENDING"

touchstart

Parameters

Returns TouchStates

uponEnter

Parameters

Returns void

uponLeave

Parameters

Returns void

Settings

On This Page

`Protected`_eventGuards

`Protected`_guards

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