Documentation - v20.0.0-dev
    Preparing search index...

    Collection of events emitted from the viewer.

    Index

    Constructors

    Properties

    historyChanged: Signal<() => void> = ...

    Signal emitted when the history has changed

    onCameraModeChanged: Signal<() => void> = ...

    Signal emitted when the camera mode changed

    onCameraMove: Signal<() => void> = ...

    Signal emitted when the camera is moving

    onCameraMoveEnd: Signal<() => void> = ...

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

    onCameraMoveStart: Signal<() => void> = ...

    Signal emitted when the camera starts moving

    onCameraRest: Signal<() => void> = ...

    Signal emitted when camera movement falls below the rest threshold

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

    Signal emitted when the visibiliity of an object controller has changed

    onObjectDoubleClicked: Signal<(object: SceneObject) => void> = ...
    onObjectSelectionChanged: Signal<() => void> = ...
    onObjectsMoved: Signal<() => void> = ...

    Signal emitted when objects are moved

    onObjectsTransformAttached: Signal<() => void> = ...
    onObjectsTransformDetached: Signal<() => void> = ...
    onObjectVisibilityChanged: Signal<() => void> = ...

    Signal emitted when the visibility of an object has changed

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

    Signal emitted when the operator changed

    onPluginAdded: Signal<(key: never) => void> = ...

    Signal emitted when a plugin has been registered, with the key it is registered under

    onPluginRemoved: Signal<(key: never) => void> = ...

    Signal emitted when a plugin has been unregistered, with the key it was registered under

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

    Signal emitted when the render mode changed

    onSceneBoundsChanged: Signal<() => void> = ...

    Signal emitted when the bounds of the scene changed

    onSceneClear: Signal<() => void> = ...

    Signal emmited when the scene is cleared

    onSceneGraphChanged: Signal<() => void> = ...

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

    onSceneReset: Signal<() => void> = ...

    Signal emitted when the scene is reset

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

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

    onUserCameraMove: Signal<() => void> = ...

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

    onViewportMounted: Signal<(renderer: Renderer) => void> = ...

    The viewport draws on a canvas: its renderer made (Viewport.mount).

    onViewportUnmounted: Signal<() => void> = ...

    The viewport no longer draws on its canvas, its renderer freed (Viewport.unmount).