Interface Facade

Facade for controlled, external interaction with the AssetCameraRenderPlugin.

interface Facade {
    addEventListener<K extends "onCameraMove">(
        event: K,
        listener: (eventData: CameraAPI.Events[K]) => void,
    ): { remove: () => void };
    animateToAngle(
        angleOptions: CameraRotation,
        animationDurationMs: number,
    ): Promise<void>;
    getCurrentCameraState(): CameraAPI.CameraState;
}

Hierarchy (View Summary)

EventEmitterInterface<CameraAPI.Events>
- Facade

Implemented by

AssetCameraSdkFacade

Index

Methods

addEventListener animateToAngle getCurrentCameraState

Methods

addEventListener

addEventListener<K extends "onCameraMove">(
event: K,
listener: (eventData: CameraAPI.Events[K]) => void,
): { remove: () => void }
Type Parameters
- K extends "onCameraMove"
Parameters
- event: K
- listener: (eventData: CameraAPI.Events[K]) => void
Returns { remove: () => void }
Inherited from EventEmitterInterface.addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:7

animateToAngle

animateToAngle(
angleOptions: CameraRotation,
animationDurationMs: number,
): Promise<void>
Animates the camera to a specific angle.
Parameters
- angleOptions: CameraRotation
- animationDurationMs: number
Returns Promise<void>
A promise that resolves when the animation is complete.
- Defined in embedded/engine/src/lib/sdk/AssetCameraFacade.ts:48

getCurrentCameraState

getCurrentCameraState(): CameraAPI.CameraState
Returns CameraAPI.CameraState
The current camera state.
- Defined in embedded/engine/src/lib/sdk/AssetCameraFacade.ts:53