Class TeiaPlugin

Base class for a ViewerPlugin.

Hierarchy (View Summary)

ViewerPlugin<TeiaViewerPluginSettings>
- TeiaPlugin

Index

Constructors

constructor

new TeiaPlugin(
    viewer: Viewer,
    s?: RecursivePartial<
        ExtractValues<
            {
                api: {
                    tiaApiUrl: StringController;
                    token: StringController;
                    twinApiUrl: StringController;
                };
                objectCountWarningLimit: NumberController;
                objectsPerRequest: NumberController;
            },
        >,
    >,
): TeiaPlugin
Parameters
- viewer: Viewer
- Optionals: RecursivePartial<
      ExtractValues<
          {
              api: {
                  tiaApiUrl: StringController;
                  token: StringController;
                  twinApiUrl: StringController;
              };
              objectCountWarningLimit: NumberController;
              objectsPerRequest: NumberController;
          },
      >,
  >
Returns TeiaPlugin
Overrides ViewerPlugin.constructor
- Defined in plugins/src/TeiaPlugin/TeiaPlugin.ts:50

Properties

`Readonly`name

name: string

Display name of the plugin

`Readonly`queryClient

queryClient: QueryClient = ...

`Readonly`settings

settings: {
    api: {
        tiaApiUrl: StringController;
        token: StringController;
        twinApiUrl: StringController;
    };
    objectCountWarningLimit: NumberController;
    objectsPerRequest: NumberController;
}

Plugin settings

`Readonly`signals

signals: {
    onSettingsMapSaved: ViewerSignal<(...args: any[]) => any>;
    onSourceChanged: ViewerSignal<(...args: any[]) => any>;
    onTokenUpdated: ViewerSignal<(...args: any[]) => any>;
} = ...

`Readonly`tiaApiClient

tiaApiClient: ApiClient

`Readonly`twinApiClient

twinApiClient: ApiClient

`Readonly`viewer

viewer: Viewer

Accessors

currentSource

get currentSource(): TwinSource | FileSource | null
Returns TwinSource | FileSource | null
- Defined in plugins/src/TeiaPlugin/TeiaPlugin.ts:88

Methods

clear

clear(): void
Returns void
Inherited from ViewerPlugin.clear
- Defined in viewer/src/core/ViewerPlugin.ts:78

dependencies

dependencies(): readonly (keyof ViewerPluginRegistry)[]
List of plugins this plugin depends on

Returns readonly (keyof ViewerPluginRegistry)[]
Inherited from ViewerPlugin.dependencies
- Defined in viewer/src/core/ViewerPlugin.ts:60

getGuidForTeiaObjects

getGuidForTeiaObjects(
objects: Iterable<TeiaObject>,
): Generator<string, void, unknown>
Returns a guid generator of the given Teia objects
Parameters
- objects: Iterable<TeiaObject>
Returns Generator<string, void, unknown>
- Defined in plugins/src/TeiaPlugin/TeiaPlugin.ts:126

getSceneObjectForTeiaObjects

getSceneObjectForTeiaObjects(
objects: Iterable<TeiaObject>,
): Generator<SceneObject, void, unknown>
Returns a SceneObject generator of the given Teia objects
Parameters
- objects: Iterable<TeiaObject>
Returns Generator<SceneObject, void, unknown>
- Defined in plugins/src/TeiaPlugin/TeiaPlugin.ts:141

getVisibleGuidsForTeiaObjects

getVisibleGuidsForTeiaObjects(
objects: Iterable<TeiaObject>,
): Generator<string, void, unknown>
Returns a guid generator of the given visible Teia objects
Parameters
- objects: Iterable<TeiaObject>
Returns Generator<string, void, unknown>
- Defined in plugins/src/TeiaPlugin/TeiaPlugin.ts:165

getVisibleSceneObjectForTeiaObjects

getVisibleSceneObjectForTeiaObjects(
objects: Iterable<TeiaObject>,
): Generator<SceneObject, void, unknown>
Returns a SceneObject generator of the given visible TTeia objects
Parameters
- objects: Iterable<TeiaObject>
Returns Generator<SceneObject, void, unknown>
- Defined in plugins/src/TeiaPlugin/TeiaPlugin.ts:151

hasSettings

hasSettings(): boolean
Indicates whether the plugin has settings

Returns boolean
Inherited from ViewerPlugin.hasSettings
- Defined in viewer/src/core/ViewerPlugin.ts:52

onRegister

onRegister(): void
Called when the plugin is registered in the viewer.

Returns void
Overrides ViewerPlugin.onRegister
- Defined in plugins/src/TeiaPlugin/TeiaPlugin.ts:92

onUnregister

onUnregister(): void
Called when the plugin is unregistred from the viewer.

Returns void
Overrides ViewerPlugin.onUnregister
- Defined in plugins/src/TeiaPlugin/TeiaPlugin.ts:103

`Static`Create

Create<S extends SettingsRecord = Record<string, never>>(
name: string,
settingFunc?: PluginSettingBuildFunction<S>,
): typeof PluginClass
Type Parameters
- S extends SettingsRecord = Record<string, never>
Parameters
- name: string
- settingFunc: PluginSettingBuildFunction<S> = ...
Returns typeof PluginClass
Inherited from ViewerPlugin.Create
- Defined in viewer/src/core/ViewerPlugin.ts:82

Class TeiaPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TeiaPlugin

Properties

Readonlyname

ReadonlyqueryClient

Readonlysettings

Readonlysignals

ReadonlytiaApiClient

ReadonlytwinApiClient

Readonlyviewer

Accessors

currentSource

Returns TwinSource | FileSource | null

Methods

clear

Returns void

dependencies

Returns readonly (keyof ViewerPluginRegistry)[]

getGuidForTeiaObjects

Parameters

Returns Generator<string, void, unknown>

getSceneObjectForTeiaObjects

Parameters

Returns Generator<SceneObject, void, unknown>

getVisibleGuidsForTeiaObjects

Parameters

Returns Generator<string, void, unknown>

getVisibleSceneObjectForTeiaObjects

Parameters

Returns Generator<SceneObject, void, unknown>

hasSettings

Returns boolean

onRegister

Returns void

onUnregister

Returns void

StaticCreate

Type Parameters

Parameters

Returns typeof PluginClass

Settings

On This Page

`Readonly`name

`Readonly`queryClient

`Readonly`settings

`Readonly`signals

`Readonly`tiaApiClient

`Readonly`twinApiClient

`Readonly`viewer

`Static`Create