Class LockedOnObjectState

Hierarchy (View Summary)

TemplateState<PanEventPayloadMapping, PanContext, PanControlStates>
- LockedOnObjectState

Index

Constructors

constructor

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

Properties

`Protected`_eventGuards

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

`Protected`_guards

_guards: Guard<PanContext> = {}

eventReactions

eventReactions: Partial<
EventAction<PanEventPayloadMapping, PanContext, PanControlStates>,
> = { unlock: { action: this.unlockHandler, 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:135

guards

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

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

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

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

unlockHandler

unlockHandler(
    stateMachine: StateMachine<
        PanEventPayloadMapping,
        PanContext,
        PanControlStates,
    >,
    context: PanContext,
    payload: {},
): PanControlStates
Parameters
- stateMachine: StateMachine<PanEventPayloadMapping, PanContext, PanControlStates>
- context: PanContext
- payload: {}
Returns PanControlStates
- Defined in control-center/pan-control-state-machine.ts:170

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

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

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 PanControlStates

lockedOnObjectPanToInputHandler

Parameters

Returns PanControlStates

unlockHandler

Parameters

Returns PanControlStates

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