Class MaterialConfiguratorBasePlugin

Material Configurator Plugin (Base)

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.

See MaterialConfiguratorPlugin in plugin-configurator for example on inheriting with a custom UI renderer.

Hierarchy (view full)

AViewerPluginSync<"">
- MaterialConfiguratorBasePlugin

Constructors

constructor

new MaterialConfiguratorBasePlugin(): MaterialConfiguratorBasePlugin
Returns MaterialConfiguratorBasePlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:27

Properties

`Protected` _dirty

_dirty: boolean = false

`Private` _picking

_picking: undefined | PickingPlugin

`Protected` _previewGenerator

_previewGenerator: undefined | MaterialPreviewGenerator

`Private` _uiNeedRefresh

_uiNeedRefresh: boolean = false

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

applyOnLoad

applyOnLoad: boolean = true

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

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

uiConfig

uiConfig: UiObjectConfig<any, string, any> = ...

variations

variations: MaterialVariations[] = []

`Static` `Optional` `Readonly` OldPluginType

OldPluginType?: string

`Static` PluginType

PluginType: string = 'MaterialConfiguratorPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:107
set dirty(value): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

Methods

`Protected` _onViewerEvent

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

`Protected` _refreshUi

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

`Private` _refreshUiConfig

_refreshUiConfig(): void
Returns void
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:142

`Private` _selectedMaterial

_selectedMaterial(): undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Returns undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:159

`Protected` _storeKey

_storeKey(prefix?): string
Parameters
- Optional prefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:49

addVariation

addVariation(material?): void
Parameters
- Optional material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Returns void
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:259

applyVariation

applyVariation(variations, matUuidOrIndex): boolean
Apply a material variation based on index or uuid.
Parameters
- variations: MaterialVariations
- matUuidOrIndex: string | number
Returns boolean
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:95

createVariation

createVariation(material): MaterialVariations
Parameters
- material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Returns MaterialVariations
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:272

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

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

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

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

findVariation

findVariation(uuid?): undefined | MaterialVariations
Parameters
- Optional uuid: string
Returns undefined | MaterialVariations
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:82

fromJSON

fromJSON(data, meta?): null | MaterialConfiguratorBasePlugin | Promise<null | MaterialConfiguratorBasePlugin>
Parameters
- data: any
- Optional meta: any
Returns null | MaterialConfiguratorBasePlugin | Promise<null | MaterialConfiguratorBasePlugin>
Overrides AViewerPluginSync.fromJSON
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:59

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
- material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  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
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:113

getSelectedVariation

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

importState

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

isDisabled

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

onAdded

onAdded(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:35

onRemove

onRemove(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:69

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 src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:55

refreshUi

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

Returns void
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:137

removeVariation

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

removeVariationForMaterial

removeVariationForMaterial(material): void
Parameters
- material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Returns void
- Defined in src/plugins/configurator/MaterialConfiguratorBasePlugin.ts:249

`Optional` setDirty

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

toJSON

toJSON(meta?): ISerializedConfig
Parameters
- Optional meta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:33

Class MaterialConfiguratorBasePlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MaterialConfiguratorBasePlugin

Properties

Protected _dirty

Private _picking

Protected _previewGenerator

Private _uiNeedRefresh

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

applyOnLoad

constructor

enabled

uiConfig

variations

Static Optional Readonly OldPluginType

Static PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _refreshUi

Returns Promise<boolean>

Private _refreshUiConfig

Returns void

Private _selectedMaterial

Returns undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Protected _storeKey

Parameters

Optional prefix: string

Returns string

addVariation

Parameters

Optional material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Returns void

applyVariation

Parameters

variations: MaterialVariations

matUuidOrIndex: string | number

Returns boolean

createVariation

Parameters

material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Returns MaterialVariations

disable

Parameters

key: any

Returns void

dispose

Returns void

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

findVariation

Parameters

Optional uuid: string

Returns undefined | MaterialVariations

fromJSON

Parameters

`Protected` _dirty

`Private` _picking

`Protected` _previewGenerator

`Private` _uiNeedRefresh

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Static` `Optional` `Readonly` OldPluginType

`Static` PluginType

`Protected` _onViewerEvent

`Protected` _refreshUi

`Private` _refreshUiConfig

`Private` _selectedMaterial

`Protected` _storeKey

`Optional` prefix: string

`Optional` material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

`Optional` uuid: string

`Optional` meta: any

`Optional` setDirty

`Rest` ...args: any[]

`Optional` meta: SerializationMetaType