Class MaterialConfiguratorPlugin

Material Configurator Plugin (Basic UI) This plugin allows you to create variations of materials mapped to material names or uuids in the scene. These variations can be applied to the materials in the scene. (This copies the properties to the same material instances instead of assigning new materials) The plugin interfaces with the picking plugin and also provides uiConfig to show and edit the variations. This functionality is inherited from MaterialConfiguratorBasePlugin

Additionally, this plugin adds a Grid UI using GridItemListPlugin in the DOM over the viewer canvas to show various material variations and allow the user to apply them. The UI can also be used in the editor to edit the variations and apply them.

Hierarchy

MaterialConfiguratorBasePlugin
- MaterialConfiguratorPlugin

Constructors

constructor

new MaterialConfiguratorPlugin(): MaterialConfiguratorPlugin
Returns MaterialConfiguratorPlugin
Inherited from MaterialConfiguratorBasePlugin.constructor
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:30

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected`_previewGenerator

_previewGenerator: undefined | MaterialPreviewGenerator

`Protected`_uicShowAllVariations

_uicShowAllVariations: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

animateApply

animateApply: boolean = true

Animate the material change when applying a variation.

animateApplyDuration

animateApplyDuration: number = 500

Duration of the animation when applying a variation in ms

applyOnLoad

applyOnLoad: boolean = true

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

applyOnLoadForce

applyOnLoadForce: boolean = false

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof GridItemListPlugin[] = ...

enabled

enabled: boolean = true

enableEditContextMenus

enableEditContextMenus: boolean = false

uiConfig

uiConfig: UiObjectConfig = ...

variations

variations: MaterialVariations[] = []

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static`PluginType

PluginType: string = 'MaterialConfiguratorPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from MaterialConfiguratorBasePlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from MaterialConfiguratorBasePlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from MaterialConfiguratorBasePlugin._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:68

`Protected`_preFrame

_preFrame(): boolean
Returns boolean
Inherited from MaterialConfiguratorBasePlugin._preFrame
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:215

`Protected`_refreshUi

_refreshUi(): Promise<boolean>
Returns Promise<boolean>
Overrides MaterialConfiguratorBasePlugin._refreshUi
- Defined in plugins/configurator/src/MaterialConfiguratorPlugin.ts:31

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from MaterialConfiguratorBasePlugin._storeKey
- Defined in src/viewer/AViewerPlugin.ts:54

addVariation

addVariation(
    material?: IMaterial<IMaterialEventMap>,
    variationKey?: string,
    cloneMaterial?: boolean,
): void
Parameters
- Optionalmaterial: IMaterial<IMaterialEventMap>
- OptionalvariationKey: string
- cloneMaterial: boolean = true
Returns void
Inherited from MaterialConfiguratorBasePlugin.addVariation
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:416

applyVariation

applyVariation(
    variations: MaterialVariations,
    matUuidOrIndex: string | number,
    setSelectedIndex?: boolean,
    time?: AnimateTime & { from?: string | number },
): boolean
Apply a material variation based on index or uuid.
Parameters
- variations: MaterialVariations
- matUuidOrIndex: string | number
- OptionalsetSelectedIndex: boolean
  default true, to be used with animation
- Optionaltime: AnimateTime & { from?: string | number }
  optional data to animate(lerp) from current value to the target material.
Returns boolean
Inherited from MaterialConfiguratorBasePlugin.applyVariation
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:120

applyVariationAnimate

applyVariationAnimate(
    variations: MaterialVariations,
    matUuidOrIndex: string | number,
    duration?: number,
): Promise<void>
Parameters
- variations: MaterialVariations
- matUuidOrIndex: string | number
- duration: number = 500
Returns Promise<void>
Inherited from MaterialConfiguratorBasePlugin.applyVariationAnimate
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:137

createVariation

createVariation(material: IMaterial, variationKey?: string): MaterialVariations
Parameters
- material: IMaterial
- OptionalvariationKey: string
Returns MaterialVariations
Inherited from MaterialConfiguratorBasePlugin.createVariation
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:429

createVariationsUiConfig

createVariationsUiConfig(
v?: MaterialVariations,
): undefined | { children: {}[]; label: string; type: string; uuid: string }
Parameters
- Optionalv: MaterialVariations
Returns undefined | { children: {}[]; label: string; type: string; uuid: string }
Inherited from MaterialConfiguratorBasePlugin.createVariationsUiConfig
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:287

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from MaterialConfiguratorBasePlugin.disable
- Defined in src/viewer/AViewerPlugin.ts:75

dispose

dispose(): void
Returns void
Inherited from MaterialConfiguratorBasePlugin.dispose
- Defined in src/viewer/AViewerPlugin.ts:34

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from MaterialConfiguratorBasePlugin.enable
- Defined in src/viewer/AViewerPlugin.ts:80

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from MaterialConfiguratorBasePlugin.exportState
- Defined in src/viewer/AViewerPlugin.ts:59

findMaterialVariation

findMaterialVariation(
matUuidOrIndex: string | number,
variations: MaterialVariations,
): undefined | IMaterial<IMaterialEventMap>
Parameters
- matUuidOrIndex: string | number
- variations: MaterialVariations
Returns undefined | IMaterial<IMaterialEventMap>
Inherited from MaterialConfiguratorBasePlugin.findMaterialVariation
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:131

findVariation

findVariation(mapping?: string): undefined | MaterialVariations
Parameters
- Optionalmapping: string
Returns undefined | MaterialVariations
Inherited from MaterialConfiguratorBasePlugin.findVariation
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:98

fromJSON

fromJSON(
    data: any,
    meta?: any,
):
    | null
    | MaterialConfiguratorPlugin
    | Promise<null | MaterialConfiguratorPlugin>
Parameters
- data: any
- Optionalmeta: any
Returns null | MaterialConfiguratorPlugin | Promise<null | MaterialConfiguratorPlugin>
Inherited from MaterialConfiguratorBasePlugin.fromJSON
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:74

getPreview

getPreview(
    material: IMaterial,
    preview: string,
    viewerSetDirty?: boolean,
): string
Get the preview for a material variation Should be called from preFrame ideally. (or preRender but set viewerSetDirty = false)
Parameters
- material: IMaterial
  Material or index of the material in the variation.
- preview: string
  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
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:171

getSelectedVariation

getSelectedVariation(): undefined | MaterialVariations
Returns undefined | MaterialVariations
Inherited from MaterialConfiguratorBasePlugin.getSelectedVariation
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:105

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from MaterialConfiguratorBasePlugin.importState
- Defined in src/viewer/AViewerPlugin.ts:62

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from MaterialConfiguratorBasePlugin.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:85

materialContextMenuItems

materialContextMenuItems(
variation: MaterialVariations,
uuid: string,
): { Remove: () => Promise<void> }
Parameters
- variation: MaterialVariations
- uuid: string
Returns { Remove: () => Promise<void> }
- Defined in plugins/configurator/src/MaterialConfiguratorPlugin.ts:76

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from MaterialConfiguratorBasePlugin.onAdded
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:39

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from MaterialConfiguratorBasePlugin.onRemove
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:84

reapplyAll

reapplyAll(): void
Reapply all selected variations again. Useful when a model or config is loaded or changed and the variations are not applied in the model. It is automatically called when the config is loaded if applyOnLoad is true.

Returns void
Inherited from MaterialConfiguratorBasePlugin.reapplyAll
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:67

refreshUi

refreshUi(): void
Refreshes the UI in the next frame

Returns void
Inherited from MaterialConfiguratorBasePlugin.refreshUi
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:195

removeVariation

removeVariation(variation: MaterialVariations): void
Parameters
- variation: MaterialVariations
Returns void
Inherited from MaterialConfiguratorBasePlugin.removeVariation
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:411

removeVariationForMaterial

removeVariationForMaterial(material: IMaterial): void
Parameters
- material: IMaterial
Returns void
Inherited from MaterialConfiguratorBasePlugin.removeVariationForMaterial
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:406

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from MaterialConfiguratorBasePlugin.setDirty
- Defined in src/viewer/AViewerPlugin.ts:89

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from MaterialConfiguratorBasePlugin.toJSON
- Defined in src/viewer/AViewerPlugin.ts:38

variationsContextMenuItems

variationsContextMenuItems(
    variation: MaterialVariations,
): {
    "Clear Materials": () => Promise<void>;
    "Remove Section": () => Promise<void>;
    "Rename mapping": () => Promise<void>;
    "Rename title": () => Promise<void>;
}
Parameters
- variation: MaterialVariations
Returns {
    "Clear Materials": () => Promise<void>;
    "Remove Section": () => Promise<void>;
    "Rename mapping": () => Promise<void>;
    "Rename title": () => Promise<void>;
}
- Defined in plugins/configurator/src/MaterialConfiguratorPlugin.ts:86

Class MaterialConfiguratorPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MaterialConfiguratorPlugin

Properties

Protected_dirty

Protected_previewGenerator

Protected_uicShowAllVariations

Protected Optional_viewer

Protected_viewerListeners

animateApply

animateApplyDuration

applyOnLoad

applyOnLoadForce

constructor

dependencies

enabled

enableEditContextMenus

uiConfig

variations

Static Optional ReadonlyOldPluginType

StaticPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_preFrame

Returns boolean

Protected_refreshUi

Returns Promise<boolean>

Protected_storeKey

Parameters

Returns string

addVariation

Parameters

Returns void

applyVariation

Parameters

Returns boolean

applyVariationAnimate

Parameters

Returns Promise<void>

createVariation

Parameters

Returns MaterialVariations

createVariationsUiConfig

Parameters

Returns undefined | { children: {}[]; label: string; type: string; uuid: string }

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

findMaterialVariation

Parameters

Returns undefined | IMaterial<IMaterialEventMap>

findVariation

Parameters

Returns undefined | MaterialVariations

fromJSON

Parameters

Returns null | MaterialConfiguratorPlugin | Promise<null | MaterialConfiguratorPlugin>

getPreview

Parameters

`Protected`_dirty

`Protected`_previewGenerator

`Protected`_uicShowAllVariations

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Static` `Optional` `Readonly`OldPluginType

`Static`PluginType

`Protected`_onViewerEvent

`Protected`_preFrame

`Protected`_refreshUi

`Protected`_storeKey

`Optional`setDirty

Returns {
"Clear Materials": () => Promise<void>;
"Remove Section": () => Promise<void>;
"Rename mapping": () => Promise<void>;
"Rename title": () => Promise<void>;
}