Merge remote-tracking branch 'origin/master' into feature/mvt-clean

Author: AlaricBaraou

CHANGELOG.md

@@ -10,11 +10,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - TilesRenderer now removes tiles from the download queue if they are no longer needed for rendering. Tiles will continue to process if they are mid-download or parsing.
 - I3DMLoader: Added support for oct-encoded normals.
 - TilesRenderer: Added "optimizedLoadStrategy" and "loadSiblings" options. These are experimental settings and are planned to be the default and only tile load strategy.
+- R3F: added "EllipsoidContext" with "ellipsoid" and "frame" fields
+- Export FeatureTable, BatchTable classes.
+- TilingScheme: "tileSplitX" and "tileSplitY" variables per tile
+- XYZImageFormat: add "projection" option and ability to set tile settings per-level.
+- DebugTilesPlugin: add "update" function so settings can be updated without updating tiles.
+- LoadRegionPlugin: Added "calculateDistance" function to regions, used for tile load sorting
 
 ### Changed
 - ImageOverlayPlugin: Textures are now assumed to be straight alpha.
 - ImageOverlayPlugin: Refactor image overlays to afford drawing directly to region textures.
 - GeoJSONOverlay: Add "redraw" function to redraw the geojson once it's changed
+- Renamed the "cached" tile subfield to "engineData".
+- Moved a number of tile fields into "traversal" and "internal" subfields on "tile" object.
+- ImplicitTilingPlugin: Moved implicit tiling fields onto a new "implicitTilingData" object.
+- DebugTilesPlugin: Replaced "getTileInformationFromActiveObject" function with "getTileFromObject3D".
+- DebugTilesPlugin: Add transparent mesh to box helper visualization.
+- TilesRenderer: Moved "update-before", "update-after" events to TilesRendererBase.
+- Plugins: moved handling of "doTilesNeedUpdate" to TilesRendererBase.
+- TilesRenderer: "dispose-model" even is now fired before "dispose" is called on sub objects.
+
+### Fixed
+- Fix mouse offset in Controls.
+- Fixed case where DebugTilesPlugin could throw an error when toggling "enabled".
+- DebugTilesPlugin: Fixed case where "enabled" was not resepected if set to false on creation.
 
 ## [0.4.19] - 2025.12.19
 ### Changed

example/three/cesiumCompare.js

@@ -93,10 +93,16 @@ function render() {
 
 	cesiumViewer.update();
 
+	updateThreeStats();
+	updateCesiumStats();
+
+}
+
+function updateThreeStats() {
+
 	let shallowTilesLoaded, loadedGeometryTiles, allLoadedTiles;
 	let textureBytes, geometryBytes;
 
-	// update three stats
 	loadedGeometryTiles = 0;
 	textureBytes = 0;
 	geometryBytes = 0;
@@ -135,7 +141,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,14 +153,16 @@ 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 ++;
 
 		}
 
 	} );
 
+	const { loadStart, loadEnd } = threeViewer;
+	const loadDelta = loadEnd - loadStart;
 	clearStats( threeStats );
 	writeStats( threeStats, 'visible tiles', threeViewer.tiles.visibleTiles.size );
 	writeStats( threeStats, 'loaded tiles', allLoadedTiles );
@@ -164,8 +172,18 @@ function render() {
 	writeStats( threeStats, 'total memory', ( threeViewer.tiles.lruCache.cachedBytes * 1e-6 ).toFixed( 3 ) + ' MB' );
 	writeStats( threeStats, 'geometry memory', ( geometryBytes * 1e-6 ).toFixed( 3 ) + ' MB' );
 	writeStats( threeStats, 'texture memory', ( textureBytes * 1e-6 ).toFixed( 3 ) + ' MB' );
+	writeStats( threeStats, 'load start', loadStart.toFixed( 0 ) + ' ms' );
+	writeStats( threeStats, 'load end', ( loadDelta < 0 ? '--' : loadEnd.toFixed( 0 ) + ' ms' ) );
+	writeStats( threeStats, 'load delta', ( loadDelta < 0 ? '--' : loadDelta.toFixed( 0 ) + ' ms' ) );
+	writeStats( threeStats, 'total load time', threeViewer.totalLoadTime.toFixed( 0 ) + ' ms' );
+	writeStats( threeStats, 'perf', ( 100 * threeViewer.totalLoadTime / cesiumViewer.totalLoadTime ).toFixed( 2 ) + '%' );
 
-	// update cesium stats
+}
+
+function updateCesiumStats() {
+
+	let shallowTilesLoaded, allLoadedTiles;
+	let textureBytes, geometryBytes;
 
 	shallowTilesLoaded = 0;
 	traverse( cesiumViewer.root, t => {
@@ -204,6 +222,8 @@ function render() {
 
 	} );
 
+	const { loadStart, loadEnd } = cesiumViewer;
+	const loadDelta = loadEnd - loadStart;
 	clearStats( cesiumStats );
 	writeStats( cesiumStats, 'visible tiles', cesiumViewer.tiles.statistics.selected );
 	writeStats( cesiumStats, 'loaded tiles', allLoadedTiles );
@@ -213,6 +233,10 @@ function render() {
 	writeStats( cesiumStats, 'total memory', ( cesiumViewer.tiles.totalMemoryUsageInBytes * 1e-6 ).toFixed( 3 ) + ' MB' );
 	writeStats( cesiumStats, 'geometry memory', ( geometryBytes * 1e-6 ).toFixed( 3 ) + ' MB' );
 	writeStats( cesiumStats, 'texture memory', ( textureBytes * 1e-6 ).toFixed( 3 ) + ' MB' );
+	writeStats( cesiumStats, 'load start', loadStart.toFixed( 0 ) + ' ms' );
+	writeStats( cesiumStats, 'load end', ( loadDelta < 0 ? '--' : loadEnd.toFixed( 0 ) + ' ms' ) );
+	writeStats( cesiumStats, 'load delta', ( loadDelta < 0 ? '--' : loadDelta.toFixed( 0 ) + ' ms' ) );
+	writeStats( cesiumStats, 'total load time', cesiumViewer.totalLoadTime.toFixed( 0 ) + ' ms' );
 
 }
 
@@ -320,6 +344,25 @@ async function initThree() {
 
 	} );
 
+	let start = 0;
+	tiles.addEventListener( 'tiles-load-start', e => {
+
+		start = performance.now();
+		if ( performance.now() - threeViewer.loadEnd > 100 ) {
+
+			threeViewer.loadStart = start;
+
+		}
+
+	} );
+
+	tiles.addEventListener( 'tiles-load-end', e => {
+
+		threeViewer.loadEnd = performance.now();
+		threeViewer.totalLoadTime += performance.now() - start;
+
+	} );
+
 	scene.add( tiles.group );
 
 	// lights
@@ -359,6 +402,9 @@ async function initThree() {
 	window.addEventListener( 'resize', onWindowResize, false );
 
 	threeViewer = {
+		totalLoadTime: 0,
+		loadStart: 0,
+		loadEnd: 0,
 		tiles,
 		camera,
 		renderer,
@@ -447,7 +493,35 @@ async function initCesium() {
 	// 	height,
 	// } );
 
+	let loading = false;
+	let start = 0;
+	tileset.loadProgress.addEventListener( ( pending, processing ) => {
+
+		const total = pending + processing;
+		if ( total !== 0 && ! loading ) {
+
+			loading = true;
+			start = performance.now();
+			if ( start - threeViewer.loadEnd > 100 ) {
+
+				cesiumViewer.loadStart = start;
+
+			}
+
+		} else if ( total === 0 && loading ) {
+
+			loading = false;
+			cesiumViewer.loadEnd = performance.now();
+			cesiumViewer.totalLoadTime += performance.now() - start;
+
+		}
+
+	} );
+
 	cesiumViewer = {
+		totalLoadTime: 0,
+		loadStart: 0,
+		loadEnd: 0,
 		tiles: tileset,
 		viewer,
 		camera,

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();
 
 	}
 

package-lock.json

@@ -67,7 +67,7 @@ export class GoogleCloudAuthPlugin {
 
 		this._visibilityChangeCallback = ( { tile, visible } ) => {
 
-			const copyright = tile.cached.metadata?.asset?.copyright || '';
+			const copyright = tile.engineData.metadata?.asset?.copyright || '';
 			if ( visible ) {
 
 				this._attributionsManager.addAttributions( copyright );

src/core/plugins/GoogleCloudAuthPlugin.js

@@ -18,24 +18,28 @@ 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
-			tile.__implicitRoot = tile;	// Keep this tile as an Implicit Root Tile
+			tile.implicitTilingData = {
+				// Keep this tile as an Implicit Root Tile
+				root: tile,
 
-			// Coords of the tile
-			tile.__x = 0;
-			tile.__y = 0;
-			tile.__z = 0;
-			tile.__level = 0;
+				// Idx of the tile in its subtree
+				subtreeIdx: 0,
+
+				// Coords of the tile
+				x: 0,
+				y: 0,
+				z: 0,
+				level: 0,
+			};
 
 		} 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 +50,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 );
 
@@ -59,12 +63,12 @@ export class ImplicitTilingPlugin {
 		if ( tile && tile.implicitTiling ) {
 
 			const implicitUri = tile.implicitTiling.subtrees.uri
-				.replace( '{level}', tile.__level )
-				.replace( '{x}', tile.__x )
-				.replace( '{y}', tile.__y )
-				.replace( '{z}', tile.__z );
+				.replace( '{level}', tile.implicitTilingData.level )
+				.replace( '{x}', tile.implicitTilingData.x )
+				.replace( '{y}', tile.implicitTilingData.y )
+				.replace( '{z}', tile.implicitTilingData.z );
 
-			return new URL( implicitUri, tile.__basePath + '/' ).toString();
+			return new URL( implicitUri, tile.internal.basePath + '/' ).toString();
 
 		}
 
@@ -84,7 +88,7 @@ export class ImplicitTilingPlugin {
 
 			} );
 			tile.children.length = 0;
-			tile.__childrenProcessed = 0;
+			tile.internal.childrenProcessed = 0;
 
 		}