CLI tools for converting glTF models into xeokit's compact XGF geometry format.
Converts glTF files to XGF, xeokit's efficient binary format for large models.
Optionally generates a JSON file containing a data model that represents the glTF scene hierarchy.
Backward compatibility for all XGF versions.
XGF format contains only geometry and color data; textures are not supported.
Installation
Install the xeokit SDK by running:
npminstall@xeokit/sdk
Usage
Converting a glTF file
Use the gltf2xgf CLI tool to convert a single glTF file into an XGF file, along with an optional JSON file containing
a simple DataModel derived from the glTF scene and node hierarchy.
Options: -v, --version output the version number -i, --source [file] path to source glTF file -s, --scenemodel [file] path to target XGF file -d, --datamodel [file] path to target JSON data model file, derived from the glTF scene hierarchy (optional) -f, --format [number] target XGF version (default is 1; supported version is 1) -h, --help display help for the command
The example below converts a binary glTF file to XGF. The resulting XGF objects will contain geometry and material color
data parsed from the glTF file. The XGF file can then be loaded into a xeokit SceneModel
using the loadXGF() function. For optimal performance, it is recommended to convert binary glTF files.
nodegltf2xgf-iduplex.glb-sduplex.xgf
Converting a glTF file and extracting the scene hierarchy
In the next example, we convert a binary glTF file to XGF, while also generating a JSON file that defines a simple data model
expressing the hierarchy of the nodes within the glTF scene. The JSON file can then be loaded into a xeokit
DataModel using Data.createModel().
nodegltf2xgf-iduplex.glb-sduplex.xgf-dduplex.json
Converting a glTF file to a specific XGF version
In the previous examples, we converted the glTF file to the latest version of XGF by default. In this example, we convert
the binary glTF file to a specific version of XGF. The XGF format is expected to evolve over time, and this feature ensures
backward compatibility.
xeokit glTF -> XGF Converter
CLI tools for converting glTF models into xeokit's compact XGF geometry format.
Installation
Install the xeokit SDK by running:
Usage
Converting a glTF file
Use the
gltf2xgfCLI tool to convert a single glTF file into an XGF file, along with an optional JSON file containing a simple DataModel derived from the glTFsceneandnodehierarchy.The example below converts a binary glTF file to XGF. The resulting XGF objects will contain geometry and material color data parsed from the glTF file. The XGF file can then be loaded into a xeokit SceneModel using the loadXGF() function. For optimal performance, it is recommended to convert binary glTF files.
Converting a glTF file and extracting the scene hierarchy
In the next example, we convert a binary glTF file to XGF, while also generating a JSON file that defines a simple data model expressing the hierarchy of the
nodeswithin the glTFscene. The JSON file can then be loaded into a xeokit DataModel using Data.createModel().Converting a glTF file to a specific XGF version
In the previous examples, we converted the glTF file to the latest version of XGF by default. In this example, we convert the binary glTF file to a specific version of XGF. The XGF format is expected to evolve over time, and this feature ensures backward compatibility.