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

    Plugin that shows a geolocated map under the twins loaded, at their reference position: its mapContainer, three.js planes textured by the map's tiles, drawn outside the engine.

    Hierarchy

    • PluginBaseClass
      • MapPlugin
    Index

    Constructors

    Properties

    mapContainer: MapContainer | null = null

    The map, while a twin is loaded and MapPluginSettings.showMap is on.

    name: string

    Display name of the plugin

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

    signals: {
        onMapInSceneChanged: Signal<(isInScene: boolean) => void>;
        onSettingsMapSaved: Signal<() => void>;
    } = ...

    Type Declaration

    • onMapInSceneChanged: Signal<(isInScene: boolean) => void>

      The map came into the scene (true) or left it (false).

    • onSettingsMapSaved: Signal<() => void>

      The map's place was saved to the twin's project.

    viewer: Viewer

    Methods

    • Returns void

    • Teia: the map is placed from the twin's project.

      Returns readonly (keyof ViewerPluginRegistry)[]

    • 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