bom-three.js (THREE.BOMLoader)

A javascript library to import BOM (Binary Object/Material) files into three.js. Loaded assets will be output as a THREE.Mesh consisting of THREE.BufferGeometry and an associated THREE.Material. Multi-material assets may be split into multiple THREE.Mesh objects, per material.

Usage

Include the loader library in your project:

<script src="https://cdn.rawgit.com/NGenesis/bom-three.js/v0.6.3/examples/js/loaders/BOMLoader.min.js"></script>

Then create an instance of BOMLoader and specify the file path to load:

var filePath = 'https://example.com/path/to/file.bom';

var loader = new THREE.BOMLoader();
//loader.setDebug(true); // Output verbose debugging information (Disabled/false by default)
//loader.setPerfTimer(true); // Output loader performance timer information (Disabled/false by default)
//loader.setTexturePath(filePath.split('/').slice(0, -1).join('/') + '/'); // Specify base texture path (Searches relative to asset path by default)

loader.load(filePath, function(obj) {
	scene.add(obj); // Add object to scene once loaded.
});

A convenience loader is also provided to load one or more files in the order provided:

var filePaths = [
	{ name: 'File 1', url: 'https://example.com/path/to/file1.bom' },
	{ name: 'File 2', url: 'https://example.com/path/to/file2.bom' }
];

THREE.BOMLoaderUtil.multiload(filePaths, function(objects) {
	for(var object of objects) {
		console.log('File loaded: ', object.name);
		scene.add(object.object); // Add object to scene once loaded.
	}
});

A-Frame components and primitives for loading BOM files are also provided:

<a-entity bom-asset="src: https://example.com/path/to/file.bom"></a-entity>

<a-bom-asset src="https://example.com/path/to/file.bom"></a-bom-asset>

See also

obj2bom - A command line tool to convert OBJ and associated MTL files to BOM (Binary Object/Material) file format.