Class: MaterialConfiguratorPlugin

Plugins.MaterialConfiguratorPlugin

Hierarchy

• MaterialConfiguratorBasePlugin

  ↳ MaterialConfiguratorPlugin

Properties

PluginType

▪ Static PluginType: string = 'MaterialConfiguratorPlugin'

Overrides

MaterialConfiguratorBasePlugin.PluginType

---

enabled

• enabled: boolean = true

Inherited from

MaterialConfiguratorBasePlugin.enabled

---

applyOnLoad

• applyOnLoad: boolean = true

Apply all variations(by selected index or first item) when a config is loaded

Inherited from

MaterialConfiguratorBasePlugin.applyOnLoad

---

dependencies

• dependencies: typeof AssetManagerPlugin[]

Inherited from

MaterialConfiguratorBasePlugin.dependencies

---

variations

• variations: MaterialVariations[] = []

Inherited from

MaterialConfiguratorBasePlugin.variations

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Inherited from

MaterialConfiguratorBasePlugin.uiConfig

---

enableEditContextMenus

• enableEditContextMenus: boolean = false

---

_dirty

• Protected _dirty: boolean = false

Inherited from

MaterialConfiguratorBasePlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

MaterialConfiguratorBasePlugin._viewer

---

_previewGenerator

• Protected _previewGenerator: undefined | MaterialPreviewGenerator

Inherited from

MaterialConfiguratorBasePlugin._previewGenerator

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

MaterialConfiguratorBasePlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

MaterialConfiguratorBasePlugin.viewer

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

MaterialConfiguratorBasePlugin.onDispose

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

MaterialConfiguratorBasePlugin.toJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

MaterialConfiguratorBasePlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

MaterialConfiguratorBasePlugin.importState

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.storeState

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

MaterialConfiguratorBasePlugin.loadState

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

MaterialConfiguratorBasePlugin.onAdded

---

reapplyAll

▸ reapplyAll(): void

Reapply all selected variations again. Useful when the scene is loaded or changed and the variations are not applied.

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.reapplyAll

---

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

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

MaterialConfiguratorBasePlugin.onRemove

---

findVariation

▸ findVariation(uuid?): undefined | MaterialVariations

Parameters

Name	Type
uuid?	string

Returns

undefined | MaterialVariations

Inherited from

MaterialConfiguratorBasePlugin.findVariation

---

getSelectedVariation

▸ getSelectedVariation(): undefined | MaterialVariations

Returns

undefined | MaterialVariations

Inherited from

MaterialConfiguratorBasePlugin.getSelectedVariation

---

applyVariation

▸ applyVariation(variations, matUuidOrIndex): boolean

Apply a material variation based on index or uuid.

Parameters

Name	Type
variations	MaterialVariations
matUuidOrIndex	string | number

Returns

boolean

Inherited from

MaterialConfiguratorBasePlugin.applyVariation

---

getPreview

▸ getPreview(material, preview, viewerSetDirty?): string

Get the preview for a material variation Should be called from preFrame ideally. (or preRender but set viewerSetDirty = false)

Parameters

Name	Type	Default value	Description
material	IMaterial<any, IMaterialEventMap>	undefined	Material or index of the material in the variation.
preview	string	undefined	Type of preview. Could be generate:sphere, generate:cube, color, map, emissive, etc.
viewerSetDirty	boolean	true	call viewer.setDirty() after setting the preview. So that the preview is cleared from the canvas.

Returns

string

Inherited from

MaterialConfiguratorBasePlugin.getPreview

---

refreshUi

▸ refreshUi(): void

Refreshes the UI in the next frame

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.refreshUi

---

removeVariationForMaterial

▸ removeVariationForMaterial(material): void

Parameters

Name	Type
material	IMaterial<any, IMaterialEventMap>

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.removeVariationForMaterial

---

removeVariation

▸ removeVariation(variation): void

Parameters

Name	Type
variation	MaterialVariations

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.removeVariation

---

addVariation

▸ addVariation(material?, variationKey?, cloneMaterial?): void

Parameters

Name	Type	Default value
material?	IMaterial<any, IMaterialEventMap>	undefined
variationKey?	string	undefined
cloneMaterial	boolean	true

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.addVariation

---

createVariation

▸ createVariation(material, variationKey?): MaterialVariations

Parameters

Name	Type
material	IMaterial<any, IMaterialEventMap>
variationKey?	string

Returns

MaterialVariations

Inherited from

MaterialConfiguratorBasePlugin.createVariation

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

MaterialConfiguratorBasePlugin._storeKey

---

_refreshUi

▸ Protected _refreshUi(): Promise<boolean>

Returns

Promise<boolean>

Overrides

MaterialConfiguratorBasePlugin._refreshUi

Constructors

constructor

• new MaterialConfiguratorPlugin()

Inherited from

MaterialConfiguratorBasePlugin.constructor