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

    Plugin that lets users create zones: markup meshes over objects (a box, a sphere, or a copy of an object's geometry, see AddZoneCommand), the Zones of its zoneController. It adds their context menu (remove a zone, all of them) and keeps the transform tool on the zones while its ZoneOperator is active. Unregistered, its zones leave the scene, their engine objects freed, and the commands history is cleared (its commands may hold them).

    Hierarchy

    • PluginBaseClass
      • ZonePlugin
    Index

    Constructors

    • Parameters

      Returns ZonePlugin

    Properties

    name: string

    Display name of the plugin

    settings: EmptySettings

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

    viewer: Viewer
    zoneController: ZoneController

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

    Methods

    • Returns void

    • Teia: its ZoneOperator is Teia's transform operator.

      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