Class: MaterialLibraryPlugin
Plugins.MaterialLibraryPlugin
Hierarchy
↳
MaterialLibraryPlugin
Properties
PluginType
▪ Static PluginType: string = 'MaterialLibraryPlugin'
Overrides
MaterialLibraryBasePlugin.PluginType
enabled
• enabled: boolean = true
Inherited from
MaterialLibraryBasePlugin.enabled
dependencies
• dependencies: typeof AssetManagerPlugin[]
Inherited from
MaterialLibraryBasePlugin.dependencies
replaceMaterial
• replaceMaterial: boolean = false
uiConfig
• uiConfig: UiObjectConfig<any, string>
Overrides
MaterialLibraryBasePlugin.uiConfig
_dirty
• Protected _dirty: boolean = false
Inherited from
MaterialLibraryBasePlugin._dirty
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
MaterialLibraryBasePlugin._viewer
_previewGenerator
• Protected _previewGenerator: undefined | MaterialPreviewGenerator
Inherited from
MaterialLibraryBasePlugin._previewGenerator
Constructors
constructor
• new MaterialLibraryPlugin()
Inherited from
MaterialLibraryBasePlugin.constructor
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Inherited from
MaterialLibraryBasePlugin.dirty
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
MaterialLibraryBasePlugin.dirty
viewer
• get viewer(): undefined | ViewerApp
Returns
undefined | ViewerApp
Inherited from
MaterialLibraryBasePlugin.viewer
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
MaterialLibraryBasePlugin.onDispose
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
MaterialLibraryBasePlugin.toJSON
fromJSON
▸ fromJSON(data, meta?): null | MaterialLibraryPlugin | Promise<null | MaterialLibraryPlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | MaterialLibraryPlugin | Promise<null | MaterialLibraryPlugin>
Inherited from
MaterialLibraryBasePlugin.fromJSON
exportState
▸ exportState(): any
Returns
any
Inherited from
MaterialLibraryBasePlugin.exportState
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
MaterialLibraryBasePlugin.importState
storeState
▸ storeState(prefix?, storage?, data?): void
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
MaterialLibraryBasePlugin.storeState
loadState
▸ loadState(prefix?, storage?): Promise<void>
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
Returns
Promise<void>
Inherited from
MaterialLibraryBasePlugin.loadState
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
MaterialLibraryBasePlugin.onAdded
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
MaterialLibraryBasePlugin.onRemove
refreshUi
▸ refreshUi(): void
Returns
void
Inherited from
MaterialLibraryBasePlugin.refreshUi
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
MaterialLibraryBasePlugin._storeKey
_selectedObject
▸ Protected _selectedObject(): undefined | IModel<any, IObject3DEventMap> & Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap>, Object3DEventMap>
Returns
undefined | IModel<any, IObject3DEventMap> & Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap>, Object3DEventMap>
Inherited from
MaterialLibraryBasePlugin._selectedObject
_selectedMaterial
▸ Protected _selectedMaterial(): undefined | IMaterial<any, IMaterialEventMap>
Returns
undefined | IMaterial<any, IMaterialEventMap>
Inherited from
MaterialLibraryBasePlugin._selectedMaterial
_refreshUi
▸ Protected _refreshUi(): Promise<boolean>
Returns
Promise<boolean>