xeokit-gltf-to-xkt

Contents

• Overview
• Usage
• Credits

Overview

xeokit-gltf-to-xkt converts models from glTF 2.0 to xeokit's optimized .xkt format.

An .xkt file is a binary file that contains a single 3D model with full-precision geometry, compressed using quantization, oct-encoding and zlib.

See the XKT Format specification for a detailed description of the .xkt format.

See Creating Files for Offline BIM for instructions on converting IFC, DAE and glTF models to .xkt.

Once you have .xkt files, you can load them into your viewer using XKTLoaderPlugin , which is the most efficient way to load high-detail models into xeokit.

Click on the screenshot below for a live demo of the XKTLoaderPlugin.

[Run this example]

Usage

• Always use the latest version of xeokit/xeokit-sdk with each new version of xeokit-gltf-xkt.

CLI

Install locally or globally from npm.

$ npm i @xeokit/xeokit-gltf-to-xkt
$ ./gltf2xkt -s scene.gltf -o scene.xkt

$ gltf2xkt --help

Usage: gltf2xkt [options]

Options:
  -v, --version          output the version number
  -s, --source [file]    path to the source glTF file
  -o, --output [file]    path to the target xkt file
  -h, --help             output usage information

Programmatically

Since version 0.1.0, the gltf2xkt tool is a thin wrapper for xeokit-xkt-utils, which does the real conversion work. To convert files programmatically, we now use the xeokit-xkt-utils library directly.

const fs = require('fs').promises;

const {
    XKTModel,
    parseGLTFIntoXKTModel,
    writeXKTModelToArrayBuffer
} = require("@xeokit/xeokit-xkt-utils/dist/xeokit-xkt-utils.cjs.js");

async function main() {

    const gltfContent = await fs.readFile('../files/my_model.gltf');

    const gltfBasePath = getBasePath('../files/my_model.gltf'); // returns ../files/

    async function getAttachment(uri, parsingContext) {
        // This method we'll be called if the GLTF has an external resource. You may want to fetch them from 
        // disk or over network. uri is the URI defined in the GLTF. You can omit this callback if you know 
        // your gltf files don't use any eternal resource.
        return fs.readFile(gltfBasePath + uri);
    }

    const xktModel = new XKTModel();

    await parseGLTFIntoXKTModel(gltfContent, xktModel, getAttachment);

    xktModel.finalize();

    const xktArrayBuffer = writeXKTModelToArrayBuffer(xktModel);

    await fs.writeFile('../files/my_model.xkt', xktArrayBuffer);
}

main();

Development

// Clone the repo
$ git clone https://github.com/xeokit/xeokit-gltf-to-xkt
$ cd xeokit-gltf-to-xkt

// Install the dependencies
$ npm install

// Link for command line usage
$ npm link

// Use global symlink for testing
$ gltf2xkt -s /path/to/scene.gltf -o /path/to/scene.xkt

See .eslint and .prettierrc for code style guide.

Credits

• The xeokit-gltf-to-xkt tool and the XKTLoaderPlugin are based on prototypes by Toni Marti at uniZite. Find the original discussion around those prototypes here.
• Thanks to Adam Eri at BIMSpot for converting xeokit-gltf-to-xkt to work as a CLI tool.