@loaders.gl/tiles 3.4.0-alpha.3 → 3.4.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/tiles",
-  "version": "3.4.0-alpha.3",
+  "version": "3.4.0-alpha.5",
   "description": "Common components for different tiles loaders.",
   "license": "MIT",
   "publishConfig": {
@@ -33,8 +33,8 @@
     "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/dist.min.js"
   },
   "dependencies": {
-    "@loaders.gl/loader-utils": "3.4.0-alpha.3",
-    "@loaders.gl/math": "3.4.0-alpha.3",
+    "@loaders.gl/loader-utils": "3.4.0-alpha.5",
+    "@loaders.gl/math": "3.4.0-alpha.5",
     "@math.gl/core": "^3.5.1",
     "@math.gl/culling": "^3.5.1",
     "@math.gl/geospatial": "^3.5.1",
@@ -44,5 +44,5 @@
   "peerDependencies": {
     "@loaders.gl/core": "^3.2.0"
   },
-  "gitHead": "a954528dd1d78a1f128d8f6b07e4baeb7a296924"
+  "gitHead": "686929f85b3420c15df051eab769942b260dd242"
 }

package/src/constants.ts

@@ -1,5 +1,13 @@
 // loaders.gl, MIT license
 
+export type TileContentState =
+  | 'unloaded' // Has never been requested
+  | 'loading' // Is waiting on a pending request
+  | 'processing' // Request received.  Contents are being processed for rendering.  Depending on the content, it might make its own requests for external data.
+  | 'ready' // Ready to render.
+  | 'expired' // Is expired and will be unloaded once new content is loaded.
+  | 'failed'; // Request failed.
+
 export const TILE_CONTENT_STATE = {
   UNLOADED: 0, // Has never been requested
   LOADING: 1, // Is waiting on a pending request
@@ -9,11 +17,15 @@ export const TILE_CONTENT_STATE = {
   FAILED: 5 // Request failed.
 };
 
+export type TileRefinement = 'add' | 'replace';
+
 export const TILE_REFINEMENT = {
   ADD: 1, // Render tile and, if screen space error exceeded, also refine to its children.
   REPLACE: 2 // Render tile or, if screen space error exceeded, refine to its descendants instead.
 };
 
+export type TileType = 'empty' | 'scenegraph' | 'pointcloud' | 'mesh';
+
 export const TILE_TYPE = {
   EMPTY: 'empty',
   SCENEGRAPH: 'scenegraph',
@@ -21,17 +33,23 @@ export const TILE_TYPE = {
   MESH: 'mesh'
 };
 
+export type TilesetType = 'I3S' | 'TILES3D';
+
 export const TILESET_TYPE = {
   I3S: 'I3S',
   TILES3D: 'TILES3D'
 };
 
+export type LODMetricType = 'geometricError' | 'maxScreenThreshold';
+
 export const LOD_METRIC_TYPE = {
   GEOMETRIC_ERROR: 'geometricError',
   MAX_SCREEN_THRESHOLD: 'maxScreenThreshold'
 };
 
 // Cesium 3D Tiles Specific
+export type Tile3DOptimizationHint = 'NOT_COMPUTED' | 'USE_OPTIMIZATION' | 'SKIP_OPTIMIZATION';
+
 export const TILE3D_OPTIMIZATION_HINT = {
   NOT_COMPUTED: -1,
   USE_OPTIMIZATION: 1,

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

@@ -1,4 +1,6 @@
-export function get3dTilesOptions(tileset) {
+import type {Tileset3D} from '../tileset-3d';
+
+export function get3dTilesOptions(tileset: Tileset3D): {assetGltfUpAxis: 'X' | 'Y' | 'Z'} {
   return {
     assetGltfUpAxis: (tileset.asset && tileset.asset.gltfUpAxis) || 'Y'
   };

package/src/tileset/tile-3d.ts

@@ -10,6 +10,7 @@ import {load} from '@loaders.gl/core';
 
 // Note: circular dependency
 import type {Tileset3D} from './tileset-3d';
+import type {DoublyLinkedListNode} from '../utils/doubly-linked-list-node';
 import {TILE_REFINEMENT, TILE_CONTENT_STATE, TILESET_TYPE} from '../constants';
 
 import {FrameState} from './helpers/frame-state';
@@ -54,73 +55,80 @@ export class Tile3D {
   id: string;
   url: string;
   parent: Tile3D;
+  /* Specifies the type of refine that is used when traversing this tile for rendering. */
   refine: number;
   type: string;
   contentUrl: string;
-  lodMetricType: string;
-  lodMetricValue: number;
-  boundingVolume: any;
-  content: any;
-  contentState: any;
-  gpuMemoryUsageInBytes: number;
-  children: Tile3D[];
-  depth: number;
-  viewportIds: any[];
-  transform: Matrix4;
-  extensions: any;
-  implicitTiling?: any;
-
-  // Container to store application specific data
-  userData: {[key: string]: any};
+  /** Different refinement algorithms used by I3S and 3D tiles */
+  lodMetricType: 'geometricError' | 'maxScreenThreshold' = 'geometricError';
+  /** The error, in meters, introduced if this tile is rendered and its children are not. */
+  lodMetricValue: number = 0;
+
+  /** @todo math.gl is not exporting BoundingVolume base type? */
+  boundingVolume: any = null;
+
+  /**
+   * The tile's content.  This represents the actual tile's payload,
+   * not the content's metadata in the tileset JSON file.
+   */
+  content: any = null;
+  contentState: number = TILE_CONTENT_STATE.UNLOADED;
+  gpuMemoryUsageInBytes: number = 0;
+
+  /** The tile's children - an array of Tile3D objects. */
+  children: Tile3D[] = [];
+  depth: number = 0;
+  viewportIds: any[] = [];
+  transform = new Matrix4();
+  extensions: any = null;
+  /** TODO Cesium 3d tiles specific */
+  implicitTiling?: any = null;
+
+  /** Container to store application specific data */
+  userData: Record<string, any> = {};
+
   computedTransform: any;
-  hasEmptyContent: boolean;
-  hasTilesetContent: boolean;
+  hasEmptyContent: boolean = false;
+  hasTilesetContent: boolean = false;
 
-  traverser: object;
+  traverser = new TilesetTraverser({});
+
+  /** Used by TilesetCache */
+  _cacheNode: DoublyLinkedListNode | null = null;
+
+  private _frameNumber: any = null;
 
-  // @ts-ignore
-  private _cacheNode: any;
-  private _frameNumber: any;
-  // TODO i3s specific, needs to remove
-  // @ts-ignore
-  private _lodJudge: any;
   // TODO Cesium 3d tiles specific
-  private _expireDate: any;
-  private _expiredContent: any;
-  // @ts-ignore
-  private _shouldRefine: boolean;
+  private _expireDate: any = null;
+  private _expiredContent: any = null;
 
   private _boundingBox?: CartographicBounds;
 
-  // Members this are updated every frame for tree traversal and rendering optimizations:
-  public _distanceToCamera: number;
-  // @ts-ignore
-  private _centerZDepth: number;
-  private _screenSpaceError: number;
+  /** updated every frame for tree traversal and rendering optimizations: */
+  public _distanceToCamera: number = 0;
+  _screenSpaceError: number = 0;
   private _visibilityPlaneMask: any;
-  private _visible?: boolean;
-  private _inRequestVolume: boolean;
-
-  // @ts-ignore
-  private _stackLength: number;
-  // @ts-ignore
-  private _selectionDepth: number;
-
-  // @ts-ignore
-  private _touchedFrame: number;
-  // @ts-ignore
-  private _visitedFrame: number;
-  private _selectedFrame: number;
-  // @ts-ignore
-  private _requestedFrame: number;
-
-  // @ts-ignore
-  private _priority: number;
+  private _visible: boolean | undefined = undefined;
 
   private _contentBoundingVolume: any;
   private _viewerRequestVolume: any;
 
-  _initialTransform: Matrix4;
+  _initialTransform: Matrix4 = new Matrix4();
+
+  // Used by traverser, cannot be marked private
+  _priority: number = 0;
+  _selectedFrame: number = 0;
+  _requestedFrame: number = 0;
+  _selectionDepth: number = 0;
+  _touchedFrame: number = 0;
+  _centerZDepth: number = 0;
+  _shouldRefine: boolean = false;
+  _stackLength: number = 0;
+  _visitedFrame: number = 0;
+  _inRequestVolume: boolean = false;
+
+  // TODO i3s specific, needs to remove
+  // private _lodJudge: any = null;
 
   /**
    * @constructs
@@ -154,69 +162,12 @@ export class Tile3D {
     this.type = header.type;
     this.contentUrl = header.contentUrl;
 
-    // The error, in meters, introduced if this tile is rendered and its children are not.
-    this.lodMetricType = 'geometricError';
-    this.lodMetricValue = 0;
-
-    // Specifies the type of refine that is used when traversing this tile for rendering.
-    this.boundingVolume = null;
-
-    // The tile's content.  This represents the actual tile's payload,
-    // not the content's metadata in the tileset JSON file.
-    this.content = null;
-    this.contentState = TILE_CONTENT_STATE.UNLOADED;
-    this.gpuMemoryUsageInBytes = 0;
-
-    // The tile's children - an array of Tile3D objects.
-    this.children = [];
-
-    this.hasEmptyContent = false;
-    this.hasTilesetContent = false;
-
-    this.depth = 0;
-    this.viewportIds = [];
-
-    // Container to store application specific data
-    this.userData = {};
-    this.extensions = null;
-
-    // PRIVATE MEMBERS
-    this._priority = 0;
-    this._touchedFrame = 0;
-    this._visitedFrame = 0;
-    this._selectedFrame = 0;
-    this._requestedFrame = 0;
-    this._screenSpaceError = 0;
-
-    this._cacheNode = null;
-    this._frameNumber = null;
-    this._cacheNode = null;
-
-    this.traverser = new TilesetTraverser({});
-    this._shouldRefine = false;
-    this._distanceToCamera = 0;
-    this._centerZDepth = 0;
-    this._visible = undefined;
-    this._inRequestVolume = false;
-    this._stackLength = 0;
-    this._selectionDepth = 0;
-    this._initialTransform = new Matrix4();
-    this.transform = new Matrix4();
-
     this._initializeLodMetric(header);
     this._initializeTransforms(header);
     this._initializeBoundingVolumes(header);
     this._initializeContent(header);
     this._initializeRenderingState(header);
 
-    // TODO i3s specific, needs to remove
-    this._lodJudge = null;
-
-    // TODO Cesium 3d tiles specific
-    this._expireDate = null;
-    this._expiredContent = null;
-    this.implicitTiling = null;
-
     Object.seal(this);
   }
 
@@ -341,6 +292,13 @@ export class Tile3D {
     this._selectedFrame = 0;
   }
 
+  /**
+   * Memory usage of tile on GPU
+   */
+  _getGpuMemoryUsageInBytes(): number {
+    return this.content.gpuMemoryUsageInBytes || this.content.byteLength || 0;
+  }
+
   /*
    * If skipLevelOfDetail is off try to load child tiles as soon as possible so that their parent can refine sooner.
    * Tiles are prioritized by screen space error.
@@ -424,6 +382,7 @@ export class Tile3D {
       const options = {
         ...this.tileset.loadOptions,
         [loader.id]: {
+          // @ts-expect-error
           ...this.tileset.loadOptions[loader.id],
           isTileset: this.type === 'json',
           ...this._getLoaderSpecificOptions(loader.id)
@@ -734,6 +693,8 @@ export class Tile3D {
     // The content may be tileset json
     if (this._isTileset()) {
       this.hasTilesetContent = true;
+    } else {
+      this.gpuMemoryUsageInBytes = this._getGpuMemoryUsageInBytes();
     }
   }