Class: MaterialConfiguratorBasePlugin
Plugins.MaterialConfiguratorBasePlugin
Hierarchy
AViewerPlugin<"">↳
MaterialConfiguratorBasePlugin
Properties
PluginType
▪ Static PluginType: string = 'MaterialConfiguratorPlugin'
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:17
enabled
• enabled: boolean = true
Overrides
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:16
applyOnLoad
• applyOnLoad: boolean = true
Apply all variations(by selected index or first item) when a config is loaded
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:44
dependencies
• dependencies: typeof AssetManagerPlugin[]
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:113
variations
• variations: MaterialVariations[] = []
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:116
uiConfig
• uiConfig: UiObjectConfig<any, string>
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:119
_dirty
• Protected _dirty: boolean = false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:27
_previewGenerator
• Protected _previewGenerator: undefined | MaterialPreviewGenerator
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:19
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
viewer
• get viewer(): undefined | TViewer
Returns
undefined | TViewer
Inherited from
AViewerPlugin.viewer
Defined in
webgi/src/core/AViewerPlugin.ts:29
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:40
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:49
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:68
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:71
storeState
▸ storeState(prefix?, storage?, data?): void
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:78
loadState
▸ loadState(prefix?, storage?): Promise<void>
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:88
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:30
reapplyAll
▸ reapplyAll(): void
Reapply all selected variations again. Useful when the scene is loaded or changed and the variations are not applied.
Returns
void
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:50
fromJSON
▸ fromJSON(data, meta?): null | MaterialConfiguratorBasePlugin | Promise<null | MaterialConfiguratorBasePlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | MaterialConfiguratorBasePlugin | Promise<null | MaterialConfiguratorBasePlugin>
Overrides
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:54
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:64
findVariation
▸ findVariation(uuid?): undefined | MaterialVariations
Parameters
| Name | Type |
|---|---|
uuid? | string |
Returns
undefined | MaterialVariations
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:77
getSelectedVariation
▸ getSelectedVariation(): undefined | MaterialVariations
Returns
undefined | MaterialVariations
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:81
applyVariation
▸ applyVariation(variations, matUuid): boolean
Parameters
| Name | Type |
|---|---|
variations | MaterialVariations |
matUuid | string |
Returns
boolean
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:85
refreshUi
▸ refreshUi(): void
Returns
void
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:94
removeVariationForMaterial
▸ removeVariationForMaterial(material): void
Parameters
| Name | Type |
|---|---|
material | IMaterial<any> |
Returns
void
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:203
removeVariation
▸ removeVariation(variation): void
Parameters
| Name | Type |
|---|---|
variation | MaterialVariations |
Returns
void
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:208
addVariation
▸ addVariation(material?): void
Parameters
| Name | Type |
|---|---|
material? | IMaterial<any> |
Returns
void
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:213
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:64
_refreshUi
▸ Protected _refreshUi(): Promise<boolean>
Returns
Promise<boolean>
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:105
Constructors
constructor
• new MaterialConfiguratorBasePlugin()