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

    Base class that handles data and events of a 3D scene.

    Index

    Constructors

    Properties

    behaviorController: BehaviorController
    commandHistory: CommandHistory
    developerTools: DeveloperToolController
    objectStateHistory: ObjectStateHistory

    Handle the history of object states

    sceneLoader: SceneLoader
    settings: ViewerSettings = ...

    Viewer settings

    settingsStorageKey: string

    Key of settings in the local storage (ViewerOptions.settingsStorageKey).

    signals: ViewerSignals

    Signals emitted by the viewer

    viewport: Viewport

    The view on the scene: camera, controls, gizmo, operators. Made with the viewer, it draws once mounted on a canvas (viewport.mount(canvas)).

    Accessors

    • get pluginKeys(): MapIterator<never>

      Returns an iterator over the keys of the registered plugins.

      Returns MapIterator<never>

    • get version(): string

      Returns the viewer version defined in package.json

      Returns string

    Methods

    • Returns void

    • Permanently releases the viewer and every resource it owns.

      Calling this method more than once has no effect. A disposed viewer must not be reused.

      Returns void

    • Key of a plugin's settings in the local storage, next to the viewer's.

      Parameters

      • pluginName: string

      Returns string

    • Returns whether the given plugin (identified with its key) has been registered in the viewer

      Type Parameters

      • TKey extends never

      Parameters

      Returns boolean

    • Registers the given plugin to the viewer

      Type Parameters

      • TKey extends never
      • TPlugin extends never

      Parameters

      Returns void

    • Asks the viewport for a frame, once mounted (see Renderer.requestFrame).

      Returns void

    • Saves the settings of the viewer and of its plugins in the local storage.

      Returns void

    • Unregisters the plugin from the viewer. The plugins depending on it are unregistered first, recursively, while their dependencies are still registered.

      Type Parameters

      • TKey extends never

      Parameters

      • key: TKey

        The plugin key.

      Returns void