Fix instances of "tileset" nomenclature in code (#1378)

gkjohnson · web-flow · commit d8bb4672e6e4 · 2025-11-25T13:45:25.000+09:00
* Update cases of "tile set" with "tileset"

* Update comments with tile set -&gt; tileset

* Update docs

* Change local variables to use "tileset" nomenclature

* Update local variables

* Update more comments

* rootTileSet -&gt; rootTileset

* Adjust event payload

* "load-tile-set" -&gt; "load-tileset"

* DebugTilesPlugin: fix callback

* fix test

* Cleanup
diff --git a/README.md b/README.md
@@ -83,7 +83,7 @@ import { TilesRenderer } from '3d-tiles-renderer';
 const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );
 tilesRenderer.setCamera( camera );
 tilesRenderer.setResolutionFromRenderer( camera, renderer );
-tilesRenderer.addEventListener( 'load-tile-set', () => {
+tilesRenderer.addEventListener( 'load-tileset', () => {
 
 	// optionally center the tileset in case it's far off center
 	const sphere = new Sphere();
@@ -251,7 +251,7 @@ The tileset and model load callbacks can be used to detect when the data has cha
 ```js
 let needsRerender = true;
 const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );
-tilesRenderer.addEventListener( 'load-tile-set', () => needsRerender = true );
+tilesRenderer.addEventListener( 'load-tileset', () => needsRerender = true );
 tilesRenderer.addEventListener( 'load-model', () => needsRerender = true );
 
 function renderLoop() {
@@ -318,7 +318,7 @@ _extends `THREE.EventDispatcher` & [TilesRendererBase](https://github.com/NASA-A
 
 ```js
 // Fired when a new root or child tileset is loaded.
-{ type: 'load-tile-set', tileSet: Object, url: String }
+{ type: 'load-tileset', tileset: Object, url: String }
 
 // Fired when a tile model is loaded.
 { type: 'load-model', scene: THREE.Group, tile: Object }
diff --git a/example/cesiumCompare.js b/example/cesiumCompare.js
@@ -264,7 +264,7 @@ async function initThree() {
 	tiles.setCamera( camera );
 
 	let controls;
-	tiles.addEventListener( 'load-tile-set', () => {
+	tiles.addEventListener( 'load-tileset', () => {
 
 		// position the camera based on the model
 		const sphere = new Sphere();
@@ -420,7 +420,7 @@ async function initCesium() {
 	viewer.scene.backgroundColor = Cesium.Color.BLACK.clone();
 	viewer.creditDisplay.container.style.display = 'none';
 
-	// initialize the tile set
+	// initialize the tileset
 	const tileset = await Cesium.Cesium3DTileset.fromUrl( url, {
 		// loadSiblings: true,
 		maximumCacheOverflowBytes: 1e20,
diff --git a/example/ionExample.js b/example/ionExample.js
@@ -69,7 +69,7 @@ function reinstantiateTiles() {
 
 	tiles = new TilesRenderer();
 	tiles.registerPlugin( new CesiumIonAuthPlugin( { apiToken: params.ionAccessToken, assetId: params.ionAssetId } ) );
-	tiles.addEventListener( 'load-tile-set', () => {
+	tiles.addEventListener( 'load-tileset', () => {
 
 		// because ion examples typically are positioned on the planet surface we can orient
 		// it such that up is Y+ and center the model
diff --git a/example/landformSiteOverlay.js b/example/landformSiteOverlay.js
@@ -84,7 +84,7 @@ function init() {
 	tilesParent.rotation.set( Math.PI / 2, 0, 0 );
 	scene.add( tilesParent );
 
-	// load all tile sets
+	// load all tilesets
 	let downloadQueue = null;
 	let parseQueue = null;
 	let lruCache = null;
diff --git a/example/metadata.js b/example/metadata.js
@@ -111,7 +111,7 @@ function init() {
 
 	scene.add( new AmbientLight( 0xffffff, 1.0 ) );
 
-	// create rotation object to orient the tile set
+	// create rotation object to orient the tileset
 	rotationContainer = new Group();
 	rotationContainer.position.y = 40;
 	scene.add( rotationContainer );
@@ -173,7 +173,7 @@ function reinstantiateTiles() {
 	// save the ion access token
 	localStorage.setItem( 'ionApiKey', params.accessToken );
 
-	// create tile set
+	// create tileset
 	tiles = new TilesRenderer();
 	tiles.registerPlugin( new CesiumIonAuthPlugin( { apiToken: params.accessToken, assetId: params.assetId } ) );
 	tiles.registerPlugin( new GLTFExtensionsPlugin( { metadata: true } ) );
diff --git a/example/r3f/basic.jsx b/example/r3f/basic.jsx
@@ -47,7 +47,7 @@ function App() {
 				<TilesRenderer url={ tilesetUrl }>
 					<TilesPlugin plugin={ TilesFadePlugin } fadeDuration={ 500 } />
 
-					{/* add mesh to local frame of the tile set*/}
+					{/* add mesh to local frame of the tileset*/}
 					<RotatingMesh position={ [ 0, - 4, - 4 ] } scale={ 2 } />
 
 				</TilesRenderer>
diff --git a/example/r3f/ion.jsx b/example/r3f/ion.jsx
@@ -51,7 +51,7 @@ function App() {
 			} }
 		>
 			{/*
-				3D Tiles renderer tile set
+				3D Tiles renderer tileset
 				Use a "key" property to ensure the tiles renderer gets recreated when the api token or asset change
 			*/}
 			<TilesRenderer key={ assetId }>
diff --git a/example/r3f/plugins/TileFlatteningPlugin.jsx b/example/r3f/plugins/TileFlatteningPlugin.jsx
@@ -62,7 +62,7 @@ export function TileFlatteningShape( props ) {
 		direction = null,
 
 		// if true then a projection direction is derived from the shape position
-		// relative to the tile set ellipsoid if "direction" is not present
+		// relative to the tileset ellipsoid if "direction" is not present
 		relativeToEllipsoid = false,
 	} = props;
 
@@ -122,7 +122,7 @@ export function TileFlatteningShape( props ) {
 
 	}, [ tiles, group, direction, relativeToEllipsoid, plugin, threshold, thresholdMode, flattenRange, relativeGroup ] );
 
-	// Add the provided shape to the tile set
+	// Add the provided shape to the tileset
 	useEffect( () => {
 
 		if ( tiles === null || group === null || plugin === null ) {
diff --git a/example/vr.js b/example/vr.js
@@ -81,7 +81,7 @@ function init() {
 	const ambLight = new AmbientLight( 0xffffff, 0.2 );
 	scene.add( ambLight );
 
-	// tile set
+	// tileset
 	box = new Box3();
 	sphere = new Sphere();
 
diff --git a/src/core/plugins/ImplicitTilingPlugin.js b/src/core/plugins/ImplicitTilingPlugin.js
@@ -14,7 +14,7 @@ export class ImplicitTilingPlugin {
 
 	}
 
-	preprocessNode( tile, tileSetDir, parentTile ) {
+	preprocessNode( tile, tilesetDir, parentTile ) {
 
 		if ( tile.implicitTiling ) {
 
diff --git a/src/core/renderer/tiles/TilesRendererBase.d.ts b/src/core/renderer/tiles/TilesRendererBase.d.ts
@@ -3,6 +3,8 @@ import { PriorityQueue } from '../utilities/PriorityQueue.js';
 
 export class TilesRendererBase {
 
+	readonly rootTileset : object | null;
+	/** @deprecated Use rootTileset instead */
 	readonly rootTileSet : object | null;
 	readonly root : object | null;
 
diff --git a/src/core/renderer/tiles/TilesRendererBase.js b/src/core/renderer/tiles/TilesRendererBase.js
@@ -75,7 +75,7 @@ const lruPriorityCallback = ( a, b ) => {
 
 	} else if ( a.__hasUnrenderableContent !== b.__hasUnrenderableContent ) {
 
-		// dispose of external tile sets last
+		// dispose of external tilesets last
 		return a.__hasUnrenderableContent ? - 1 : 1;
 
 	} else if ( a.__error !== b.__error ) {
@@ -93,8 +93,15 @@ export class TilesRendererBase {
 
 	get root() {
 
-		const tileSet = this.rootTileSet;
-		return tileSet ? tileSet.root : null;
+		const tileset = this.rootTileset;
+		return tileset ? tileset.root : null;
+
+	}
+
+	get rootTileSet() {
+
+		console.warn( 'TilesRenderer: "rootTileSet" has been deprecated. Use "rootTileset" instead.' );
+		return this.rootTileset;
 
 	}
 
@@ -124,7 +131,7 @@ export class TilesRendererBase {
 
 		// state
 		this.rootLoadingState = UNLOADED;
-		this.rootTileSet = null;
+		this.rootTileset = null;
 		this.rootURL = url;
 		this.fetchOptions = {};
 		this.plugins = [];
@@ -329,12 +336,12 @@ export class TilesRendererBase {
 
 					}
 					this.rootLoadingState = LOADED;
-					this.rootTileSet = root;
+					this.rootTileset = root;
 					this.dispatchEvent( { type: 'needs-update' } );
 					this.dispatchEvent( { type: 'load-content' } );
 					this.dispatchEvent( {
-						type: 'load-tile-set',
-						tileSet: root,
+						type: 'load-tileset',
+						tileset: root,
 						url: processedUrl,
 					} );
 
@@ -344,7 +351,7 @@ export class TilesRendererBase {
 					this.rootLoadingState = FAILED;
 					console.error( error );
 
-					this.rootTileSet = null;
+					this.rootTileset = null;
 					this.dispatchEvent( {
 						type: 'load-error',
 						tile: null,
@@ -514,7 +521,7 @@ export class TilesRendererBase {
 
 	}
 
-	preprocessNode( tile, tileSetDir, parentTile = null ) {
+	preprocessNode( tile, tilesetDir, parentTile = null ) {
 
 		this.processedTiles.add( tile );
 
@@ -550,7 +557,7 @@ export class TilesRendererBase {
 
 		if ( tile.content?.uri ) {
 
-			// "content" should only indicate loadable meshes, not external tile sets
+			// "content" should only indicate loadable meshes, not external tilesets
 			const extension = getUrlExtension( tile.content.uri );
 
 			tile.__hasContent = true;
@@ -608,13 +615,13 @@ export class TilesRendererBase {
 
 		}
 
-		tile.__basePath = tileSetDir;
+		tile.__basePath = tilesetDir;
 
 		tile.__lastFrameVisited = - 1;
 
 		this.invokeAllPlugins( plugin => {
 
-			plugin !== this && plugin.preprocessNode && plugin.preprocessNode( tile, tileSetDir, parentTile );
+			plugin !== this && plugin.preprocessNode && plugin.preprocessNode( tile, tilesetDir, parentTile );
 
 		} );
 
@@ -815,7 +822,7 @@ export class TilesRendererBase {
 
 		}
 
-		let isExternalTileSet = false;
+		let isExternalTileset = false;
 		let externalTileset = null;
 		let uri = new URL( tile.content.uri, tile.__basePath + '/' ).toString();
 		this.invokeAllPlugins( plugin => uri = plugin.preprocessURL ? plugin.preprocessURL( uri, tile ) : uri );
@@ -835,7 +842,7 @@ export class TilesRendererBase {
 			controller.abort();
 
 			// Clear out all tile content
-			if ( isExternalTileSet ) {
+			if ( isExternalTileset ) {
 
 				t.children.length = 0;
 				t.__childrenProcessed = 0;
@@ -962,7 +969,7 @@ export class TilesRendererBase {
 						this.preprocessTileSet( content, uri, tile );
 						tile.children.push( content.root );
 						externalTileset = content;
-						isExternalTileSet = true;
+						isExternalTileset = true;
 						return Promise.resolve();
 
 					} else {
@@ -1006,11 +1013,11 @@ export class TilesRendererBase {
 				// call to "update" is needed.
 				this.dispatchEvent( { type: 'needs-update' } );
 				this.dispatchEvent( { type: 'load-content' } );
-				if ( isExternalTileSet ) {
+				if ( isExternalTileset ) {
 
 					this.dispatchEvent( {
-						type: 'load-tile-set',
-						tileSet: externalTileset,
+						type: 'load-tileset',
+						tileset: externalTileset,
 						url: uri,
 					} );
 
diff --git a/src/r3f/README.md b/src/r3f/README.md
@@ -107,7 +107,7 @@ Wrapper for the three.js `TilesRenderer` class. Listening for events are specifi
   lruCache-maxBytesSize={ 0.5 * 1e6 }
 
   // event registration
-  onLoadTileSet={ onLoadTileSetCallback }
+  onLoadTileset={ onLoadTilesetCallback }
   onLoadModel={ onLoadModelCallback }
 />
 ```
diff --git a/src/r3f/components/TilesAttributionOverlay.jsx b/src/r3f/components/TilesAttributionOverlay.jsx
@@ -41,12 +41,12 @@ export function TilesAttributionOverlay( { children, style, generateAttributions
 		};
 
 		tiles.addEventListener( 'tile-visibility-change', callback );
-		tiles.addEventListener( 'load-tile-set', callback );
+		tiles.addEventListener( 'load-tileset', callback );
 
 		return () => {
 
 			tiles.removeEventListener( 'tile-visibility-change', callback );
-			tiles.removeEventListener( 'load-tile-set', callback );
+			tiles.removeEventListener( 'load-tileset', callback );
 
 		};
 
diff --git a/src/r3f/components/TilesRenderer.jsx b/src/r3f/components/TilesRenderer.jsx
@@ -126,10 +126,10 @@ export function EastNorthUpFrame( props ) {
 
 		}
 
-		tiles.addEventListener( 'load-tile-set', updateCallback );
+		tiles.addEventListener( 'load-tileset', updateCallback );
 		return () => {
 
-			tiles.removeEventListener( 'load-tile-set', updateCallback );
+			tiles.removeEventListener( 'load-tileset', updateCallback );
 
 		};
 
diff --git a/src/three/plugins/DebugTilesPlugin.js b/src/three/plugins/DebugTilesPlugin.js
@@ -239,7 +239,7 @@ export class DebugTilesPlugin {
 		this.regionGroup.updateMatrixWorld();
 
 		// register events
-		this._onLoadTileSetCB = () => {
+		this._onLoadTilesetCB = () => {
 
 			this._initExtremes();
 
@@ -269,7 +269,7 @@ export class DebugTilesPlugin {
 
 		};
 
-		tiles.addEventListener( 'load-tile-set', this._onLoadTileSetCB );
+		tiles.addEventListener( 'load-tileset', this._onLoadTilesetCB );
 		tiles.addEventListener( 'load-model', this._onLoadModelCB );
 		tiles.addEventListener( 'dispose-model', this._onDisposeModelCB );
 		tiles.addEventListener( 'update-after', this._onUpdateAfterCB );
@@ -922,7 +922,7 @@ export class DebugTilesPlugin {
 
 		const tiles = this.tiles;
 
-		tiles.removeEventListener( 'load-tile-set', this._onLoadTileSetCB );
+		tiles.removeEventListener( 'load-tileset', this._onLoadTilesetCB );
 		tiles.removeEventListener( 'load-model', this._onLoadModelCB );
 		tiles.removeEventListener( 'dispose-model', this._onDisposeModelCB );
 		tiles.removeEventListener( 'update-after', this._onUpdateAfterCB );
diff --git a/src/three/plugins/ReorientationPlugin.js b/src/three/plugins/ReorientationPlugin.js
@@ -104,11 +104,11 @@ export class ReorientationPlugin {
 
 			}
 
-			tiles.removeEventListener( 'load-tile-set', this._callback );
+			tiles.removeEventListener( 'load-tileset', this._callback );
 
 		};
 
-		tiles.addEventListener( 'load-tile-set', this._callback );
+		tiles.addEventListener( 'load-tileset', this._callback );
 
 		if ( tiles.root ) {
 
@@ -138,7 +138,7 @@ export class ReorientationPlugin {
 		group.quaternion.identity();
 		group.scale.set( 1, 1, 1 );
 
-		this.tiles.removeEventListener( 'load-tile-set', this._callback );
+		this.tiles.removeEventListener( 'load-tileset', this._callback );
 
 	}
 
diff --git a/src/three/renderer/tiles/TilesRenderer.d.ts b/src/three/renderer/tiles/TilesRenderer.d.ts
@@ -7,7 +7,9 @@ export interface TilesRendererEventMap {
 	'add-camera': { camera: Camera };
 	'delete-camera': { camera: Camera };
 	'camera-resolution-change': {};
-	'load-tile-set': { tileSet: object, url: string };
+	'load-tileset': { tileset: object, /* @deprecated Use tileset instead */ tileSet?: object, url: string };
+	/* @deprecated Use 'load-tileset' instead */
+	'load-tile-set': { tileset: object, /* @deprecated Use tileset instead */ tileSet?: object, url: string };
 	'tiles-load-start': {};
 	'tiles-load-end': {};
 	'tile-download-start': { tile: Tile };
diff --git a/src/three/renderer/tiles/TilesRenderer.js b/src/three/renderer/tiles/TilesRenderer.js
diff --git a/test/types/TilesRenderer.test.ts b/test/types/TilesRenderer.test.ts

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ function App() {`
`51`	`51`	`} }`
`52`	`52`	`>`
`53`	`53`	`{/*`
`54`		`- 3D Tiles renderer tile set`
	`54`	`+ 3D Tiles renderer tileset`
`55`	`55`	`Use a "key" property to ensure the tiles renderer gets recreated when the api token or asset change`
`56`	`56`	`*/}`
`57`	`57`	`<TilesRenderer key={ assetId }>`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ export class ImplicitTilingPlugin {`
`14`	`14`
`15`	`15`	`}`
`16`	`16`
`17`		`- preprocessNode( tile, tileSetDir, parentTile ) {`
	`17`	`+ preprocessNode( tile, tilesetDir, parentTile ) {`
`18`	`18`
`19`	`19`	`if ( tile.implicitTiling ) {`
`20`	`20`