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

package/dist/tileset/helpers/zoom.js

@@ -1,36 +1,89 @@
-import { Vector3 } from '@math.gl/core';
+"use strict";
+// loaders.gl, MIT license
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getZoomFromExtent = exports.getZoomFromFullExtent = exports.getZoomFromBoundingVolume = void 0;
+const core_1 = require("@math.gl/core");
+const culling_1 = require("@math.gl/culling");
+const geospatial_1 = require("@math.gl/geospatial");
 const WGS84_RADIUS_X = 6378137.0;
 const WGS84_RADIUS_Y = 6378137.0;
 const WGS84_RADIUS_Z = 6356752.3142451793;
-const scratchVector = new Vector3();
-export function getZoomFromBoundingVolume(boundingVolume) {
-  const {
-    halfAxes,
-    radius,
-    width,
-    height
-  } = boundingVolume;
-
-  if (halfAxes) {
-    const obbSize = getObbSize(halfAxes);
-    return Math.log2(WGS84_RADIUS_Z / obbSize);
-  } else if (radius) {
-    return Math.log2(WGS84_RADIUS_Z / radius);
-  } else if (height && width) {
-    const zoomX = Math.log2(WGS84_RADIUS_X / width);
-    const zoomY = Math.log2(WGS84_RADIUS_Y / height);
-    return (zoomX + zoomY) / 2;
-  }
-
-  return 1;
+const scratchVector = new core_1.Vector3();
+/**
+ * Calculate appropriate zoom value for a particular boundingVolume
+ * @param boundingVolume - the instance of bounding volume
+ * @param cartorgraphicCenter - cartographic center of the bounding volume
+ * @returns {number} - zoom value
+ */
+function getZoomFromBoundingVolume(boundingVolume, cartorgraphicCenter) {
+    if (boundingVolume instanceof culling_1.OrientedBoundingBox) {
+        // OrientedBoundingBox
+        const { halfAxes } = boundingVolume;
+        const obbSize = getObbSize(halfAxes);
+        // Use WGS84_RADIUS_Z to allign with BoundingSphere algorithm
+        // Add the tile elevation value for correct zooming to elevated tiles
+        return Math.log2(WGS84_RADIUS_Z / (obbSize + cartorgraphicCenter[2]));
+    }
+    else if (boundingVolume instanceof culling_1.BoundingSphere) {
+        // BoundingSphere
+        const { radius } = boundingVolume;
+        // Add the tile elevation value for correct zooming to elevated tiles
+        return Math.log2(WGS84_RADIUS_Z / (radius + cartorgraphicCenter[2]));
+    }
+    else if (boundingVolume.width && boundingVolume.height) {
+        // BoundingRectangle
+        const { width, height } = boundingVolume;
+        const zoomX = Math.log2(WGS84_RADIUS_X / width);
+        const zoomY = Math.log2(WGS84_RADIUS_Y / height);
+        return (zoomX + zoomY) / 2;
+    }
+    return 1;
 }
-
+exports.getZoomFromBoundingVolume = getZoomFromBoundingVolume;
+/**
+ * Calculate initial zoom for the tileset from 3D `fullExtent` defined in
+ * the tileset metadata
+ * @param fullExtent - 3D extent of the tileset
+ * @param fullExtent.xmin - minimal longitude in decimal degrees
+ * @param fullExtent.xmax - maximal longitude in decimal degrees
+ * @param fullExtent.ymin - minimal latitude in decimal degrees
+ * @param fullExtent.ymax - maximal latitude in decimal degrees
+ * @param fullExtent.zmin - minimal elevation in meters
+ * @param fullExtent.zmax - maximal elevation in meters
+ * @param cartorgraphicCenter - tileset center in cartographic coordinate system
+ * @param cartesianCenter - tileset center in cartesian coordinate system
+ * @returns - initial zoom for the tileset
+ */
+function getZoomFromFullExtent(fullExtent, cartorgraphicCenter, cartesianCenter) {
+    const extentVertex = geospatial_1.Ellipsoid.WGS84.cartographicToCartesian([fullExtent.xmax, fullExtent.ymax, fullExtent.zmax], new core_1.Vector3());
+    const extentSize = Math.sqrt(Math.pow(extentVertex[0] - cartesianCenter[0], 2) +
+        Math.pow(extentVertex[1] - cartesianCenter[1], 2) +
+        Math.pow(extentVertex[2] - cartesianCenter[2], 2));
+    return Math.log2(WGS84_RADIUS_Z / (extentSize + cartorgraphicCenter[2]));
+}
+exports.getZoomFromFullExtent = getZoomFromFullExtent;
+/**
+ * Calculate initial zoom for the tileset from 2D `extent` defined in
+ * the tileset metadata
+ * @param extent - 2D extent of the tileset. It is array of 4 elements [xmin, ymin, xmax, ymax]
+ * @param extent[0] - minimal longitude in decimal degrees
+ * @param extent[1] - minimal latitude in decimal degrees
+ * @param extent[2] - maximal longitude in decimal degrees
+ * @param extent[3] - maximal latitude in decimal degrees
+ * @param cartorgraphicCenter - tileset center in cartographic coordinate system
+ * @param cartesianCenter - tileset center in cartesian coordinate system
+ * @returns - initial zoom for the tileset
+ */
+function getZoomFromExtent(extent, cartorgraphicCenter, cartesianCenter) {
+    const [xmin, ymin, xmax, ymax] = extent;
+    return getZoomFromFullExtent({ xmin, xmax, ymin, ymax, zmin: 0, zmax: 0 }, cartorgraphicCenter, cartesianCenter);
+}
+exports.getZoomFromExtent = getZoomFromExtent;
 function getObbSize(halfAxes) {
-  halfAxes.getColumn(0, scratchVector);
-  const axeY = halfAxes.getColumn(1);
-  const axeZ = halfAxes.getColumn(2);
-  const farthestVertex = scratchVector.add(axeY).add(axeZ);
-  const size = farthestVertex.len();
-  return size;
+    halfAxes.getColumn(0, scratchVector);
+    const axeY = halfAxes.getColumn(1);
+    const axeZ = halfAxes.getColumn(2);
+    const farthestVertex = scratchVector.add(axeY).add(axeZ);
+    const size = farthestVertex.len();
+    return size;
 }
-//# sourceMappingURL=zoom.js.map

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

@@ -0,0 +1,222 @@
+import { Matrix4 } from '@math.gl/core';
+import type { Tileset3D } from './tileset-3d';
+import type { DoublyLinkedListNode } from '../utils/doubly-linked-list-node';
+import { FrameState } from './helpers/frame-state';
+import { CartographicBounds } from './helpers/bounding-volume';
+import { TilesetTraverser } from './tileset-traverser';
+/**
+ * @param tileset - Tileset3D instance
+ * @param header - tile header - JSON loaded from a dataset
+ * @param parentHeader - parent Tile3D instance
+ * @param extendedId - optional ID to separate copies of a tile for different viewports.
+ *                              const extendedId = `${tile.id}-${frameState.viewport.id}`;
+ */
+export type Tile3DProps = {
+    tileset: Tileset3D;
+    header: Object;
+    parentHeader: Tile3D;
+    extendedId: string;
+};
+/**
+ * A Tile3DHeader represents a tile as Tileset3D. When a tile is first created, its content is not loaded;
+ * the content is loaded on-demand when needed based on the view.
+ * Do not construct this directly, instead access tiles through {@link Tileset3D#tileVisible}.
+ */
+export declare class Tile3D {
+    tileset: Tileset3D;
+    header: any;
+    id: string;
+    url: string;
+    parent: Tile3D;
+    refine: number;
+    type: string;
+    contentUrl: string;
+    /** Different refinement algorithms used by I3S and 3D tiles */
+    lodMetricType: 'geometricError' | 'maxScreenThreshold';
+    /** The error, in meters, introduced if this tile is rendered and its children are not. */
+    lodMetricValue: number;
+    /** @todo math.gl is not exporting BoundingVolume base type? */
+    boundingVolume: any;
+    /**
+     * The tile's content.  This represents the actual tile's payload,
+     * not the content's metadata in the tileset JSON file.
+     */
+    content: any;
+    contentState: number;
+    gpuMemoryUsageInBytes: number;
+    /** The tile's children - an array of Tile3D objects. */
+    children: Tile3D[];
+    depth: number;
+    viewportIds: any[];
+    transform: Matrix4;
+    extensions: any;
+    /** TODO Cesium 3d tiles specific */
+    implicitTiling?: any;
+    /** Container to store application specific data */
+    userData: Record<string, any>;
+    computedTransform: any;
+    hasEmptyContent: boolean;
+    hasTilesetContent: boolean;
+    traverser: TilesetTraverser;
+    /** Used by TilesetCache */
+    _cacheNode: DoublyLinkedListNode | null;
+    private _frameNumber;
+    private _expireDate;
+    private _expiredContent;
+    private _boundingBox?;
+    /** updated every frame for tree traversal and rendering optimizations: */
+    _distanceToCamera: number;
+    _screenSpaceError: number;
+    private _visibilityPlaneMask;
+    private _visible;
+    private _contentBoundingVolume;
+    private _viewerRequestVolume;
+    _initialTransform: Matrix4;
+    _priority: number;
+    _selectedFrame: number;
+    _requestedFrame: number;
+    _selectionDepth: number;
+    _touchedFrame: number;
+    _centerZDepth: number;
+    _shouldRefine: boolean;
+    _stackLength: number;
+    _visitedFrame: number;
+    _inRequestVolume: boolean;
+    _lodJudge: any;
+    /**
+     * @constructs
+     * Create a Tile3D instance
+     * @param tileset - Tileset3D instance
+     * @param header - tile header - JSON loaded from a dataset
+     * @param parentHeader - parent Tile3D instance
+     * @param extendedId - optional ID to separate copies of a tile for different viewports.
+     *    const extendedId = `${tile.id}-${frameState.viewport.id}`;
+     */
+    constructor(tileset: Tileset3D, header: {
+        [key: string]: any;
+    }, parentHeader?: Tile3D, extendedId?: string);
+    destroy(): void;
+    isDestroyed(): boolean;
+    get selected(): boolean;
+    get isVisible(): boolean | undefined;
+    get isVisibleAndInRequestVolume(): boolean | undefined;
+    /** Returns true if tile is not an empty tile and not an external tileset */
+    get hasRenderContent(): boolean;
+    /** Returns true if tile has children */
+    get hasChildren(): any;
+    /**
+     * Determines if the tile's content is ready. This is automatically `true` for
+     * tiles with empty content.
+     */
+    get contentReady(): boolean;
+    /**
+     * Determines if the tile has available content to render.  `true` if the tile's
+     * content is ready or if it has expired content this renders while new content loads; otherwise,
+     */
+    get contentAvailable(): boolean;
+    /** Returns true if tile has renderable content but it's unloaded */
+    get hasUnloadedContent(): boolean;
+    /**
+     * Determines if the tile's content has not be requested. `true` if tile's
+     * content has not be requested; otherwise, `false`.
+     */
+    get contentUnloaded(): boolean;
+    /**
+     * Determines if the tile's content is expired. `true` if tile's
+     * content is expired; otherwise, `false`.
+     */
+    get contentExpired(): boolean;
+    get contentFailed(): boolean;
+    /**
+     * Distance from the tile's bounding volume center to the camera
+     */
+    get distanceToCamera(): number;
+    /**
+     * Screen space error for LOD selection
+     */
+    get screenSpaceError(): number;
+    /**
+     * Get bounding box in cartographic coordinates
+     * @returns [min, max] each in [longitude, latitude, altitude]
+     */
+    get boundingBox(): CartographicBounds;
+    /** Get the tile's screen space error. */
+    getScreenSpaceError(frameState: any, useParentLodMetric: any): number;
+    /**
+     * Make tile unselected than means it won't be shown
+     * but it can be still loaded in memory
+     */
+    unselect(): void;
+    /**
+     * Memory usage of tile on GPU
+     */
+    _getGpuMemoryUsageInBytes(): number;
+    _getPriority(): number;
+    /**
+     *  Requests the tile's content.
+     * The request may not be made if the Request Scheduler can't prioritize it.
+     */
+    loadContent(): Promise<boolean>;
+    unloadContent(): boolean;
+    /**
+     * Update the tile's visibility
+     * @param {Object} frameState - frame state for tile culling
+     * @param {string[]} viewportIds - a list of viewport ids that show this tile
+     * @return {void}
+     */
+    updateVisibility(frameState: any, viewportIds: any): void;
+    visibility(frameState: any, parentVisibilityPlaneMask: any): any;
+    contentVisibility(): boolean;
+    /**
+     * Computes the (potentially approximate) distance from the closest point of the tile's bounding volume to the camera.
+     * @param frameState The frame state.
+     * @returns {Number} The distance, in meters, or zero if the camera is inside the bounding volume.
+     */
+    distanceToTile(frameState: FrameState): number;
+    /**
+     * Computes the tile's camera-space z-depth.
+     * @param frameState The frame state.
+     * @returns The distance, in meters.
+     */
+    cameraSpaceZDepth({ camera }: {
+        camera: any;
+    }): number;
+    /**
+     * Checks if the camera is inside the viewer request volume.
+     * @param {FrameState} frameState The frame state.
+     * @returns {Boolean} Whether the camera is inside the volume.
+     */
+    insideViewerRequestVolume(frameState: FrameState): boolean;
+    updateExpiration(): void;
+    get extras(): any;
+    _initializeLodMetric(header: any): void;
+    _initializeTransforms(tileHeader: any): void;
+    _initializeBoundingVolumes(tileHeader: any): void;
+    _initializeContent(tileHeader: any): void;
+    _initializeRenderingState(header: any): void;
+    _getRefine(refine: any): any;
+    _isTileset(): boolean;
+    _onContentLoaded(): void;
+    _updateBoundingVolume(header: any): void;
+    _updateTransform(parentTransform?: Matrix4): void;
+    _getLoaderSpecificOptions(loaderId: any): {
+        assetGltfUpAxis: "X" | "Y" | "Z";
+    } | {
+        _tileOptions: {
+            attributeUrls: any;
+            textureUrl: any;
+            textureFormat: any;
+            textureLoaderOptions: any;
+            materialDefinition: any;
+            isDracoGeometry: any;
+            mbs: any;
+        };
+        _tilesetOptions: {
+            store: any;
+            attributeStorageInfo: any;
+            fields: any;
+        };
+        isTileHeader: boolean;
+    };
+}
+//# sourceMappingURL=tile-3d.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tile-3d.d.ts","sourceRoot":"","sources":["../../src/tileset/tile-3d.ts"],"names":[],"mappings":"AAKA,OAAO,EAAU,OAAO,EAAC,MAAM,eAAe,CAAC;AAM/C,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,kCAAkC,CAAC;AAG3E,OAAO,EAAC,UAAU,EAAC,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAGL,kBAAkB,EACnB,MAAM,2BAA2B,CAAC;AAInC,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AAQrD;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,MAAM;IACjB,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,GAAG,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,aAAa,EAAE,gBAAgB,GAAG,oBAAoB,CAAoB;IAC1E,0FAA0F;IAC1F,cAAc,EAAE,MAAM,CAAK;IAE3B,+DAA+D;IAC/D,cAAc,EAAE,GAAG,CAAQ;IAE3B;;;OAGG;IACH,OAAO,EAAE,GAAG,CAAQ;IACpB,YAAY,EAAE,MAAM,CAA+B;IACnD,qBAAqB,EAAE,MAAM,CAAK;IAElC,wDAAwD;IACxD,QAAQ,EAAE,MAAM,EAAE,CAAM;IACxB,KAAK,EAAE,MAAM,CAAK;IAClB,WAAW,EAAE,GAAG,EAAE,CAAM;IACxB,SAAS,UAAiB;IAC1B,UAAU,EAAE,GAAG,CAAQ;IACvB,oCAAoC;IACpC,cAAc,CAAC,EAAE,GAAG,CAAQ;IAE5B,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;IAEnC,iBAAiB,EAAE,GAAG,CAAC;IACvB,eAAe,EAAE,OAAO,CAAS;IACjC,iBAAiB,EAAE,OAAO,CAAS;IAEnC,SAAS,mBAA4B;IAErC,2BAA2B;IAC3B,UAAU,EAAE,oBAAoB,GAAG,IAAI,CAAQ;IAE/C,OAAO,CAAC,YAAY,CAAa;IAGjC,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,eAAe,CAAa;IAEpC,OAAO,CAAC,YAAY,CAAC,CAAqB;IAE1C,0EAA0E;IACnE,iBAAiB,EAAE,MAAM,CAAK;IACrC,iBAAiB,EAAE,MAAM,CAAK;IAC9B,OAAO,CAAC,oBAAoB,CAAM;IAClC,OAAO,CAAC,QAAQ,CAAkC;IAElD,OAAO,CAAC,sBAAsB,CAAM;IACpC,OAAO,CAAC,oBAAoB,CAAM;IAElC,iBAAiB,EAAE,OAAO,CAAiB;IAG3C,SAAS,EAAE,MAAM,CAAK;IACtB,cAAc,EAAE,MAAM,CAAK;IAC3B,eAAe,EAAE,MAAM,CAAK;IAC5B,eAAe,EAAE,MAAM,CAAK;IAC5B,aAAa,EAAE,MAAM,CAAK;IAC1B,aAAa,EAAE,MAAM,CAAK;IAC1B,aAAa,EAAE,OAAO,CAAS;IAC/B,YAAY,EAAE,MAAM,CAAK;IACzB,aAAa,EAAE,MAAM,CAAK;IAC1B,gBAAgB,EAAE,OAAO,CAAS;IAClC,SAAS,EAAE,GAAG,CAAQ;IAEtB;;;;;;;;OAQG;gBAGD,OAAO,EAAE,SAAS,EAClB,MAAM,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EAC5B,YAAY,CAAC,EAAE,MAAM,EACrB,UAAU,SAAK;IA2BjB,OAAO;IAIP,WAAW;IAIX,IAAI,QAAQ,YAEX;IAED,IAAI,SAAS,wBAEZ;IAED,IAAI,2BAA2B,wBAE9B;IAED,4EAA4E;IAC5E,IAAI,gBAAgB,YAEnB;IAED,wCAAwC;IACxC,IAAI,WAAW,QAEd;IAED;;;OAGG;IACH,IAAI,YAAY,YAEf;IAED;;;OAGG;IACH,IAAI,gBAAgB,YAInB;IAED,oEAAoE;IACpE,IAAI,kBAAkB,YAErB;IAED;;;OAGG;IACH,IAAI,eAAe,YAElB;IAED;;;OAGG;IACH,IAAI,cAAc,YAEjB;IAID,IAAI,aAAa,YAEhB;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,kBAAkB,CAKpC;IAED,yCAAyC;IACzC,mBAAmB,CAAC,UAAU,KAAA,EAAE,kBAAkB,KAAA;IAYlD;;;OAGG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,yBAAyB,IAAI,MAAM;IASnC,YAAY;IAsCZ;;;OAGG;IAEG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAoErC,aAAa;IAab;;;;;OAKG;IACH,gBAAgB,CAAC,UAAU,KAAA,EAAE,WAAW,KAAA;IA+BxC,UAAU,CAAC,UAAU,KAAA,EAAE,yBAAyB,KAAA;IAyBhD,iBAAiB;IAuCjB;;;;OAIG;IACH,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;IAK9C;;;;OAIG;IACH,iBAAiB,CAAC,EAAC,MAAM,EAAC;;KAAA,GAAG,MAAM;IAMnC;;;;OAIG;IACH,yBAAyB,CAAC,UAAU,EAAE,UAAU;IAUhD,gBAAgB;IAWhB,IAAI,MAAM,QAET;IAID,oBAAoB,CAAC,MAAM,KAAA;IAsB3B,qBAAqB,CAAC,UAAU,KAAA;IAkBhC,0BAA0B,CAAC,UAAU,KAAA;IAOrC,kBAAkB,CAAC,UAAU,KAAA;IAiB7B,yBAAyB,CAAC,MAAM,KAAA;IAwBhC,UAAU,CAAC,MAAM,KAAA;IAKjB,UAAU;IAIV,gBAAgB;IAmBhB,qBAAqB,CAAC,MAAM,KAAA;IAoC5B,gBAAgB,CAAC,eAAe,UAAgB;IAchD,yBAAyB,CAAC,QAAQ,KAAA;;;;;;;;;;;;;;;;;;;CA2BnC"}