@loaders.gl/tiles 3.4.0-alpha.4 → 3.4.0

package/dist/tileset/tileset-3d.js

@@ -4,40 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tileset3D = void 0;
 // This file is derived from the Cesium code base under Apache 2 license
 // See LICENSE.md and https://github.com/AnalyticalGraphicsInc/cesium/blob/master/LICENSE.md
-/*
-
-  The Tileset loading and rendering flow is as below,
-  A rendered (i.e. deck.gl `Tile3DLayer`) triggers `tileset.update()` after a `tileset` is loaded
-  `tileset` starts traversing the tile tree and update `requestTiles` (tiles of which content need
-  to be fetched) and `selectedTiles` (tiles ready for rendering under the current viewport).
-  `Tile3DLayer` will update rendering based on `selectedTiles`.
-  `Tile3DLayer` also listens to `onTileLoad` callback and trigger another round of `update and then traversal`
-  when new tiles are loaded.
-
-  As I3S tileset have stored `tileHeader` file (metadata) and tile content files (geometry, texture, ...) separately.
-  During each traversal, it issues `tilHeader` requests if that `tileHeader` is not yet fetched,
-  after the tile header is fulfilled, it will resume the traversal starting from the tile just fetched (not root).
-
-  Tile3DLayer
-       |
-   await load(tileset)
-       |
-   tileset.update()
-       |                async load tileHeader
-   tileset.traverse() -------------------------- Queued
-       |        resume traversal after fetched  |
-       |----------------------------------------|
-       |
-       |                     async load tile content
-  tilset.requestedTiles  ----------------------------- RequestScheduler
-                                                              |
-  tilset.selectedTiles (ready for rendering)                  |
-       |         Listen to                                    |
-    Tile3DLayer ----------- onTileLoad  ----------------------|
-       |                         |   notify new tile is available
-    updateLayers                 |
-                        tileset.update // trigger another round of update
-*/
 const core_1 = require("@math.gl/core");
 const geospatial_1 = require("@math.gl/geospatial");
 const stats_1 = require("@probe.gl/stats");
@@ -55,39 +21,18 @@ const i3s_tileset_traverser_1 = require("./format-i3s/i3s-tileset-traverser");
 const DEFAULT_PROPS = {
     description: '',
     ellipsoid: geospatial_1.Ellipsoid.WGS84,
-    // A 4x4 transformation matrix this transforms the entire tileset.
     modelMatrix: new core_1.Matrix4(),
-    // Set to false to disable network request throttling
     throttleRequests: true,
-    // Number of simultaneous requsts, if throttleRequests is true
     maxRequests: 64,
     maximumMemoryUsage: 32,
-    /** Maximum number limit of tiles selected for show. 0 means no limit */
     maximumTilesSelected: 0,
-    /** Delay time before the tileset traversal. It prevents traversal requests spam.*/
     debounceTime: 0,
-    /**
-     * Callback. Indicates this a tile's content was loaded
-     * @param tile {TileHeader}
-     */
     onTileLoad: () => { },
-    /**
-     * Callback. Indicates this a tile's content was unloaded
-     * @param tile {TileHeader}
-     */
     onTileUnload: () => { },
     onTileError: () => { },
-    /**
-     * Callback. Allows post-process selectedTiles right after traversal.
-     * @param selectedTiles {TileHeader[]}
-     * @returns TileHeader[] - output array of tiles to return to deck.gl
-     */
     onTraversalComplete: (selectedTiles) => selectedTiles,
-    // Optional async tile content loader
     contentLoader: undefined,
-    // View distance scale modifier
     viewDistanceScale: 1.0,
-    // The maximum screen space error used to drive level of detail refinement.
     maximumScreenSpaceError: 8,
     loadTiles: true,
     updateTransforms: true,
@@ -108,6 +53,39 @@ const TILES_UNLOADED = 'Tiles Unloaded';
 const TILES_LOAD_FAILED = 'Failed Tile Loads';
 const POINTS_COUNT = 'Points/Vertices';
 const TILES_GPU_MEMORY = 'Tile Memory Use';
+/**
+ * The Tileset loading and rendering flow is as below,
+ * A rendered (i.e. deck.gl `Tile3DLayer`) triggers `tileset.update()` after a `tileset` is loaded
+ * `tileset` starts traversing the tile tree and update `requestTiles` (tiles of which content need
+ * to be fetched) and `selectedTiles` (tiles ready for rendering under the current viewport).
+ * `Tile3DLayer` will update rendering based on `selectedTiles`.
+ * `Tile3DLayer` also listens to `onTileLoad` callback and trigger another round of `update and then traversal`
+ * when new tiles are loaded.
+
+ * As I3S tileset have stored `tileHeader` file (metadata) and tile content files (geometry, texture, ...) separately.
+ * During each traversal, it issues `tilHeader` requests if that `tileHeader` is not yet fetched,
+ * after the tile header is fulfilled, it will resume the traversal starting from the tile just fetched (not root).
+
+ * Tile3DLayer
+ *      |
+ *  await load(tileset)
+ *      |
+ *  tileset.update()
+ *      |                async load tileHeader
+ *  tileset.traverse() -------------------------- Queued
+ *      |        resume traversal after fetched  |
+ *      |----------------------------------------|
+ *      |
+ *      |                     async load tile content
+ * tilset.requestedTiles  ----------------------------- RequestScheduler
+ *                                                             |
+ * tilset.selectedTiles (ready for rendering)                  |
+ *      |         Listen to                                    |
+ *   Tile3DLayer ----------- onTileLoad  ----------------------|
+ *      |                         |   notify new tile is available
+ *   updateLayers                 |
+ *                       tileset.update // trigger another round of update
+*/
 class Tileset3D {
     /**
      * Create a new Tileset3D
@@ -115,75 +93,80 @@ class Tileset3D {
      * @param props
      */
     // eslint-disable-next-line max-statements
-    constructor(json, options) {
+    constructor(tileset, options) {
+        this.root = null;
+        this.roots = {};
+        /** @todo any->unknown */
+        this.asset = {};
+        // Metadata for the entire tileset
+        this.description = '';
+        this.extras = null;
+        this.attributions = {};
+        this.credits = {};
         /** flags that contain information about data types in nested tiles */
         this.contentFormats = { draco: false, meshopt: false, dds: false, ktx2: false };
+        // view props
+        this.cartographicCenter = null;
+        this.cartesianCenter = null;
+        this.zoom = 1;
+        this.boundingVolume = null;
+        /** Updated based on the camera position and direction */
+        this.dynamicScreenSpaceErrorComputedDensity = 0.0;
+        // METRICS
+        /**
+         * The maximum amount of GPU memory (in MB) that may be used to cache tiles
+         * Tiles not in view are unloaded to enforce private
+         */
+        this.maximumMemoryUsage = 32;
+        /** The total amount of GPU memory in bytes used by the tileset. */
+        this.gpuMemoryUsageInBytes = 0;
+        /** Update tracker. increase in each update cycle. */
+        this._frameNumber = 0;
+        this._queryParams = {};
+        this._extensionsUsed = [];
+        this._tiles = {};
+        /** counter for tracking tiles requests */
+        this._pendingCount = 0;
+        /** Hold traversal results */
+        this.selectedTiles = [];
+        // TRAVERSAL
+        this.traverseCounter = 0;
+        this.geometricError = 0;
+        this.lastUpdatedVieports = null;
+        this._requestedTiles = [];
+        this._emptyTiles = [];
+        this.frameStateData = {};
+        this._cache = new tileset_cache_1.TilesetCache();
+        // Promise tracking
         this.updatePromise = null;
-        (0, loader_utils_1.assert)(json);
         // PUBLIC MEMBERS
         this.options = { ...DEFAULT_PROPS, ...options };
         // raw data
-        this.tileset = json;
-        this.loader = json.loader;
+        this.tileset = tileset;
+        this.loader = tileset.loader;
         // could be  3d tiles, i3s
-        this.type = json.type;
+        this.type = tileset.type;
         // The url to a tileset JSON file.
-        this.url = json.url;
-        this.basePath = json.basePath || loader_utils_1.path.dirname(this.url);
+        this.url = tileset.url;
+        this.basePath = tileset.basePath || loader_utils_1.path.dirname(this.url);
         this.modelMatrix = this.options.modelMatrix;
         this.ellipsoid = this.options.ellipsoid;
         // Geometric error when the tree is not rendered at all
-        this.lodMetricType = json.lodMetricType;
-        this.lodMetricValue = json.lodMetricValue;
-        this.refine = json.root.refine;
+        this.lodMetricType = tileset.lodMetricType;
+        this.lodMetricValue = tileset.lodMetricValue;
+        this.refine = tileset.root.refine;
         this.loadOptions = this.options.loadOptions || {};
-        this.root = null;
-        this.roots = {};
-        // view props
-        this.cartographicCenter = null;
-        this.cartesianCenter = null;
-        this.zoom = 1;
-        this.boundingVolume = null;
         // TRAVERSAL
-        this.traverseCounter = 0;
-        this.geometricError = 0;
         this._traverser = this._initializeTraverser();
-        this._cache = new tileset_cache_1.TilesetCache();
         this._requestScheduler = new loader_utils_1.RequestScheduler({
             throttleRequests: this.options.throttleRequests,
             maxRequests: this.options.maxRequests
         });
-        // update tracker
-        // increase in each update cycle
-        this._frameNumber = 0;
-        // counter for tracking tiles requests
-        this._pendingCount = 0;
-        // HOLD TRAVERSAL RESULTS
-        this._tiles = {};
-        this.selectedTiles = [];
-        this._emptyTiles = [];
-        this._requestedTiles = [];
-        this.frameStateData = {};
-        this.lastUpdatedVieports = null;
-        this._queryParams = {};
-        this._queryParamsString = '';
         // METRICS
-        // The maximum amount of GPU memory (in MB) that may be used to cache tiles.
-        // Tiles not in view are unloaded to enforce this.
-        this.maximumMemoryUsage = this.options.maximumMemoryUsage || 32;
         // The total amount of GPU memory in bytes used by the tileset.
-        this.gpuMemoryUsageInBytes = 0;
         this.stats = new stats_1.Stats({ id: this.url });
         this._initializeStats();
-        // EXTRACTED FROM TILESET
-        this._extensionsUsed = undefined;
-        this.dynamicScreenSpaceErrorComputedDensity = 0.0; // Updated based on the camera position and direction
-        // Metadata for the entire tileset
-        this.extras = null;
-        this.asset = {};
-        this.credits = {};
-        this.description = this.options.description || '';
-        this.tilesetInitializationPromise = this._initializeTileSet(json);
+        this.tilesetInitializationPromise = this._initializeTileSet(tileset);
     }
     /** Release resources */
     destroy() {
@@ -201,10 +184,8 @@ class Tileset3D {
         return this._frameNumber;
     }
     get queryParams() {
-        if (!this._queryParamsString) {
-            this._queryParamsString = getQueryParamString(this._queryParams);
-        }
-        return this._queryParamsString;
+        const search = new URLSearchParams(this._queryParams).toString();
+        return search ? `?${search}` : '';
     }
     setProps(props) {
         this.options = { ...this.options, ...props };
@@ -222,11 +203,11 @@ class Tileset3D {
         if (isDataUrl) {
             return tilePath;
         }
-        return `${tilePath}${this.queryParams}`;
+        return `${tilePath}${tilePath.includes('?') ? '&' : '?'}${this.queryParams}`;
     }
     // TODO CESIUM specific
     hasExtension(extensionName) {
-        return Boolean(this._extensionsUsed && this._extensionsUsed.indexOf(extensionName) > -1);
+        return Boolean(this._extensionsUsed.indexOf(extensionName) > -1);
     }
     /**
      * Update visible tiles relying on a list of viewports
@@ -468,7 +449,6 @@ class Tileset3D {
      */
     calculateViewPropsTiles3D() {
         const root = this.root;
-        (0, loader_utils_1.assert)(root);
         const { center } = root.boundingVolume;
         // TODO - handle all cases
         if (!center) {
@@ -522,6 +502,15 @@ class Tileset3D {
                 const children = tile.header.children || [];
                 for (const childHeader of children) {
                     const childTile = new tile_3d_1.Tile3D(this, childHeader, tile);
+                    // Special handling for Google
+                    // A session key must be used for all tile requests
+                    if (childTile.contentUrl?.includes('?session=')) {
+                        const url = new URL(childTile.contentUrl);
+                        const session = url.searchParams.get('session');
+                        if (session) {
+                            this._queryParams.session = session;
+                        }
+                    }
                     tile.children.push(childTile);
                     childTile.depth = tile.depth + 1;
                     stack.push(childTile);
@@ -558,7 +547,7 @@ class Tileset3D {
             loaded = await tile.loadContent();
         }
         catch (error) {
-            this._onTileLoadError(tile, error);
+            this._onTileLoadError(tile, error instanceof Error ? error : new Error('load failed'));
         }
         finally {
             this._onEndTileLoading();
@@ -638,11 +627,11 @@ class Tileset3D {
         this.stats.get(TILES_LOADED).incrementCount();
         this.stats.get(TILES_IN_MEMORY).incrementCount();
         // Good enough? Just use the raw binary ArrayBuffer's byte length.
-        this.gpuMemoryUsageInBytes += tile.content.byteLength || 0;
+        this.gpuMemoryUsageInBytes += tile.gpuMemoryUsageInBytes || 0;
         this.stats.get(TILES_GPU_MEMORY).count = this.gpuMemoryUsageInBytes;
     }
     _unloadTile(tile) {
-        this.gpuMemoryUsageInBytes -= (tile.content && tile.content.byteLength) || 0;
+        this.gpuMemoryUsageInBytes -= tile.gpuMemoryUsageInBytes || 0;
         this.stats.get(TILES_IN_MEMORY).decrementCount();
         this.stats.get(TILES_UNLOADED).incrementCount();
         this.stats.get(TILES_GPU_MEMORY).count = this.gpuMemoryUsageInBytes;
@@ -686,6 +675,11 @@ class Tileset3D {
         tile.destroy();
     }
     _initializeTiles3DTileset(tilesetJson) {
+        if (tilesetJson.queryString) {
+            const searchParams = new URLSearchParams(tilesetJson.queryString);
+            const queryParams = Object.fromEntries(searchParams.entries());
+            this._queryParams = { ...this._queryParams, ...queryParams };
+        }
         this.asset = tilesetJson.asset;
         if (!this.asset) {
             throw new Error('Tileset must have an asset property.');
@@ -706,28 +700,15 @@ class Tileset3D {
         // Gets the tileset's properties dictionary object, which contains metadata about per-feature properties.
         this.properties = tilesetJson.properties;
         this.geometricError = tilesetJson.geometricError;
-        this._extensionsUsed = tilesetJson.extensionsUsed;
+        this._extensionsUsed = tilesetJson.extensionsUsed || [];
         // Returns the extras property at the top of the tileset JSON (application specific metadata).
         this.extras = tilesetJson.extras;
     }
     _initializeI3STileset() {
+        // @ts-expect-error
         if (this.loadOptions.i3s && 'token' in this.loadOptions.i3s) {
             this._queryParams.token = this.loadOptions.i3s.token;
         }
     }
 }
 exports.Tileset3D = Tileset3D;
-function getQueryParamString(queryParams) {
-    const queryParamStrings = [];
-    for (const key of Object.keys(queryParams)) {
-        queryParamStrings.push(`${key}=${queryParams[key]}`);
-    }
-    switch (queryParamStrings.length) {
-        case 0:
-            return '';
-        case 1:
-            return `?${queryParamStrings[0]}`;
-        default:
-            return `?${queryParamStrings.join('&')}`;
-    }
-}

package/dist/tileset/tileset-cache.d.ts

@@ -1,6 +1,7 @@
+import type { Tileset3D } from './tileset-3d';
+import type { Tile3D } from './tile-3d';
 /**
  * Stores tiles with content loaded.
- *
  * @private
  */
 export declare class TilesetCache {
@@ -9,9 +10,9 @@ export declare class TilesetCache {
     private _trimTiles;
     constructor();
     reset(): void;
-    touch(tile: any): void;
-    add(tileset: any, tile: any, addCallback: any): void;
-    unloadTile(tileset: any, tile: any, unloadCallback?: any): void;
+    touch(tile: Tile3D): void;
+    add(tileset: Tileset3D, tile: Tile3D, addCallback?: (tileset: Tileset3D, tile: Tile3D) => void): void;
+    unloadTile(tileset: Tileset3D, tile: Tile3D, unloadCallback?: (tileset: Tileset3D, tile: Tile3D) => void): void;
     unloadTiles(tileset: any, unloadCallback: any): void;
     trim(): void;
 }

package/dist/tileset/tileset-cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tileset-cache.d.ts","sourceRoot":"","sources":["../../src/tileset/tileset-cache.ts"],"names":[],"mappings":"AAWA;;;;GAIG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,SAAS,CAAM;IACvB,OAAO,CAAC,UAAU,CAAU;;IAU5B,KAAK;IAOL,KAAK,CAAC,IAAI,KAAA;IAOV,GAAG,CAAC,OAAO,KAAA,EAAE,IAAI,KAAA,EAAE,WAAW,KAAA;IAU9B,UAAU,CAAC,OAAO,KAAA,EAAE,IAAI,KAAA,EAAE,cAAc,CAAC,KAAA;IAazC,WAAW,CAAC,OAAO,KAAA,EAAE,cAAc,KAAA;IA0BnC,IAAI;CAGL"}
+{"version":3,"file":"tileset-cache.d.ts","sourceRoot":"","sources":["../../src/tileset/tileset-cache.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AAGtC;;;GAGG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,SAAS,CAAM;IACvB,OAAO,CAAC,UAAU,CAAU;;IAU5B,KAAK,IAAI,IAAI;IAOb,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAOzB,GAAG,CACD,OAAO,EAAE,SAAS,EAClB,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,GACvD,IAAI;IAUP,UAAU,CACR,OAAO,EAAE,SAAS,EAClB,IAAI,EAAE,MAAM,EACZ,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,GAC1D,IAAI;IAaP,WAAW,CAAC,OAAO,KAAA,EAAE,cAAc,KAAA,GAAG,IAAI;IA0B1C,IAAI,IAAI,IAAI;CAGb"}

package/dist/tileset/tileset-cache.js

@@ -2,15 +2,9 @@
 // loaders.gl, MIT license
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TilesetCache = void 0;
-// This file is derived from the Cesium code base under Apache 2 license
-// See LICENSE.md and https://github.com/AnalyticalGraphicsInc/cesium/blob/master/LICENSE.md
 const doubly_linked_list_1 = require("../utils/doubly-linked-list");
-function defined(x) {
-    return x !== undefined && x !== null;
-}
 /**
  * Stores tiles with content loaded.
- *
  * @private
  */
 class TilesetCache {
@@ -29,12 +23,12 @@ class TilesetCache {
     }
     touch(tile) {
         const node = tile._cacheNode;
-        if (defined(node)) {
+        if (node) {
             this._list.splice(this._sentinel, node);
         }
     }
     add(tileset, tile, addCallback) {
-        if (!defined(tile._cacheNode)) {
+        if (!tile._cacheNode) {
             tile._cacheNode = this._list.add(tile);
             if (addCallback) {
                 addCallback(tileset, tile);
@@ -43,11 +37,11 @@ class TilesetCache {
     }
     unloadTile(tileset, tile, unloadCallback) {
         const node = tile._cacheNode;
-        if (!defined(node)) {
+        if (!node) {
             return;
         }
         this._list.remove(node);
-        tile._cacheNode = undefined;
+        tile._cacheNode = null;
         if (unloadCallback) {
             unloadCallback(tileset, tile);
         }

package/dist/tileset/tileset-traverser.d.ts

@@ -1,46 +1,57 @@
+import type { Tile3D } from './tile-3d';
 import { ManagedArray } from '../utils/managed-array';
 import { FrameState } from './helpers/frame-state';
 export type TilesetTraverserProps = {
     loadSiblings?: boolean;
     skipLevelOfDetail?: boolean;
+    updateTransforms?: boolean;
     maximumScreenSpaceError?: number;
     onTraversalEnd?: (frameState: any) => any;
-    viewportTraversersMap?: {
-        [key: string]: any;
-    };
+    viewportTraversersMap?: Record<string, any>;
     basePath?: string;
-    updateTransforms?: boolean;
 };
 export declare const DEFAULT_PROPS: Required<TilesetTraverserProps>;
 export declare class TilesetTraverser {
     options: Required<TilesetTraverserProps>;
     root: any;
-    requestedTiles: object;
-    selectedTiles: object;
-    emptyTiles: object;
+    selectedTiles: Record<string, Tile3D>;
+    requestedTiles: Record<string, Tile3D>;
+    emptyTiles: Record<string, Tile3D>;
     protected lastUpdate: number;
     protected readonly updateDebounceTime = 1000;
+    /** temporary storage to hold the traversed tiles during a traversal */
     protected _traversalStack: ManagedArray;
     protected _emptyTraversalStack: ManagedArray;
+    /** set in every traverse cycle */
     protected _frameNumber: number | null;
     protected traversalFinished(frameState: FrameState): boolean;
     constructor(options: TilesetTraverserProps);
     traverse(root: any, frameState: any, options: any): void;
     reset(): void;
+    /**
+     * Execute traverse
+     * Depth-first traversal that traverses all visible tiles and marks tiles for selection.
+     * If skipLevelOfDetail is off then a tile does not refine until all children are loaded.
+     * This is the traditional replacement refinement approach and is called the base traversal.
+     * Tiles that have a greater screen space error than the base screen space error are part of the base traversal,
+     * all other tiles are part of the skip traversal. The skip traversal allows for skipping levels of the tree
+     * and rendering children and parent tiles simultaneously.
+     */
     executeTraversal(root: any, frameState: FrameState): void;
-    updateChildTiles(tile: any, frameState: any): boolean;
-    updateAndPushChildren(tile: any, frameState: any, stack: any, depth: any): boolean;
-    updateTile(tile: any, frameState: any): void;
-    selectTile(tile: any, frameState: any): void;
-    loadTile(tile: any, frameState: any): void;
-    touchTile(tile: any, frameState: any): void;
-    canTraverse(tile: any, frameState: any, useParentMetric?: boolean, ignoreVisibility?: boolean): boolean;
-    shouldLoadTile(tile: any): any;
-    shouldSelectTile(tile: any): any;
-    shouldRefine(tile: any, frameState: any, useParentMetric: any): boolean;
-    updateTileVisibility(tile: any, frameState: any): void;
-    compareDistanceToCamera(b: any, a: any): number;
-    anyChildrenVisible(tile: any, frameState: any): boolean;
-    executeEmptyTraversal(root: any, frameState: any): boolean;
+    updateChildTiles(tile: Tile3D, frameState: FrameState): void;
+    updateAndPushChildren(tile: Tile3D, frameState: FrameState, stack: any, depth: any): boolean;
+    updateTile(tile: Tile3D, frameState: FrameState): void;
+    selectTile(tile: Tile3D, frameState: FrameState): void;
+    loadTile(tile: Tile3D, frameState: FrameState): void;
+    touchTile(tile: Tile3D, frameState: FrameState): void;
+    canTraverse(tile: Tile3D, frameState: FrameState, useParentMetric?: boolean, ignoreVisibility?: boolean): boolean;
+    shouldLoadTile(tile: Tile3D): boolean;
+    shouldSelectTile(tile: Tile3D): boolean;
+    /** Decide if tile LoD (level of detail) is not sufficient under current viewport */
+    shouldRefine(tile: Tile3D, frameState: FrameState, useParentMetric?: boolean): boolean;
+    updateTileVisibility(tile: Tile3D, frameState: FrameState): void;
+    compareDistanceToCamera(b: Tile3D, a: Tile3D): number;
+    anyChildrenVisible(tile: Tile3D, frameState: FrameState): boolean;
+    executeEmptyTraversal(root: Tile3D, frameState: FrameState): boolean;
 }
 //# sourceMappingURL=tileset-traverser.d.ts.map

package/dist/tileset/tileset-traverser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tileset-traverser.d.ts","sourceRoot":"","sources":["../../src/tileset/tileset-traverser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEpD,OAAO,EAAC,UAAU,EAAC,MAAM,uBAAuB,CAAC;AAEjD,MAAM,MAAM,qBAAqB,GAAG;IAClC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,cAAc,CAAC,EAAE,CAAC,UAAU,KAAA,KAAK,GAAG,CAAC;IACrC,qBAAqB,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAYF,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,qBAAqB,CAQzD,CAAC;AAEF,qBAAa,gBAAgB;IAC3B,OAAO,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAEzC,IAAI,EAAE,GAAG,CAAC;IACV,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IAEnB,SAAS,CAAC,UAAU,EAAE,MAAM,CAAwB;IACpD,SAAS,CAAC,QAAQ,CAAC,kBAAkB,QAAQ;IAC7C,SAAS,CAAC,eAAe,EAAE,YAAY,CAAC;IACxC,SAAS,CAAC,oBAAoB,EAAE,YAAY,CAAC;IAC7C,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;gBAKhD,OAAO,EAAE,qBAAqB;IAuB1C,QAAQ,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA,EAAE,OAAO,KAAA;IAclC,KAAK;IAgBL,gBAAgB,CAAC,IAAI,KAAA,EAAE,UAAU,EAAE,UAAU;IAmE7C,gBAAgB,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA;IASjC,qBAAqB,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA,EAAE,KAAK,KAAA,EAAE,KAAK,KAAA;IAuDpD,UAAU,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA;IAK3B,UAAU,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA;IAS3B,QAAQ,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA;IASzB,SAAS,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA;IAQ1B,WAAW,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA,EAAE,eAAe,UAAQ,EAAE,gBAAgB,UAAQ;IAmB/E,cAAc,CAAC,IAAI,KAAA;IAMnB,gBAAgB,CAAC,IAAI,KAAA;IAOrB,YAAY,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA,EAAE,eAAe,KAAA;IAS9C,oBAAoB,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA;IAiBrC,uBAAuB,CAAC,CAAC,KAAA,EAAE,CAAC,KAAA;IAI5B,kBAAkB,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA;IAWnC,qBAAqB,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA;CAqCvC"}
+{"version":3,"file":"tileset-traverser.d.ts","sourceRoot":"","sources":["../../src/tileset/tileset-traverser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AACtC,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEpD,OAAO,EAAC,UAAU,EAAC,MAAM,uBAAuB,CAAC;AAEjD,MAAM,MAAM,qBAAqB,GAAG;IAClC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,cAAc,CAAC,EAAE,CAAC,UAAU,KAAA,KAAK,GAAG,CAAC;IACrC,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,qBAAqB,CAQzD,CAAC;AAEF,qBAAa,gBAAgB;IAC3B,OAAO,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAGzC,IAAI,EAAE,GAAG,CAAQ;IAGjB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAE3C,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAE5C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAExC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAwB;IACpD,SAAS,CAAC,QAAQ,CAAC,kBAAkB,QAAQ;IAC7C,uEAAuE;IACvE,SAAS,CAAC,eAAe,eAAsB;IAC/C,SAAS,CAAC,oBAAoB,eAAsB;IACpD,kCAAkC;IAClC,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAQ;IAG7C,SAAS,CAAC,iBAAiB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;gBAKhD,OAAO,EAAE,qBAAqB;IAK1C,QAAQ,CAAC,IAAI,KAAA,EAAE,UAAU,KAAA,EAAE,OAAO,KAAA;IAclC,KAAK;IAKL;;;;;;;;OAQG;IAEH,gBAAgB,CAAC,IAAI,KAAA,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;IAmEpD,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;IAQ5D,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,KAAA,EAAE,KAAK,KAAA,GAAG,OAAO;IAuDlF,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;IAKtD,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;IAStD,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;IASpD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;IAQrD,WAAW,CACT,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,UAAU,EACtB,eAAe,GAAE,OAAe,EAChC,gBAAgB,GAAE,OAAe,GAChC,OAAO;IAmBV,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAMrC,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAMvC,oFAAoF;IACpF,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO;IAS7F,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;IAiBhE,uBAAuB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAIrD,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO;IAajE,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO;CAqCrE"}

package/dist/tileset/tileset-traverser.js

@@ -1,17 +1,9 @@
 "use strict";
+// loaders.gl, MIT license
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TilesetTraverser = exports.DEFAULT_PROPS = void 0;
 const managed_array_1 = require("../utils/managed-array");
 const constants_1 = require("../constants");
-// export type Props = {
-//   loadSiblings: boolean;
-//   skipLevelOfDetail: boolean;
-//   updateTransforms: boolean;
-//   maximumScreenSpaceError: number;
-//   onTraversalEnd: (frameState) => any;
-//   viewportTraversersMap: {[key: string]: any};
-//   basePath: string;
-// };
 exports.DEFAULT_PROPS = {
     loadSiblings: false,
     skipLevelOfDetail: false,
@@ -22,29 +14,28 @@ exports.DEFAULT_PROPS = {
     basePath: ''
 };
 class TilesetTraverser {
+    // RESULT
     traversalFinished(frameState) {
         return true;
     }
     // TODO nested props
     constructor(options) {
-        this.lastUpdate = new Date().getTime();
-        this.updateDebounceTime = 1000;
-        this.options = { ...exports.DEFAULT_PROPS, ...options };
-        // TRAVERSAL
-        // temporary storage to hold the traversed tiles during a traversal
-        this._traversalStack = new managed_array_1.ManagedArray();
-        this._emptyTraversalStack = new managed_array_1.ManagedArray();
-        // set in every traverse cycle
-        this._frameNumber = null;
         // fulfill in traverse call
         this.root = null;
-        // RESULT
         // tiles should be rendered
         this.selectedTiles = {};
         // tiles should be loaded from server
         this.requestedTiles = {};
         // tiles does not have render content
         this.emptyTiles = {};
+        this.lastUpdate = new Date().getTime();
+        this.updateDebounceTime = 1000;
+        /** temporary storage to hold the traversed tiles during a traversal */
+        this._traversalStack = new managed_array_1.ManagedArray();
+        this._emptyTraversalStack = new managed_array_1.ManagedArray();
+        /** set in every traverse cycle */
+        this._frameNumber = null;
+        this.options = { ...exports.DEFAULT_PROPS, ...options };
     }
     // tiles should be visible
     traverse(root, frameState, options) {
@@ -58,19 +49,18 @@ class TilesetTraverser {
         this.executeTraversal(root, frameState);
     }
     reset() {
-        this.requestedTiles = {};
-        this.selectedTiles = {};
-        this.emptyTiles = {};
         this._traversalStack.reset();
         this._emptyTraversalStack.reset();
     }
-    // execute traverse
-    // Depth-first traversal that traverses all visible tiles and marks tiles for selection.
-    // If skipLevelOfDetail is off then a tile does not refine until all children are loaded.
-    // This is the traditional replacement refinement approach and is called the base traversal.
-    // Tiles that have a greater screen space error than the base screen space error are part of the base traversal,
-    // all other tiles are part of the skip traversal. The skip traversal allows for skipping levels of the tree
-    // and rendering children and parent tiles simultaneously.
+    /**
+     * Execute traverse
+     * Depth-first traversal that traverses all visible tiles and marks tiles for selection.
+     * If skipLevelOfDetail is off then a tile does not refine until all children are loaded.
+     * This is the traditional replacement refinement approach and is called the base traversal.
+     * Tiles that have a greater screen space error than the base screen space error are part of the base traversal,
+     * all other tiles are part of the skip traversal. The skip traversal allows for skipping levels of the tree
+     * and rendering children and parent tiles simultaneously.
+     */
     /* eslint-disable-next-line complexity, max-statements */
     executeTraversal(root, frameState) {
         // stack to store traversed tiles, only visible tiles should be added to stack
@@ -132,7 +122,6 @@ class TilesetTraverser {
         for (const child of children) {
             this.updateTile(child, frameState);
         }
-        return true;
     }
     /* eslint-disable complexity, max-statements */
     updateAndPushChildren(tile, frameState, stack, depth) {
@@ -235,8 +224,8 @@ class TilesetTraverser {
         // and content available
         return tile.contentAvailable && !this.options.skipLevelOfDetail;
     }
-    // Decide if tile LoD (level of detail) is not sufficient under current viewport
-    shouldRefine(tile, frameState, useParentMetric) {
+    /** Decide if tile LoD (level of detail) is not sufficient under current viewport */
+    shouldRefine(tile, frameState, useParentMetric = false) {
         let screenSpaceError = tile._screenSpaceError;
         if (useParentMetric) {
             screenSpaceError = tile.getScreenSpaceError(frameState, true);
@@ -265,7 +254,9 @@ class TilesetTraverser {
     anyChildrenVisible(tile, frameState) {
         let anyVisible = false;
         for (const child of tile.children) {
+            // @ts-expect-error
             child.updateVisibility(frameState);
+            // @ts-expect-error
             anyVisible = anyVisible || child.isVisibleAndInRequestVolume;
         }
         return anyVisible;
@@ -304,6 +295,3 @@ class TilesetTraverser {
     }
 }
 exports.TilesetTraverser = TilesetTraverser;
-// TODO
-// enable expiration
-// enable optimization hint