Class: MaterialConfiguratorBasePlugin

Plugins.MaterialConfiguratorBasePlugin

Hierarchy

• AViewerPlugin<"">

  ↳ MaterialConfiguratorBasePlugin

  ↳↳ MaterialConfiguratorPlugin

Properties

PluginType

▪ Static PluginType: string = 'MaterialConfiguratorBasePlugin'

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:17

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:16

---

dependencies

• dependencies: typeof AssetManagerPlugin[]

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:99

---

variations

• variations: MaterialVariations[] = []

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:102

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:105

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

---

_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:18

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:47

---

addEventListener

▸ addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

Name	Type
type	"" | "serialize" | "deserialize"
listener	(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48

---

hasEventListener

▸ hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

Name	Type
type	"" | "serialize" | "deserialize"
listener	(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Inherited from

AViewerPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56

---

removeEventListener

▸ removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

Name	Type
type	"" | "serialize" | "deserialize"
listener	(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Inherited from

AViewerPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63

---

dispatchEvent

▸ dispatchEvent(event): void

Fire an event type.

Parameters

Name	Type
event	IEvent<"" | "serialize" | "deserialize">

Returns

void

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:22

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | MaterialConfiguratorBasePlugin | Promise<null | MaterialConfiguratorBasePlugin>

Overrides

AViewerPlugin.fromJSON

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:38

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:43

---

findVariation

▸ findVariation(uuid?): undefined | MaterialVariations

Parameters

Name	Type
uuid?	string

Returns

undefined | MaterialVariations

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:56

---

getSelectedVariation

▸ getSelectedVariation(): undefined | MaterialVariations

Returns

undefined | MaterialVariations

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:60

---

applyVariation

▸ applyVariation(variations, matUuid): void

Parameters

Name	Type
variations	MaterialVariations
matUuid	string

Returns

void

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:64

---

refreshUi

▸ refreshUi(): void

Returns

void

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:80

---

removeVariationForMaterial

▸ removeVariationForMaterial(material): void

Parameters

Name	Type
material	IMaterial<any>

Returns

void

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:175

---

removeVariation

▸ removeVariation(variation): void

Parameters

Name	Type
variation	MaterialVariations

Returns

void

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:180

---

addVariation

▸ addVariation(material?): void

Parameters

Name	Type
material?	IMaterial<any>

Returns

void

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:185

---

_refreshUi

▸ Protected _refreshUi(): Promise<boolean>

Returns

Promise<boolean>

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:91

Constructors

constructor

• new MaterialConfiguratorBasePlugin()

Inherited from

AViewerPlugin.constructor

Defined in

webgi/src/helpers/EventDispatcher.ts:39