matterport/3DTilesRendererJS

3d-tiles-renderer

Three.js renderer implementation for the 3D Tiles format. The renderer supports most of the 3D Tiles spec features with a few exceptions. For a list of available data sets and generation tools see the 3d Tiles resources list.

If a tile set or geometry does not load or render properly please make an issue! Example data is needed for adding and testing features. See the Feature Complete Milestone for information on which features are not yet implemented.

Examples

Dingo Gap Mars dataset with multiple tile sets

Kitchen sink example with all options here

Rendering in VR example here

External Tiles Providers

Personal Google Tiles API Key or Cesium Ion API Key required

Cesium Ion 3D Tiles

Cesium Ion Lunar Tiles

Google Photorealistic Tiles

Google Globe Tiles

Customization

Custom material example

Rendering shadows from offscreen tiles example

Alterate texture overlays

Plugins

Tile Metadata

Tile LoD Fade Transition

Deep Zoom Image Format Support

TMS, XYZ Map Tiles Support

Quantized Mesh with Overlays

Loading Tiles in Region Volumes

React Three Fiber

See the dedicated documentation for information on using the project with @react-three/fiber.

Use

Installation

npm install 3d-tiles-renderer --save

Basic TilesRenderer

Setting up a basic application with a 3D Tile Set.

import { TilesRenderer } from '3d-tiles-renderer';

// ... initialize three scene ...

const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );
tilesRenderer.setCamera( camera );
tilesRenderer.setResolutionFromRenderer( camera, renderer );
tilesRenderer.addEventListener( 'load-tile-set', () => {

	// optionally center the tile set in case it's far off center
	const sphere = new Sphere();
	tilesRenderer.getBoundingSphere( sphere );
	tilesRenderer.group.position.copy( sphere.center ).multiplyScalar( - 1 );

} );

scene.add( tilesRenderer.group );

renderLoop();

function renderLoop() {

	requestAnimationFrame( renderLoop );

	// The camera matrix is expected to be up to date
	// before calling tilesRenderer.update
	camera.updateMatrixWorld();
	tilesRenderer.update();
	renderer.render( scene, camera );

}

Custom Material

Setting up a 3D Tile Set using a custom material.

const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );
tilesRenderer.setCamera( camera );
tilesRenderer.setResolutionFromRenderer( camera, renderer );
tilesRenderer.addEventListener( 'load-model', ( { scene } ) => {

	// create a custom material for the tile
	scene.traverse( c => {

		if ( c.material ) {

			c.originalMaterial = c.material;
			c.material = new MeshBasicMaterial();

		}

	} );

};

tilesRenderer.addEventListener( 'dispose-model', ( { scene } ) => {

	// dispose of any manually created materials
	scene.traverse( c => {

		if ( c.material ) {

			c.material.dispose();

		}

	} );

};
scene.add( tilesRenderer.group );

Multiple TilesRenderers with Shared Caches and Queues

Using multiple tiles renderers that share LRUCache and PriorityQueue instances to cut down on memory and correctly prioritize downloads.

// create multiple tiles renderers
const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );
tilesRenderer.setCamera( camera );
tilesRenderer.setResolutionFromRenderer( camera, renderer );

const tilesRenderer2 = new TilesRenderer( './path/to/tileset2.json' );
tilesRenderer2.setCamera( camera );
tilesRenderer2.setResolutionFromRenderer( camera, renderer );

// set the second renderer to share the cache and queues from the first
tilesRenderer2.lruCache = tilesRenderer.lruCache;
tilesRenderer2.downloadQueue = tilesRenderer.downloadQueue;
tilesRenderer2.parseQueue = tilesRenderer.parseQueue;
tilesRenderer2.processNodeQueue = tilesRenderer.processNodeQueue;

// add them to the scene
scene.add( tilesRenderer.group );
scene.add( tilesRenderer2.group );

Adding DRACO Decompression Support

Adding support for DRACO decompression within the GLTF files that are transported in B3DM and I3DM formats. The same approach can be used to add support for KTX2 and DDS textures. Alternatively the GLTFExtensionsPlugin can be used to simplify the setup.

// Note the DRACO compression files need to be supplied via an explicit source.
// We use unpkg here but in practice should be provided by the application.
// Decompressing GLTF requires the GLTF branch of the draco decoder
const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );

const dracoLoader = new DRACOLoader();
dracoLoader.setDecoderPath( 'https://unpkg.com/[email protected]/examples/js/libs/draco/gltf/' );

const loader = new GLTFLoader( tilesRenderer.manager );
loader.setDRACOLoader( dracoLoader );

tilesRenderer.manager.addHandler( /\.(gltf|glb)$/g, loader );

Adding support for DRACO decompression within the PNTS files requires a different draco decoder. See more info here.

// Note the DRACO compression files need to be supplied via an explicit source.
// We use unpkg here but in practice should be provided by the application.
// Decompressing point clouds should use the master branch of the draco decoder in place of the GLTF branch
const dracoLoader = new DRACOLoader();
dracoLoader.setDecoderPath( 'https://unpkg.com/[email protected]/examples/js/libs/draco/' );

const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );
tilesRenderer.manager.addHandler( /\.drc$/g, dracoLoader );

Loading from Cesium Ion

Loading from Cesium Ion requires some extra fetching of the ion url endpoint, as well as a temporary bearer access token. A full example is found in the ionExample.js file in the examples folder.

Set the desired assetId as well as your Ion AccessToken. More reading is provided by the Cesium REST API documentation.

// fetch a temporary token for the Cesium Ion asset
const url = new URL( `https://api.cesium.com/v1/assets/${ assetId }/endpoint` );
url.searchParams.append( 'access_token', accessToken );

fetch( url, { mode: 'cors' } )
	.then( res => res.json() )
	.then( json => {

		url = new URL( json.url );

		const version = url.searchParams.get( 'v' );
		tiles = new TilesRenderer( url );
		tiles.fetchOptions.headers = {};
		tiles.fetchOptions.headers.Authorization = `Bearer ${json.accessToken}`;

		// Prefilter each model fetch by setting the cesium Ion version to the search
		// parameters of the url.
		tiles.preprocessURL = uri => {

			uri = new URL( uri );
			uri.searchParams.append( 'v', version );
			return uri.toString();

		};

	} );

Render On Change

The tile set and model load callbacks can be used to detect when the data has changed and a new render is necessary.

let needsRerender = true;
const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );
tilesRenderer.addEventListener( 'load-tile-set', () => needsRerender = true );
tilesRenderer.addEventListener( 'load-model', () => needsRerender = true );

function renderLoop() {

	requestAnimationFrame( renderLoop );
	if ( needsRerender ) {

		needsRerender = false;
		camera.updateMatrixWorld();
		tilesRenderer.update();
		renderer.render( scene, camera );

	}

}
renderLoop();

Read Batch Id and Batch Table Data

How to find the batch id and batch table associated with a mesh and read the data.

const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );

// ...checking intersections...

const intersects = raycaster.intersectObject( scene, true );
if ( intersects.length ) {

	const { face, object } = intersects[ 0 ];
	const batchidAttr = object.geometry.getAttribute( '_batchid' );

	if ( batchidAttr ) {

		// Traverse the parents to find the batch table.
		let batchTableObject = object;
		while ( ! batchTableObject.batchTable ) {

			batchTableObject = batchTableObject.parent;

		}

		// Log the batch data
		const batchTable = batchTableObject.batchTable;
		const hoveredBatchid = batchidAttr.getX( face.a );
		const batchData = batchTable.getDataFromId( hoveredBatchid );
		console.log( batchData );

	}

}

API

See the plugins documentation for GLTFLoader extension plugins, TilesRenderer plugins, and extra classes.

TilesRenderer

extends THREE.EventDispatcher & TilesRendererBase, which can be used to implement a 3d tiles renderer in other engines

events

// Fired when a new root or child tile set is loaded.
{ type: 'load-tile-set', tileSet: Object, url: String }

// Fired when a tile model is loaded.
{ type: 'load-model', scene: THREE.Group, tile: Object }

// Fired when the content of a model is loaded. Fired along side the
// above two events.
{ type: 'load-content' }

// Fired when a tile model is disposed.
{ type: 'dispose-model', scene: THREE.Group, tile: Object }

// Fired when the tile set hierarchy is ready for "update to be called
// again due to new content having loaded or asynchronous processing finished.
{ type: 'needs-update' }

// Fired when a tiles visibility changes.
{ type: 'tile-visibility-change', scene: THREE.Group, tile: Object, visible: boolean }

// Fired when tiles start loading.
{ type: 'tiles-load-start' }

// Fired when all tiles finish loading.
{ type: 'tiles-load-end' }

// Fired when tile content begins downloading.
{ type: 'tile-download-start', tile: Object }

// Fired when a tile content or the root tile set fails to load.
{ type: 'load-error', tile: Object | null, error: Error, url: string | URL }

// Fired when a camera is added to be accounted for when traversing the tile set.
{ type: 'add-camera', camera: Camera }

// Fired when a camera is removed from being accounted for when traversing the tile set.
{ type: 'delete-camera', camera: Camera }

// Fired when the resolution being rendered to is changed for any tracked camera.
{ type: 'camera-resolution-change' }

.fetchOptions

fetchOptions = {} : Object

Options passed to fetch when loading tile set and model data.

.errorTarget

errorTarget = 6 : Number

The target screenspace error in pixels to target when updating the geometry. Tiles will not render if they have below this level of screenspace error. See the "geometric error" section in the 3d tiles specification for more information.

.maxDepth

maxDepth = Infinity : Number

The max depth to which tiles will be loaded and rendered. Setting it to 1 will only render the root tile. If the tile at depth maxDepth is an empty tile then the next set of visible children will be rendered.

.displayActiveTiles

displayActiveTiles = false : Boolean

"Active tiles" are those that are loaded and available but not necessarily visible. These tiles are useful for raycasting off camera or for casting shadows.

Active tiles not currently visible in a camera frustum are removed from the scene as an optimization. Setting displayActiveTiles to true will keep them in the scene to be rendered from an outside camera view not accounted for by the tiles renderer.

.autoDisableRendererCulling

autoDisableRendererCulling = true : Boolean

If true then all tile meshes automatically have their frustumCulled field set to false. This is useful particularly when using one camera because the tiles renderer automatically performs it's own frustum culling on visible tiles. If displayActiveTiles is true or multiple cameras are being used then you may consider setting this to false.

.lruCache

lruCache = new LRUCache() : LRUCache

NOTE: This cannot be set once update is called for the first time.

.downloadQueue

downloadQueue = new PriorityQueue : PriorityQueue

NOTE: This cannot be set once update is called for the first time.

Queue for downloading tile content. Max jobs defaults to 10.

.parseQueue

parseQueue = new PriorityQueue : PriorityQueue

NOTE: This cannot be modified once update is called for the first time.

Queue for parsing downloaded tile content. Max jobs defaults to 1.

.processNodeQueue

processNodeQueue = new PriorityQueue : PriorityQueue

NOTE: This cannot be set once update is called for the first time.

Queue for expanding and initializing tiles for traversal. Max jobs defaults to 25.

.group

group : Group

The container group for the 3d tiles. Add this to the three.js scene in order to render it. The group includes an additional matrixWorldInverse field for transforming objects into the local tile set frame.

.manager

manager : LoadingManager

The manager used when loading tile geometry.

.loadProgress

readOnly loadProgress : Number

Returns the total load progress between [0, 1]. Progress is measured since the last set of loading tiles completed.

.ellipsoid

readonly ellipsoid : Ellipsoid

A definition on the ellipsoid used for the tile set. Defaults to the WGS84 ellipsoid and is modified if the 3DTILES_ELLIPSOID plugin is present. Specified in the local frame of TilesRenderer.group.

.constructor

constructor( url = null : String | null )

Takes the url of the tileset.json for the tile set to be rendered.

.update

update() : void

Updates the tiles to render and kicks off loads for the appropriate tiles in the 3d tile set.

Both group.matrixWorld and all cameras world matrices are expected to be up to date before this is called.

.resetFailedTiles

resetFailedTiles() : void

If any tiles failed to load due to server or network issues then they will not be retried by automatically. This function clears all failed tile states so unloaded tiles can be retried again.

.getBoundingBox

getBoundingBox( box : Box3 ) : boolean

Sets box to the axis aligned root bounding box of the tile set in the group frame. Returns false if the tile root is not loaded and the bounding box cannot be set.

.getOrientedBoundingBox

getOrientedBoundingBox( box : Box3, boxTransform : Matrix4 ) : boolean;

Sets box and boxTransform to the bounds and matrix that describe the oriented bounding box that encapsulates the root of the tile set. Returns false if the tile root is not loaded and the bounding box cannot be set.

.getBoundingSphere

getBoundingSphere( sphere : Sphere ) : boolean;

Sets sphere to the bounding sphere that encapsulates the root of the tile set. Returns false if the tile root is not loaded and the bounding sphere cannot be set.

.hasCamera

hasCamera( camera : Camera ) : boolean

Returns true if the camera has already been set on the renderer.

.setCamera

setCamera( camera : Camera ) : boolean

Adds the camera to the camera to be accounted for when traversing the tile set. Returns false if the camera is already being tracked. Returns true otherwise.

.deleteCamera

deleteCamera( camera : Camera ) : boolean

Removes the given camera from being accounted for when traversing the tile set. Returns false if the camera was not tracked.

.setResolution

setResolution( camera : Camera, resolution : Vector2 ) : boolean
setResolution( camera : Camera, x : number, y : number ) : boolean

Sets the resolution being rendered to for the given camera. Returns false if the camera is not being tracked.

.setResolutionFromRenderer

setResolutionFromRenderer( camera : Camera, renderer : WebGLRenderer ) : boolean

Sets the resolution being rendered to for the given camera via renderer which accounts for canvas size. The pixel ratio is ignored to help normalize the amount of data loaded and performance across devices. Returns false if the camera is not being tracked.

.forEachLoadedModel

forEachLoadedModel( callback : ( scene : Object3D, tile : object ) => void ) : void

Fires the callback for every loaded scene in the hierarchy with the associated tile as the second argument. This can be used to update the materials of all loaded meshes in the tile set.

.registerPlugin

registerPlugin( plugin : TilesPlugin ) : void

Register a plugin to the TilesRenderer. See the plugins documentation for more information.

.unregisterPlugin

unregisterPlugin( plugin : TilesPlugin | String ) : Boolean

Removes a plugin from the tiles renderer. Returns true if the plugin was in the renderer and was removed. Returns false otherwise.

.getPluginByName

getPluginByName( name : string ) : TilesPlugin

Returns the plugin with the given name if it has been registered. Returns the first one if multiple have been registered.

.getAttributions

getAttributions( target = [] : Array ) : Array<{
	type: string,
	value: any,
}>

Returns a list of attributions for the data in the tile set. The list can change when tile visibility changes.

The "type" can be a "string", "html", or "image" depending on the type of attribution. Google Photorealistic Tiles, for example, returns a list of sources as a string.

.dispose

dispose() : void

Disposes of all the tiles in the renderer. Calls dispose on all materials, textures, and geometries that were loaded by the renderer and subsequently calls onDisposeModel for any loaded tile model.

PriorityQueue

Priority-sorted queue to prioritize file downloads and parsing.

.maxJobs

maxJobs = 6 : number

The maximum number of jobs to be processing at once.

.priorityCallback

priorityCallback = null : ( itemA, itemB ) => Number

Function to derive the job priority of the given item. Higher priority values get processed first (ie return 1 to have itemA processed first).

.schedulingCallback

schedulingCallback = requestAnimationFrame : ( cb : Function ) => void

A function used for scheduling when to run jobs next so more work doesn't happen in a single frame than there is time for -- defaults to the next frame. This should be overridden in scenarios where requestAnimationFrame is not reliable, such as when running in WebXR. See the VR demo for one example on how to handle this with WebXR.

LRUCache

Utility class for the TilesRenderer to keep track of currently used items so rendered items will not be unloaded.

.maxSize

maxSize = 800 : number

The maximum cached size in number of items. If that current amount of cached items is equal to this value then no more items can be cached.

.minSize

minSize = 600 : number

The minimum cache size in number of items. Above this cached data will be unloaded if it's unused.

.maxBytesSize

maxByteSize = 0.3 * 2**30 : Number

The maximum cached size in bytes. If that current amount of cached bytes is equal to this value then no more items can be cached.

NOTE: Only works with three >= 0.166.0.

.minBytesSize

minByteSize = 0.2 * 2**30 : Number

The minimum cache size in number of bytes. Above this cached data will be unloaded if it's unused.

NOTE: Only works with three >= 0.166.0.

.unloadPercent

unloadPercent = 0.05 : number

The maximum percentage of minSize to unload during a given frame.

.unloadPriorityCallback

unloadPriorityCallback = null : ( itemA, itemB ) => Number

Function to derive the unload priority of the given item. Higher priority values get unloaded first (ie return 1 to have itemA removed first).

BatchTable

.getKeys

getKeys() : Array<String>

Returns the keys of all the data in the batch table.

.getDataFromId

getDataFromId( id: Number, target?: Object ) : Object;

Returns an object definition for all properties of the batch table and its extensions for a given id. A target object can be specified to store the result. Throws an error if the id is out of the batch table bounds.

.getPropertyArray

getPropertyArray( key : String ) : Array | TypedArray | null

Returns an array of data associated with the key passed into the function. Returns null if the key is not in the table.

LICENSE

The software is available under the Apache V2.0 license.

Copyright © 2020 California Institute of Technology. ALL RIGHTS RESERVED. United States Government Sponsorship Acknowledged. Neither the name of Caltech nor its operating division, the Jet Propulsion Laboratory, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.