Interface ExportAssetOptions

interface ExportAssetOptions {
    animations?: AnimationClip[];
    compress?: boolean;
    convertMeshToIndexed?: boolean;
    embedUrlImagePreviews?: boolean;
    embedUrlImages?: boolean;
    encodeUint16Rgbe?: boolean;
    encrypt?: boolean;
    encryptKey?: string | Uint8Array;
    exportExt?: string;
    externalImagesInExtras?: boolean;
    forceIndices?: boolean;
    includeCustomExtensions?: boolean;
    jsonSpaces?: number;
    maxTextureSize?: number;
    name?: string;
    onlyVisible?: boolean;
    preserveUUIDs?: boolean;
    trs?: boolean;
    truncateDrawRange?: boolean;
    viewerConfig?: boolean;
}

Hierarchy (view full)

Properties

animations? compress? convertMeshToIndexed? embedUrlImagePreviews? embedUrlImages? encodeUint16Rgbe? encrypt? encryptKey? exportExt? externalImagesInExtras? forceIndices? includeCustomExtensions? jsonSpaces? maxTextureSize? name? onlyVisible? preserveUUIDs? trs? truncateDrawRange? viewerConfig?

Properties

Optional animations

animations?: AnimationClip[]

List of animations to be included in the export.

Optional compress

compress?: boolean

Optional convertMeshToIndexed

convertMeshToIndexed?: boolean

Optional embedUrlImagePreviews

embedUrlImagePreviews?: boolean

Embed previews of images in glb

Default

false

Optional embedUrlImages

embedUrlImages?: boolean

embed images in glb even when remote url is available

Default

false

Optional encodeUint16Rgbe

encodeUint16Rgbe?: boolean

see GLTFViewerExport->processViewer

Default

false

Optional encrypt

encrypt?: boolean

Encrypt the exported file in a GLB container using encryptKey

Default

false.
Works only for glb export.

Optional encryptKey

encryptKey?: string | Uint8Array

Encryption key, if not provided, will be prompted

Default

undefined.
Works only for glb export.

Optional exportExt

exportExt?: string

Extension to export to, default for object/scene = glb, default for viewerConfig = json, default for material = mat, otherwise determined by exporter

Optional externalImagesInExtras

externalImagesInExtras?: boolean

see GLTFDracoExporter and GLTFMaterialExtrasExtension

Optional forceIndices

forceIndices?: boolean

Generate indices for non-index geometry and export with them. Default is false.

Optional includeCustomExtensions

includeCustomExtensions?: boolean

Export custom glTF extensions defined on an object's userData.gltfExtensions property. Default is true.

Optional jsonSpaces

jsonSpaces?: number

Number of spaces to use when exporting to json

Default

2

Optional maxTextureSize

maxTextureSize?: number

Restricts the image maximum size (both width and height) to the given value. This option works only if embedImages is true. Default is Infinity.

Optional name

name?: string

Optional onlyVisible

onlyVisible?: boolean

Export only visible objects. Default is false.

Optional preserveUUIDs

preserveUUIDs?: boolean

Optional trs

trs?: boolean

Export position, rotation and scale instead of matrix per node. Default is false

Optional truncateDrawRange

truncateDrawRange?: boolean

Export just the attributes within the drawRange, if defined, instead of exporting the whole array. Default is true.

Optional viewerConfig

viewerConfig?: boolean

Export and bundle the viewer config (scene settings). only works for rootSceneModelRoot and supported only in GLTFExporter2 GLTFExporter2Options.viewerConfig

Default

true

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc