Class BlueprintJsUiPlugin

Hierarchy

UiConfigRendererBlueprint
- BlueprintJsUiPlugin

Implements

IViewerPluginSync

Index

Constructors

Properties

_plugins _viewer? constructor enabled PluginType

Accessors

Methods

_postFrame _postRender _preFrame _preRender _setupPluginSerializationContext onAdded onRemove refreshPluginsEnabled setupPluginUi setupPlugins

Constructors

constructor

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

Properties

`Private` _plugins

_plugins: IViewerPlugin<ThreeViewer, boolean>[] = []

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

constructor

constructor: typeof BlueprintJsUiPlugin

enabled

enabled: boolean = true

`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:135

Methods

`Private` _postFrame

_postFrame(e): void
Parameters
- e: IEvent<"postFrame">
Returns void
- Defined in BlueprintJsUiPlugin.ts:141

`Private` _postRender

_postRender(): void
Returns void
- Defined in BlueprintJsUiPlugin.ts:140

`Private` _preFrame

_preFrame(): void
Returns void
- Defined in BlueprintJsUiPlugin.ts:145

`Private` _preRender

_preRender(): void
Returns void
- Defined in BlueprintJsUiPlugin.ts:139

`Private` _setupPluginSerializationContext

_setupPluginSerializationContext(ui, p): void
Parameters
- ui: any
- p: IViewerPlugin<ThreeViewer, boolean>
Returns void
- Defined in BlueprintJsUiPlugin.ts:71

onAdded

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

onRemove

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

refreshPluginsEnabled

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

setupPluginUi

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

setupPlugins

setupPlugins(...plugins): void
Parameters
- Rest ...plugins: Class<IViewerPlugin<ThreeViewer, boolean>>[]
Returns void
- Defined in BlueprintJsUiPlugin.ts:52

Generated using TypeDoc