IN PROGRESS

In progress three.js implementation of the 3D Tiles format.

The renderer supports a limited subset of the spec for the moment. See Issue #15 for information on which features are not yet implemented.

See it in action here!

In Progress Features

• Performance
• Bug Triage
• Tileset / Browser validation

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

// ... initialize three scene ...

const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );
tilesRenderer.setCamera( camera );
tilesRenderer.setResolutionFromRenderer( camera, renderer );
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( camera, scene );

}

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

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.

errorThreshold = Infinity : Number

Value used to compute the threshold errorTarget * errorThreshold above which tiles will not render. This is used to enable traversal to skip loading and rendering parent tiles far from the cameras current screenspace error requirement.

If errorThreshold is set to Infinity then all parent tiles will be loaded and rendered. If it's set to 0 then no parent tiles will render and only the tiles that are being rendered will be loaded.

maxDepth = Infinity : Number

The max depth to which tiles will be loaded and rendered.

loadSiblings = true : Boolean

If true then all sibling tiles will be loaded, as well, to ensure coherence when moving the camera. If false then only currently viewed tiles will be loaded.

lruCache = new LRUCache() : LRUCache

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

downloadQueue = new PriorityQueue : PriorityQueue

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

parseQueue = new PriorityQueue : PriorityQueue

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

group : Group

The container group for the 3d tiles. Add this to the three.js scene in order to render it.

When raycasting a higher performance traversal approach is used if raycaster.firstHitOnly = true. If true then only the first hit of the terrain is reported in the tileset.

constructor( url : String )

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

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 to date before this is called.

getBounds( box : Box3 ) : boolean

Sets box to the root bounding box of the tileset in the group frame. Returns false if the tile root was not loaded.

hasCamera( camera : Camera ) : boolean

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

setCamera( camera : Camera ) : boolean

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

deleteCamera( camera : Camera ) : boolean

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

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( camera : Camera, renderer : WebGLRenderer ) : boolean

Sets the resolution being rendered to for the given camera via renderer which accounts for canvas size and current pixel ratio. Returns false if the camera is not being tracked.

extends TilesRenderer

TODO

colorMode = NONE : ColorMode

TODO

displayBoxBounds = false : Boolean

TODO

displaySphereBounds = false : Boolean

TODO

maxDebugDepth = - 1 : Number

TODO

maxDebugError = - 1 : Number

TODO

maxDebugDistance = - 1 : Number

TODO

Piority-sorted queue to prioritize file downloads and parsing.

maxJobs = 6 : number

The maximum number of jobs to be processing at once.

unloadPriorityCallback = null : ( item ) => Number

Function to derive the unload priority of the given item. Higher priority values get unloaded first.

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

maxSize = 800 : number

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

minSize = 600 : number

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

unloadPercent = 0.05 : number

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

priorityCallback = null : ( item ) => Number

Function to derive the job priority of the given item. Higher priority values get processed first.

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

Copyright © 2020 California Institute of Technology. ALL RIGHTS RESERVED. United States Government Sponsorship Acknowledged. This software may be subject to U.S. export control laws. By accepting this software, the user agrees to comply with all applicable U.S. export laws and regulations. User has the responsibility to obtain export licenses, or other export authority as may be required before exporting such information to foreign countries or providing access to foreign persons. 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.