Skip to main content

Class: MaterialLibraryPlugin

Plugins.MaterialLibraryPlugin

Hierarchy

Properties

PluginType

Static PluginType: string = 'MaterialLibraryPlugin'

Overrides

MaterialLibraryBasePlugin.PluginType

Defined in

webgi/src/plugins/MaterialLibraryPlugin.ts:14


enabled

enabled: boolean = true

Inherited from

MaterialLibraryBasePlugin.enabled

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:13


dependencies

dependencies: typeof AssetManagerPlugin[]

Inherited from

MaterialLibraryBasePlugin.dependencies

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:76


replaceMaterial

replaceMaterial: boolean = false

Defined in

webgi/src/plugins/MaterialLibraryPlugin.ts:29


uiConfig

uiConfig: UiObjectConfig<any, string>

Overrides

MaterialLibraryBasePlugin.uiConfig

Defined in

webgi/src/plugins/MaterialLibraryPlugin.ts:31


_dirty

Protected _dirty: boolean = false

Inherited from

MaterialLibraryBasePlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

MaterialLibraryBasePlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29


_previewGenerator

Protected _previewGenerator: undefined | MaterialPreviewGenerator

Inherited from

MaterialLibraryBasePlugin._previewGenerator

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:17

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

MaterialLibraryBasePlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

MaterialLibraryBasePlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

MaterialLibraryBasePlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

MaterialLibraryBasePlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:47


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | MaterialLibraryPlugin | Promise<null | MaterialLibraryPlugin>

Inherited from

MaterialLibraryBasePlugin.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

MaterialLibraryBasePlugin.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

MaterialLibraryBasePlugin.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

MaterialLibraryBasePlugin.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

MaterialLibraryBasePlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

MaterialLibraryBasePlugin.onAdded

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:20


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

MaterialLibraryBasePlugin.onRemove

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:35


refreshUi

refreshUi(): void

Returns

void

Inherited from

MaterialLibraryBasePlugin.refreshUi

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:50


_selectedObject

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

Returns

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

Inherited from

MaterialLibraryBasePlugin._selectedObject

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:78


_selectedMaterial

Protected _selectedMaterial(): undefined | IMaterial<any>

Returns

undefined | IMaterial<any>

Inherited from

MaterialLibraryBasePlugin._selectedMaterial

Defined in

webgi/src/plugins/MaterialLibraryBasePlugin.ts:79


_refreshUi

Protected _refreshUi(): Promise<boolean>

Returns

Promise<boolean>

Overrides

MaterialLibraryBasePlugin._refreshUi

Defined in

webgi/src/plugins/MaterialLibraryPlugin.ts:78

Constructors

constructor

new MaterialLibraryPlugin()

Inherited from

MaterialLibraryBasePlugin.constructor

Defined in

webgi/src/helpers/EventDispatcher.ts:39