uē-tôo

Appearance

@ue-too/board / ZoomAcceptingUserInputState

Class: ZoomAcceptingUserInputState ​

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

State implementation for accepting user zoom input (idle/normal state). Accepts user zoom input and can transition to animation or locked states.

Extends ​

Constructors ​

Constructor ​

new ZoomAcceptingUserInputState(): ZoomAcceptingUserInputState

Returns ​

ZoomAcceptingUserInputState

Inherited from ​

TemplateState< ZoomEventPayloadMapping, BaseContext, ZoomControlStates, ZoomControlOutputMapping >.constructor

Properties ​

_defer ​

protected _defer: Defer<BaseContext, ZoomEventPayloadMapping, ZoomControlStates, ZoomControlOutputMapping> | undefined

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

Inherited from ​

TemplateState._defer

_delay ​

protected _delay: Delay<BaseContext, ZoomEventPayloadMapping, ZoomControlStates, ZoomControlOutputMapping> | 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<ZoomEventPayloadMapping, BaseContext, ZoomControlStates, ZoomControlOutputMapping>

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

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<ZoomEventPayloadMapping, BaseContext, ZoomControlStates, ZoomControlOutputMapping>

to ​

ZoomControlStates | "TERMINAL"

Returns ​

void

Inherited from ​

TemplateState.beforeExit

handles() ​

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

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

Type Parameters ​

K ​

K extends string

Parameters ​

args ​

EventArgs<ZoomEventPayloadMapping, K>

context ​

BaseContext

stateMachine ​

StateMachine<ZoomEventPayloadMapping, BaseContext, ZoomControlStates, ZoomControlOutputMapping>

Returns ​

EventResult<ZoomControlStates, K extends keyof ZoomControlOutputMapping ? ZoomControlOutputMapping[K<K>] : void>

Inherited from ​

TemplateState.handles

uponEnter() ​

uponEnter(context, stateMachine, from): void

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

Parameters ​

context ​

BaseContext

stateMachine ​

StateMachine<ZoomEventPayloadMapping, BaseContext, ZoomControlStates, ZoomControlOutputMapping>

from ​

ZoomControlStates | "INITIAL"

Returns ​

void

Inherited from ​

TemplateState.uponEnter

userZoomByAtInput() ​

userZoomByAtInput(context, payload): ZoomControlOutputEvent

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

Parameters ​

context ​

BaseContext

payload ​

ZoomByAtInputPayload

Returns ​

ZoomControlOutputEvent

userZoomToAtInput() ​

userZoomToAtInput(context, payload): ZoomControlOutputEvent

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

Parameters ​

context ​

BaseContext

payload ​

ZoomToAtInputPayload

Returns ​

ZoomControlOutputEvent