@loaders.gl/tiles 4.0.0-alpha.1 → 4.0.0-alpha.11

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

@@ -0,0 +1,264 @@
+import { Matrix4, Vector3 } from '@math.gl/core';
+import { Stats } from '@probe.gl/stats';
+import { RequestScheduler, LoaderWithParser, LoaderOptions } from '@loaders.gl/loader-utils';
+import { TilesetCache } from './tileset-cache';
+import { FrameState } from './helpers/frame-state';
+import type { Viewport } from '../types';
+import { Tile3D } from './tile-3d';
+import { TilesetTraverser } from './tileset-traverser';
+export type TilesetJSON = any;
+export type Tileset3DProps = {
+    throttleRequests?: boolean;
+    maxRequests?: number;
+    loadOptions?: LoaderOptions;
+    loadTiles?: boolean;
+    basePath?: string;
+    maximumMemoryUsage?: number;
+    maximumTilesSelected?: number;
+    debounceTime?: number;
+    description?: string;
+    attributions?: string[];
+    ellipsoid?: object;
+    modelMatrix?: Matrix4;
+    maximumScreenSpaceError?: number;
+    viewportTraversersMap?: any;
+    updateTransforms?: boolean;
+    viewDistanceScale?: number;
+    onTileLoad?: (tile: Tile3D) => any;
+    onTileUnload?: (tile: Tile3D) => any;
+    onTileError?: (tile: Tile3D, message: string, url: string) => any;
+    contentLoader?: (tile: Tile3D) => Promise<void>;
+    onTraversalComplete?: (selectedTiles: Tile3D[]) => Tile3D[];
+};
+type Props = {
+    description: string;
+    ellipsoid: object;
+    /** A 4x4 transformation matrix this transforms the entire tileset. */
+    modelMatrix: Matrix4;
+    /** Set to false to disable network request throttling */
+    throttleRequests: boolean;
+    /** Number of simultaneous requsts, if throttleRequests is true */
+    maxRequests: number;
+    maximumMemoryUsage: number;
+    /** Maximum number limit of tiles selected for show. 0 means no limit */
+    maximumTilesSelected: number;
+    /** Delay time before the tileset traversal. It prevents traversal requests spam.*/
+    debounceTime: number;
+    /** Callback. Indicates this a tile's content was loaded */
+    onTileLoad: (tile: Tile3D) => void;
+    /** Callback. Indicates this a tile's content was unloaded (cache full) */
+    onTileUnload: (tile: Tile3D) => void;
+    /** Callback. Indicates this a tile's content failed to load */
+    onTileError: (tile: Tile3D, message: string, url: string) => void;
+    /** Callback. Allows post-process selectedTiles right after traversal. */
+    onTraversalComplete: (selectedTiles: Tile3D[]) => Tile3D[];
+    /** The maximum screen space error used to drive level of detail refinement. */
+    maximumScreenSpaceError: number;
+    viewportTraversersMap: Record<string, any> | null;
+    attributions: string[];
+    loadTiles: boolean;
+    loadOptions: LoaderOptions;
+    updateTransforms: boolean;
+    /** View distance scale modifier */
+    viewDistanceScale: number;
+    basePath: string;
+    /** Optional async tile content loader */
+    contentLoader?: (tile: Tile3D) => Promise<void>;
+    /** @todo I3S specific knowledge should be moved to I3S module */
+    i3s: Record<string, any>;
+};
+/**
+ * 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
+*/
+export declare class Tileset3D {
+    options: Props;
+    loadOptions: LoaderOptions;
+    type: string;
+    tileset: TilesetJSON;
+    loader: LoaderWithParser;
+    url: string;
+    basePath: string;
+    modelMatrix: Matrix4;
+    ellipsoid: any;
+    lodMetricType: string;
+    lodMetricValue: number;
+    refine: string;
+    root: Tile3D | null;
+    roots: Record<string, Tile3D>;
+    /** @todo any->unknown */
+    asset: Record<string, any>;
+    description: string;
+    properties: any;
+    extras: any;
+    attributions: any;
+    credits: any;
+    stats: Stats;
+    /** flags that contain information about data types in nested tiles */
+    contentFormats: {
+        draco: boolean;
+        meshopt: boolean;
+        dds: boolean;
+        ktx2: boolean;
+    };
+    cartographicCenter: Vector3 | null;
+    cartesianCenter: Vector3 | null;
+    zoom: number;
+    boundingVolume: any;
+    /** Updated based on the camera position and direction */
+    dynamicScreenSpaceErrorComputedDensity: number;
+    /**
+     * The maximum amount of GPU memory (in MB) that may be used to cache tiles
+     * Tiles not in view are unloaded to enforce private
+     */
+    maximumMemoryUsage: number;
+    /** The total amount of GPU memory in bytes used by the tileset. */
+    gpuMemoryUsageInBytes: number;
+    /** Update tracker. increase in each update cycle. */
+    _frameNumber: number;
+    private _queryParams;
+    private _extensionsUsed;
+    private _tiles;
+    /** counter for tracking tiles requests */
+    private _pendingCount;
+    /** Hold traversal results */
+    selectedTiles: Tile3D[];
+    traverseCounter: number;
+    geometricError: number;
+    private lastUpdatedVieports;
+    private _requestedTiles;
+    private _emptyTiles;
+    private frameStateData;
+    _traverser: TilesetTraverser;
+    _cache: TilesetCache;
+    _requestScheduler: RequestScheduler;
+    private updatePromise;
+    tilesetInitializationPromise: Promise<void>;
+    /**
+     * Create a new Tileset3D
+     * @param json
+     * @param props
+     */
+    constructor(tileset: TilesetJSON, options?: Tileset3DProps);
+    /** Release resources */
+    destroy(): void;
+    /** Is the tileset loaded (update needs to have been called at least once) */
+    isLoaded(): boolean;
+    get tiles(): object[];
+    get frameNumber(): number;
+    get queryParams(): string;
+    setProps(props: Tileset3DProps): void;
+    /** @deprecated */
+    setOptions(options: Tileset3DProps): void;
+    /**
+     * Return a loadable tile url for a specific tile subpath
+     * @param tilePath a tile subpath
+     */
+    getTileUrl(tilePath: string): string;
+    hasExtension(extensionName: string): boolean;
+    /**
+     * Update visible tiles relying on a list of viewports
+     * @param viewports - list of viewports
+     * @deprecated
+     */
+    update(viewports?: Viewport[] | Viewport | null): void;
+    /**
+     * Update visible tiles relying on a list of viewports.
+     * Do it with debounce delay to prevent update spam
+     * @param viewports viewports
+     * @returns Promise of new frameNumber
+     */
+    selectTiles(viewports?: Viewport[] | Viewport | null): Promise<number>;
+    /**
+     * Update visible tiles relying on a list of viewports
+     * @param viewports viewports
+     */
+    private doUpdate;
+    /**
+     * Check if traversal is needed for particular viewport
+     * @param {string} viewportId - id of a viewport
+     * @return {boolean}
+     */
+    _needTraverse(viewportId: string): boolean;
+    /**
+     * The callback to post-process tiles after traversal procedure
+     * @param frameState - frame state for tile culling
+     */
+    _onTraversalEnd(frameState: FrameState): void;
+    /**
+     * Update tiles relying on data from all traversers
+     */
+    _updateTiles(): void;
+    _tilesChanged(oldSelectedTiles: Tile3D[], selectedTiles: Tile3D[]): boolean;
+    _loadTiles(): void;
+    _unloadTiles(): void;
+    _updateStats(): void;
+    _initializeTileSet(tilesetJson: TilesetJSON): Promise<void>;
+    /**
+     * Called during initialize Tileset to initialize the tileset's cartographic center (longitude, latitude) and zoom.
+     * These metrics help apps center view on tileset
+     * For I3S there is extent (<1.8 version) or fullExtent (>=1.8 version) to calculate view props
+     * @returns
+     */
+    private calculateViewPropsI3S;
+    /**
+     * Called during initialize Tileset to initialize the tileset's cartographic center (longitude, latitude) and zoom.
+     * These metrics help apps center view on tileset.
+     * For 3DTiles the root tile data is used to calculate view props.
+     * @returns
+     */
+    private calculateViewPropsTiles3D;
+    _initializeStats(): void;
+    _initializeTileHeaders(tilesetJson: TilesetJSON, parentTileHeader?: any): Tile3D;
+    _initializeTraverser(): TilesetTraverser;
+    _destroyTileHeaders(parentTile: Tile3D): void;
+    _loadTile(tile: Tile3D): Promise<void>;
+    _onTileLoadError(tile: Tile3D, error: Error): void;
+    _onTileLoad(tile: Tile3D, loaded: boolean): void;
+    /**
+     * Update information about data types in nested tiles
+     * @param tile instance of a nested Tile3D
+     */
+    private updateContentTypes;
+    _onStartTileLoading(): void;
+    _onEndTileLoading(): void;
+    _addTileToCache(tile: Tile3D): void;
+    _updateCacheStats(tile: any): void;
+    _unloadTile(tile: any): void;
+    _destroy(): void;
+    _destroySubtree(tile: any): void;
+    _destroyTile(tile: any): void;
+    _initializeTiles3DTileset(tilesetJson: any): void;
+    _initializeI3STileset(): void;
+}
+export {};
+//# sourceMappingURL=tileset-3d.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tileset-3d.d.ts","sourceRoot":"","sources":["../../src/tileset/tileset-3d.ts"],"names":[],"mappings":"AAKA,OAAO,EAAC,OAAO,EAAE,OAAO,EAAC,MAAM,eAAe,CAAC;AAE/C,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAC,gBAAgB,EAAQ,gBAAgB,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AACjG,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAC,UAAU,EAAoC,MAAM,uBAAuB,CAAC;AAGpF,OAAO,KAAK,EAAqB,QAAQ,EAAC,MAAM,UAAU,CAAC;AAC3D,OAAO,EAAC,MAAM,EAAC,MAAM,WAAW,CAAC;AAGjC,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AAMrD,MAAM,MAAM,WAAW,GAAG,GAAG,CAAC;AAqB9B,MAAM,MAAM,cAAc,GAAG;IAE3B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IAGtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAGxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IAGtB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,GAAG,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAG3B,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC;IACnC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC;IACrC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,GAAG,CAAC;IAClE,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,mBAAmB,CAAC,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;CAC7D,CAAC;AAEF,KAAK,KAAK,GAAG;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,WAAW,EAAE,OAAO,CAAC;IACrB,yDAAyD;IACzD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wEAAwE;IACxE,oBAAoB,EAAE,MAAM,CAAC;IAC7B,mFAAmF;IACnF,YAAY,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,0EAA0E;IAC1E,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,+DAA+D;IAC/D,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAClE,yEAAyE;IACzE,mBAAmB,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3D,+EAA+E;IAC/E,uBAAuB,EAAE,MAAM,CAAC;IAChC,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAClD,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,aAAa,CAAC;IAC3B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,mCAAmC;IACnC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,iEAAiE;IACjE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC1B,CAAC;AAuCF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgCE;AACF,qBAAa,SAAS;IAEpB,OAAO,EAAE,KAAK,CAAC;IACf,WAAW,EAAE,aAAa,CAAC;IAE3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,gBAAgB,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,GAAG,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IACnC,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IAGhC,WAAW,EAAE,MAAM,CAAM;IACzB,UAAU,EAAE,GAAG,CAAC;IAEhB,MAAM,EAAE,GAAG,CAAQ;IACnB,YAAY,EAAE,GAAG,CAAM;IACvB,OAAO,EAAE,GAAG,CAAM;IAElB,KAAK,EAAE,KAAK,CAAC;IAEb,sEAAsE;IACtE,cAAc;;;;;MAA2D;IAGzE,kBAAkB,EAAE,OAAO,GAAG,IAAI,CAAQ;IAC1C,eAAe,EAAE,OAAO,GAAG,IAAI,CAAQ;IACvC,IAAI,EAAE,MAAM,CAAK;IACjB,cAAc,EAAE,GAAG,CAAQ;IAE3B,yDAAyD;IACzD,sCAAsC,EAAE,MAAM,CAAO;IAIrD;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAM;IAEhC,mEAAmE;IACnE,qBAAqB,EAAE,MAAM,CAAK;IAElC,qDAAqD;IACrD,YAAY,EAAE,MAAM,CAAK;IACzB,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,eAAe,CAAgB;IACvC,OAAO,CAAC,MAAM,CAA8B;IAE5C,0CAA0C;IAC1C,OAAO,CAAC,aAAa,CAAa;IAElC,6BAA6B;IAC7B,aAAa,EAAE,MAAM,EAAE,CAAM;IAG7B,eAAe,EAAE,MAAM,CAAK;IAC5B,cAAc,EAAE,MAAM,CAAK;IAC3B,OAAO,CAAC,mBAAmB,CAAsC;IACjE,OAAO,CAAC,eAAe,CAAgB;IACvC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,cAAc,CAAW;IAEjC,UAAU,EAAE,gBAAgB,CAAC;IAC7B,MAAM,eAAsB;IAC5B,iBAAiB,EAAE,gBAAgB,CAAC;IAGpC,OAAO,CAAC,aAAa,CAAgC;IACrD,4BAA4B,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;OAIG;gBAES,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc;IAoC1D,wBAAwB;IACxB,OAAO,IAAI,IAAI;IAIf,6EAA6E;IAC7E,QAAQ,IAAI,OAAO;IAKnB,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAIrC,kBAAkB;IAClB,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAIzC;;;OAGG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IASpC,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO;IAI5C;;;;OAIG;IACH,MAAM,CAAC,SAAS,GAAE,QAAQ,EAAE,GAAG,QAAQ,GAAG,IAAW;IAcrD;;;;;OAKG;IACG,WAAW,CAAC,SAAS,GAAE,QAAQ,EAAE,GAAG,QAAQ,GAAG,IAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBlF;;;OAGG;IAEH,OAAO,CAAC,QAAQ;IAsChB;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAY1C;;;OAGG;IACH,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IA4B7C;;OAEG;IACH,YAAY,IAAI,IAAI;IAuBpB,aAAa,CAAC,gBAAgB,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO;IAW3E,UAAU,IAAI,IAAI;IAYlB,YAAY,IAAI,IAAI;IAKpB,YAAY,IAAI,IAAI;IAoBd,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBjE;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAoC7B;;;;;OAKG;IACH,OAAO,CAAC,yBAAyB;IAsBjC,gBAAgB;IAehB,sBAAsB,CAAC,WAAW,EAAE,WAAW,EAAE,gBAAgB,CAAC,EAAE,GAAG;IA4CvE,oBAAoB,IAAI,gBAAgB;IAoBxC,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAIvC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAa5C,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAUlD,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAsBhD;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA4B1B,mBAAmB;IAKnB,iBAAiB;IAKjB,eAAe,CAAC,IAAI,EAAE,MAAM;IAI5B,iBAAiB,CAAC,IAAI,KAAA;IAStB,WAAW,CAAC,IAAI,KAAA;IAYhB,QAAQ;IAoBR,eAAe,CAAC,IAAI,KAAA;IAgBpB,YAAY,CAAC,IAAI,KAAA;IAMjB,yBAAyB,CAAC,WAAW,KAAA;IAuCrC,qBAAqB;CAMtB"}