Class XGFExporter

Exports a SceneModel to an XGF file.

For detailed usage, refer to @xeokit/sdk/formats/xgf.

Versions:

"1.0.0" — geometry + per-mesh inline RGBA only. Default.
"1.1.0" ("XKT2") — adds materials with full PBR + alpha mode/cutoff, textures (image bytes + sampler params), and per-geometry normals + UVs.

Hierarchy (View Summary)

ModelExporter
- XGFExporter

Index

Constructors

Properties

defaultVersion encoders fileDataType format versions

Methods

Constructors

constructor

new XGFExporter(): XGFExporter
Returns XGFExporter
Overrides ModelExporter.constructor
- Defined in packages/sdk/src/formats/xgf/XGFExporter.ts:17

Properties

defaultVersion

defaultVersion: string

The default supported schema version.

`Internal`encoders

encoders: { [key: string]: ModelEncoder }

An encoder for each supported schema version.

fileDataType

fileDataType: string

Data type of the file written by this Exporter.

format

format: string

The exported model file format.

versions

versions: string[]

List of supported schema versions.

Methods

write

write(params: ModelExportParams, options?: ModelExportOptions): Promise<any>
Exports a SceneModel and/or a DataModel to file data.
Parameters
- params: ModelExportParams
  The parameters used for writing the file data.
- options: ModelExportOptions = {}
  Options for customizing the export process.
Returns Promise<any>
Resolves when the SceneModel and/or DataModel has been successfully written.
Throws
- If the SceneModel has already been destroyed.
- If the DataModel has already been destroyed.
Inherited from ModelExporter.write
- Defined in packages/sdk/src/formats/ModelExporter.ts:66