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

Properties

_dirty _previewGenerator _viewer? _viewerListeners applyOnLoad constructor dependencies enabled enableEditContextMenus uiConfig variations OldPluginType? PluginType

Accessors

dirty

Methods

_onViewerEvent _refreshUi _storeKey addVariation applyVariation createVariation disable dispose enable exportState findVariation fromJSON getPreview getSelectedVariation importState isDisabled materialContextMenuItems onAdded onRemove reapplyAll refreshUi removeVariation removeVariationForMaterial setDirty? toJSON variationsContextMenuItems

Constructors

constructor

Properties

Protected_dirty

_dirty: boolean = false

Protected_previewGenerator

_previewGenerator: undefined | MaterialPreviewGenerator

Protected Optional_viewer

_viewer?: ThreeViewer

Protected_viewerListeners

_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => 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

dependencies

dependencies: typeof GridItemListPlugin[] = ...

enabled

enabled: boolean = true

enableEditContextMenus

enableEditContextMenus: boolean = false

uiConfig

uiConfig: UiObjectConfig = ...

variations

variations: MaterialVariations[] = []

Static Optional ReadonlyOldPluginType

OldPluginType?: string

StaticPluginType

PluginType: string = 'MaterialConfiguratorPlugin'

Accessors

dirty

Methods

Protected_onViewerEvent

  • _onViewerEvent(e: IViewerEvent): IViewerEvent

  • Parameters

    • e: IViewerEvent

    Returns IViewerEvent

Protected_refreshUi

Protected_storeKey

  • _storeKey(prefix?: string): string

  • Parameters

    • Optionalprefix: string

    Returns string

addVariation

  • addVariation(
        material?: IMaterial,
        variationKey?: string,
        cloneMaterial?: boolean,
    ): void

  • Parameters

    • Optionalmaterial: IMaterial
    • OptionalvariationKey: string
    • cloneMaterial: boolean = true

    Returns void

applyVariation

  • applyVariation(
        variations: MaterialVariations,
        matUuidOrIndex: string | number,
    ): boolean

  • Apply a material variation based on index or uuid.

    Parameters

    • variations: MaterialVariations
    • matUuidOrIndex: string | number

    Returns boolean

createVariation

disable

dispose

enable

exportState

  • exportState(): ISerializedConfig | Record<string, never>

  • Returns ISerializedConfig | Record<string, never>

findVariation

fromJSON

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

getSelectedVariation

importState

  • importState(state: any): Promise<void>

  • Parameters

    • state: any

    Returns Promise<void>

isDisabled

materialContextMenuItems

onAdded

onRemove

reapplyAll

refreshUi

removeVariation

removeVariationForMaterial

OptionalsetDirty

  • setDirty(...args: any[]): any

  • Parameters

    • ...args: any[]

    Returns any

toJSON

  • toJSON(meta?: SerializationMetaType): ISerializedConfig

  • Parameters

    • Optionalmeta: SerializationMetaType

    Returns ISerializedConfig

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>;
    }

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods