@loaders.gl/tiles 4.4.2 → 5.0.0-alpha.1

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

@@ -0,0 +1,177 @@
+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.js";
+import { FrameState } from "../helpers/frame-state.js";
+import type { Viewport } from "../../types.js";
+import { Tile3D } from "./tile-3d.js";
+import { TILESET_TYPE } from "../../constants.js";
+import { TilesetTraverser } from "./tileset-traverser.js";
+import { TileContentLoadResult, TilesetContentFormats, TilesetJSON, Tileset3DSource } from "./tileset-source.js";
+export type { TilesetJSON } from "./tileset-source.js";
+export type Tileset3DProps = {
+    throttleRequests?: boolean;
+    maxRequests?: number;
+    loadOptions?: LoaderOptions;
+    loadTiles?: boolean;
+    basePath?: string;
+    maximumMemoryUsage?: number;
+    memoryCacheOverflow?: number;
+    maximumTilesSelected?: number;
+    debounceTime?: number;
+    description?: string;
+    attributions?: string[];
+    ellipsoid?: object;
+    modelMatrix?: Matrix4;
+    maximumScreenSpaceError?: number;
+    memoryAdjustedScreenSpaceError?: boolean;
+    viewportTraversersMap?: any;
+    updateTransforms?: boolean;
+    viewDistanceScale?: number;
+    onTileLoad?: (tile: Tile3D) => any;
+    onTileUnload?: (tile: Tile3D) => any;
+    onTileError?: (tile: Tile3D, message: string, url: string) => any;
+    /** Called when a format-specific source operation fails. */
+    onSourceError?: (error: Error, source: Tileset3DSource, tile?: Tile3D | null) => any;
+    /** Called when tileset initialization fails before traversal can begin. */
+    onTilesetError?: (error: Error, tileset: Tileset3D) => any;
+    contentLoader?: (tile: Tile3D) => Promise<void>;
+    onTraversalComplete?: (selectedTiles: Tile3D[]) => Tile3D[];
+    onUpdate?: () => void;
+};
+type Props = {
+    description: string;
+    ellipsoid: object;
+    modelMatrix: Matrix4;
+    throttleRequests: boolean;
+    maxRequests: number;
+    maximumMemoryUsage: number;
+    memoryCacheOverflow: number;
+    maximumTilesSelected: number;
+    debounceTime: number;
+    onTileLoad: (tile: Tile3D) => void;
+    onTileUnload: (tile: Tile3D) => void;
+    onTileError: (tile: Tile3D, message: string, url: string) => void;
+    onSourceError: (error: Error, source: Tileset3DSource, tile?: Tile3D | null) => void;
+    onTilesetError: (error: Error, tileset: Tileset3D) => void;
+    onTraversalComplete: (selectedTiles: Tile3D[]) => Tile3D[];
+    onUpdate: () => void;
+    maximumScreenSpaceError: number;
+    memoryAdjustedScreenSpaceError: boolean;
+    viewportTraversersMap: Record<string, any> | null;
+    attributions: string[];
+    loadTiles: boolean;
+    loadOptions: LoaderOptions;
+    updateTransforms: boolean;
+    viewDistanceScale: number;
+    basePath: string;
+    contentLoader?: (tile: Tile3D) => Promise<void>;
+    i3s: Record<string, any>;
+};
+/**
+ * Shared runtime for tile traversal, selection, cache management, and request scheduling.
+ *
+ * Format-specific loading behavior is delegated to a {@link Tileset3DSource} implementation.
+ */
+export declare class Tileset3D {
+    options: Props;
+    loadOptions: LoaderOptions;
+    /** Source implementation responsible for format-specific initialization and loading. */
+    source: Tileset3DSource;
+    type: TILESET_TYPE;
+    tileset: TilesetJSON | null;
+    loader: LoaderWithParser;
+    url: string;
+    basePath: string;
+    modelMatrix: Matrix4;
+    ellipsoid: any;
+    lodMetricType: string;
+    lodMetricValue: number;
+    refine: string;
+    root: Tile3D | null;
+    roots: Record<string, Tile3D>;
+    asset: Record<string, any>;
+    description: string;
+    properties: any;
+    extras: any;
+    attributions: any;
+    credits: any;
+    stats: Stats;
+    contentFormats: TilesetContentFormats;
+    cartographicCenter: Vector3 | null;
+    cartesianCenter: Vector3 | null;
+    zoom: number;
+    boundingVolume: any;
+    dynamicScreenSpaceErrorComputedDensity: number;
+    maximumMemoryUsage: number;
+    gpuMemoryUsageInBytes: number;
+    memoryAdjustedScreenSpaceError: number;
+    private _cacheBytes;
+    private _cacheOverflowBytes;
+    _frameNumber: number;
+    private _tiles;
+    private _pendingCount;
+    selectedTiles: Tile3D[];
+    traverseCounter: number;
+    geometricError: number;
+    private lastUpdatedVieports;
+    private _requestedTiles;
+    private _emptyTiles;
+    private frameStateData;
+    _traverser: TilesetTraverser;
+    _cache: TilesetCache;
+    _requestScheduler: RequestScheduler;
+    private _heldTiles;
+    private updatePromise;
+    tilesetInitializationPromise: Promise<void>;
+    /**
+     * Creates a tileset runtime from an explicit source implementation.
+     * @param source Source-backed tileset implementation.
+     * @param options Traversal and runtime options.
+     */
+    constructor(source: Tileset3DSource, options?: Tileset3DProps);
+    destroy(): void;
+    isLoaded(): boolean;
+    get tiles(): object[];
+    get frameNumber(): number;
+    get queryParams(): string;
+    setProps(props: Tileset3DProps): void;
+    getTileUrl(tilePath: string): string;
+    hasExtension(extensionName: string): boolean;
+    update(viewports?: Viewport[] | Viewport | null): void;
+    selectTiles(viewports?: Viewport[] | Viewport | null): Promise<number>;
+    adjustScreenSpaceError(): void;
+    private doUpdate;
+    _needTraverse(viewportId: string): boolean;
+    _onTraversalEnd(frameState: FrameState): void;
+    _updateTiles(): void;
+    _tilesChanged(oldSelectedTiles: Tile3D[], selectedTiles: Tile3D[]): boolean;
+    _loadTiles(): void;
+    _unloadTiles(): void;
+    _updateStats(): void;
+    _initializeTileSet(): Promise<void>;
+    _initializeStats(): void;
+    _initializeTileHeaders(tilesetJson: TilesetJSON, parentTileHeader?: Tile3D | null): Tile3D;
+    _initializeTraverser(): TilesetTraverser;
+    _destroyTileHeaders(parentTile: Tile3D): void;
+    _loadTile(tile: Tile3D): Promise<void>;
+    _onTileLoadError(tile: Tile3D, error: Error): void;
+    _onSourceError(error: Error, tile?: Tile3D | null): void;
+    _onTilesetError(error: Error): void;
+    _onTileLoad(tile: Tile3D, loadResult: TileContentLoadResult | null): void;
+    _onStartTileLoading(): void;
+    _onEndTileLoading(): void;
+    _addTileToCache(tile: Tile3D): void;
+    _updateCacheStats(tile: Tile3D): void;
+    _unloadTile(tile: Tile3D): void;
+    _destroy(): void;
+    _destroySubtree(tile: Tile3D): void;
+    _destroyTile(tile: Tile3D): void;
+    private _syncSourceState;
+    private _applyViewState;
+    /**
+     * Returns normalized source metadata when initialization has already populated it.
+     */
+    private _getSourceMetadata;
+}
+//# sourceMappingURL=tileset-3d.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tileset-3d.d.ts","sourceRoot":"","sources":["../../../src/tileset-3d/common/tileset-3d.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,OAAO,EAAE,OAAO,EAAC,MAAM,eAAe,CAAC;AAE/C,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAC,gBAAgB,EAAE,gBAAgB,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAC3F,OAAO,EAAC,YAAY,EAAC,2BAAwB;AAE7C,OAAO,EAAC,UAAU,EAAoC,kCAA+B;AAErF,OAAO,KAAK,EAAqB,QAAQ,EAAC,uBAAoB;AAC9D,OAAO,EAAC,MAAM,EAAC,qBAAkB;AACjC,OAAO,EAAC,YAAY,EAAC,2BAAwB;AAE7C,OAAO,EAAC,gBAAgB,EAAC,+BAA4B;AACrD,OAAO,EAEL,qBAAqB,EACrB,qBAAqB,EACrB,WAAW,EACX,eAAe,EAEhB,4BAAyB;AAE1B,YAAY,EAAC,WAAW,EAAC,4BAAyB;AAElD,MAAM,MAAM,cAAc,GAAG;IAC3B,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,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC,qBAAqB,CAAC,EAAE,GAAG,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,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,4DAA4D;IAC5D,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,GAAG,CAAC;IACrF,2EAA2E;IAC3E,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,KAAK,GAAG,CAAC;IAC3D,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;IAC5D,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB,CAAC;AAEF,KAAK,KAAK,GAAG;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAClE,aAAa,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IACrF,cAAc,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,KAAK,IAAI,CAAC;IAC3D,mBAAmB,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3D,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,uBAAuB,EAAE,MAAM,CAAC;IAChC,8BAA8B,EAAE,OAAO,CAAC;IACxC,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,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC1B,CAAC;AA4CF;;;;GAIG;AACH,qBAAa,SAAS;IACpB,OAAO,EAAE,KAAK,CAAC;IACf,WAAW,EAAE,aAAa,CAAC;IAC3B,wFAAwF;IACxF,MAAM,EAAE,eAAe,CAAC;IAExB,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,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,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IAEhC,WAAW,SAAM;IACjB,UAAU,EAAE,GAAG,CAAC;IAChB,MAAM,EAAE,GAAG,CAAQ;IACnB,YAAY,EAAE,GAAG,CAAM;IACvB,OAAO,EAAE,GAAG,CAAM;IAElB,KAAK,EAAE,KAAK,CAAC;IACb,cAAc,EAAE,qBAAqB,CAAC;IAEtC,kBAAkB,EAAE,OAAO,GAAG,IAAI,CAAQ;IAC1C,eAAe,EAAE,OAAO,GAAG,IAAI,CAAQ;IACvC,IAAI,SAAK;IACT,cAAc,EAAE,GAAG,CAAQ;IAE3B,sCAAsC,SAAO;IAE7C,kBAAkB,SAAM;IACxB,qBAAqB,SAAK;IAC1B,8BAA8B,SAAO;IAErC,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,mBAAmB,CAAK;IAEhC,YAAY,SAAK;IACjB,OAAO,CAAC,MAAM,CAA8B;IAC5C,OAAO,CAAC,aAAa,CAAK;IAE1B,aAAa,EAAE,MAAM,EAAE,CAAM;IAE7B,eAAe,SAAK;IACpB,cAAc,SAAK;IACnB,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;IAEpC,OAAO,CAAC,UAAU,CAA0B;IAC5C,OAAO,CAAC,aAAa,CAAgC;IACrD,4BAA4B,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;OAIG;gBACS,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc;IAqC7D,OAAO,IAAI,IAAI;IAIf,QAAQ,IAAI,OAAO;IAInB,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,WAAW,IAAI,MAAM,CAIxB;IAED,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAIrC,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIpC,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO;IAI5C,MAAM,CAAC,SAAS,GAAE,QAAQ,EAAE,GAAG,QAAQ,GAAG,IAAW,GAAG,IAAI;IAatD,WAAW,CAAC,SAAS,GAAE,QAAQ,EAAE,GAAG,QAAQ,GAAG,IAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBlF,sBAAsB,IAAI,IAAI;IAW9B,OAAO,CAAC,QAAQ;IAoChB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAQ1C,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IA4B7C,YAAY,IAAI,IAAI;IA0DpB,aAAa,CAAC,gBAAgB,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO;IAW3E,UAAU,IAAI,IAAI;IASlB,YAAY,IAAI,IAAI;IAIpB,YAAY,IAAI,IAAI;IAoBd,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IA8BzC,gBAAgB,IAAI,IAAI;IAcxB,sBAAsB,CAAC,WAAW,EAAE,WAAW,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM;IAI1F,oBAAoB,IAAI,gBAAgB;IAOxC,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAIvC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5C,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IASlD,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,GAAE,MAAM,GAAG,IAAW,GAAG,IAAI;IAI9D,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAInC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,GAAG,IAAI,GAAG,IAAI;IAsBzE,mBAAmB,IAAI,IAAI;IAK3B,iBAAiB,IAAI,IAAI;IAKzB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAInC,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAYrC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAW/B,QAAQ,IAAI,IAAI;IAmBhB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAenC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMhC,OAAO,CAAC,gBAAgB;IAoBxB,OAAO,CAAC,eAAe;IAgBvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;CAO3B"}