feat(DebugTilesPlugin): allow toggling the plugin (#647)

Author: sguimmara

src/plugins/three/DebugTilesPlugin.d.ts

@@ -14,6 +14,8 @@ export const RANDOM_NODE_COLOR: ColorMode;
 export const CUSTOM_COLOR: ColorMode;
 export class DebugTilesPlugin {
 
+	enabled: boolean;
+
 	displayBoxBounds : boolean;
 	displaySphereBounds : boolean;
 	displayRegionBounds : boolean;

src/plugins/three/DebugTilesPlugin.js

@@ -60,6 +60,8 @@ export class DebugTilesPlugin {
 		this.name = 'DEBUG_TILES_PLUGIN';
 		this.tiles = null;
 
+		this._enabled = true;
+
 		this.extremeDebugDepth = - 1;
 		this.extremeDebugError = - 1;
 		this.boxGroup = null;
@@ -84,6 +86,36 @@ export class DebugTilesPlugin {
 
 	}
 
+	get enabled() {
+
+		return this._enabled;
+
+	}
+
+	set enabled( v ) {
+
+		if ( v !== this._enabled ) {
+
+			this._enabled = v;
+
+			if ( this._enabled ) {
+
+				if ( this.tiles ) {
+
+					this.init( this.tiles );
+
+				}
+
+			} else {
+
+				this.dispose();
+
+			}
+
+		}
+
+	}
+
 	// initialize the groups for displaying helpers, register events, and initialize existing tiles
 	init( tiles ) {
 
@@ -109,31 +141,48 @@ export class DebugTilesPlugin {
 		// register events
 		this._onLoadTileSetCB = () => {
 
-			this._initExtremes();
+			if ( this.enabled ) {
+
+				this._initExtremes();
+
+			}
 
 		};
 
 		this._onLoadModelCB = ( { scene, tile } ) => {
 
-			this._onLoadModel( scene, tile );
+			if ( this.enabled ) {
+
+				this._onLoadModel( scene, tile );
+
+			}
 
 		};
 
 		this._onDisposeModelCB = ( { tile } ) => {
 
+			// Note that we want to cleanup memory even if the plugin is disabled.
 			this._onDisposeModel( tile );
 
 		};
 
 		this._onUpdateAfterCB = () => {
 
-			this._onUpdateAfter();
+			if ( this.enabled ) {
+
+				this._onUpdateAfter();
+
+			}
 
 		};
 
 		this._onTileVisibilityChangeCB = ( { scene, tile, visible } ) => {
 
-			this._onTileVisibilityChange( tile, visible );
+			if ( this.enabled ) {
+
+				this._onTileVisibilityChange( tile, visible );
+
+			}
 
 		};
 
@@ -143,6 +192,8 @@ export class DebugTilesPlugin {
 		tiles.addEventListener( 'update-after', this._onUpdateAfterCB );
 		tiles.addEventListener( 'tile-visibility-change', this._onTileVisibilityChangeCB );
 
+		this._initExtremes();
+
 		// initialize an already-loaded tiles
 		tiles.traverse( tile => {
 
@@ -215,11 +266,19 @@ export class DebugTilesPlugin {
 
 	_initExtremes() {
 
+		if ( ! ( this.tiles && this.tiles.root ) ) {
+
+			return;
+
+		}
+
 		// initialize the extreme values of the hierarchy
 		let maxDepth = - 1;
 		let maxError = - 1;
 
-		traverseSet( this.tiles.root, null, ( tile, parent, depth ) => {
+		// Note that we are not using this.tiles.traverse()
+		// as we don't want to pay the cost of preprocessing tiles.
+		traverseSet( this.tiles.root, null, ( tile, _, depth ) => {
 
 			maxDepth = Math.max( maxDepth, depth );
 			maxError = Math.max( maxError, tile.geometricError );