Skip to main content

Class: VariationConfiguratorGridUiPlugin

Plugins.VariationConfiguratorGridUiPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "VariationConfiguratorPlugin"

Overrides

VariationConfiguratorPlugin.PluginType


dependencies

dependencies: typeof AssetManagerPlugin[]

Inherited from

VariationConfiguratorPlugin.dependencies


enabled

enabled: boolean = true

Inherited from

VariationConfiguratorPlugin.enabled


serializeWithViewer

serializeWithViewer: boolean = false

Inherited from

VariationConfiguratorPlugin.serializeWithViewer


baseUrl

baseUrl: string = ''

Inherited from

VariationConfiguratorPlugin.baseUrl


variations

variations: Object

Type declaration

NameType
objectsIConfiguratorVariation[]
materialsIConfiguratorVariation[]

Inherited from

VariationConfiguratorPlugin.variations


autoDispose

autoDispose: boolean = true

Default = true. When set to false the items will not be disposed when removed.

Inherited from

VariationConfiguratorPlugin.autoDispose


utils

Readonly utils: Object

Type declaration

NameType
getName(item: IConfiguratorVariation | { name?: string ; prefix: string }) => string
getTitle(item: IConfiguratorVariation) => string
getIcon(variation: IConfiguratorVariation, type: "objects" | "materials") => string
getItemIcon(variation: IConfiguratorVariation, i: number, type: "objects" | "materials") => string
getItemTitle(variation: IConfiguratorVariation, i: number) => string
getItemPath(variation: IConfiguratorVariation, i: number, type: "objects" | "materials") => string
pathToTitle(item: string) => string
pathToIcon(item: string) => string

Inherited from

VariationConfiguratorPlugin.utils


toJSON

toJSON: any = undefined

Inherited from

VariationConfiguratorPlugin.toJSON


_dirty

Protected _dirty: boolean = false

Inherited from

VariationConfiguratorPlugin._dirty


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

VariationConfiguratorPlugin._viewer


_ty

Protected _ty: readonly ["objects", "materials"]

Inherited from

VariationConfiguratorPlugin._ty


_extForType

Protected _extForType: Object

Type declaration

NameType
objectsstring[]
materialsstring[]
imagesstring[]

Inherited from

VariationConfiguratorPlugin._extForType

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

VariationConfiguratorPlugin.dirty

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

VariationConfiguratorPlugin.dirty


viewer

get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

VariationConfiguratorPlugin.viewer

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

VariationConfiguratorPlugin.onDispose


exportState

exportState(): any

Returns

any

Inherited from

VariationConfiguratorPlugin.exportState


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

VariationConfiguratorPlugin.importState


storeState

storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

VariationConfiguratorPlugin.storeState


loadState

loadState(prefix?, storage?): Promise<void>

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

VariationConfiguratorPlugin.loadState


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

VariationConfiguratorPlugin.onAdded


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

VariationConfiguratorPlugin.onRemove


refreshUi

refreshUi(): void

Returns

void


applyVariation

applyVariation(variation, item, type, force?): Promise<void>

Parameters

NameTypeDefault value
variationIConfiguratorVariationundefined
itemstring | numberundefined
type"objects" | "materials"undefined
forcebooleanfalse

Returns

Promise<void>

Inherited from

VariationConfiguratorPlugin.applyVariation


clearVariations

clearVariations(): void

Returns

void

Inherited from

VariationConfiguratorPlugin.clearVariations


importConfig

importConfig(config, folder?): void

Parameters

NameType
configany
folder?Unzipped

Returns

void

Inherited from

VariationConfiguratorPlugin.importConfig


importPath

importPath(configPath): Promise<void>

Parameters

NameType
configPathstring

Returns

Promise<void>

Inherited from

VariationConfiguratorPlugin.importPath


getMaterials

getMaterials(name): string[]

Parameters

NameType
namestring

Returns

string[]

Inherited from

VariationConfiguratorPlugin.getMaterials


getObjects

getObjects(name): string[]

Parameters

NameType
namestring

Returns

string[]

Inherited from

VariationConfiguratorPlugin.getObjects


getMaterialVariations

getMaterialVariations(): string[]

Returns

string[]

Inherited from

VariationConfiguratorPlugin.getMaterialVariations


getObjectVariations

getObjectVariations(): string[]

Returns

string[]

Inherited from

VariationConfiguratorPlugin.getObjectVariations


fromJSON

fromJSON(json): null | VariationConfiguratorGridUiPlugin

Parameters

NameType
jsonany

Returns

null | VariationConfiguratorGridUiPlugin

Inherited from

VariationConfiguratorPlugin.fromJSON


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

VariationConfiguratorPlugin._storeKey


_refreshUi

Protected _refreshUi(): Promise<boolean>

Returns

Promise<boolean>


_loadMaterial

Protected _loadMaterial(path, blob?): Promise<undefined | IMaterial<any, IMaterialEventMap>>

Parameters

NameType
pathstring
blob?IFile

Returns

Promise<undefined | IMaterial<any, IMaterialEventMap>>

Inherited from

VariationConfiguratorPlugin._loadMaterial


_loadObject

Protected _loadObject(path, blob?): Promise<IModel<Object3D<Object3DEventMap>, IObject3DEventMap>[]>

Parameters

NameType
pathstring
blob?IFile

Returns

Promise<IModel<Object3D<Object3DEventMap>, IObject3DEventMap>[]>

Inherited from

VariationConfiguratorPlugin._loadObject


_exportConfiguratorState

Protected _exportConfiguratorState(): Promise<{ folder: undefined | Zippable ; config: any }>

Returns

Promise<{ folder: undefined | Zippable ; config: any }>

Inherited from

VariationConfiguratorPlugin._exportConfiguratorState

Constructors

constructor

new VariationConfiguratorGridUiPlugin()

Overrides

VariationConfiguratorPlugin.constructor