xeokit ifc2gltf → XGF Converter

---

CLI tools for converting glTF models into xeokit's compact XGF geometry format.

---

Features

• Optimizes ifc2gltf output for efficient loading in a xeokit Viewer.
• Converts glTF files to XGF, xeokit's compact binary geometry format.
• Converts JSON MetaModel files to JSON MetaData files, xeokit's newer data model format.
• Supports generation of all XGF versions.

Installation

npm install @xeokit/sdk
Copy

Usage

Converting a Batch of glTF + MetaModel Files

Use the ifc2gltf2xgf tool to convert a batch of glTF+MetaModel files into a batch of XGF+DataModel files.

node ifc2gltf2xgf.js -h
Usage: ifc2gltf2xgf [options]

CLI to batch-convert a manifest of glTF/GLB files into XGF SceneModel files and/or JSON DataModel files

Options:
  -v, --version          Output the version number
  -i, --input [file]     Path to input manifest of glTF+JSON files (required)
  -o, --output [file]    Path to target manifest of XGF+JSON files (required)
  -f, --format [number]  Target XGF version (optional, default: 1)
  -l, --log              Enable logging (optional)
  -h, --help             Display help for command
Copy

The input manifest, ifc2gltfManifest.json, follows this structure:

{
    "inputFile": "model.ifc",
    "converterApplication": "ifc2gltfcxconverter",
    "converterApplicationVersion": "4.14",
    "conversionDate": "2024-09-13 21:43:58",
    "gltfOutFiles": ["model.glb", "model2.glb", "model3.glb"],
    "metadataOutFiles": ["model.json", "model2.json"],
    "numCreatedGltfMeshes": 871,
    "numCreatedMetaObjects": 246,
    "numExportedPropertySetsOrElementQuantities": 0,
    "modelBoundsMax": [9.0415, 5.0175, 9.0],
    "modelBoundsMin": [-0.2415, -22.1827, -1.55],
    "generalMessages": ["Detected IFC version: IFC4X3"],
    "warnings": [],
    "errors": []
}
Copy

Convert to XGF using:

node ifc2gltf2xgf -i ifc2gltfManifest.json -o xgfManifest.json
Copy

To load ifc2gltfManifest.json into a SceneModel and DataModel:

import { Scene } from "@xeokit/sdk/scene";
import { Data } from "@xeokit/sdk/data";
import { ModelChunksLoader } from "@xeokit/sdk/modelChunksLoader";
import { loadGLTF } from "@xeokit/sdk/gltf";
import { loadMetaModel } from "@xeokit/sdk/metamodel";

const scene = new Scene();
const data = new Data();

const sceneModel = scene.createModel({ id: "myModel" });
const dataModel = data.createModel({ id: "myModel" });

const modelChunksLoader = new ModelChunksLoader({
    sceneModelLoader: loadGLTF,
    dataModelLoader: loadMetaModel
});

fetch("ifc2gltfManifest.json").then(response => {
    response.json().then(ifc2gltfManifest => {
        const modelChunksManifest = xeokit.ifc2gltf2xgf.convertIfc2gltfManifest(ifc2gltfManifest);
        modelChunksLoader.load({
            modelChunksManifest,
            baseDir: ".",
            sceneModel,
            dataModel
        }).then(() => {
            sceneModel.build();
            dataModel.build();
        });
    });
});
Copy

The generated xgfManifest.json:

{
    "sceneModelMIMEType": "arraybuffer",
    "sceneModelFiles": ["model.xgf", "model2.xgf", "model3.xgf"],
    "dataModelFiles": ["model.json", "model2.json", "model3.json"]
}
Copy

To load xgfManifest.json:

import { Scene } from "@xeokit/sdk/scene";
import { Data } from "@xeokit/sdk/data";
import { ModelChunksLoader } from "@xeokit/sdk/modelChunksLoader";
import { loadXGF } from "@xeokit/sdk/xgf";
import { loadDataModel } from "@xeokit/sdk/data";

const scene = new Scene();
const data = new Data();

const sceneModel = scene.createModel({ id: "myModel" });
const dataModel = data.createModel({ id: "myModel" });

const modelChunksLoader = new ModelChunksLoader({
    sceneModelLoader: loadXGF,
    dataModelLoader: loadDataModel
});

fetch("xgfManifest.json").then(response => {
    response.json().then(xgfManifest => {
        modelChunksLoader.load({
            modelChunksManifest: xgfManifest,
            baseDir: ".",
            sceneModel,
            dataModel
        }).then(() => {
            sceneModel.build();
            dataModel.build();
        });
    });
});
Copy