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

    Viewer plugin hosting the React viewport: sets up the widgets system, the spotlight search, keyboard shortcuts and the hierarchy banner, and opens/closes plugin widgets in response to object double-clicks and transform attach/detach events.

    Hierarchy

    • PluginBaseClass
      • ViewportPlugin
    Index

    Constructors

    Properties

    frameAlertController: FrameAlertController = ...
    name: string

    Display name of the plugin

    onToolbarDisabledChanged: Signal<(disabled: boolean) => void> = ...

    Emitted with toolbarDisabled when it changes.

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

    spotlight: Spotlight = ...
    viewer: Viewer
    widgetController: WidgetController = ...
    wrappers: ObservableSet<FunctionComponent<{}>> = ...

    Accessors

    • get toolbarDisabled(): boolean

      Whether the toolbar's items are disabled, e.g. while an operator waits for its validation (see OperatorValidationBehavior). A state of the interface, not a setting: never saved.

      Returns boolean

    • set toolbarDisabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    • Returns void

    • List of plugins this plugin depends on

      Returns readonly "Viewport"[]

    • 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