Class: MaterialConfiguratorPlugin
Plugins.MaterialConfiguratorPlugin
Hierarchy
MaterialConfiguratorBasePlugin↳
MaterialConfiguratorPlugin
Properties
PluginType
▪ Static PluginType: string = 'MaterialConfiguratorPlugin'
Overrides
MaterialConfiguratorBasePlugin.PluginType
Defined in
webgi/src/plugins/MaterialConfiguratorPlugin.ts:8
enabled
• enabled: boolean = true
Inherited from
MaterialConfiguratorBasePlugin.enabled
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:16
dependencies
• dependencies: typeof AssetManagerPlugin[]
Inherited from
MaterialConfiguratorBasePlugin.dependencies
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:90
variations
• variations: MaterialVariations[] = []
Inherited from
MaterialConfiguratorBasePlugin.variations
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:93
uiConfig
• uiConfig: UiObjectConfig<any, string>
Inherited from
MaterialConfiguratorBasePlugin.uiConfig
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:96
enableEditContextMenus
• enableEditContextMenus: boolean = false
Defined in
webgi/src/plugins/MaterialConfiguratorPlugin.ts:10
_dirty
• Protected _dirty: boolean = false
Inherited from
MaterialConfiguratorBasePlugin._dirty
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
MaterialConfiguratorBasePlugin._viewer
Defined in
webgi/src/core/AViewerPlugin.ts:27
_previewGenerator
• Protected _previewGenerator: undefined | MaterialPreviewGenerator
Inherited from
MaterialConfiguratorBasePlugin._previewGenerator
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:19
Constructors
constructor
• new MaterialConfiguratorPlugin()
Inherited from
MaterialConfiguratorBasePlugin.constructor
Defined in
webgi/node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:41
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Inherited from
MaterialConfiguratorBasePlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
MaterialConfiguratorBasePlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
MaterialConfiguratorBasePlugin.onDispose
Defined in
webgi/src/core/AViewerPlugin.ts:36
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
MaterialConfiguratorBasePlugin.toJSON
Defined in
webgi/src/core/AViewerPlugin.ts:45
exportState
▸ exportState(): any
Returns
any
Inherited from
MaterialConfiguratorBasePlugin.exportState
Defined in
webgi/src/core/AViewerPlugin.ts:64
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
MaterialConfiguratorBasePlugin.importState
Defined in
webgi/src/core/AViewerPlugin.ts:67
storeState
▸ storeState(prefix?, storage?, data?): void
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
MaterialConfiguratorBasePlugin.storeState
Defined in
webgi/src/core/AViewerPlugin.ts:74
loadState
▸ loadState(prefix?, storage?): Promise<void>
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
Returns
Promise<void>
Inherited from
MaterialConfiguratorBasePlugin.loadState
Defined in
webgi/src/core/AViewerPlugin.ts:84
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
MaterialConfiguratorBasePlugin.onAdded
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:22
fromJSON
▸ fromJSON(data, meta?): null | MaterialConfiguratorPlugin | Promise<null | MaterialConfiguratorPlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | MaterialConfiguratorPlugin | Promise<null | MaterialConfiguratorPlugin>
Inherited from
MaterialConfiguratorBasePlugin.fromJSON
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:37
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
MaterialConfiguratorBasePlugin.onRemove
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:42
findVariation
▸ findVariation(uuid?): undefined | MaterialVariations
Parameters
| Name | Type |
|---|---|
uuid? | string |
Returns
undefined | MaterialVariations
Inherited from
MaterialConfiguratorBasePlugin.findVariation
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:55
getSelectedVariation
▸ getSelectedVariation(): undefined | MaterialVariations
Returns
undefined | MaterialVariations
Inherited from
MaterialConfiguratorBasePlugin.getSelectedVariation
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:59
applyVariation
▸ applyVariation(variations, matUuid): boolean
Parameters
| Name | Type |
|---|---|
variations | MaterialVariations |
matUuid | string |
Returns
boolean
Inherited from
MaterialConfiguratorBasePlugin.applyVariation
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:63
refreshUi
▸ refreshUi(): void
Returns
void
Inherited from
MaterialConfiguratorBasePlugin.refreshUi
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:71
removeVariationForMaterial
▸ removeVariationForMaterial(material): void
Parameters
| Name | Type |
|---|---|
material | IMaterial<any> |
Returns
void
Inherited from
MaterialConfiguratorBasePlugin.removeVariationForMaterial
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:173
removeVariation
▸ removeVariation(variation): void
Parameters
| Name | Type |
|---|---|
variation | MaterialVariations |
Returns
void
Inherited from
MaterialConfiguratorBasePlugin.removeVariation
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:178
addVariation
▸ addVariation(material?): void
Parameters
| Name | Type |
|---|---|
material? | IMaterial<any> |
Returns
void
Inherited from
MaterialConfiguratorBasePlugin.addVariation
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:183
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
MaterialConfiguratorBasePlugin._storeKey
Defined in
webgi/src/core/AViewerPlugin.ts:60
_refreshUi
▸ Protected _refreshUi(): Promise<boolean>
Returns
Promise<boolean>
Overrides
MaterialConfiguratorBasePlugin._refreshUi