ThreePipe
    Preparing search index...

    Interface ExportAssetOptions

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

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

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

    Properties

    animations?: AnimationClip[]

    List of animations to be included in the export.

    compress?: boolean
    convertMeshToIndexed?: boolean
    embedUrlImagePreviews?: boolean

    Embed previews of images in glb

    false
    embedUrlImages?: boolean

    embed images in glb even when remote url is available

    false
    encodeUint16Rgbe?: boolean

    see GLTFViewerExport->processViewer

    false
    encrypt?: boolean

    Encrypt the exported file in a GLB container using encryptKey

    false.
    Works only for glb export.
    encryptKey?: string | Uint8Array<ArrayBufferLike>

    Encryption key, if not provided, will be prompted

    undefined.
    Works only for glb export.
    exportExt?: string

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

    externalImagesInExtras?: boolean

    see GLTFDracoExporter and GLTFMaterialExtrasExtension

    forceIndices?: boolean

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

    includeCustomExtensions?: boolean

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

    jsonSpaces?: number

    Number of spaces to use when exporting to json

    2
    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.

    name?: string
    onlyVisible?: boolean

    Export only visible objects. Default is false.

    preserveUUIDs?: boolean
    trs?: boolean

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

    truncateDrawRange?: boolean

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

    viewerConfig?: boolean

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

    true

    Settings

    Member Visibility

    On This Page

    Properties