@ue-too/board / index / TransitionState

Class: TransitionState

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

State implementation for pan animations and transitions. Processes animation updates and allows user input to interrupt.

Extends

• TemplateState<PanEventPayloadMapping, BaseContext, PanControlStates, PanControlOutputMapping>

Constructors

Constructor

new TransitionState(): TransitionState

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

Returns

TransitionState

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

Inherited from

TemplateState._defer

---

_delay

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

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

Inherited from

TemplateState._delay

---

_eventGuards

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

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

Inherited from

TemplateState._eventGuards

---

_eventPreconditions

protected _eventPreconditions: Partial<EventPreconditions<EventPayloadMapping, Context, Guard<Context>>>

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

Inherited from

TemplateState._eventPreconditions

---

_eventReactions

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

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

Overrides

TemplateState._eventReactions

---

_guards

protected _guards: Guard<Context>

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

Inherited from

TemplateState._guards

Accessors

delay

Get Signature

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

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

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

Returns

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

Inherited from

TemplateState.eventGuards

---

eventPreconditions

Get Signature

get eventPreconditions(): Partial<EventPreconditions<EventPayloadMapping, Context, Guard<Context>>>

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

Pre-action vetoes: named guards that must all pass before this state handles an event. Optional so existing State implementations remain valid; TemplateState always provides it.

Returns

Partial<EventPreconditions<EventPayloadMapping, Context, Guard<Context>>>

Inherited from

TemplateState.eventPreconditions

---

eventReactions

Get Signature

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

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

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

Returns

Guard<Context>

Inherited from

TemplateState.guards

---

handlingEvents

Get Signature

get handlingEvents(): keyof EventPayloadMapping[]

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

Returns

keyof EventPayloadMapping[]

Inherited from

TemplateState.handlingEvents

Methods

beforeExit()

beforeExit(context, stateMachine, to): void

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

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

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

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

Parameters

context

BaseContext

payload

PanToInputEventPayload

Returns

PanControlOutputEvent

---

transitionPanByInputHandler()

transitionPanByInputHandler(context, payload): PanControlOutputEvent

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

Parameters

context

BaseContext

payload

PanByInputEventPayload

Returns

PanControlOutputEvent

---

transitionPanToInputHandler()

transitionPanToInputHandler(context, payload): PanControlOutputEvent

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

Parameters

context

BaseContext

payload

PanToInputEventPayload

Returns

PanControlOutputEvent

---

uponEnter()

uponEnter(context, stateMachine, from): void

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

Parameters

context

BaseContext

stateMachine

StateMachine<PanEventPayloadMapping, BaseContext, PanControlStates, PanControlOutputMapping>

from

PanControlStates | "INITIAL"

Returns

void

Inherited from

TemplateState.uponEnter

---

userPanByInputHandler()

userPanByInputHandler(context, payload): PanControlOutputEvent

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

Parameters

context

BaseContext

payload

PanByInputEventPayload

Returns

PanControlOutputEvent

---

userPanToInputHandler()

userPanToInputHandler(context, payload): PanControlOutputEvent

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

Parameters

context

BaseContext

payload

PanToInputEventPayload

Returns

PanControlOutputEvent