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

    Plugin that shows the 2D floor plans of a Teia twin in the scene: the FloorPlans of its floorPlanController, added by AddFloorPlanCommand, with their context menu (remove a plan). Unregistered, its plans leave the scene, their engine objects freed, and the commands history is cleared (its commands may hold them).

    Hierarchy

    • PluginBaseClass
      • FloorPlanPlugin
    Index

    Constructors

    Properties

    floorPlanController: FloorPlanController

    The controller of the plans, in the scene while the plugin is registered.

    name: string

    Display name of the plugin

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

    viewer: Viewer

    Methods

    • Returns void

    • Teia: the plans are read from its twins.

      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