Class: MaterialConfiguratorBasePlugin
Plugins.MaterialConfiguratorBasePlugin
Hierarchy
AViewerPlugin
<""
>↳
MaterialConfiguratorBasePlugin
Properties
PluginType
▪ Static
PluginType: string
= 'MaterialConfiguratorBasePlugin'
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:17
enabled
• enabled: boolean
= true
Overrides
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:16
dependencies
• dependencies: typeof AssetManagerPlugin
[]
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:90
variations
• variations: MaterialVariations
[] = []
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:93
uiConfig
• uiConfig: UiObjectConfig
<any
, string
>
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:96
_dirty
• Protected
_dirty: boolean
= false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:27
_previewGenerator
• Protected
_previewGenerator: undefined
| MaterialPreviewGenerator
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:19
Constructors
constructor
• new MaterialConfiguratorBasePlugin()
Inherited from
Defined in
webgi/node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:41
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
AViewerPlugin.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
Defined in
webgi/src/core/AViewerPlugin.ts:36
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:45
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:64
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
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
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
Defined in
webgi/src/core/AViewerPlugin.ts:84
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Overrides
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:22
fromJSON
▸ fromJSON(data
, meta?
): null
| MaterialConfiguratorBasePlugin
| Promise
<null
| MaterialConfiguratorBasePlugin
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| MaterialConfiguratorBasePlugin
| Promise
<null
| MaterialConfiguratorBasePlugin
>
Overrides
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:37
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Overrides
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:42
findVariation
▸ findVariation(uuid?
): undefined
| MaterialVariations
Parameters
Name | Type |
---|---|
uuid? | string |
Returns
undefined
| MaterialVariations
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:55
getSelectedVariation
▸ getSelectedVariation(): undefined
| MaterialVariations
Returns
undefined
| MaterialVariations
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:59
applyVariation
▸ applyVariation(variations
, matUuid
): boolean
Parameters
Name | Type |
---|---|
variations | MaterialVariations |
matUuid | string |
Returns
boolean
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:63
refreshUi
▸ refreshUi(): void
Returns
void
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:71
removeVariationForMaterial
▸ removeVariationForMaterial(material
): void
Parameters
Name | Type |
---|---|
material | IMaterial <any > |
Returns
void
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:173
removeVariation
▸ removeVariation(variation
): void
Parameters
Name | Type |
---|---|
variation | MaterialVariations |
Returns
void
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:178
addVariation
▸ addVariation(material?
): void
Parameters
Name | Type |
---|---|
material? | IMaterial <any > |
Returns
void
Defined in
webgi/src/plugins/MaterialConfiguratorBasePlugin.ts:183
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:60
_refreshUi
▸ Protected
_refreshUi(): Promise
<boolean
>
Returns
Promise
<boolean
>