Class: VariationConfiguratorEditorUiPlugin
Plugins.VariationConfiguratorEditorUiPlugin
Hierarchy
VariationConfiguratorGridUiPlugin↳
VariationConfiguratorEditorUiPlugin
Properties
PluginType
▪ Static Readonly PluginType: "VariationConfiguratorPlugin"
Overrides
VariationConfiguratorGridUiPlugin.PluginType
Defined in
webgi/src/plugins/VariationConfiguratorEditorUiPlugin.ts:8
uiConfig
• uiConfig: UiObjectConfig<any, string>
Defined in
webgi/src/plugins/VariationConfiguratorEditorUiPlugin.ts:11
dependencies
• dependencies: typeof AssetManagerPlugin[]
Inherited from
VariationConfiguratorGridUiPlugin.dependencies
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:29
enabled
• enabled: boolean = true
Inherited from
VariationConfiguratorGridUiPlugin.enabled
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:30
serializeWithViewer
• serializeWithViewer: boolean = false
Inherited from
VariationConfiguratorGridUiPlugin.serializeWithViewer
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:31
baseUrl
• baseUrl: string = ''
Inherited from
VariationConfiguratorGridUiPlugin.baseUrl
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:33
variations
• variations: Object
Type declaration
| Name | Type |
|---|---|
objects | IConfiguratorVariation[] |
materials | IConfiguratorVariation[] |
Inherited from
VariationConfiguratorGridUiPlugin.variations
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:35
autoDispose
• autoDispose: boolean = true
Default = true. When set to false the items will not be disposed when removed.
Inherited from
VariationConfiguratorGridUiPlugin.autoDispose
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:42
utils
• Readonly utils: Object
Type declaration
| Name | Type |
|---|---|
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
VariationConfiguratorGridUiPlugin.utils
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:240
toJSON
• toJSON: any = undefined
Inherited from
VariationConfiguratorGridUiPlugin.toJSON
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:289
_dirty
• Protected _dirty: boolean = false
Inherited from
VariationConfiguratorGridUiPlugin._dirty
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
VariationConfiguratorGridUiPlugin._viewer
Defined in
webgi/src/core/AViewerPlugin.ts:27
_ty
• Protected _ty: readonly ["objects", "materials"]
Inherited from
VariationConfiguratorGridUiPlugin._ty
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:149
_extForType
• Protected _extForType: Object
Type declaration
| Name | Type |
|---|---|
objects | string[] |
materials | string[] |
images | string[] |
Inherited from
VariationConfiguratorGridUiPlugin._extForType
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:150
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Inherited from
VariationConfiguratorGridUiPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
VariationConfiguratorGridUiPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
VariationConfiguratorGridUiPlugin.onDispose
Defined in
webgi/src/core/AViewerPlugin.ts:36
exportState
▸ exportState(): any
Returns
any
Inherited from
VariationConfiguratorGridUiPlugin.exportState
Defined in
webgi/src/core/AViewerPlugin.ts:64
importState
▸ importState(state): Promise<void>
Parameters
| Name | Type |
|---|---|
state | any |
Returns
Promise<void>
Inherited from
VariationConfiguratorGridUiPlugin.importState
Defined in
webgi/src/core/AViewerPlugin.ts:67
storeState
▸ storeState(prefix?, storage?, data?): void
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
VariationConfiguratorGridUiPlugin.storeState
Defined in
webgi/src/core/AViewerPlugin.ts:74
loadState
▸ loadState(prefix?, storage?): Promise<void>
Parameters
| Name | Type |
|---|---|
prefix? | string |
storage? | Storage |
Returns
Promise<void>
Inherited from
VariationConfiguratorGridUiPlugin.loadState
Defined in
webgi/src/core/AViewerPlugin.ts:84
refreshUi
▸ refreshUi(): void
Returns
void
Overrides
VariationConfiguratorGridUiPlugin.refreshUi
Defined in
webgi/src/plugins/VariationConfiguratorEditorUiPlugin.ts:353
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
VariationConfiguratorGridUiPlugin.onAdded
Defined in
webgi/src/plugins/VariationConfiguratorGridUiPlugin.ts:26
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
VariationConfiguratorGridUiPlugin.onRemove
Defined in
webgi/src/plugins/VariationConfiguratorGridUiPlugin.ts:34
applyVariation
▸ applyVariation(variation, item, type, force?): Promise<void>
Parameters
| Name | Type | Default value |
|---|---|---|
variation | IConfiguratorVariation | undefined |
item | string | number | undefined |
type | "objects" | "materials" | undefined |
force | boolean | false |
Returns
Promise<void>
Inherited from
VariationConfiguratorGridUiPlugin.applyVariation
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:47
clearVariations
▸ clearVariations(): void
Returns
void
Inherited from
VariationConfiguratorGridUiPlugin.clearVariations
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:124
importConfig
▸ importConfig(config, folder?): void
Parameters
| Name | Type |
|---|---|
config | any |
folder? | Unzipped |
Returns
void
Inherited from
VariationConfiguratorGridUiPlugin.importConfig
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:158
importPath
▸ importPath(configPath): Promise<void>
Parameters
| Name | Type |
|---|---|
configPath | string |
Returns
Promise<void>
Inherited from
VariationConfiguratorGridUiPlugin.importPath
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:209
getMaterials
▸ getMaterials(name): string[]
Parameters
| Name | Type |
|---|---|
name | string |
Returns
string[]
Inherited from
VariationConfiguratorGridUiPlugin.getMaterials
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:226
getObjects
▸ getObjects(name): string[]
Parameters
| Name | Type |
|---|---|
name | string |
Returns
string[]
Inherited from
VariationConfiguratorGridUiPlugin.getObjects
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:229
getMaterialVariations
▸ getMaterialVariations(): string[]
Returns
string[]
Inherited from
VariationConfiguratorGridUiPlugin.getMaterialVariations
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:233
getObjectVariations
▸ getObjectVariations(): string[]
Returns
string[]
Inherited from
VariationConfiguratorGridUiPlugin.getObjectVariations
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:236
fromJSON
▸ fromJSON(json): null | VariationConfiguratorEditorUiPlugin
Parameters
| Name | Type |
|---|---|
json | any |
Returns
null | VariationConfiguratorEditorUiPlugin
Inherited from
VariationConfiguratorGridUiPlugin.fromJSON
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:282
_storeKey
▸ Protected _storeKey(prefix?): string
Parameters
| Name | Type |
|---|---|
prefix? | string |
Returns
string
Inherited from
VariationConfiguratorGridUiPlugin._storeKey
Defined in
webgi/src/core/AViewerPlugin.ts:60
_refreshUiConfig
▸ Protected _refreshUiConfig(): void
Returns
void
Defined in
webgi/src/plugins/VariationConfiguratorEditorUiPlugin.ts:349
_loadObject
▸ Protected _loadObject(path, blob?): Promise<IModel<Object3D<Event, string>>[]>
Parameters
| Name | Type |
|---|---|
path | string |
blob? | IFile |
Returns
Promise<IModel<Object3D<Event, string>>[]>
Overrides
VariationConfiguratorGridUiPlugin._loadObject
Defined in
webgi/src/plugins/VariationConfiguratorEditorUiPlugin.ts:358
_refreshUi
▸ Protected _refreshUi(): Promise<boolean>
Returns
Promise<boolean>
Inherited from
VariationConfiguratorGridUiPlugin._refreshUi
Defined in
webgi/src/plugins/VariationConfiguratorGridUiPlugin.ts:47
_loadMaterial
▸ Protected _loadMaterial(path, blob?): Promise<undefined | IMaterial<any>>
Parameters
| Name | Type |
|---|---|
path | string |
blob? | IFile |
Returns
Promise<undefined | IMaterial<any>>
Inherited from
VariationConfiguratorGridUiPlugin._loadMaterial
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:138
_exportConfiguratorState
▸ Protected _exportConfiguratorState(): Promise<{ folder: undefined | Zippable ; config: any }>
Returns
Promise<{ folder: undefined | Zippable ; config: any }>
Inherited from
VariationConfiguratorGridUiPlugin._exportConfiguratorState
Defined in
webgi/src/plugins/VariationConfiguratorPlugin.ts:300
Constructors
constructor
• new VariationConfiguratorEditorUiPlugin()
Inherited from
VariationConfiguratorGridUiPlugin.constructor