Class GLTFDracoExportPlugin

GLTF Draco Export Plugin

Overloads the default gltf exporter in the asset manager with GLTFDracoExporter. When exporting with compress = true, the output will be compressed. Note - Only glb supported right now.

Hierarchy

AViewerPluginSync
- GLTFDracoExportPlugin

Index

Constructors

constructor

new GLTFDracoExportPlugin(): GLTFDracoExportPlugin
Creates THREE.EventDispatcher | EventDispatcher object.

Returns GLTFDracoExportPlugin
Inherited from AViewerPluginSync.constructor
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:55

Properties

`Protected`_ctor

_ctor: (
assetExporter: IAssetExporter,
exporter: IExporter,
) => undefined | IExportWriter = ...

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

extraExtensions

extraExtensions: [string, undefined | Record<string, string | number>][] = ...

These are added here, but also added as plugins. Added here by default so that the data is not lost if some plugin is not added in an app. To explicitly remove the data, use removeExtension with the name of the extension

isViewerPluginSync

isViewerPluginSync: true = ...

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "GLTFDracoExportPlugin" = 'GLTFDracoExportPlugin'

Accessors

dirty

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

gltfTransformExtensions

get gltfTransformExtensions(): typeof Extension[]
Returns typeof Extension[]
- Defined in plugins/gltf-transform/src/GLTFDracoExportPlugin.ts:77

Methods

`Protected`_makeUi

_makeUi(
    exporter: AssetExporterPlugin,
): (
    | {
        children?: undefined;
        hidden?: undefined;
        label: string;
        onChange: () => undefined | void;
        property: (string | ExportAssetOptions)[];
        type: string;
    }
    | {
        children: (
            | {
                bounds: number[];
                children?: undefined;
                label: string;
                property: (undefined | string | EncoderOptions)[];
                type: string;
            }
            | {
                bounds?: undefined;
                children: { label: string }[];
                label: string;
                property: (undefined | string | EncoderOptions)[];
                type: string;
            }
            | {
                bounds?: undefined;
                children: {
                    bounds: number[];
                    label: string;
                    property: (undefined | string | { [key: ...]: ... })[];
                    stepSize: number;
                    type: string;
                }[];
                label: string;
                property?: undefined;
                type: string;
            }
        )[];
        hidden: () => boolean;
        label: string;
        onChange?: undefined;
        property?: undefined;
        type: string;
    }
)[]
Parameters
- exporter: AssetExporterPlugin
Returns (
    | {
        children?: undefined;
        hidden?: undefined;
        label: string;
        onChange: () => undefined | void;
        property: (string | ExportAssetOptions)[];
        type: string;
    }
    | {
        children: (
            | {
                bounds: number[];
                children?: undefined;
                label: string;
                property: (undefined | string | EncoderOptions)[];
                type: string;
            }
            | {
                bounds?: undefined;
                children: { label: string }[];
                label: string;
                property: (undefined | string | EncoderOptions)[];
                type: string;
            }
            | {
                bounds?: undefined;
                children: {
                    bounds: number[];
                    label: string;
                    property: (undefined | string | { [key: ...]: ... })[];
                    stepSize: number;
                    type: string;
                }[];
                label: string;
                property?: undefined;
                type: string;
            }
        )[];
        hidden: () => boolean;
        label: string;
        onChange?: undefined;
        property?: undefined;
        type: string;
    }
)[]
- Defined in plugins/gltf-transform/src/GLTFDracoExportPlugin.ts:165

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

addExtension

addExtension(name: string, textures?: Record<string, string | number>): void
Parameters
- name: string
- Optionaltextures: Record<string, string | number>
Returns void
- Defined in plugins/gltf-transform/src/GLTFDracoExportPlugin.ts:81

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:76

dispose

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

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:81

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in plugins/gltf-transform/src/GLTFDracoExportPlugin.ts:111

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in plugins/gltf-transform/src/GLTFDracoExportPlugin.ts:156

removeExtension

removeExtension(name: string): void
Note - don't remove an extension when removing a plugin.

extensions can be removed if you don't want to save the data of some plugin when transforming glb. But since this is not desirable in most cases, it is not recommended.
Parameters
- name: string
Returns void
- Defined in plugins/gltf-transform/src/GLTFDracoExportPlugin.ts:93

`Optional`setDirty

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

toJSON

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

Class GLTFDracoExportPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GLTFDracoExportPlugin

Properties

Protected_ctor

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

extraExtensions

isViewerPluginSync

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

gltfTransformExtensions

Returns typeof Extension[]

Methods

Protected_makeUi

Parameters

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

addExtension

Parameters

Returns void

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | GLTFDracoExportPlugin | Promise<null | GLTFDracoExportPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

removeExtension

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_ctor

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_makeUi

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty