@stereograph/teiaviewer - v17.8.0-dev
    Preparing search index...

    Class TeiaViewerSignals

    Class of collection of events emitted from the viewer.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    historyChanged onCameraModeChanged onCameraMove onCameraMoveEnd onCameraMoveStart onContextMenuOpenStatusChanged onGizmoModeChanged onLoadingError onLoadingFinished onLoadingProgress onLoadingStarted onObjectControllerVisibilityChanged onObjectSelectionChanged onObjectsMoved onObjectVisibilityChanged onOperatorChanged onRenderModeChanged onSceneClear onSceneGraphChanged onSceneReset onSettingsMapSaved onSourceChanged onSpotlightOpenStatusChanged onSpriteClicked onTokenUpdated onUserCameraMove onViewportReady

    Constructors

    Properties

    historyChanged: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the history has changed

    onCameraModeChanged: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the camera mode changed

    onCameraMove: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the camera is moving

    onCameraMoveEnd: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the camera ends moving (including inertia scrolling)

    onCameraMoveStart: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the camera starts moving

    onContextMenuOpenStatusChanged: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the viewport context menu open status changes

    onGizmoModeChanged: ViewerSignal<(mode: GizmoMode) => void> = ...

    Signal emitted when the gizmo mode changed

    onLoadingError: ViewerSignal<(error: Error) => void> = ...
    onLoadingFinished: ViewerSignal<(info: SceneLoadingProgressInfo) => void> = ...
    onLoadingProgress: ViewerSignal<(info: SceneLoadingProgressInfo) => void> = ...
    onLoadingStarted: ViewerSignal<(info: SceneLoadingProgressInfo) => void> = ...
    onObjectControllerVisibilityChanged: ViewerSignal<
        (controller: SceneObjectController) => void,
    > = ...

    Signal emitted when the visibiliity of an object controller has changed

    onObjectSelectionChanged: ViewerSignal<(...args: any[]) => any> = ...
    onObjectsMoved: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when objects are moved

    onObjectVisibilityChanged: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the visibility of an object has changed with the SetObjectsVisibilityCommand

    onOperatorChanged: ViewerSignal<(operator: ViewportOperator) => void> = ...

    Signal emitted when the operator changed

    onRenderModeChanged: ViewerSignal<(renderMode: RenderMode) => void> = ...

    Signal emitted when the render mode changed

    onSceneClear: ViewerSignal<(...args: any[]) => any> = ...

    Signal emmited when the scene is cleared

    onSceneGraphChanged: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the scene graph changed (objects added, parent changed, removed)

    onSceneReset: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the scene is reset

    onSettingsMapSaved: ViewerSignal<(...args: any[]) => any> = ...
    onSourceChanged: ViewerSignal<(...args: any[]) => any> = ...
    onSpotlightOpenStatusChanged: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the viewport spotlight open status changes

    onSpriteClicked: ViewerSignal<(uuid: string) => void> = ...

    Signal emitted when a sprite in the scene has been clicked by the user.

    onTokenUpdated: ViewerSignal<(...args: any[]) => any> = ...
    onUserCameraMove: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the user directly moves the camera (ignores animations)

    onViewportReady: ViewerSignal<(...args: any[]) => any> = ...

    Signal emitted when the viewport react component is mounted and connected to the viewer

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties