Skip to main content

Class: MaterialLibraryBasePlugin

Plugins.MaterialLibraryBasePlugin

Hierarchy

Properties

PluginType

Static PluginType: string = 'MaterialLibraryBasePlugin'

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:15


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:13


dependencies

dependencies: typeof AssetManagerPlugin[]

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:76


uiConfig

Optional uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:81


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29


_previewGenerator

Protected _previewGenerator: undefined | MaterialPreviewGenerator

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:17

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:47


fromJSON

fromJSON(data, meta?): null | MaterialLibraryBasePlugin | Promise<null | MaterialLibraryBasePlugin>

Parameters

NameType
dataany
meta?any

Returns

null | MaterialLibraryBasePlugin | Promise<null | MaterialLibraryBasePlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:54


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Inherited from

AViewerPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:20


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:35


refreshUi

refreshUi(): void

Returns

void

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:50


_refreshUi

Protected _refreshUi(): Promise<boolean>

Returns

Promise<boolean>

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:61


_selectedObject

Protected _selectedObject(): undefined | IModel<any> & Mesh<BufferGeometry, Material>

Returns

undefined | IModel<any> & Mesh<BufferGeometry, Material>

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:78


_selectedMaterial

Protected _selectedMaterial(): undefined | IMaterial<any>

Returns

undefined | IMaterial<any>

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:79

Constructors

constructor

new MaterialLibraryBasePlugin()

Inherited from

AViewerPlugin.constructor

Defined in

webgi/src/helpers/EventDispatcher.ts:39