@ue-too/board / index / PanControlStateMachine

類別: PanControlStateMachine

定義於: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:129

State machine controlling pan input flow and animations.

備註

This state machine manages the lifecycle of pan operations:

User input handling: Accepts or blocks user pan gestures based on state
Animation control: Manages smooth pan-to animations
Object tracking: Supports locking camera to follow objects

State transitions:

ACCEPTING_USER_INPUT → TRANSITION: Start animation (initateTransition)
ACCEPTING_USER_INPUT → LOCKED_ON_OBJECT: Lock to object (lockedOnObjectPan...)
TRANSITION → ACCEPTING_USER_INPUT: User input interrupts animation
LOCKED_ON_OBJECT → ACCEPTING_USER_INPUT: Unlock (unlock event)

Helper methods simplify event dispatching without memorizing event names.

範例

typescript

const stateMachine = createDefaultPanControlStateMachine(cameraRig);

// User pans - accepted in ACCEPTING_USER_INPUT state
const result = stateMachine.notifyPanInput({ x: 50, y: 30 });

// Start animation - transitions to TRANSITION state
stateMachine.notifyPanToAnimationInput({ x: 1000, y: 500 });

// User input now blocked while animating

參閱

createDefaultPanControlStateMachine for factory function

Extends

TemplateStateMachine<PanEventPayloadMapping, BaseContext, PanControlStates, PanControlOutputMapping>

建構函式

new PanControlStateMachine(states, initialState, context): PanControlStateMachine

定義於: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:135

參數

states

Record<PanControlStates, State<PanEventPayloadMapping, BaseContext, PanControlStates, PanControlOutputMapping>>

initialState

PanControlStates

context

BaseContext

回傳

PanControlStateMachine

覆寫了

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

屬性

_context

protected _context: BaseContext

定義於: packages/being/dist/interface.d.ts:468

繼承自

TemplateStateMachine._context

_currentState

protected _currentState: PanControlStates | "INITIAL" | "TERMINAL"

定義於: packages/being/dist/interface.d.ts:466

繼承自

TemplateStateMachine._currentState

_eventResultCallbacks

protected _eventResultCallbacks: EventResultCallback<PanEventPayloadMapping, BaseContext, PanControlStates>[]

定義於: packages/being/dist/interface.d.ts:472

繼承自

TemplateStateMachine._eventResultCallbacks

_happensCallbacks

protected _happensCallbacks: (args, context) => void[]

定義於: packages/being/dist/interface.d.ts:471

參數

args

context

BaseContext

回傳

void

繼承自

TemplateStateMachine._happensCallbacks

_initialState

protected _initialState: PanControlStates

定義於: packages/being/dist/interface.d.ts:474

繼承自

TemplateStateMachine._initialState

_stateChangeCallbacks

protected _stateChangeCallbacks: StateChangeCallback<PanControlStates>[]

定義於: packages/being/dist/interface.d.ts:470

繼承自

TemplateStateMachine._stateChangeCallbacks

_states

protected _states: Record<States, State<EventPayloadMapping, Context, States, EventOutputMapping>>

定義於: packages/being/dist/interface.d.ts:467

繼承自

TemplateStateMachine._states

_statesArray

protected _statesArray: PanControlStates[]

定義於: packages/being/dist/interface.d.ts:469

繼承自

TemplateStateMachine._statesArray

_timeouts

protected _timeouts: number | undefined

定義於: packages/being/dist/interface.d.ts:473

繼承自

KmtInputStateMachineWebWorkerProxy._timeouts

存取器

context

Getter 簽章

get context(): Context

定義於: packages/being/dist/interface.d.ts:487

Read-only access to the machine's live context object. Optional so existing StateMachine implementations remain valid; TemplateStateMachine always provides it. Intended for tooling/introspection (e.g. visualizers evaluating guards against the current context) — mutate state through events, not through this reference.

回傳

Context

繼承自

TemplateStateMachine.context

currentState

Getter 簽章

get currentState(): States | "INITIAL" | "TERMINAL"

定義於: packages/being/dist/interface.d.ts:485

回傳

States | "INITIAL" | "TERMINAL"

繼承自

TemplateStateMachine.currentState

possibleStates

Getter 簽章

get possibleStates(): States[]

定義於: packages/being/dist/interface.d.ts:488

回傳

States[]

繼承自

TemplateStateMachine.possibleStates

states

Getter 簽章

get states(): Record<States, State<EventPayloadMapping, Context, States, EventOutputMapping>>

定義於: packages/being/dist/interface.d.ts:489

回傳

Record<States, State<EventPayloadMapping, Context, States, EventOutputMapping>>

繼承自

TemplateStateMachine.states

方法

happens()

呼叫簽章

happens<K>(...args): EventResult<PanControlStates, K extends keyof PanControlOutputMapping ? PanControlOutputMapping[K<K>] : void>

定義於: packages/being/dist/interface.d.ts:480

型別參數

K

K extends keyof PanEventPayloadMapping

參數

args

...EventArgs<PanEventPayloadMapping, K>

回傳

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

繼承自

TemplateStateMachine.happens

呼叫簽章

happens<K>(...args): EventResult<PanControlStates, unknown>

定義於: packages/being/dist/interface.d.ts:481

型別參數

K

K extends string

參數

args

...EventArgs<PanEventPayloadMapping, K>

回傳

EventResult<PanControlStates, unknown>

繼承自

TemplateStateMachine.happens

initateTransition()

initateTransition(): EventResult<PanControlStates, void>

定義於: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:186

Initiates transition to TRANSITION state.

回傳

EventResult<PanControlStates, void>

備註

Forces state change to begin animation or transition sequence. Called when starting programmatic camera movements.

notifyPanInput()

notifyPanInput(diff): EventResult<PanControlStates, PanControlOutputEvent>

定義於: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:161

Notifies the state machine of user pan input.

參數

diff

Point

Pan displacement in viewport coordinates

回傳

EventResult<PanControlStates, PanControlOutputEvent>

Event handling result with output event

備註

Dispatches userPanByInput event. Accepted in ACCEPTING_USER_INPUT and TRANSITION states, where it may transition back to ACCEPTING_USER_INPUT (user interrupting animation).

notifyPanToAnimationInput()

notifyPanToAnimationInput(target): EventResult<PanControlStates, PanControlOutputEvent>

定義於: packages/board/src/camera/camera-mux/animation-and-lock/pan-control-state-machine.ts:175

Initiates a pan animation to a target position.

參數

target

Point

Target position in world coordinates

回傳

EventResult<PanControlStates, PanControlOutputEvent>

Event handling result

備註

Dispatches transitionPanToInput event, starting a pan animation. Transitions to TRANSITION state where animation updates occur.

onEventResult()

onEventResult(callback): () => void

定義於: packages/being/dist/interface.d.ts:484

Subscribe to every event result. Optional so existing StateMachine implementations remain valid; TemplateStateMachine always provides it. Returns a disposer on implementations that support one. Disposing during a dispatch takes effect starting with the next dispatch, not the one in progress — see EventResultCallback for the exact snapshot-iteration semantics.

參數

callback

EventResultCallback<PanEventPayloadMapping, BaseContext, PanControlStates>

回傳

(): void

回傳

void

繼承自

TemplateStateMachine.onEventResult

onHappens()

onHappens(callback): () => void

定義於: packages/being/dist/interface.d.ts:483

Subscribe to every happens() call, before the state handles it. Returns a disposer on implementations that support one. Disposing during a dispatch takes effect starting with the next dispatch, not the one in progress — see EventResultCallback for the exact snapshot-iteration semantics.

參數

callback

(args, context) => void

回傳

(): void

回傳

void

繼承自

TemplateStateMachine.onHappens

onStateChange()

onStateChange(callback): () => void

定義於: packages/being/dist/interface.d.ts:482

Subscribe to state changes. Returns a disposer on implementations that support one. Disposing during a dispatch takes effect starting with the next dispatch, not the one in progress — see EventResultCallback for the exact snapshot-iteration semantics.

參數

callback

StateChangeCallback<PanControlStates>

回傳

(): void

回傳

void

繼承自

TemplateStateMachine.onStateChange

reset()

reset(): void

定義於: packages/being/dist/interface.d.ts:476

回傳

void

繼承自

TemplateStateMachine.reset

setContext()

setContext(context): void

定義於: packages/being/dist/interface.d.ts:486

參數

context

BaseContext

回傳

void

繼承自

TemplateStateMachine.setContext

start()

start(): void

定義於: packages/being/dist/interface.d.ts:477

回傳

void

繼承自

TemplateStateMachine.start

switchTo()

switchTo(state): void

定義於: packages/being/dist/interface.d.ts:479

參數

state

PanControlStates | "INITIAL" | "TERMINAL"

回傳

void

繼承自

TemplateStateMachine.switchTo

wrapup()

wrapup(): void

定義於: packages/being/dist/interface.d.ts:478

回傳

void

繼承自

TemplateStateMachine.wrapup

類別: PanControlStateMachine ​

備註 ​

範例 ​

參閱 ​

Extends ​

建構函式 ​

建構函式 ​

參數 ​

states ​

initialState ​

context ​

回傳 ​

覆寫了 ​

屬性 ​

_context ​

繼承自 ​

_currentState ​

繼承自 ​

_eventResultCallbacks ​

繼承自 ​

_happensCallbacks ​

參數 ​

args ​

context ​

回傳 ​

繼承自 ​

_initialState ​

繼承自 ​

_stateChangeCallbacks ​

繼承自 ​

_states ​

繼承自 ​

_statesArray ​

繼承自 ​

_timeouts ​

繼承自 ​

存取器 ​

context ​

Getter 簽章 ​

回傳 ​

繼承自 ​

currentState ​

Getter 簽章 ​

回傳 ​

繼承自 ​

possibleStates ​

Getter 簽章 ​

回傳 ​

繼承自 ​

states ​

Getter 簽章 ​

回傳 ​

繼承自 ​

方法 ​

happens() ​

呼叫簽章 ​

型別參數 ​

K ​

參數 ​

args ​

回傳 ​

繼承自 ​

呼叫簽章 ​

型別參數 ​

K ​

參數 ​

args ​

回傳 ​

繼承自 ​

initateTransition() ​

回傳 ​

備註 ​

notifyPanInput() ​

參數 ​

diff ​

回傳 ​

備註 ​

notifyPanToAnimationInput() ​

參數 ​

target ​

類別: PanControlStateMachine

備註

範例

參閱

Extends

建構函式

建構函式

參數

states

initialState

context

回傳

覆寫了

屬性

_context

繼承自

_currentState

繼承自

_eventResultCallbacks

繼承自

_happensCallbacks

參數

args

context

回傳

繼承自

_initialState

繼承自

_stateChangeCallbacks

繼承自

_states

繼承自

_statesArray

繼承自

_timeouts

繼承自

存取器

context

Getter 簽章

回傳

繼承自

currentState

Getter 簽章

回傳

繼承自

possibleStates

Getter 簽章

回傳

繼承自

states

Getter 簽章

回傳

繼承自

方法

happens()

呼叫簽章

型別參數

K

參數

args

回傳

繼承自

呼叫簽章

型別參數

K

參數

args

回傳

繼承自

initateTransition()

回傳

備註

notifyPanInput()

參數

diff

回傳

備註

notifyPanToAnimationInput()

參數

target