Class BlueprintJsUiPlugin

Hierarchy

UiConfigRendererBlueprint
- BlueprintJsUiPlugin

Implements

IViewerPluginSync

Index

Constructors

Properties

_viewer? constructor enabled CONTAINER_SLOT PluginType

Accessors

Methods

dispose onAdded onRemove refreshPluginsEnabled setupPlugins setupPluginUi

Constructors

constructor

new BlueprintJsUiPlugin(container?: HTMLElement): BlueprintJsUiPlugin
Parameters
- Optionalcontainer: HTMLElement
Returns BlueprintJsUiPlugin
Overrides UiConfigRendererBlueprint.constructor
- Defined in BlueprintJsUiPlugin.ts:26

Properties

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

constructor

constructor: typeof BlueprintJsUiPlugin

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

enabled

enabled: boolean = true

`Static`CONTAINER_SLOT

CONTAINER_SLOT: string = 'uiconfigMainPanelSlot'

`Static` `Readonly`PluginType

PluginType: "BlueprintJsUi" = 'BlueprintJsUi'

Accessors

fileLoader

get fileLoader(): undefined | ThreeViewer
Required for loading files in BPFileComponent

Returns undefined | ThreeViewer
- Defined in BlueprintJsUiPlugin.ts:162

Methods

dispose

dispose(): void
Returns void
Implementation of IViewerPluginSync.dispose
- Defined in BlueprintJsUiPlugin.ts:72

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Implementation of IViewerPluginSync.onAdded
- Defined in BlueprintJsUiPlugin.ts:46

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Implementation of IViewerPluginSync.onRemove
- Defined in BlueprintJsUiPlugin.ts:61

refreshPluginsEnabled

refreshPluginsEnabled(): void
Returns void
- Defined in BlueprintJsUiPlugin.ts:142

setupPlugins

setupPlugins(...plugins: Class<IViewerPlugin>[]): void
Parameters
- ...plugins: Class<IViewerPlugin>[]
Returns void
- Defined in BlueprintJsUiPlugin.ts:79

setupPluginUi

setupPluginUi<T extends IViewerPlugin>(
plugin: T | Class<T>,
): undefined | UiObjectConfig
Type Parameters
- T extends IViewerPlugin
Parameters
- plugin: T | Class<T>
Returns undefined | UiObjectConfig
- Defined in BlueprintJsUiPlugin.ts:83