@loaders.gl/tiles 4.2.0-alpha.4 → 4.2.0-alpha.5

package/dist/tileset/format-i3s/i3s-pending-tiles-register.js

@@ -1,25 +1,43 @@
+/**
+ * Counter to register pending tile headers for the particular frameNumber
+ * Until all tiles are loaded we won't call `onTraversalEnd` callback
+ */
 export class I3SPendingTilesRegister {
-  constructor() {
-    this.frameNumberMap = new Map();
-  }
-  register(viewportId, frameNumber) {
-    const viewportMap = this.frameNumberMap.get(viewportId) || new Map();
-    const oldCount = viewportMap.get(frameNumber) || 0;
-    viewportMap.set(frameNumber, oldCount + 1);
-    this.frameNumberMap.set(viewportId, viewportMap);
-  }
-  deregister(viewportId, frameNumber) {
-    const viewportMap = this.frameNumberMap.get(viewportId);
-    if (!viewportMap) {
-      return;
+    constructor() {
+        this.frameNumberMap = new Map();
+    }
+    /**
+     * Register a new pending tile header for the particular frameNumber
+     * @param viewportId
+     * @param frameNumber
+     */
+    register(viewportId, frameNumber) {
+        const viewportMap = this.frameNumberMap.get(viewportId) || new Map();
+        const oldCount = viewportMap.get(frameNumber) || 0;
+        viewportMap.set(frameNumber, oldCount + 1);
+        this.frameNumberMap.set(viewportId, viewportMap);
+    }
+    /**
+     * Deregister a pending tile header for the particular frameNumber
+     * @param viewportId
+     * @param frameNumber
+     */
+    deregister(viewportId, frameNumber) {
+        const viewportMap = this.frameNumberMap.get(viewportId);
+        if (!viewportMap) {
+            return;
+        }
+        const oldCount = viewportMap.get(frameNumber) || 1;
+        viewportMap.set(frameNumber, oldCount - 1);
+    }
+    /**
+     * Check is there are no pending tile headers registered for the particular frameNumber
+     * @param viewportId
+     * @param frameNumber
+     * @returns
+     */
+    isZero(viewportId, frameNumber) {
+        const count = this.frameNumberMap.get(viewportId)?.get(frameNumber) || 0;
+        return count === 0;
     }
-    const oldCount = viewportMap.get(frameNumber) || 1;
-    viewportMap.set(frameNumber, oldCount - 1);
-  }
-  isZero(viewportId, frameNumber) {
-    var _this$frameNumberMap$;
-    const count = ((_this$frameNumberMap$ = this.frameNumberMap.get(viewportId)) === null || _this$frameNumberMap$ === void 0 ? void 0 : _this$frameNumberMap$.get(frameNumber)) || 0;
-    return count === 0;
-  }
 }
-//# sourceMappingURL=i3s-pending-tiles-register.js.map

package/dist/tileset/format-i3s/i3s-tile-manager.d.ts

@@ -1,4 +1,4 @@
-import { FrameState } from '../helpers/frame-state';
+import { FrameState } from "../helpers/frame-state.js";
 export declare class I3STileManager {
     private _statusMap;
     private pendingTilesRegister;

package/dist/tileset/format-i3s/i3s-tile-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"i3s-tile-manager.d.ts","sourceRoot":"","sources":["../../../src/tileset/format-i3s/i3s-tile-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AAUlD,qBAAa,cAAc;IACzB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,oBAAoB,CAAiC;;IAM7D;;;;;;OAMG;IACH,GAAG,CAAC,OAAO,KAAA,EAAE,GAAG,KAAA,EAAE,QAAQ,KAAA,EAAE,UAAU,EAAE,UAAU;IAiClD;;;;OAIG;IACH,MAAM,CAAC,GAAG,KAAA,EAAE,UAAU,EAAE,UAAU;IAmBlC;;;;OAIG;IACH,IAAI,CAAC,GAAG,KAAA;IAIR;;;;;OAKG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO;CAGlE"}
+{"version":3,"file":"i3s-tile-manager.d.ts","sourceRoot":"","sources":["../../../src/tileset/format-i3s/i3s-tile-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,kCAA+B;AAUlD,qBAAa,cAAc;IACzB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,oBAAoB,CAAiC;;IAM7D;;;;;;OAMG;IACH,GAAG,CAAC,OAAO,KAAA,EAAE,GAAG,KAAA,EAAE,QAAQ,KAAA,EAAE,UAAU,EAAE,UAAU;IAiClD;;;;OAIG;IACH,MAAM,CAAC,GAAG,KAAA,EAAE,UAAU,EAAE,UAAU;IAmBlC;;;;OAIG;IACH,IAAI,CAAC,GAAG,KAAA;IAIR;;;;;OAKG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO;CAGlE"}

package/dist/tileset/format-i3s/i3s-tile-manager.js

@@ -1,78 +1,76 @@
 import { I3SPendingTilesRegister } from "./i3s-pending-tiles-register.js";
 const STATUS = {
-  REQUESTED: 'REQUESTED',
-  COMPLETED: 'COMPLETED',
-  ERROR: 'ERROR'
+    REQUESTED: 'REQUESTED',
+    COMPLETED: 'COMPLETED',
+    ERROR: 'ERROR'
 };
+// A helper class to manage tile metadata fetching
 export class I3STileManager {
-  constructor() {
-    this._statusMap = void 0;
-    this.pendingTilesRegister = new I3SPendingTilesRegister();
-    this._statusMap = {};
-  }
-  add(request, key, callback, frameState) {
-    if (!this._statusMap[key]) {
-      const {
-        frameNumber,
-        viewport: {
-          id
-        }
-      } = frameState;
-      this._statusMap[key] = {
-        request,
-        callback,
-        key,
-        frameState,
-        status: STATUS.REQUESTED
-      };
-      this.pendingTilesRegister.register(id, frameNumber);
-      request().then(data => {
-        this._statusMap[key].status = STATUS.COMPLETED;
-        const {
-          frameNumber: actualFrameNumber,
-          viewport: {
-            id
-          }
-        } = this._statusMap[key].frameState;
-        this.pendingTilesRegister.deregister(id, actualFrameNumber);
-        this._statusMap[key].callback(data, frameState);
-      }).catch(error => {
-        this._statusMap[key].status = STATUS.ERROR;
-        const {
-          frameNumber: actualFrameNumber,
-          viewport: {
-            id
-          }
-        } = this._statusMap[key].frameState;
-        this.pendingTilesRegister.deregister(id, actualFrameNumber);
-        callback(error);
-      });
+    constructor() {
+        this.pendingTilesRegister = new I3SPendingTilesRegister();
+        this._statusMap = {};
     }
-  }
-  update(key, frameState) {
-    if (this._statusMap[key]) {
-      const {
-        frameNumber,
-        viewport: {
-          id
+    /**
+     * Add request to map
+     * @param request - node metadata request
+     * @param key - unique key
+     * @param callback - callback after request completed
+     * @param frameState - frameState data
+     */
+    add(request, key, callback, frameState) {
+        if (!this._statusMap[key]) {
+            const { frameNumber, viewport: { id } } = frameState;
+            this._statusMap[key] = { request, callback, key, frameState, status: STATUS.REQUESTED };
+            // Register pending request for the frameNumber
+            this.pendingTilesRegister.register(id, frameNumber);
+            request()
+                .then((data) => {
+                this._statusMap[key].status = STATUS.COMPLETED;
+                const { frameNumber: actualFrameNumber, viewport: { id } } = this._statusMap[key].frameState;
+                // Deregister pending request for the frameNumber
+                this.pendingTilesRegister.deregister(id, actualFrameNumber);
+                this._statusMap[key].callback(data, frameState);
+            })
+                .catch((error) => {
+                this._statusMap[key].status = STATUS.ERROR;
+                const { frameNumber: actualFrameNumber, viewport: { id } } = this._statusMap[key].frameState;
+                // Deregister pending request for the frameNumber
+                this.pendingTilesRegister.deregister(id, actualFrameNumber);
+                callback(error);
+            });
         }
-      } = this._statusMap[key].frameState;
-      this.pendingTilesRegister.deregister(id, frameNumber);
-      const {
-        frameNumber: newFrameNumber,
-        viewport: {
-          id: newViewportId
+    }
+    /**
+     * Update request if it is still actual for the new frameState
+     * @param key - unique key
+     * @param frameState - frameState data
+     */
+    update(key, frameState) {
+        if (this._statusMap[key]) {
+            // Deregister pending request for the old frameNumber
+            const { frameNumber, viewport: { id } } = this._statusMap[key].frameState;
+            this.pendingTilesRegister.deregister(id, frameNumber);
+            // Register pending request for the new frameNumber
+            const { frameNumber: newFrameNumber, viewport: { id: newViewportId } } = frameState;
+            this.pendingTilesRegister.register(newViewportId, newFrameNumber);
+            this._statusMap[key].frameState = frameState;
         }
-      } = frameState;
-      this.pendingTilesRegister.register(newViewportId, newFrameNumber);
-      this._statusMap[key].frameState = frameState;
     }
-  }
-  find(key) {
-    return this._statusMap[key];
-  }
-  hasPendingTiles(viewportId, frameNumber) {
-    return !this.pendingTilesRegister.isZero(viewportId, frameNumber);
-  }
+    /**
+     * Find request in the map
+     * @param key - unique key
+     * @returns
+     */
+    find(key) {
+        return this._statusMap[key];
+    }
+    /**
+     * Check it there are pending tile headers for the particular frameNumber
+     * @param viewportId
+     * @param frameNumber
+     * @returns
+     */
+    hasPendingTiles(viewportId, frameNumber) {
+        return !this.pendingTilesRegister.isZero(viewportId, frameNumber);
+    }
 }
-//# sourceMappingURL=i3s-tile-manager.js.map

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

@@ -1,5 +1,5 @@
-import { TilesetTraverser } from '../tileset-traverser';
-import { FrameState } from '../helpers/frame-state';
+import { TilesetTraverser } from "../tileset-traverser.js";
+import { FrameState } from "../helpers/frame-state.js";
 export declare class I3STilesetTraverser extends TilesetTraverser {
     private _tileManager;
     constructor(options: any);

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

@@ -1 +1 @@
-{"version":3,"file":"i3s-tileset-traverser.d.ts","sourceRoot":"","sources":["../../../src/tileset/format-i3s/i3s-tileset-traverser.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAKtD,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AAElD,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,OAAO,CAAC,YAAY,CAAiB;gBAEzB,OAAO,KAAA;IAKnB;;;;OAIG;IACH,iBAAiB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAIlD,YAAY,CAAC,IAAI,KAAA,EAAE,UAAU,EAAE,UAAU;IAKzC,gBAAgB,CAAC,IAAI,KAAA,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO;IAoCjD,SAAS,CAAC,MAAM,KAAA,EAAE,OAAO,KAAA;IAe/B;;;;;;;OAOG;IACH,WAAW,CAAC,MAAM,KAAA,EAAE,IAAI,KAAA,EAAE,UAAU,KAAA;CAgBrC"}
+{"version":3,"file":"i3s-tileset-traverser.d.ts","sourceRoot":"","sources":["../../../src/tileset/format-i3s/i3s-tileset-traverser.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAC,gCAA6B;AAKtD,OAAO,EAAC,UAAU,EAAC,kCAA+B;AAElD,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,OAAO,CAAC,YAAY,CAAiB;gBAEzB,OAAO,KAAA;IAKnB;;;;OAIG;IACH,iBAAiB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAIlD,YAAY,CAAC,IAAI,KAAA,EAAE,UAAU,EAAE,UAAU;IAKzC,gBAAgB,CAAC,IAAI,KAAA,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO;IAoCjD,SAAS,CAAC,MAAM,KAAA,EAAE,OAAO,KAAA;IAe/B;;;;;;;OAOG;IACH,WAAW,CAAC,MAAM,KAAA,EAAE,IAAI,KAAA,EAAE,UAAU,KAAA;CAgBrC"}

package/dist/tileset/format-i3s/i3s-tileset-traverser.js

@@ -4,64 +4,85 @@ import { getLodStatus } from "../helpers/i3s-lod.js";
 import { Tile3D } from "../tile-3d.js";
 import { I3STileManager } from "./i3s-tile-manager.js";
 export class I3STilesetTraverser extends TilesetTraverser {
-  constructor(options) {
-    super(options);
-    this._tileManager = void 0;
-    this._tileManager = new I3STileManager();
-  }
-  traversalFinished(frameState) {
-    return !this._tileManager.hasPendingTiles(frameState.viewport.id, this._frameNumber || 0);
-  }
-  shouldRefine(tile, frameState) {
-    tile._lodJudge = getLodStatus(tile, frameState);
-    return tile._lodJudge === 'DIG';
-  }
-  updateChildTiles(tile, frameState) {
-    const children = tile.header.children || [];
-    const childTiles = tile.children;
-    const tileset = tile.tileset;
-    for (const child of children) {
-      const extendedId = `${child.id}-${frameState.viewport.id}`;
-      const childTile = childTiles && childTiles.find(t => t.id === extendedId);
-      if (!childTile) {
-        let request = () => this._loadTile(child.id, tileset);
-        const cachedRequest = this._tileManager.find(extendedId);
-        if (!cachedRequest) {
-          if (tileset.tileset.nodePages) {
-            request = () => tileset.tileset.nodePagesTile.formTileFromNodePages(child.id);
-          }
-          this._tileManager.add(request, extendedId, header => this._onTileLoad(header, tile, extendedId), frameState);
-        } else {
-          this._tileManager.update(extendedId, frameState);
+    constructor(options) {
+        super(options);
+        this._tileManager = new I3STileManager();
+    }
+    /**
+     * Check if there are no penging tile header requests,
+     * that means the traversal is finished and we can call
+     * following-up callbacks.
+     */
+    traversalFinished(frameState) {
+        return !this._tileManager.hasPendingTiles(frameState.viewport.id, this._frameNumber || 0);
+    }
+    shouldRefine(tile, frameState) {
+        tile._lodJudge = getLodStatus(tile, frameState);
+        return tile._lodJudge === 'DIG';
+    }
+    updateChildTiles(tile, frameState) {
+        const children = tile.header.children || [];
+        // children which are already fetched and constructed as Tile3D instances
+        const childTiles = tile.children;
+        const tileset = tile.tileset;
+        for (const child of children) {
+            const extendedId = `${child.id}-${frameState.viewport.id}`;
+            // if child tile is not fetched
+            const childTile = childTiles && childTiles.find((t) => t.id === extendedId);
+            if (!childTile) {
+                let request = () => this._loadTile(child.id, tileset);
+                const cachedRequest = this._tileManager.find(extendedId);
+                if (!cachedRequest) {
+                    // eslint-disable-next-line max-depth
+                    if (tileset.tileset.nodePages) {
+                        request = () => tileset.tileset.nodePagesTile.formTileFromNodePages(child.id);
+                    }
+                    this._tileManager.add(request, extendedId, (header) => this._onTileLoad(header, tile, extendedId), frameState);
+                }
+                else {
+                    // update frameNumber since it is still needed in current frame
+                    this._tileManager.update(extendedId, frameState);
+                }
+            }
+            else if (childTile) {
+                // if child tile is fetched and available
+                this.updateTile(childTile, frameState);
+            }
         }
-      } else if (childTile) {
-        this.updateTile(childTile, frameState);
-      }
+        return false;
     }
-    return false;
-  }
-  async _loadTile(nodeId, tileset) {
-    const {
-      loader
-    } = tileset;
-    const nodeUrl = tileset.getTileUrl(`${tileset.url}/nodes/${nodeId}`);
-    const options = {
-      ...tileset.loadOptions,
-      i3s: {
-        ...tileset.loadOptions.i3s,
-        isTileHeader: true
-      }
-    };
-    return await load(nodeUrl, loader, options);
-  }
-  _onTileLoad(header, tile, extendedId) {
-    const childTile = new Tile3D(tile.tileset, header, tile, extendedId);
-    tile.children.push(childTile);
-    const frameState = this._tileManager.find(childTile.id).frameState;
-    this.updateTile(childTile, frameState);
-    if (this._frameNumber === frameState.frameNumber && (this.traversalFinished(frameState) || new Date().getTime() - this.lastUpdate > this.updateDebounceTime)) {
-      this.executeTraversal(childTile, frameState);
+    async _loadTile(nodeId, tileset) {
+        const { loader } = tileset;
+        const nodeUrl = tileset.getTileUrl(`${tileset.url}/nodes/${nodeId}`);
+        // load metadata
+        const options = {
+            ...tileset.loadOptions,
+            i3s: {
+                ...tileset.loadOptions.i3s,
+                isTileHeader: true
+            }
+        };
+        return await load(nodeUrl, loader, options);
+    }
+    /**
+     * The callback to init Tile3D instance after loading the tile JSON
+     * @param {Object} header - the tile JSON from a dataset
+     * @param {Tile3D} tile - the parent Tile3D instance
+     * @param {string} extendedId - optional ID to separate copies of a tile for different viewports.
+     *                              const extendedId = `${tile.id}-${frameState.viewport.id}`;
+     * @return {void}
+     */
+    _onTileLoad(header, tile, extendedId) {
+        // after child tile is fetched
+        const childTile = new Tile3D(tile.tileset, header, tile, extendedId);
+        tile.children.push(childTile);
+        const frameState = this._tileManager.find(childTile.id).frameState;
+        this.updateTile(childTile, frameState);
+        // after tile fetched, resume traversal if still in current update/traversal frame
+        if (this._frameNumber === frameState.frameNumber &&
+            (this.traversalFinished(frameState) ||
+                new Date().getTime() - this.lastUpdate > this.updateDebounceTime)) {
+            this.executeTraversal(childTile, frameState);
+        }
     }
-  }
 }
-//# sourceMappingURL=i3s-tileset-traverser.js.map

package/dist/tileset/helpers/3d-tiles-options.d.ts

@@ -1,4 +1,4 @@
-import type { Tileset3D } from '../tileset-3d';
+import type { Tileset3D } from "../tileset-3d.js";
 export declare function get3dTilesOptions(tileset: Tileset3D): {
     assetGltfUpAxis: 'X' | 'Y' | 'Z';
 };

package/dist/tileset/helpers/3d-tiles-options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"3d-tiles-options.d.ts","sourceRoot":"","sources":["../../../src/tileset/helpers/3d-tiles-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,eAAe,CAAC;AAE7C,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,SAAS,GAAG;IAAC,eAAe,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;CAAC,CAIxF"}
+{"version":3,"file":"3d-tiles-options.d.ts","sourceRoot":"","sources":["../../../src/tileset/helpers/3d-tiles-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,yBAAsB;AAE7C,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,SAAS,GAAG;IAAC,eAAe,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;CAAC,CAIxF"}

package/dist/tileset/helpers/3d-tiles-options.js

@@ -1,6 +1,5 @@
 export function get3dTilesOptions(tileset) {
-  return {
-    assetGltfUpAxis: tileset.asset && tileset.asset.gltfUpAxis || 'Y'
-  };
+    return {
+        assetGltfUpAxis: (tileset.asset && tileset.asset.gltfUpAxis) || 'Y'
+    };
 }
-//# sourceMappingURL=3d-tiles-options.js.map