docsby gkjohnson

DebugTilesPlugin

Plugin that adds visual debugging aids to a TilesRenderer: bounding-volume helpers (box, sphere, region), tile color modes based on depth/error/distance/load order, and an unlit rendering mode. Color modes are available via the static ColorModes property.

Showing tile bounds and coloring tiles by depth
Data courtesy of NASA/JPL-Caltech
On this page

Properties

getDebugColor: ( val: number, target: Color ) => void = ( value, target ) => target.setRGB( value, value, value )

Maps a normalized [0, 1] value to a Color for debug visualizations. Defaults to a black-to-white gradient. Replace with a custom function to use a different color ramp.

Methods

constructor

new DebugTilesPlugin(
	options?: {
		// Show OBB bounding-box helpers.
		displayBoxBounds: boolean = false,

		// Show bounding-sphere helpers.
		displaySphereBounds: boolean = false,

		// Show bounding-region helpers.
		displayRegionBounds: boolean = false,

		// Also show ancestor bounding volumes for visible tiles.
		displayParentBounds: boolean = false,

		// Initial tile color mode.
		colorMode: number = ColorModes.NONE,

		// Color mode applied to bounding-volume helpers.
		boundsColorMode: number = ColorModes.NONE,

		// Maximum tree depth for depth-based coloring (`-1` = auto).
		maxDebugDepth: number = -1,

		// Maximum distance for distance-based coloring (`-1` = auto).
		maxDebugDistance: number = -1,

		// Maximum error for error-based coloring (`-1` = auto).
		maxDebugError: number = -1,

		// Callback invoked per-object when `colorMode` is `CUSTOM_COLOR`.
		customColorCallback: ( tile: Object, child: Object3D ) => void | null = null,

		// Replace tile materials with unlit `MeshBasicMaterial`.
		unlit: boolean = false,

		// Whether the plugin is active on init.
		enabled: boolean = true
	}
)

update

update(): void

Applies the current plugin field values to all visible tile geometry. Call this after modifying properties such as colorMode, displayBoxBounds, or displayParentBounds when TilesRenderer.update is not being called every frame so changes can be reflected.