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

    Viewer plugin providing the Teia Digital Twin integration: REST API clients, current-source (twin or file) tracking, Teia object selection helpers, and the related settings.

    Hierarchy

    • PluginBaseClass
      • TeiaPlugin
    Index

    Constructors

    Properties

    name: string

    Display name of the plugin

    queryClient: QueryClient = ...

    Its settings: those saved in the local storage set, then config.

    signals: {
        onSourceChanged: Signal<() => void>;
        onTokenUpdated: Signal<() => void>;
    } = ...

    Type Declaration

    • ReadonlyonSourceChanged: Signal<() => void>

      The source loaded (currentSource) changed.

    • ReadonlyonTokenUpdated: Signal<() => void>

      The user's token changed (settings.token).

    tiaApiClient: ApiClient
    twinApiClient: ApiClient
    viewer: Viewer

    Accessors

    Methods

    • Returns void

    • List of plugins this plugin depends on

      Returns readonly (keyof ViewerPluginRegistry)[]

    • Returns a guid generator of the given Teia objects

      Parameters

      Returns Generator<string, void, unknown>

    • Returns a SceneObject generator of the given Teia objects

      Parameters

      Returns Generator<SceneObject, void, unknown>

    • Returns a guid generator of the given visible Teia objects

      Parameters

      Returns Generator<string, void, unknown>

    • Returns a SceneObject generator of the given visible TTeia objects

      Parameters

      Returns Generator<SceneObject, void, unknown>

    • Whether the plugin has at least one setting an interface shows (not hidden).

      Returns boolean

    • Called when the plugin is registered in the viewer.

      Returns void

    • Called when the plugin is unregistred from the viewer.

      Returns void

    • A base class for a plugin of this name, its settings an instance of SettingsClass (EmptySettings for none): class MyPlugin extends ViewerPlugin.Create('MyPlugin', MySettings) {}.

      Type Parameters

      Parameters

      • name: string
      • SettingsClass: new () => S

      Returns typeof PluginClass