TilesRenderer: Move "traversal" fields into a dedicated subobject (#1431)

* Change to use a "traversal" sub object

* Clean up

* Create an "internal" subfield

* Fix tests

* Fix priority sort

* Remove types

* Convert fields

* Small fixes

* Fixes

* More updates

Author: gkjohnson

example/three/cesiumCompare.js

@@ -135,7 +135,7 @@ function render() {
 	shallowTilesLoaded = 0;
 	traverse( threeViewer.root, t => {
 
-		if ( t.__hasRenderableContent && t.__loadingState !== 0 ) {
+		if ( t.internal && t.internal.hasRenderableContent && t.internal.loadingState !== 0 ) {
 
 			shallowTilesLoaded ++;
 			return true;
@@ -147,7 +147,7 @@ function render() {
 	allLoadedTiles = 0;
 	traverse( threeViewer.root, ( t, d ) => {
 
-		if ( t.__hasContent && t.__loadingState !== 0 ) {
+		if ( t.internal && t.internal.hasContent && t.internal.loadingState !== 0 ) {
 
 			allLoadedTiles ++;
 

example/three/index.js

@@ -97,7 +97,6 @@ function reinstantiateTiles() {
 	ktx2loader.detectSupport( renderer );
 
 	tiles = new TilesRenderer( url );
-	tiles.registerPlugin( new DebugTilesPlugin() );
 	tiles.registerPlugin( new ImplicitTilingPlugin() );
 	tiles.registerPlugin( new GLTFExtensionsPlugin( {
 		rtc: true,
@@ -109,9 +108,11 @@ function reinstantiateTiles() {
 	geospatialRotationParent.add( tiles.group );
 
 	// Used with CUSTOM_COLOR
-	tiles.customColorCallback = ( tile, object ) => {
+	const debugPlugin = new DebugTilesPlugin();
+	tiles.registerPlugin( debugPlugin );
+	debugPlugin.customColorCallback = ( tile, object ) => {
 
-		const depthIsEven = tile.__depth % 2 === 0;
+		const depthIsEven = tile.internal.depth % 2 === 0;
 		const hex = depthIsEven ? 0xff0000 : 0xffffff;
 		object.traverse( c => {
 

example/three/src/plugins/overlays/TextureOverlayPlugin.js

@@ -283,7 +283,7 @@ export class TextureOverlayPlugin {
 	// public functions
 	getTileKey( tile ) {
 
-		return new URL( tile.content.uri, tile.__basePath + '/' ).toString();
+		return new URL( tile.content.uri, tile.internal.basePath + '/' ).toString();
 
 	}
 

src/core/plugins/ImplicitTilingPlugin.js

@@ -18,8 +18,8 @@ export class ImplicitTilingPlugin {
 
 		if ( tile.implicitTiling ) {
 
-			tile.__hasUnrenderableContent = true;
-			tile.__hasRenderableContent = false;
+			tile.internal.hasUnrenderableContent = true;
+			tile.internal.hasRenderableContent = false;
 
 			// Declare some properties
 			tile.__subtreeIdx = 0;	// Idx of the tile in its subtree
@@ -34,8 +34,8 @@ export class ImplicitTilingPlugin {
 		} else if ( /.subtree$/i.test( tile.content?.uri ) ) {
 
 			// Handling content uri pointing to a subtree file
-			tile.__hasUnrenderableContent = true;
-			tile.__hasRenderableContent = false;
+			tile.internal.hasUnrenderableContent = true;
+			tile.internal.hasRenderableContent = false;
 
 		}
 
@@ -46,7 +46,7 @@ export class ImplicitTilingPlugin {
 		if ( /^subtree$/i.test( extension ) ) {
 
 			const loader = new SUBTREELoader( tile );
-			loader.workingPath = tile.__basePath;
+			loader.workingPath = tile.internal.basePath;
 			loader.fetchOptions = this.tiles.fetchOptions;
 			return loader.parse( buffer );
 
@@ -64,7 +64,7 @@ export class ImplicitTilingPlugin {
 				.replace( '{y}', tile.__y )
 				.replace( '{z}', tile.__z );
 
-			return new URL( implicitUri, tile.__basePath + '/' ).toString();
+			return new URL( implicitUri, tile.internal.basePath + '/' ).toString();
 
 		}
 
@@ -84,7 +84,7 @@ export class ImplicitTilingPlugin {
 
 			} );
 			tile.children.length = 0;
-			tile.__childrenProcessed = 0;
+			tile.internal.childrenProcessed = 0;
 
 		}
 

src/core/renderer/tiles/Tile.d.ts

@@ -1,50 +1,68 @@
 import { TileBase } from './TileBase.js';
 
 /**
- * Documented 3d-tile state managed by the TilesRenderer* / used/usable in priority / traverseFunctions!
+ * Internal implementation details for tile management
  */
-export interface Tile extends TileBase {
-
-	parent: Tile;
+export interface TileInternalData {
+	hasContent: boolean;
+	hasRenderableContent: boolean;
+	hasUnrenderableContent: boolean;
+	loadingState: number;
+	basePath: string;
+	childrenProcessed: number;
+	depth: number;
+	depthFromRenderedParent: number;
+}
 
+/**
+ * Traversal state data updated during each frame's tile traversal
+ */
+export interface TileTraversalData {
 	/**
-	 * Hierarchy Depth from the TileGroup
+	 * How far this tile's bounds are from the nearest active camera.
+	 * Expected to be filled in during calculateError implementations.
 	 */
-	__depth : number;
+	distanceFromCamera: number;
 	/**
 	 * The screen space error for this tile
 	 */
-	__error : number;
+	error: number;
 	/**
-	 * How far is this tiles bounds from the nearest active Camera.
-	 * Expected to be filled in during calculateError implementations.
+	 * Whether or not the tile was within the frustum on the last update run
+	 */
+	inFrustum: boolean;
+	/**
+	 * Whether this tile is a leaf node in the used tree
 	 */
-	__distanceFromCamera : number;
+	isLeaf: boolean;
 	/**
-	 * This tile is currently active if:
-	 *  1: Tile content is loaded and ready to be made visible if needed
+	 * Whether or not the tile was visited during the last update run
 	 */
-	__active : boolean;
+	used: boolean;
+	/**
+	 * Whether or not the tile was used in the previous frame
+	 */
+	usedLastFrame: boolean;
 	/**
 	 * This tile is currently visible if:
 	 *  1: Tile content is loaded
 	 *  2: Tile is within a camera frustum
 	 *  3: Tile meets the SSE requirements
 	 */
-	__visible : boolean;
-	/**
-	 * Whether or not the tile was visited during the last update run.
-	 */
-	__used : boolean;
+	visible: boolean;
+}
 
-	/**
-	 * Whether or not the tile was within the frustum on the last update run.
-	 */
-	__inFrustum : boolean;
+/**
+ * Documented 3d-tile state managed by the TilesRenderer* / used/usable in priority / traverseFunctions!
+ */
+export interface Tile extends TileBase {
 
-	/**
-	 * The depth of the tiles that increments only when a child with geometry content is encountered
-	 */
-	__depthFromRenderedParent : number;
+	parent: Tile;
+
+	// Internal implementation details for tile management
+	internal: TileInternalData;
+
+	// Traversal state data updated during each frame's tile traversal
+	traversal: TileTraversalData;
 
 }