Class AssetExporterPlugin

Asset Exporter Plugin Provides options and methods to export the scene, object GLB or Viewer Config. All the functionality is available in the viewer directly, this provides only a ui-config and maintains state of the options.

Hierarchy (View Summary)

AViewerPluginSync
- AssetExporterPlugin

Index

Constructors

constructor

new AssetExporterPlugin(): AssetExporterPlugin
Returns AssetExporterPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/export/AssetExporterPlugin.ts:28

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "dispose"
    | "update"
    | "*"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => void,
> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

`Readonly`exportOptions

exportOptions: ExportAssetOptions = ...

uiConfig

uiConfig: UiObjectConfig = ...

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "AssetExporterPlugin" = 'AssetExporterPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:68

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:54

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:75

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:34

downloadSceneGlb

downloadSceneGlb(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/export/AssetExporterPlugin.ts:72

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:80

exportScene

exportScene(options?: ExportAssetOptions): Promise<undefined | BlobExt>
Parameters
- Optionaloptions: ExportAssetOptions
Returns Promise<undefined | BlobExt>
- Defined in src/plugins/export/AssetExporterPlugin.ts:68

exportSelected

exportSelected(
options?: ExportAssetOptions,
download?: boolean,
): Promise<undefined | BlobExt>
Parameters
- Optionaloptions: ExportAssetOptions
- download: boolean = true
Returns Promise<undefined | BlobExt>
- Defined in src/plugins/export/AssetExporterPlugin.ts:77

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:59

fromJSON

fromJSON(
data: ISerializedConfig,
meta?: SerializationMetaType,
): null | AssetExporterPlugin | Promise<null | AssetExporterPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | AssetExporterPlugin | Promise<null | AssetExporterPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:46

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:62

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:85

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/export/AssetExporterPlugin.ts:33

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/export/AssetExporterPlugin.ts:50

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:89

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:38

Class AssetExporterPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AssetExporterPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

ReadonlyexportOptions

uiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

downloadSceneGlb

Returns Promise<void>

enable

Parameters

Returns void

exportScene

Parameters

Returns Promise<undefined | BlobExt>

exportSelected

Parameters

Returns Promise<undefined | BlobExt>

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | AssetExporterPlugin | Promise<null | AssetExporterPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`exportOptions

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty