Class GLTFExporter2

constructor

• new GLTFExporter2(): GLTFExporter2

  Returns GLTFExporter2

processors

StaticExportExtensions

gltfViewerWriter

• gltfViewerWriter(
      viewer: ThreeViewer,
  ): (writer: GLTFWriter2) => GLTFExporterPlugin

  Parameters

  • viewer: ThreeViewer

  Returns (writer: GLTFWriter2) => GLTFExporterPlugin

parse

• parse(
      input: Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[],
      onDone: (gltf: ArrayBuffer | { [key: string]: any }) => void,
      onError: (error: ErrorEvent) => void,
      options?: GLTFExporter2Options,
  ): void

  Generates a .gltf (JSON) or .glb (binary) output from the input (Scenes or Objects)

  Parameters

  • input: Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

    Scenes or objects to export. Valid options:

    • Export scenes

      exporter.parse( scene1, ... )
      exporter.parse( [ scene1, scene2 ], ... )
      Copy

    • Export objects (It will create a new Scene to hold all the objects)

      exporter.parse( object1, ... )
      exporter.parse( [ object1, object2 ], ... )
      Copy

    • Mix scenes and objects (It will export the scenes as usual but it will create a new scene to hold all the single objects).

      exporter.parse( [ scene1, object1, object2, scene2 ], ... )
      Copy

  • onDone: (gltf: ArrayBuffer | { [key: string]: any }) => void

    Will be called when the export completes. The argument will be the generated glTF JSON or binary ArrayBuffer.

  • onError: (error: ErrorEvent) => void

    Will be called if there are any errors during the gltf generation.

  • options: GLTFExporter2Options = {}

    Export options

  Returns void

parseAsync

• parseAsync(obj: any, options: GLTFExporter2Options): Promise<Blob>

  Generates a .gltf (JSON) or .glb (binary) output from the input (Scenes or Objects).

  This is just like the parse() method, but instead of accepting callbacks it returns a promise that resolves with the result, and otherwise accepts the same options.

  Parameters

  • obj: any
  • options: GLTFExporter2Options

  Returns Promise<Blob>

register

• register(callback: (writer: GLTFWriter2) => GLTFExporterPlugin): this

  Parameters

  • callback: (writer: GLTFWriter2) => GLTFExporterPlugin

  Returns this

setup

• setup(
      viewer: ThreeViewer,
      extraExtensions?: ((writer: GLTFWriter2) => GLTFExporterPlugin)[],
  ): this

  Parameters

  • viewer: ThreeViewer
  • OptionalextraExtensions: ((writer: GLTFWriter2) => GLTFExporterPlugin)[]

  Returns this