@gltf-transform/view

@gltf-transform/view

Creates three.js objects from glTF Scene, Node, Mesh, Material and other properties, and keeps those three.js objects updated in realtime as changes are made through the glTF Transform library. Combined with import/export using WebIO, @gltf-transform/view provides a lossless workflow to load, view, edit, and export glTF assets — particularly useful in editor-like applications on the web. Changes to a glTF Document are reflected in three.js immediately, and any features three.js doesn't support won't be lost — they just aren't rendered in the preview.

NOTICE: three.js can load glTF 2.0 files with THREE.GLTFLoader and export them with THREE.GLTFExporter, the GLTFExporter step is lossy and slow. In comparison, the fast edit/refresh loop provided by @gltf-transform/view requires some additional memory overhead, and so this project is not meant to replace THREE.GLTFLoader for one-time resource loading.

Quickstart

Installation:

npm install --save @gltf-transform/view

API

import { Scene, WebGLRenderer, PerspectiveCamera } from 'three';

import { WebIO } from '@gltf-transform/core';
import { KHRONOS_EXTENSIONS } from '@gltf-transform/extensions';
import { DocumentView } from '@gltf-transform/view';

// Set up three.js scene.

const scene = new Scene();
// ...

// Load glTF Document.
const io = new WebIO().registerExtensions(KHRONOS_EXTENSIONS);
const document = await io.read('path/to/input.glb');
const documentView = new DocumentView(document);

// Add glTF content to the scene (just once).
const sceneDef = document.getRoot().listScenes()[0];
const sceneGroup = documentView.view(sceneDef);
scene.add(sceneGroup);

// Render.
function animate () {
	requestAnimationFrame(animate);
	renderer.render(scene, camera);
}

// When glTF Document is edited, scene updates automatically.
const materialDef = document.getRoot().listMaterials()
	.find((mat) => mat.getName() === 'MyMaterial');
buttonEl.addEventListener('click', () => {
	materialDef.setBaseColorHex(0xFF0000);
});

Each DocumentView instance maintains reference counts and disposes of three.js WebGL resources (textures, geometry, materials) when the underlying glTF Transform properties are disposed. Unused resources are not disposed immediately, in case they might be used again later. To manually dispose of unused resources — e.g. to free up GPU memory — call documentView.gc(). Resources will be re-allocated automatically if they are used again.

Feature support

• ✅  Renders and updates
• 🚧  Static render, no updates
• ❌  Not rendered

binding	status
Scene	✅
Node	✅
Mesh	✅
Primitive	✅
Accessor	✅
Material	✅
Texture	✅
TextureInfo	🚧
Morph Targets	❌
Animation	❌
Camera	❌
Light	❌

For supported extensions, see glTF-Transform-View#7.

Contributing

See CONTRIBUTING.md.