Skip to main content

Class: MaterialConfiguratorPlugin

Plugins.MaterialConfiguratorPlugin

Hierarchy

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:99


variations

variations: MaterialVariations[] = []

Inherited from

MaterialConfiguratorBasePlugin.variations

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:102


uiConfig

uiConfig: UiObjectConfig<any, string>

Inherited from

MaterialConfiguratorBasePlugin.uiConfig

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:105


_dirty

Protected _dirty: boolean = false

Inherited from

MaterialConfiguratorBasePlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

MaterialConfiguratorBasePlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29


_previewGenerator

Protected _previewGenerator: undefined | MaterialPreviewGenerator

Inherited from

MaterialConfiguratorBasePlugin._previewGenerator

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:19

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

MaterialConfiguratorBasePlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

MaterialConfiguratorBasePlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

MaterialConfiguratorBasePlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:47


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

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

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

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

Returns

boolean

Inherited from

MaterialConfiguratorBasePlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

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

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

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

NameType
dataany
meta?any

Returns

null | MaterialConfiguratorPlugin | Promise<null | MaterialConfiguratorPlugin>

Inherited from

MaterialConfiguratorBasePlugin.fromJSON

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:38


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

MaterialConfiguratorBasePlugin.onRemove

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:43


findVariation

findVariation(uuid?): undefined | MaterialVariations

Parameters

NameType
uuid?string

Returns

undefined | MaterialVariations

Inherited from

MaterialConfiguratorBasePlugin.findVariation

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:56


getSelectedVariation

getSelectedVariation(): undefined | MaterialVariations

Returns

undefined | MaterialVariations

Inherited from

MaterialConfiguratorBasePlugin.getSelectedVariation

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:60


applyVariation

applyVariation(variations, matUuid): void

Parameters

NameType
variationsMaterialVariations
matUuidstring

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.applyVariation

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:64


refreshUi

refreshUi(): void

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.refreshUi

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:80


removeVariationForMaterial

removeVariationForMaterial(material): void

Parameters

NameType
materialIMaterial<any>

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.removeVariationForMaterial

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:175


removeVariation

removeVariation(variation): void

Parameters

NameType
variationMaterialVariations

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.removeVariation

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:180


addVariation

addVariation(material?): void

Parameters

NameType
material?IMaterial<any>

Returns

void

Inherited from

MaterialConfiguratorBasePlugin.addVariation

Defined in

webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:185


_refreshUi

Protected _refreshUi(): Promise<boolean>

Returns

Promise<boolean>

Overrides

MaterialConfiguratorBasePlugin._refreshUi

Defined in

webgi/src/plugins/MaterialConfiguratorPlugin.ts:11

Constructors

constructor

new MaterialConfiguratorPlugin()

Inherited from

MaterialConfiguratorBasePlugin.constructor

Defined in

webgi/src/helpers/EventDispatcher.ts:39