@loaders.gl/tiles 4.0.0-alpha.6 → 4.0.0-alpha.7

package/src/tileset/tileset-cache.ts

@@ -3,15 +3,12 @@
 // 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
 
+import type {Tileset3D} from './tileset-3d';
+import type {Tile3D} from './tile-3d';
 import {DoublyLinkedList} from '../utils/doubly-linked-list';
 
-function defined(x) {
-  return x !== undefined && x !== null;
-}
-
 /**
  * Stores tiles with content loaded.
- *
  * @private
  */
 export class TilesetCache {
@@ -27,22 +24,26 @@ export class TilesetCache {
     this._trimTiles = false;
   }
 
-  reset() {
+  reset(): void {
     // Move sentinel node to the tail so, at the start of the frame, all tiles
     // may be potentially replaced.  Tiles are moved to the right of the sentinel
     // when they are selected so they will not be replaced.
     this._list.splice(this._list.tail, this._sentinel);
   }
 
-  touch(tile) {
+  touch(tile: Tile3D): void {
     const node = tile._cacheNode;
-    if (defined(node)) {
+    if (node) {
       this._list.splice(this._sentinel, node);
     }
   }
 
-  add(tileset, tile, addCallback) {
-    if (!defined(tile._cacheNode)) {
+  add(
+    tileset: Tileset3D,
+    tile: Tile3D,
+    addCallback?: (tileset: Tileset3D, tile: Tile3D) => void
+  ): void {
+    if (!tile._cacheNode) {
       tile._cacheNode = this._list.add(tile);
 
       if (addCallback) {
@@ -51,20 +52,24 @@ export class TilesetCache {
     }
   }
 
-  unloadTile(tileset, tile, unloadCallback?) {
+  unloadTile(
+    tileset: Tileset3D,
+    tile: Tile3D,
+    unloadCallback?: (tileset: Tileset3D, tile: Tile3D) => void
+  ): void {
     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);
     }
   }
 
-  unloadTiles(tileset, unloadCallback) {
+  unloadTiles(tileset, unloadCallback): void {
     const trimTiles = this._trimTiles;
     this._trimTiles = false;
 
@@ -90,7 +95,7 @@ export class TilesetCache {
     }
   }
 
-  trim() {
+  trim(): void {
     this._trimTiles = true;
   }
 }

package/src/tileset/tileset-traverser.ts

@@ -1,3 +1,6 @@
+// loaders.gl, MIT license
+
+import type {Tile3D} from './tile-3d';
 import {ManagedArray} from '../utils/managed-array';
 import {TILE_REFINEMENT} from '../constants';
 import {FrameState} from './helpers/frame-state';
@@ -5,23 +8,13 @@ import {FrameState} from './helpers/frame-state';
 export type TilesetTraverserProps = {
   loadSiblings?: boolean;
   skipLevelOfDetail?: boolean;
+  updateTransforms?: boolean;
   maximumScreenSpaceError?: number;
   onTraversalEnd?: (frameState) => any;
-  viewportTraversersMap?: {[key: string]: any};
+  viewportTraversersMap?: Record<string, any>;
   basePath?: string;
-  updateTransforms?: boolean;
 };
 
-// export type Props = {
-//   loadSiblings: boolean;
-//   skipLevelOfDetail: boolean;
-//   updateTransforms: boolean;
-//   maximumScreenSpaceError: number;
-//   onTraversalEnd: (frameState) => any;
-//   viewportTraversersMap: {[key: string]: any};
-//   basePath: string;
-// };
-
 export const DEFAULT_PROPS: Required<TilesetTraverserProps> = {
   loadSiblings: false,
   skipLevelOfDetail: false,
@@ -35,17 +28,25 @@ export const DEFAULT_PROPS: Required<TilesetTraverserProps> = {
 export class TilesetTraverser {
   options: Required<TilesetTraverserProps>;
 
-  root: any;
-  requestedTiles: object;
-  selectedTiles: object;
-  emptyTiles: object;
+  // fulfill in traverse call
+  root: any = null;
+
+  // tiles should be rendered
+  selectedTiles: Record<string, Tile3D> = {};
+  // tiles should be loaded from server
+  requestedTiles: Record<string, Tile3D> = {};
+  // tiles does not have render content
+  emptyTiles: Record<string, Tile3D> = {};
 
   protected lastUpdate: number = new Date().getTime();
   protected readonly updateDebounceTime = 1000;
-  protected _traversalStack: ManagedArray;
-  protected _emptyTraversalStack: ManagedArray;
-  protected _frameNumber: number | null;
+  /** temporary storage to hold the traversed tiles during a traversal */
+  protected _traversalStack = new ManagedArray();
+  protected _emptyTraversalStack = new ManagedArray();
+  /** set in every traverse cycle */
+  protected _frameNumber: number | null = null;
 
+  // RESULT
   protected traversalFinished(frameState: FrameState): boolean {
     return true;
   }
@@ -53,24 +54,6 @@ export class TilesetTraverser {
   // TODO nested props
   constructor(options: TilesetTraverserProps) {
     this.options = {...DEFAULT_PROPS, ...options};
-    // TRAVERSAL
-    // temporary storage to hold the traversed tiles during a traversal
-    this._traversalStack = new ManagedArray();
-    this._emptyTraversalStack = new 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 = {};
   }
 
   // tiles should be visible
@@ -96,15 +79,17 @@ export class TilesetTraverser {
     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: FrameState) {
+  executeTraversal(root, frameState: FrameState): void {
     // stack to store traversed tiles, only visible tiles should be added to stack
     // visible: visible in the current view frustum
     const stack = this._traversalStack;
@@ -171,16 +156,15 @@ export class TilesetTraverser {
     }
   }
 
-  updateChildTiles(tile, frameState) {
+  updateChildTiles(tile: Tile3D, frameState: FrameState): void {
     const children = tile.children;
     for (const child of children) {
       this.updateTile(child, frameState);
     }
-    return true;
   }
 
   /* eslint-disable complexity, max-statements */
-  updateAndPushChildren(tile, frameState, stack, depth) {
+  updateAndPushChildren(tile: Tile3D, frameState: FrameState, stack, depth): boolean {
     const {loadSiblings, skipLevelOfDetail} = this.options;
 
     const children = tile.children;
@@ -235,12 +219,12 @@ export class TilesetTraverser {
   }
   /* eslint-enable complexity, max-statements */
 
-  updateTile(tile, frameState) {
+  updateTile(tile: Tile3D, frameState: FrameState): void {
     this.updateTileVisibility(tile, frameState);
   }
 
   // tile to render in the browser
-  selectTile(tile, frameState) {
+  selectTile(tile: Tile3D, frameState: FrameState): void {
     if (this.shouldSelectTile(tile)) {
       // The tile can be selected right away and does not require traverseAndSelect
       tile._selectedFrame = frameState.frameNumber;
@@ -249,7 +233,7 @@ export class TilesetTraverser {
   }
 
   // tile to load from server
-  loadTile(tile, frameState) {
+  loadTile(tile: Tile3D, frameState: FrameState): void {
     if (this.shouldLoadTile(tile)) {
       tile._requestedFrame = frameState.frameNumber;
       tile._priority = tile._getPriority();
@@ -258,7 +242,7 @@ export class TilesetTraverser {
   }
 
   // cache tile
-  touchTile(tile, frameState) {
+  touchTile(tile: Tile3D, frameState: FrameState): void {
     tile.tileset._cache.touch(tile);
     tile._touchedFrame = frameState.frameNumber;
   }
@@ -266,7 +250,12 @@ export class TilesetTraverser {
   // tile should be visible
   // tile should have children
   // tile LoD (level of detail) is not sufficient under current viewport
-  canTraverse(tile, frameState, useParentMetric = false, ignoreVisibility = false) {
+  canTraverse(
+    tile: Tile3D,
+    frameState: FrameState,
+    useParentMetric: boolean = false,
+    ignoreVisibility: boolean = false
+  ): boolean {
     if (!tile.hasChildren) {
       return false;
     }
@@ -285,20 +274,20 @@ export class TilesetTraverser {
     return this.shouldRefine(tile, frameState, useParentMetric);
   }
 
-  shouldLoadTile(tile) {
+  shouldLoadTile(tile: Tile3D): boolean {
     // if request tile is in current frame
     // and has unexpired render content
     return tile.hasUnloadedContent || tile.contentExpired;
   }
 
-  shouldSelectTile(tile) {
+  shouldSelectTile(tile: Tile3D): boolean {
     // if select tile is in current frame
     // 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: Tile3D, frameState: FrameState, useParentMetric: boolean = false): boolean {
     let screenSpaceError = tile._screenSpaceError;
     if (useParentMetric) {
       screenSpaceError = tile.getScreenSpaceError(frameState, true);
@@ -307,7 +296,7 @@ export class TilesetTraverser {
     return screenSpaceError > this.options.maximumScreenSpaceError;
   }
 
-  updateTileVisibility(tile, frameState) {
+  updateTileVisibility(tile: Tile3D, frameState: FrameState): void {
     const viewportIds: string[] = [];
     if (this.options.viewportTraversersMap) {
       for (const key in this.options.viewportTraversersMap) {
@@ -324,14 +313,16 @@ export class TilesetTraverser {
 
   // UTILITIES
 
-  compareDistanceToCamera(b, a) {
+  compareDistanceToCamera(b: Tile3D, a: Tile3D): number {
     return b._distanceToCamera - a._distanceToCamera;
   }
 
-  anyChildrenVisible(tile, frameState) {
+  anyChildrenVisible(tile: Tile3D, frameState: FrameState): boolean {
     let anyVisible = false;
     for (const child of tile.children) {
+      // @ts-expect-error
       child.updateVisibility(frameState);
+      // @ts-expect-error
       anyVisible = anyVisible || child.isVisibleAndInRequestVolume;
     }
     return anyVisible;
@@ -339,7 +330,7 @@ export class TilesetTraverser {
 
   // Depth-first traversal that checks if all nearest descendants with content are loaded.
   // Ignores visibility.
-  executeEmptyTraversal(root, frameState) {
+  executeEmptyTraversal(root: Tile3D, frameState: FrameState): boolean {
     let allDescendantsLoaded = true;
     const stack = this._emptyTraversalStack;
 
@@ -377,7 +368,3 @@ export class TilesetTraverser {
     return allDescendantsLoaded;
   }
 }
-
-// TODO
-// enable expiration
-// enable optimization hint