Documentation - v19.12.0-dev
    Preparing search index...

    Class MapPlugin

    Plugin that overlays a geolocated, textured map plane under the scene and keeps it in sync with the loaded twin's reference position.

    Hierarchy

    • PluginBaseClass
      • MapPlugin
    Index

    Constructors

    constructor

    Properties

    mapContainer name settings signals viewer

    Methods

    clear dependencies hasSettings onRegister onUnregister Create

    Constructors

    Properties

    mapContainer: MapContainer | null = null
    name: string

    Display name of the plugin

    settings: {
        nbOfPlanesPerLine: NumberController;
        opacity: NumberController;
        planeSize: NumberController;
        shape: SelectController<readonly [square, circle]>;
        showMap: BooleanController;
        size: NumberController;
        type: SelectController<readonly [default, simple, satellite, cadastral]>;
    }

    Plugin settings

    signals: {
        onMapInSceneChanged: ViewerSignal<(isInScene: boolean) => void>;
        onSettingsMapSaved: ViewerSignal<(...args: any[]) => any>;
    } = ...
    viewer: Viewer

    Methods

    • Returns void

    • List of plugins this plugin depends on

      Returns readonly (keyof ViewerPluginRegistry)[]

    • Indicates whether the plugin has settings

      Returns boolean

    • Called when the plugin is registered in the viewer.

      Returns void

    • Called when the plugin is unregistred from the viewer.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods