Babylon.js/loaders/src/glTF

Babylon.js glTF File Loader

Usage

The glTF file loader is a SceneLoader plugin.

glTF2 Playground example

Step 1 - Include the glTF File Loader

Full Version

This loader supports both glTF 1.0 and 2.0 and will use the correct loader based on the glTF version string.

<script src="babylon.js"></script>
<script src="babylon.glTFFileLoader.js"></script>

Version 1 Only

This loader supports only glTF 1.0 and will fail to load glTF 2.0.

<script src="babylon.js"></script>
<script src="babylon.glTF1FileLoader.js"></script>

Version 2 Only

This loader supports only glTF 2.0 and will fail to load glTF 1.0.

<script src="babylon.js"></script>
<script src="babylon.glTF2FileLoader.js"></script>

Step 2 - Call the Scene Loader

BABYLON.SceneLoader.Load("./", "duck.gltf", engine, function (scene) { 
   // do somethings with the scene
});

You can also call the ImportMesh function and import specific meshes

// meshesNames can be set to "null" to load all meshes and skeletons
BABYLON.SceneLoader.ImportMesh(["myMesh1", "myMesh2", "..."], "./", "duck.gltf", scene, function (meshes, particleSystems, skeletons) { 
   // do somethings with the meshes, particleSystems (not handled in glTF files) and skeletons
});

You can also append a glTF file to a scene. When using SceneLoader.Append, configure the scene to use right handed system by setting the property useRightHandedSystem to true.

// glTF Files use right handed system 
scene.useRightHandedSystem = true;

// Append sample glTF model to scene
BABYLON.SceneLoader.Append("https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Models/master/2.0/BoomBox/glTF/", "BoomBox.gltf", scene, function (scene) {
}, null, function (scene) {
    alert("error");
});

Step 3 (V1 Only) - Optionally Specify Flags

If you want to disable incremental loading, you can set the property IncrementalLoading to false. Then, you'll be able to be called back with all geometries and shaders loaded. Textures are always loaded asynchronously. For example, you can retrieve the real bounding infos of a mesh loaded when incremental loading is disabled.

BABYLON.GLTFFileLoader.IncrementalLoading = false; // true by default

In order to work with homogeneous coordinates (that can be available with some converters and exporters):

BABYLON.GLTFFileLoader.HomogeneousCoordinates = true; // false by default

Supported Features

• Load scenes (SceneLoader.Load and SceneLoader.Append)
• Support of ImportMesh function
• Import geometries
  • From binary files
  • From base64 buffers
• Import lights (V1 only)
• Import cameras
• Import and set custom shaders (V1 only)
  • Automatically bind attributes
  • Automatically bind matrices
  • Set uniforms
• Import and set animations
• Skinning (BETA, sometimes wrong on tricky models)
  • Skeletons
  • Hardware skinning (shaders support)
  • Bones import
• Handle dummy nodes (empty nodes)
• PBR materials (V2 only)

Future Improvements

• Test on more geometries
• Test on more animated models
• Test on more skinned models
• Improve shaders support (V1 only) (glitches with samplers can appear in particular configurations)
• Add support for morph targets (V2 only)