uē-tôo

Appearance

@ue-too/board / LockedOnObjectState

Class: LockedOnObjectState ​

Defined in: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:355

State implementation for camera locked to follow an object. Only accepts locked object pan events until unlocked.

Extends ​

Constructors ​

Constructor ​

new LockedOnObjectState(): LockedOnObjectState

Defined in: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:361

Returns ​

LockedOnObjectState

Overrides ​

TemplateState< PanEventPayloadMapping, BaseContext, PanControlStates, PanControlOutputMapping >.constructor

Properties ​

_defer ​

protected _defer: Defer<BaseContext, PanEventPayloadMapping, PanControlStates, PanControlOutputMapping> | undefined

Defined in: packages/being/dist/interface.d.ts:492

Inherited from ​

TemplateState._defer

_delay ​

protected _delay: Delay<BaseContext, PanEventPayloadMapping, PanControlStates, PanControlOutputMapping> | undefined

Defined in: packages/being/dist/interface.d.ts:491

Inherited from ​

TemplateState._delay

_eventGuards ​

protected _eventGuards: Partial<EventGuards<EventPayloadMapping, States, Context, Guard<Context>>>

Defined in: packages/being/dist/interface.d.ts:490

Inherited from ​

TemplateState._eventGuards

_eventReactions ​

protected _eventReactions: EventReactions<PanEventPayloadMapping, BaseContext, PanControlStates, PanControlOutputMapping>

Defined in: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:365

Overrides ​

TemplateState._eventReactions

_guards ​

protected _guards: Guard<Context>

Defined in: packages/being/dist/interface.d.ts:489

Inherited from ​

TemplateState._guards

Accessors ​

delay ​

Get Signature ​

get delay(): Delay<Context, EventPayloadMapping, States, EventOutputMapping> | undefined

Defined in: packages/being/dist/interface.d.ts:497

Returns ​

Delay<Context, EventPayloadMapping, States, EventOutputMapping> | undefined

Inherited from ​

TemplateState.delay

eventGuards ​

Get Signature ​

get eventGuards(): Partial<EventGuards<EventPayloadMapping, States, Context, Guard<Context>>>

Defined in: packages/being/dist/interface.d.ts:495

Returns ​

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

Inherited from ​

TemplateState.eventGuards

eventReactions ​

Get Signature ​

get eventReactions(): EventReactions<EventPayloadMapping, Context, States, EventOutputMapping>

Defined in: packages/being/dist/interface.d.ts:496

Returns ​

EventReactions<EventPayloadMapping, Context, States, EventOutputMapping>

Inherited from ​

TemplateState.eventReactions

guards ​

Get Signature ​

get guards(): Guard<Context>

Defined in: packages/being/dist/interface.d.ts:494

Returns ​

Guard<Context>

Inherited from ​

TemplateState.guards

handlingEvents ​

Get Signature ​

get handlingEvents(): keyof EventPayloadMapping[]

Defined in: packages/being/dist/interface.d.ts:493

Returns ​

keyof EventPayloadMapping[]

Inherited from ​

TemplateState.handlingEvents

Methods ​

beforeExit() ​

beforeExit(context, stateMachine, to): void

Defined in: packages/being/dist/interface.d.ts:499

Parameters ​

context ​

BaseContext

stateMachine ​

StateMachine<PanEventPayloadMapping, BaseContext, PanControlStates, PanControlOutputMapping>

to ​

PanControlStates | "TERMINAL"

Returns ​

void

Inherited from ​

TemplateState.beforeExit

handles() ​

handles<K>(args, context, stateMachine): EventResult<PanControlStates, K extends keyof PanControlOutputMapping ? PanControlOutputMapping[K<K>] : void>

Defined in: packages/being/dist/interface.d.ts:500

Type Parameters ​

K ​

K extends string

Parameters ​

args ​

EventArgs<PanEventPayloadMapping, K>

context ​

BaseContext

stateMachine ​

StateMachine<PanEventPayloadMapping, BaseContext, PanControlStates, PanControlOutputMapping>

Returns ​

EventResult<PanControlStates, K extends keyof PanControlOutputMapping ? PanControlOutputMapping[K<K>] : void>

Inherited from ​

TemplateState.handles

lockedOnObjectPanByInputHandler() ​

lockedOnObjectPanByInputHandler(context, payload): PanControlOutputEvent

Defined in: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:382

Parameters ​

context ​

BaseContext

payload ​

PanByInputEventPayload

Returns ​

PanControlOutputEvent

lockedOnObjectPanToInputHandler() ​

lockedOnObjectPanToInputHandler(context, payload): PanControlOutputEvent

Defined in: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:389

Parameters ​

context ​

BaseContext

payload ​

PanToInputEventPayload

Returns ​

PanControlOutputEvent

uponEnter() ​

uponEnter(context, stateMachine, from): void

Defined in: packages/being/dist/interface.d.ts:498

Parameters ​

context ​

BaseContext

stateMachine ​

StateMachine<PanEventPayloadMapping, BaseContext, PanControlStates, PanControlOutputMapping>

from ​

PanControlStates | "INITIAL"

Returns ​

void

Inherited from ​

TemplateState.uponEnter