Class: AssetExporterPlugin

Asset-Management.AssetExporterPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ AssetExporterPlugin

Properties

PluginType

▪ Static Readonly PluginType: "AssetExporterPlugin"

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:25

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:26

---

exporter

• Optional exporter: IAssetExporter

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:28

---

exportOptions

• exportOptions: ExportAssetOptions

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:63

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

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

---

viewer

• get viewer(): undefined | TViewer

Returns

undefined | TViewer

Inherited from

AViewerPlugin.viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

---

uiConfig

• get uiConfig(): UiObjectConfig<any, string> | { type: string = 'folder'; label: string = 'Asset Export'; limitedUi: true = true; children: ({ type: string = 'input'; property: [ExportAssetOptions, string] ; limitedUi: true = true; label: undefined = 'Preset/Config export'; children: undefined } | { type: string = 'folder'; label: string = 'GLB Export'; limitedUi: true = true; children: ({ type: string = 'checkbox'; label: string = 'DRACO Compress'; property: [ExportAssetOptions, string] ; limitedUi: true = true; onChange: () => undefined | void ; hidden: undefined ; value: undefined ; children: undefined } | { onChange: undefined ; hidden: undefined ; property: undefined ; type: undefined = 'button'; limitedUi: undefined = true; value: undefined ; label: undefined = 'Preset/Config export'; children: undefined } | { type: string = 'folder'; hidden: () => boolean ; label: string = 'DRACO Options'; children: ({ type: string = 'slider'; label: string = 'Encode Speed'; bounds: number[] ; property: [any, string] ; children: undefined } | { bounds: undefined ; type: string = 'dropdown'; label: string = 'Quantization Volume'; property: [any, string] ; children: { label: string = v }[] } | { bounds: undefined ; type: string = 'folder'; label: string = 'Quantization Bits'; children: { type: string = 'slider'; label: string = k; bounds: number[] ; stepSize: number = 1; property: [any, string] }[] ; property: undefined })[] ; onChange: undefined ; property: undefined ; limitedUi: undefined = true; value: undefined } | { type: string = 'checkbox'; label: string = 'Embed Image Previews'; property: [ExportAssetOptions, string] ; onChange: undefined ; hidden: undefined ; limitedUi: undefined = true; value: undefined ; children: undefined } | { type: string = 'checkbox'; label: string = 'Encrypt'; property: [ExportAssetOptions, string] ; onChange: () => undefined | void ; hidden: undefined ; limitedUi: undefined = true; value: undefined ; children: undefined } | { onChange: undefined ; type: string = 'checkbox'; label: string = 'Encrypt Password'; hidden: () => boolean ; property: [ExportAssetOptions, string] ; limitedUi: undefined = true; value: undefined ; children: undefined } | { onChange: undefined ; hidden: undefined ; property: undefined ; type: string = 'button'; label: string = 'Export GLB'; limitedUi: true = true; value: () => Promise<void> ; children: undefined })[] ; property: undefined } | { property: undefined ; limitedUi: undefined = true; type: string = 'folder'; label: string = 'Preset/Config export'; children: ({ limitedUi: undefined = true; value: undefined ; type: string = 'folder'; label: string = 'Plugins'; children: UiObjectConfig<any, string>[] = plugins } | { limitedUi: undefined = true; children: undefined ; type: string = 'button'; label: string = 'Select none'; value: () => void } | { children: undefined ; type: string = 'button'; label: string = 'Export Plugins'; limitedUi: true = true; value: () => Promise<void> })[] })[] }

Returns

UiObjectConfig<any, string> | { type: string = 'folder'; label: string = 'Asset Export'; limitedUi: true = true; children: ({ type: string = 'input'; property: [ExportAssetOptions, string] ; limitedUi: true = true; label: undefined = 'Preset/Config export'; children: undefined } | { type: string = 'folder'; label: string = 'GLB Export'; limitedUi: true = true; children: ({ type: string = 'checkbox'; label: string = 'DRACO Compress'; property: [ExportAssetOptions, string] ; limitedUi: true = true; onChange: () => undefined | void ; hidden: undefined ; value: undefined ; children: undefined } | { onChange: undefined ; hidden: undefined ; property: undefined ; type: undefined = 'button'; limitedUi: undefined = true; value: undefined ; label: undefined = 'Preset/Config export'; children: undefined } | { type: string = 'folder'; hidden: () => boolean ; label: string = 'DRACO Options'; children: ({ type: string = 'slider'; label: string = 'Encode Speed'; bounds: number[] ; property: [any, string] ; children: undefined } | { bounds: undefined ; type: string = 'dropdown'; label: string = 'Quantization Volume'; property: [any, string] ; children: { label: string = v }[] } | { bounds: undefined ; type: string = 'folder'; label: string = 'Quantization Bits'; children: { type: string = 'slider'; label: string = k; bounds: number[] ; stepSize: number = 1; property: [any, string] }[] ; property: undefined })[] ; onChange: undefined ; property: undefined ; limitedUi: undefined = true; value: undefined } | { type: string = 'checkbox'; label: string = 'Embed Image Previews'; property: [ExportAssetOptions, string] ; onChange: undefined ; hidden: undefined ; limitedUi: undefined = true; value: undefined ; children: undefined } | { type: string = 'checkbox'; label: string = 'Encrypt'; property: [ExportAssetOptions, string] ; onChange: () => undefined | void ; hidden: undefined ; limitedUi: undefined = true; value: undefined ; children: undefined } | { onChange: undefined ; type: string = 'checkbox'; label: string = 'Encrypt Password'; hidden: () => boolean ; property: [ExportAssetOptions, string] ; limitedUi: undefined = true; value: undefined ; children: undefined } | { onChange: undefined ; hidden: undefined ; property: undefined ; type: string = 'button'; label: string = 'Export GLB'; limitedUi: true = true; value: () => Promise<void> ; children: undefined })[] ; property: undefined } | { property: undefined ; limitedUi: undefined = true; type: string = 'folder'; label: string = 'Preset/Config export'; children: ({ limitedUi: undefined = true; value: undefined ; type: string = 'folder'; label: string = 'Plugins'; children: UiObjectConfig<any, string>[] = plugins } | { limitedUi: undefined = true; children: undefined ; type: string = 'button'; label: string = 'Select none'; value: () => void } | { children: undefined ; type: string = 'button'; label: string = 'Export Plugins'; limitedUi: true = true; value: () => Promise<void> })[] })[] }

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:105

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:40

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:49

---

fromJSON

▸ fromJSON(data, meta?): null | AssetExporterPlugin | Promise<null | AssetExporterPlugin>

Parameters

Name	Type
data	any
meta?	any

Returns

null | AssetExporterPlugin | Promise<null | AssetExporterPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:56

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:68

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:71

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:78

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:88

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:36

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:55

---

exportScene

▸ exportScene(options?): Promise<undefined | BlobExt>

Parameters

Name	Type
options?	ExportAssetOptions

Returns

Promise<undefined | BlobExt>

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:87

---

downloadSceneGlb

▸ downloadSceneGlb(): Promise<void>

Returns

Promise<void>

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:90

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:64

Constructors

constructor

• new AssetExporterPlugin(exporter?)

Parameters

Name	Type
exporter?	IAssetExporter

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/extras/asset_manager/AssetExporterPlugin.ts:30