Class LockedOnObjectState

The locked on object state of the pan control state machine.

Hierarchy (View Summary)

TemplateState<PanEventPayloadMapping, PanContext, PanControlStates>
- LockedOnObjectState

Index

Constructors

constructor

new LockedOnObjectState(): LockedOnObjectState
Returns LockedOnObjectState
Overrides TemplateState.constructor
- Defined in input-flow-control/pan-control-state-machine.ts:207

Properties

`Protected`_eventGuards

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

`Protected`_guards

_guards: Guard<PanContext> = {}

eventReactions

eventReactions: EventReactions<
    PanEventPayloadMapping,
    PanContext,
    PanControlStates,
> = { unlock: { action: NO_OP, defaultTargetState: "ACCEPTING_USER_INPUT" }, lockedOnObjectPanByInput: { action: this.lockedOnObjectPanByInputHandler, defaultTargetState: "LOCKED_ON_OBJECT" }, lockedOnObjectPanToInput: { action: this.lockedOnObjectPanToInputHandler, defaultTargetState: "LOCKED_ON_OBJECT" }, }

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

guards

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

Methods

handles

handles<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 TemplateState.handles
- Defined in being/interfaces.ts:252

lockedOnObjectPanByInputHandler

lockedOnObjectPanByInputHandler(
context: PanContext,
payload: PanByInputEventPayload,
): void
Parameters
- context: PanContext
- payload: PanByInputEventPayload
Returns void
- Defined in input-flow-control/pan-control-state-machine.ts:217

lockedOnObjectPanToInputHandler

lockedOnObjectPanToInputHandler(
context: PanContext,
payload: PanToInputEventPayload,
): void
Parameters
- context: PanContext
- payload: PanToInputEventPayload
Returns void
- Defined in input-flow-control/pan-control-state-machine.ts:221

uponEnter

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

uponLeave

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

Class LockedOnObjectState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns LockedOnObjectState

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

lockedOnObjectPanByInputHandler

Parameters

Returns void

lockedOnObjectPanToInputHandler

Parameters

Returns void

uponEnter

Parameters

Returns void

uponLeave

Parameters

Returns void

Settings

On This Page

Class LockedOnObjectState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns LockedOnObjectState

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

lockedOnObjectPanByInputHandler

Parameters

Returns void

lockedOnObjectPanToInputHandler

Parameters

Returns void

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>,
>,
>