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

    Plugin adding measure lines: chains of anchors placed on the objects, showing the distances between them (see MeasureLinesOperator). Its measureLineController holds them; the default operator does not pick them. Unregistered, its MeasureLinesOperator gives way to the default one (the line it was drawing cancelled), its lines leave the scene, their engine objects freed, and the commands history is cleared (its commands may hold them).

    Hierarchy

    • PluginBaseClass
      • MeasureLinePlugin
    Index

    Constructors

    Properties

    measureLineController: MeasureLineController

    The controller of the measure lines' anchors, in the scene while registered.

    name: string

    Display name of the plugin

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

    viewer: Viewer

    Methods

    • Returns void

    • None.

      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