Skip to content

Commit 19083d7

Browse files
authored
Docs, comments: Replace "tile set" with "tileset" (#1377)
* Update cases of "tile set" with "tileset" * Update comments with tile set -> tileset * Update docs
1 parent 78304a8 commit 19083d7

20 files changed

Lines changed: 95 additions & 95 deletions

CHANGELOG.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
162162
- Change `load-error` event field from `uri` to `url` as documented.
163163
- Fixed type definitions for some events.
164164
- B3DM, I3DM, PNTS Loaders: Fixed case where RTC_CENTER feature would not be parsed correctly.
165-
- Re-add "load-tile-set" event when child tile sets are loaded.
165+
- Re-add "load-tile-set" event when child tilesets are loaded.
166166
- Re-add url to "load-tile-set" event.
167167
- TMSTilesPlugin: Add support for limited bounds.
168168

@@ -196,7 +196,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
196196

197197
### Changed
198198
- Internal "force-rerender" function renamed to "needs-render".
199-
- TilesRenderer: Move check for cameras after update traversal to enable loading the root tile set file without a camera defined.
199+
- TilesRenderer: Move check for cameras after update traversal to enable loading the root tileset file without a camera defined.
200200

201201
## [0.4.8] - 2025.04.07
202202
### Fixed
@@ -207,7 +207,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
207207
- EnvironmentControls: Fixed shift key not working as expected.
208208
- Fixed error caused by loading a glTF file with no scenes.
209209
- GLTF Metadata Extensions: Fix case where an error would be thrown when non-mesh nodes are present.
210-
- Fixed case where tile sets with implicit tiling would not be loaded correctly if an external availability buffer was used.
210+
- Fixed case where tilesets with implicit tiling would not be loaded correctly if an external availability buffer was used.
211211
- Asynchronously process child tiles to avoid processing stalls.
212212
- CesiumIonPlugin: Forward "autoRefreshToken" value to GoogleCloudAuthPlugin.
213213

@@ -220,7 +220,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
220220

221221
## [0.4.7] - 2025.03.03
222222
### Added
223-
- GlobeControls: If no raycast intersection is fund then fallback to intersecting the tile set globe.
223+
- GlobeControls: If no raycast intersection is fund then fallback to intersecting the tileset globe.
224224
- EnvironmentControls, GlobeControls: Fix inertia calculations for orthographic cameras.
225225
- R3F EastNorthUpFrame: Add support for passing the ellipsoid in directly.
226226
- TilesRenderer.group: Added "matrixWorldInverse" field.
@@ -246,7 +246,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
246246
- Fix GLTF Metadata plugin not returning matrix values correctly.
247247
- TMS, XYZ Plugins: Fix case where texture would be distorted due to incorrect vertex placement when using mercator projection.
248248
- Case where TilesRenderer.root was not initialized before the "load-tile-set" event was fired.
249-
- R3F TilesRenderer: Update the tile set when a tile set is loaded.
249+
- R3F TilesRenderer: Update the tileset when a tileset is loaded.
250250
- ImageFormatPlugins: Fix plugin so it does not preclude updates incorrectly.
251251
- R3F TilesRenderer: Prevent reinstantiation of all child plugins, objects on options change.
252252
- R3F EastNorthUpFrame: Automatically update based on ellipsoid updates.
@@ -270,13 +270,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
270270

271271
## [0.4.4] - 2025.01.24
272272
### Added
273-
- `load-error` events when model, tile set, and API token requests fail to fetch or parse.
273+
- `load-error` events when model, tileset, and API token requests fail to fetch or parse.
274274
- CanvasDOMOverlay: Add support for "ref".
275275
- CameraTransitionManager: Add `easeFunction` setting.
276276
- CameraTransitionManager: Add option to pass delta time to the update function.
277277

278278
### Fixed
279-
- Improved the behavior of `loadProgress` so it "bounces" less during loading by queueing all tiles load immediately (other than cases with external tile sets).
279+
- Improved the behavior of `loadProgress` so it "bounces" less during loading by queueing all tiles load immediately (other than cases with external tilesets).
280280
- Moved the dispatch location of "load-model", "tiles-load-start", and "tiles-load-end" so the behavior is more consistent.
281281

282282
## [0.4.3] - 2025.01.19
@@ -335,7 +335,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
335335

336336
### Changed
337337
- TilesFadePlugin: TilesRenderer will now fire visibility hidden events once the tile is completely faded out.
338-
- TilesFadePlugin: Fading tiles are now present in the tile set root rather than a sub group.
338+
- TilesFadePlugin: Fading tiles are now present in the tileset root rather than a sub group.
339339
- TileCompressionPlugin: Change the defaults to not automatically compress normals, uvs to avoid artifacts.
340340
- GlobeControls: Orthographic "near" margin around the globe has been increased from 10% to 25% of the large ellipsoid radius value.
341341

@@ -390,7 +390,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
390390
## [0.3.40] - 2024.10.29
391391
### Added
392392
- I3DMLoader: Add support for EAST_NORTH_UP semantic.
393-
- R3F TilesRenderer: Added `group` property for passing react properties to the root tile set object.
393+
- R3F TilesRenderer: Added `group` property for passing react properties to the root tileset object.
394394
- R3F `<CompassGizmo>` component.
395395

396396
### Changed
@@ -424,7 +424,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
424424
- Improve EnvironmentControls momementum thresholds so movement stops sooner.
425425

426426
### Fixed
427-
- Case where tile set scale was incorrectly used when computed screenspace error.
427+
- Case where tileset scale was incorrectly used when computed screenspace error.
428428
- Case where `setTileVisibility` could get called asymmetrically.
429429
- Case where `TilesFadePlugin` would hold on to scene geometry after disposal.
430430

@@ -453,7 +453,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
453453
- EnvironmentControls: Added "enableDamping" option for inertial animation.
454454
- Ellipsoid: Added "getEastNorthUpAxes".
455455
- Ellipsoid: Added "getAzElRollFromRotationMatrix" and "getRotationMatrixFromAzElRoll"
456-
- TilesRendererBase: Tiles are now queued and sorted before triggering load to avoid only a single tile set branch loading and filling up the lru cache.
456+
- TilesRendererBase: Tiles are now queued and sorted before triggering load to avoid only a single tileset branch loading and filling up the lru cache.
457457

458458
### Changed
459459
- TilesOverlayPlugin: Changed constructor to take options object, instead.
@@ -497,14 +497,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
497497
- GLTFStructureMetadata extension exits gracefully if no extension is present.
498498

499499
### Changed
500-
- CesiumIonTilesRenderer: Will immediately load the tile set after resolving credentials.
500+
- CesiumIonTilesRenderer: Will immediately load the tileset after resolving credentials.
501501
- Examples FadeTilesRenderer has been changed to a plugin.
502502
- Deprecated `GoogleTilesRenderer` and `CesiumIonTilesRenderer` in favor of using the new authentication plugins.
503503
- Loaders: ".load" function has been renamed to ".loadAsync".
504504
- Deprecated `onLoadTileset`, `onLoadModel`, `onDisposeModel`, and `onTileVisibilityChange` in favor of their event equivalents.
505505
- LRUCache: "unloadPriorityCallback" has been changted to take two tile arguments to sort instead of one.
506506
- DebugTilesRenderer has been deprecated in favor of the "DebugTilesPlugin".
507-
- LRU Cache unload priority function now unloads deepest tiles first, then least recently used, then non-external tile sets.
507+
- LRU Cache unload priority function now unloads deepest tiles first, then least recently used, then non-external tilesets.
508508

509509
## [0.3.35] - 2024.06.25
510510
### Fixed
@@ -519,7 +519,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
519519

520520
## [0.3.33] - 2024.05.31
521521
### Fixed
522-
- Remove logged error when a tile set is aborted.
522+
- Remove logged error when a tileset is aborted.
523523
- Adjusted raycast early exit behavior based on three.js r165.
524524
- EnvironmentControls: fix case where the dragging does not work from below
525525
- Remote glTF textures failing to load.
@@ -817,7 +817,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
817817

818818
## [0.2.1] - 2020-12-15
819819
### Added
820-
- Support for external tile sets.
820+
- Support for external tilesets.
821821
- B3DM support for RTC_CENTER.
822822

823823
### Fixed

PLUGINS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ _extends [EnvironmentControls](#environmentcontrols)_
108108
nearMargin = 0.25 : number
109109
```
110110

111-
The margin around the globe to include when positioning the camera near plane as a percentage of the max radius of the tile set ellipsoid. Useful for ensuring visualizations and other models are visible around the globe.
111+
The margin around the globe to include when positioning the camera near plane as a percentage of the max radius of the tileset ellipsoid. Useful for ensuring visualizations and other models are visible around the globe.
112112

113113
Default is 25%.
114114

@@ -118,7 +118,7 @@ Default is 25%.
118118
farMargin = 0 : number
119119
```
120120

121-
The margin around the globe to include when positioning the camera far plane as a percentage of the max radius of the tile set ellipsoid. Useful for ensuring visualizations and other models are visible around the globe.
121+
The margin around the globe to include when positioning the camera far plane as a percentage of the max radius of the tileset ellipsoid. Useful for ensuring visualizations and other models are visible around the globe.
122122

123123
Default is 0%.
124124

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77

88
Three.js renderer implementation for the [3D Tiles format](https://github.com/AnalyticalGraphicsInc/3d-tiles/blob/master/specification/). The renderer supports most of the 3D Tiles spec features with a few exceptions. For a list of available data sets and generation tools see the [3d Tiles resources](https://github.com/CesiumGS/3d-tiles/blob/main/RESOURCES.md) list.
99

10-
If a tile set or geometry does not load or render properly please make an issue! Example data is needed for adding and testing features. See the [Feature Complete Milestone](https://github.com/NASA-AMMOS/3DTilesRendererJS/milestone/1) for information on which features are not yet implemented.
10+
If a tileset or geometry does not load or render properly please make an issue! Example data is needed for adding and testing features. See the [Feature Complete Milestone](https://github.com/NASA-AMMOS/3DTilesRendererJS/milestone/1) for information on which features are not yet implemented.
1111

1212
**Examples**
1313

14-
[Dingo Gap Mars dataset with multiple tile sets](https://nasa-ammos.github.io/3DTilesRendererJS/example/bundle/mars.html)
14+
[Dingo Gap Mars dataset with multiple tilesets](https://nasa-ammos.github.io/3DTilesRendererJS/example/bundle/mars.html)
1515

1616
[Kitchen sink example with all options here](https://nasa-ammos.github.io/3DTilesRendererJS/example/bundle/index.html)
1717

@@ -73,7 +73,7 @@ npm install 3d-tiles-renderer --save
7373

7474
## Basic TilesRenderer
7575

76-
Setting up a basic application with a 3D Tile Set.
76+
Setting up a basic application with a 3D Tileset.
7777

7878
```js
7979
import { TilesRenderer } from '3d-tiles-renderer';
@@ -85,7 +85,7 @@ tilesRenderer.setCamera( camera );
8585
tilesRenderer.setResolutionFromRenderer( camera, renderer );
8686
tilesRenderer.addEventListener( 'load-tile-set', () => {
8787

88-
// optionally center the tile set in case it's far off center
88+
// optionally center the tileset in case it's far off center
8989
const sphere = new Sphere();
9090
tilesRenderer.getBoundingSphere( sphere );
9191
tilesRenderer.group.position.copy( sphere.center ).multiplyScalar( - 1 );
@@ -111,7 +111,7 @@ function renderLoop() {
111111

112112
## Custom Material
113113

114-
Setting up a 3D Tile Set using a custom material.
114+
Setting up a 3D Tileset using a custom material.
115115

116116
```js
117117
const tilesRenderer = new TilesRenderer( './path/to/tileset.json' );
@@ -246,7 +246,7 @@ fetch( url, { mode: 'cors' } )
246246
247247
## Render On Change
248248
249-
The tile set and model load callbacks can be used to detect when the data has changed and a new render is necessary.
249+
The tileset and model load callbacks can be used to detect when the data has changed and a new render is necessary.
250250
251251
```js
252252
let needsRerender = true;
@@ -317,7 +317,7 @@ _extends `THREE.EventDispatcher` & [TilesRendererBase](https://github.com/NASA-A
317317
### events
318318
319319
```js
320-
// Fired when a new root or child tile set is loaded.
320+
// Fired when a new root or child tileset is loaded.
321321
{ type: 'load-tile-set', tileSet: Object, url: String }
322322

323323
// Fired when a tile model is loaded.
@@ -330,7 +330,7 @@ _extends `THREE.EventDispatcher` & [TilesRendererBase](https://github.com/NASA-A
330330
// Fired when a tile model is disposed.
331331
{ type: 'dispose-model', scene: THREE.Group, tile: Object }
332332

333-
// Fired when the tile set hierarchy is ready for "update to be called
333+
// Fired when the tileset hierarchy is ready for "update to be called
334334
// again due to new content having loaded or asynchronous processing finished.
335335
{ type: 'needs-update' }
336336

@@ -346,13 +346,13 @@ _extends `THREE.EventDispatcher` & [TilesRendererBase](https://github.com/NASA-A
346346
// Fired when tile content begins downloading.
347347
{ type: 'tile-download-start', tile: Object }
348348

349-
// Fired when a tile content or the root tile set fails to load.
349+
// Fired when a tile content or the root tileset fails to load.
350350
{ type: 'load-error', tile: Object | null, error: Error, url: string | URL }
351351

352-
// Fired when a camera is added to be accounted for when traversing the tile set.
352+
// Fired when a camera is added to be accounted for when traversing the tileset.
353353
{ type: 'add-camera', camera: Camera }
354354

355-
// Fired when a camera is removed from being accounted for when traversing the tile set.
355+
// Fired when a camera is removed from being accounted for when traversing the tileset.
356356
{ type: 'delete-camera', camera: Camera }
357357

358358
// Fired when the resolution being rendered to is changed for any tracked camera.
@@ -365,7 +365,7 @@ _extends `THREE.EventDispatcher` & [TilesRendererBase](https://github.com/NASA-A
365365
fetchOptions = {} : Object
366366
```
367367
368-
Options passed to `fetch` when loading tile set and model data.
368+
Options passed to `fetch` when loading tileset and model data.
369369
370370
### .errorTarget
371371
@@ -445,7 +445,7 @@ Queue for expanding and initializing tiles for traversal. Max jobs defaults to `
445445
group : Group
446446
```
447447
448-
The container group for the 3d tiles. Add this to the three.js scene in order to render it. The group includes an additional `matrixWorldInverse` field for transforming objects into the local tile set frame.
448+
The container group for the 3d tiles. Add this to the three.js scene in order to render it. The group includes an additional `matrixWorldInverse` field for transforming objects into the local tileset frame.
449449
450450
### .manager
451451
@@ -469,23 +469,23 @@ Returns the total load progress between `[0, 1]`. Progress is measured since the
469469
readonly ellipsoid : Ellipsoid
470470
```
471471
472-
A definition on the ellipsoid used for the tile set. Defaults to the WGS84 ellipsoid and is modified if the `3DTILES_ELLIPSOID` plugin is present. Specified in the local frame of [TilesRenderer.group](#group).
472+
A definition on the ellipsoid used for the tileset. Defaults to the WGS84 ellipsoid and is modified if the `3DTILES_ELLIPSOID` plugin is present. Specified in the local frame of [TilesRenderer.group](#group).
473473
474474
### .constructor
475475
476476
```js
477477
constructor( url = null : String | null )
478478
```
479479

480-
Takes the url of the `tileset.json` for the tile set to be rendered.
480+
Takes the url of the `tileset.json` for the tileset to be rendered.
481481

482482
### .update
483483

484484
```js
485485
update() : void
486486
```
487487

488-
Updates the tiles to render and kicks off loads for the appropriate tiles in the 3d tile set.
488+
Updates the tiles to render and kicks off loads for the appropriate tiles in the 3d tileset.
489489

490490
Both `group.matrixWorld` and all cameras world matrices are expected to be up to date before this is called.
491491

@@ -503,23 +503,23 @@ If any tiles failed to load due to server or network issues then they will not b
503503
getBoundingBox( box : Box3 ) : boolean
504504
```
505505

506-
Sets `box` to the axis aligned root bounding box of the tile set in the [group](#group) frame. Returns `false` if the tile root is not loaded and the bounding box cannot be set.
506+
Sets `box` to the axis aligned root bounding box of the tileset in the [group](#group) frame. Returns `false` if the tile root is not loaded and the bounding box cannot be set.
507507

508508
### .getOrientedBoundingBox
509509

510510
```js
511511
getOrientedBoundingBox( box : Box3, boxTransform : Matrix4 ) : boolean;
512512
```
513513

514-
Sets `box` and `boxTransform` to the bounds and matrix that describe the oriented bounding box that encapsulates the root of the tile set. Returns `false` if the tile root is not loaded and the bounding box cannot be set.
514+
Sets `box` and `boxTransform` to the bounds and matrix that describe the oriented bounding box that encapsulates the root of the tileset. Returns `false` if the tile root is not loaded and the bounding box cannot be set.
515515

516516
### .getBoundingSphere
517517

518518
```js
519519
getBoundingSphere( sphere : Sphere ) : boolean;
520520
```
521521

522-
Sets `sphere` to the bounding sphere that encapsulates the root of the tile set. Returns `false` if the tile root is not loaded and the bounding sphere cannot be set.
522+
Sets `sphere` to the bounding sphere that encapsulates the root of the tileset. Returns `false` if the tile root is not loaded and the bounding sphere cannot be set.
523523

524524
### .hasCamera
525525

@@ -535,15 +535,15 @@ Returns `true` if the camera has already been set on the renderer.
535535
setCamera( camera : Camera ) : boolean
536536
```
537537

538-
Adds the camera to the camera to be accounted for when traversing the tile set. Returns `false` if the camera is already being tracked. Returns `true` otherwise.
538+
Adds the camera to the camera to be accounted for when traversing the tileset. Returns `false` if the camera is already being tracked. Returns `true` otherwise.
539539

540540
### .deleteCamera
541541

542542
```js
543543
deleteCamera( camera : Camera ) : boolean
544544
```
545545

546-
Removes the given camera from being accounted for when traversing the tile set. Returns `false` if the camera was not tracked.
546+
Removes the given camera from being accounted for when traversing the tileset. Returns `false` if the camera was not tracked.
547547

548548
### .setResolution
549549

@@ -568,7 +568,7 @@ Sets the resolution being rendered to for the given camera via renderer which ac
568568
forEachLoadedModel( callback : ( scene : Object3D, tile : object ) => void ) : void
569569
```
570570

571-
Fires the callback for every loaded scene in the hierarchy with the associated tile as the second argument. This can be used to update the materials of all loaded meshes in the tile set.
571+
Fires the callback for every loaded scene in the hierarchy with the associated tile as the second argument. This can be used to update the materials of all loaded meshes in the tileset.
572572

573573
### .registerPlugin
574574

@@ -603,7 +603,7 @@ getAttributions( target = [] : Array ) : Array<{
603603
}>
604604
```
605605
606-
Returns a list of attributions for the data in the tile set. The list can change when tile visibility changes.
606+
Returns a list of attributions for the data in the tileset. The list can change when tile visibility changes.
607607
608608
The "type" can be a "string", "html", or "image" depending on the type of attribution. Google Photorealistic Tiles, for example, returns a list of sources as a string.
609609

TESTCASES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ Verify that the external tileset does not load but the rest of the tileset conti
311311

312312
Verify all steps happen as written.
313313

314-
## Verify disposing of the tileset removes all sub tile sets
314+
## Verify disposing of the tileset removes all sub tilesets
315315

316316
#### steps
317317

@@ -326,7 +326,7 @@ Verify all steps happen as written.
326326

327327
Verify that the total geometries in the render stats display is still "220".
328328

329-
## Verify tileset raycasting with additive tile sets
329+
## Verify tileset raycasting with additive tilesets
330330

331331
#### steps
332332

src/core/plugins/CesiumIonAuthPlugin.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export class CesiumIonAuthPlugin {
7474
loadRootTileSet() {
7575

7676
// ensure we have an up-to-date token and root url, then trigger the internal
77-
// root tile set load function
77+
// root tileset load function
7878
return this
7979
.auth
8080
.refreshToken()
@@ -142,7 +142,7 @@ export class CesiumIonAuthPlugin {
142142
const url = new URL( json.options.url );
143143
tiles.rootURL = json.options.url;
144144

145-
// if the tile set is "external" then assume it's a google API tile set
145+
// if the tileset is "external" then assume it's a google API tileset
146146
tiles.registerPlugin( new GoogleCloudAuthPlugin( {
147147
apiToken: url.searchParams.get( 'key' ),
148148
autoRefreshToken: this.autoRefreshToken,

0 commit comments

Comments
 (0)