@deck.gl/geo-layers 8.8.0-alpha.5 → 8.8.0-beta.2

package/typed/s2-layer/s2-utils.js

@@ -0,0 +1,88 @@
+// s2-geometry is a pure JavaScript port of Google/Niantic's S2 Geometry library
+// which is perfect since it works in the browser.
+import { toHilbertQuadkey, FromHilbertQuadKey, IJToST, STToUV, FaceUVToXYZ, XYZToLngLat } from './s2-geometry';
+import Long from 'long';
+/**
+ * Given an S2 token this function convert the token to 64 bit id
+   https://github.com/google/s2-geometry-library-java/blob/c04b68bf3197a9c34082327eeb3aec7ab7c85da1/src/com/google/common/geometry/S2CellId.java#L439
+ * */
+function getIdFromToken(token) {
+    // pad token with zeros to make the length 16
+    const paddedToken = token.padEnd(16, '0');
+    return Long.fromString(paddedToken, 16);
+}
+const MAX_RESOLUTION = 100;
+/* Adapted from s2-geometry's S2Cell.getCornerLatLngs */
+/* eslint-disable max-statements */
+function getGeoBounds({ face, ij, level }) {
+    const offsets = [
+        [0, 0],
+        [0, 1],
+        [1, 1],
+        [1, 0],
+        [0, 0]
+    ];
+    // The S2 cell edge is curved: http://s2geometry.io/
+    // This is more prominent at lower levels
+    // resolution is the number of segments to generate per edge.
+    // We exponentially reduce resolution as level increases so it doesn't affect perf
+    // when there are a large number of cells
+    const resolution = Math.max(1, Math.ceil(MAX_RESOLUTION * Math.pow(2, -level)));
+    const result = new Float64Array(4 * resolution * 2 + 2);
+    let ptIndex = 0;
+    let prevLng = 0;
+    for (let i = 0; i < 4; i++) {
+        const offset = offsets[i].slice(0);
+        const nextOffset = offsets[i + 1];
+        const stepI = (nextOffset[0] - offset[0]) / resolution;
+        const stepJ = (nextOffset[1] - offset[1]) / resolution;
+        for (let j = 0; j < resolution; j++) {
+            offset[0] += stepI;
+            offset[1] += stepJ;
+            // Cell can be represented by coordinates IJ, ST, UV, XYZ
+            // http://s2geometry.io/devguide/s2cell_hierarchy#coordinate-systems
+            const st = IJToST(ij, level, offset);
+            const uv = STToUV(st);
+            const xyz = FaceUVToXYZ(face, uv);
+            const lngLat = XYZToLngLat(xyz);
+            // Adjust longitude for Web Mercator projection
+            if (Math.abs(lngLat[1]) > 89.999) {
+                lngLat[0] = prevLng;
+            }
+            const deltaLng = lngLat[0] - prevLng;
+            lngLat[0] += deltaLng > 180 ? -360 : deltaLng < -180 ? 360 : 0;
+            result[ptIndex++] = lngLat[0];
+            result[ptIndex++] = lngLat[1];
+            prevLng = lngLat[0];
+        }
+    }
+    // close the loop
+    result[ptIndex++] = result[0];
+    result[ptIndex++] = result[1];
+    return result;
+}
+/* eslint-enable max-statements */
+export function getS2QuadKey(token) {
+    if (typeof token === 'string') {
+        if (token.indexOf('/') > 0) {
+            // is Hilbert quad key
+            return token;
+        }
+        // is S2 token
+        token = getIdFromToken(token);
+    }
+    // is Long id
+    return toHilbertQuadkey(token.toString());
+}
+/**
+ * Get a polygon with corner coordinates for an s2 cell
+ * @param {*} cell - This can be an S2 key or token
+ * @return {Array} - a simple polygon in array format: [[lng, lat], ...]
+ *   - each coordinate is an array [lng, lat]
+ *   - the polygon is closed, i.e. last coordinate is a copy of the first coordinate
+ */
+export function getS2Polygon(token) {
+    const key = getS2QuadKey(token);
+    const s2cell = FromHilbertQuadKey(key);
+    return getGeoBounds(s2cell);
+}

package/typed/terrain-layer/terrain-layer.d.ts

@@ -0,0 +1,28 @@
+/**
+ * state: {
+ *   isTiled: True renders TileLayer of many SimpleMeshLayers, false renders one SimpleMeshLayer
+ *   terrain: Mesh object. Only defined when isTiled is false.
+ * }
+ */
+declare class TerrainLayer extends CompositeLayer<any> {
+    constructor(...propObjects: Partial<any>[]);
+    loadTerrain({ elevationData, bounds, elevationDecoder, meshMaxError, signal }: {
+        elevationData: any;
+        bounds: any;
+        elevationDecoder: any;
+        meshMaxError: any;
+        signal: any;
+    }): any;
+    getTiledTerrainData(tile: any): Promise<[any, any]>;
+    renderSubLayers(props: any): SimpleMeshLayer<any, {}> | null;
+    onViewportLoad(tiles: any): void;
+}
+declare namespace TerrainLayer {
+    export const layerName: string;
+    export { defaultProps };
+}
+export default TerrainLayer;
+import { CompositeLayer } from '@deck.gl/core/typed';
+import { SimpleMeshLayer } from '@deck.gl/mesh-layers/typed';
+declare const defaultProps: any;
+//# sourceMappingURL=terrain-layer.d.ts.map

package/typed/terrain-layer/terrain-layer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"terrain-layer.d.ts","sourceRoot":"","sources":["../../src/terrain-layer/terrain-layer.js"],"names":[],"mappings":"AAoEA;;;;;GAKG;AACH;IAjEmE,4CAC1B;IA8FvC;;;;;;YAiBC;IAED,oDA4BC;IAED,6DAmBC;IAGD,iCAsBC;CA6EF;;;;;;;;AArPD,gCA6BE"}

package/typed/terrain-layer/terrain-layer.js

@@ -0,0 +1,226 @@
+// Copyright (c) 2015 - 2017 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+import { CompositeLayer, log } from '@deck.gl/core';
+import { SimpleMeshLayer } from '@deck.gl/mesh-layers';
+import { COORDINATE_SYSTEM } from '@deck.gl/core';
+import { TerrainWorkerLoader } from '@loaders.gl/terrain';
+import TileLayer from '../tile-layer/tile-layer';
+import { urlType, getURLFromTemplate } from '../tile-layer/utils';
+const DUMMY_DATA = [1];
+const defaultProps = {
+    ...TileLayer.defaultProps,
+    // Image url that encodes height data
+    elevationData: urlType,
+    // Image url to use as texture
+    texture: { ...urlType, optional: true },
+    // Martini error tolerance in meters, smaller number -> more detailed mesh
+    meshMaxError: { type: 'number', value: 4.0 },
+    // Bounding box of the terrain image, [minX, minY, maxX, maxY] in world coordinates
+    bounds: { type: 'array', value: null, optional: true, compare: true },
+    // Color to use if texture is unavailable
+    color: { type: 'color', value: [255, 255, 255] },
+    // Object to decode height data, from (r, g, b) to height in meters
+    elevationDecoder: {
+        type: 'object',
+        value: {
+            rScaler: 1,
+            gScaler: 0,
+            bScaler: 0,
+            offset: 0
+        }
+    },
+    // Supply url to local terrain worker bundle. Only required if running offline and cannot access CDN.
+    workerUrl: { type: 'string', value: null },
+    // Same as SimpleMeshLayer wireframe
+    wireframe: false,
+    material: true,
+    loaders: [TerrainWorkerLoader]
+};
+// Turns array of templates into a single string to work around shallow change
+function urlTemplateToUpdateTrigger(template) {
+    if (Array.isArray(template)) {
+        return template.join(';');
+    }
+    return template;
+}
+/**
+ * state: {
+ *   isTiled: True renders TileLayer of many SimpleMeshLayers, false renders one SimpleMeshLayer
+ *   terrain: Mesh object. Only defined when isTiled is false.
+ * }
+ */
+export default class TerrainLayer extends CompositeLayer {
+    updateState({ props, oldProps }) {
+        const elevationDataChanged = props.elevationData !== oldProps.elevationData;
+        if (elevationDataChanged) {
+            const { elevationData } = props;
+            const isTiled = elevationData &&
+                (Array.isArray(elevationData) ||
+                    (elevationData.includes('{x}') && elevationData.includes('{y}')));
+            this.setState({ isTiled });
+        }
+        // Reloading for single terrain mesh
+        const shouldReload = elevationDataChanged ||
+            props.meshMaxError !== oldProps.meshMaxError ||
+            props.elevationDecoder !== oldProps.elevationDecoder ||
+            props.bounds !== oldProps.bounds;
+        if (!this.state.isTiled && shouldReload) {
+            const terrain = this.loadTerrain(props);
+            this.setState({ terrain });
+        }
+        // TODO - remove in v9
+        if (props.workerUrl) {
+            log.removed('workerUrl', 'loadOptions.terrain.workerUrl')();
+        }
+    }
+    loadTerrain({ elevationData, bounds, elevationDecoder, meshMaxError, signal }) {
+        if (!elevationData) {
+            return null;
+        }
+        let loadOptions = this.getLoadOptions();
+        loadOptions = {
+            ...loadOptions,
+            terrain: {
+                skirtHeight: this.state.isTiled ? meshMaxError * 2 : 0,
+                ...loadOptions?.terrain,
+                bounds,
+                meshMaxError,
+                elevationDecoder
+            }
+        };
+        const { fetch } = this.props;
+        return fetch(elevationData, { propName: 'elevationData', layer: this, loadOptions, signal });
+    }
+    getTiledTerrainData(tile) {
+        const { elevationData, fetch, texture, elevationDecoder, meshMaxError } = this.props;
+        const { viewport } = this.context;
+        const dataUrl = getURLFromTemplate(elevationData, tile);
+        const textureUrl = getURLFromTemplate(texture, tile);
+        const { bbox, signal } = tile;
+        const bottomLeft = viewport.isGeospatial
+            ? viewport.projectFlat([bbox.west, bbox.south])
+            : [bbox.left, bbox.bottom];
+        const topRight = viewport.isGeospatial
+            ? viewport.projectFlat([bbox.east, bbox.north])
+            : [bbox.right, bbox.top];
+        const bounds = [bottomLeft[0], bottomLeft[1], topRight[0], topRight[1]];
+        const terrain = this.loadTerrain({
+            elevationData: dataUrl,
+            bounds,
+            elevationDecoder,
+            meshMaxError,
+            signal
+        });
+        const surface = textureUrl
+            ? // If surface image fails to load, the tile should still be displayed
+                fetch(textureUrl, { propName: 'texture', layer: this, loaders: [], signal }).catch(_ => null)
+            : Promise.resolve(null);
+        return Promise.all([terrain, surface]);
+    }
+    renderSubLayers(props) {
+        const SubLayerClass = this.getSubLayerClass('mesh', SimpleMeshLayer);
+        const { data, color } = props;
+        if (!data) {
+            return null;
+        }
+        const [mesh, texture] = data;
+        return new SubLayerClass(props, {
+            data: DUMMY_DATA,
+            mesh,
+            texture,
+            _instanced: false,
+            coordinateSystem: COORDINATE_SYSTEM.CARTESIAN,
+            getPosition: d => [0, 0, 0],
+            getColor: color
+        });
+    }
+    // Update zRange of viewport
+    onViewportLoad(tiles) {
+        if (!tiles) {
+            return;
+        }
+        const { zRange } = this.state;
+        const ranges = tiles
+            .map(tile => tile.content)
+            .filter(Boolean)
+            .map(arr => {
+            const bounds = arr[0].header.boundingBox;
+            return bounds.map(bound => bound[2]);
+        });
+        if (ranges.length === 0) {
+            return;
+        }
+        const minZ = Math.min(...ranges.map(x => x[0]));
+        const maxZ = Math.max(...ranges.map(x => x[1]));
+        if (!zRange || minZ < zRange[0] || maxZ > zRange[1]) {
+            this.setState({ zRange: [minZ, maxZ] });
+        }
+    }
+    renderLayers() {
+        const { color, material, elevationData, texture, wireframe, meshMaxError, elevationDecoder, tileSize, maxZoom, minZoom, extent, maxRequests, onTileLoad, onTileUnload, onTileError, maxCacheSize, maxCacheByteSize, refinementStrategy } = this.props;
+        if (this.state.isTiled) {
+            return new TileLayer(this.getSubLayerProps({
+                id: 'tiles'
+            }), {
+                wireframe,
+                color,
+                material,
+                getTileData: this.getTiledTerrainData.bind(this),
+                renderSubLayers: this.renderSubLayers.bind(this),
+                updateTriggers: {
+                    getTileData: {
+                        elevationData: urlTemplateToUpdateTrigger(elevationData),
+                        texture: urlTemplateToUpdateTrigger(texture),
+                        meshMaxError,
+                        elevationDecoder
+                    }
+                },
+                onViewportLoad: this.onViewportLoad.bind(this),
+                zRange: this.state.zRange || null,
+                tileSize,
+                maxZoom,
+                minZoom,
+                extent,
+                maxRequests,
+                onTileLoad,
+                onTileUnload,
+                onTileError,
+                maxCacheSize,
+                maxCacheByteSize,
+                refinementStrategy
+            });
+        }
+        const SubLayerClass = this.getSubLayerClass('mesh', SimpleMeshLayer);
+        return new SubLayerClass(this.getSubLayerProps({
+            id: 'mesh'
+        }), {
+            data: DUMMY_DATA,
+            mesh: this.state.terrain,
+            texture,
+            _instanced: false,
+            getPosition: d => [0, 0, 0],
+            getColor: color,
+            material,
+            wireframe
+        });
+    }
+}
+TerrainLayer.layerName = 'TerrainLayer';
+TerrainLayer.defaultProps = defaultProps;

package/typed/tile-3d-layer/tile-3d-layer.d.ts

@@ -0,0 +1,60 @@
+import { Accessor, Color, CompositeLayer, CompositeLayerProps, FilterContext, GetPickingInfoParams, Layer, LayersList, PickingInfo, UpdateParameters, Viewport } from '@deck.gl/core/typed';
+import { Tileset3D, Tile3D } from '@loaders.gl/tiles';
+import { Tiles3DLoader } from '@loaders.gl/3d-tiles';
+/** All properties supported by Tile3DLayer */
+export declare type Tile3dLayerProps<DataT = any> = _Tile3dLayerProps<DataT> & CompositeLayerProps<DataT>;
+/** Props added by the Tile3DLayer */
+declare type _Tile3dLayerProps<DataT> = {
+    /** Color Accessor for point clouds. **/
+    getPointColor?: Accessor<DataT, Color>;
+    /** Global radius of all points in pixels. **/
+    pointSize?: number;
+    /** A loader which is used to decode the fetched tiles.
+     * @deprecated Use `loaders` instead
+     */
+    loader?: typeof Tiles3DLoader;
+    /** Called when Tileset JSON file is loaded. **/
+    onTilesetLoad?: (tile: Tileset3D) => void;
+    /** Called when a tile in the tileset hierarchy is loaded. **/
+    onTileLoad?: (tile: Tile3D) => void;
+    /** Called when a tile is unloaded. **/
+    onTileUnload?: (tile: Tile3D) => void;
+    /** Called when a tile fails to load. **/
+    onTileError?: (tile: Tile3D, url: string, message: string) => void;
+    /** (Experimental) Accessor to change color of mesh based on properties. **/
+    _getMeshColor?: (tile: Tile3D) => Color;
+};
+export default class Tile3DLayer<DataT = any, ExtraPropsT = {}> extends CompositeLayer<ExtraPropsT & Required<_Tile3dLayerProps<DataT>>> {
+    static defaultProps: any;
+    static layerName: string;
+    state: {
+        activeViewports: {};
+        frameNumber?: number;
+        lastUpdatedViewports: {
+            [viewportId: string]: Viewport;
+        } | null;
+        layerMap: {
+            [layerId: string]: any;
+        };
+        tileset3d: Tileset3D | null;
+    };
+    initializeState(): void;
+    get isLoaded(): boolean;
+    shouldUpdateState({ changeFlags }: UpdateParameters<this>): boolean;
+    updateState({ props, oldProps, changeFlags }: UpdateParameters<this>): void;
+    activateViewport(viewport: Viewport): void;
+    getPickingInfo({ info, sourceLayer }: GetPickingInfoParams): PickingInfo;
+    filterSubLayer({ layer, viewport }: FilterContext): boolean;
+    protected _updateAutoHighlight(info: PickingInfo): void;
+    private _loadTileset;
+    private _onTileLoad;
+    private _onTileUnload;
+    private _updateTileset;
+    private _getSubLayer;
+    private _makePointCloudLayer;
+    private _make3DModelLayer;
+    private _makeSimpleMeshLayer;
+    renderLayers(): Layer | null | LayersList;
+}
+export {};
+//# sourceMappingURL=tile-3d-layer.d.ts.map

package/typed/tile-3d-layer/tile-3d-layer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tile-3d-layer.d.ts","sourceRoot":"","sources":["../../src/tile-3d-layer/tile-3d-layer.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,QAAQ,EACR,KAAK,EACL,cAAc,EACd,mBAAmB,EAEnB,aAAa,EACb,oBAAoB,EACpB,KAAK,EACL,UAAU,EAEV,WAAW,EACX,gBAAgB,EAChB,QAAQ,EAET,MAAM,eAAe,CAAC;AAOvB,OAAO,EAAC,SAAS,EAAE,MAAM,EAAY,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AAmBnD,8CAA8C;AAC9C,oBAAY,gBAAgB,CAAC,KAAK,GAAG,GAAG,IAAI,iBAAiB,CAAC,KAAK,CAAC,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAElG,qCAAqC;AACrC,aAAK,iBAAiB,CAAC,KAAK,IAAI;IAC9B,wCAAwC;IACxC,aAAa,CAAC,EAAE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAEvC,8CAA8C;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,aAAa,CAAC;IAE9B,gDAAgD;IAChD,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;IAE1C,8DAA8D;IAC9D,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAEpC,uCAAuC;IACvC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAEtC,yCAAyC;IACzC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAEnE,4EAA4E;IAC5E,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,KAAK,CAAC;CACzC,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,WAAW,CAAC,KAAK,GAAG,GAAG,EAAE,WAAW,GAAG,EAAE,CAAE,SAAQ,cAAc,CACpF,WAAW,GAAG,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CACjD;IACC,MAAM,CAAC,YAAY,MAAuB;IAC1C,MAAM,CAAC,SAAS,SAAiB;IAEjC,KAAK,EAAG;QACN,eAAe,EAAE,EAAE,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,oBAAoB,EAAE;YAAC,CAAC,UAAU,EAAE,MAAM,GAAG,QAAQ,CAAA;SAAC,GAAG,IAAI,CAAC;QAC9D,QAAQ,EAAE;YAAC,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAA;SAAC,CAAC;QACnC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;KAC7B,CAAC;IAEF,eAAe;IAaf,IAAI,QAAQ,IAAI,OAAO,CAGtB;IAED,iBAAiB,CAAC,EAAC,WAAW,EAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,OAAO;IAIjE,WAAW,CAAC,EAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,IAAI;IAsBzE,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAY1C,cAAc,CAAC,EAAC,IAAI,EAAE,WAAW,EAAC,EAAE,oBAAoB;IAaxD,cAAc,CAAC,EAAC,KAAK,EAAE,QAAQ,EAAC,EAAE,aAAa,GAAG,OAAO;IAOzD,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;YAMzC,YAAY;IAwC1B,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,aAAa;IAMrB,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,YAAY;IAoBpB,OAAO,CAAC,oBAAoB;IA4C5B,OAAO,CAAC,iBAAiB;IA4BzB,OAAO,CAAC,oBAAoB;IA2C5B,YAAY,IAAI,KAAK,GAAG,IAAI,GAAG,UAAU;CA2B1C"}