@deck.gl/geo-layers 8.8.0-beta.3 → 8.8.0-beta.4

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

@@ -0,0 +1,123 @@
+/*
+Adapted from s2-geometry
+
+ISC License (ISC)
+
+Copyright (c) 2012-2016, Jon Atkins <github@jonatkins.com>
+Copyright (c) 2016, AJ ONeal <aj@daplie.com>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+import Long from 'long';
+//
+// Functional Style
+//
+const FACE_BITS = 3;
+const MAX_LEVEL = 30;
+const POS_BITS = 2 * MAX_LEVEL + 1; // 61 (60 bits of data, 1 bit lsb marker)
+const RADIAN_TO_DEGREE = 180 / Math.PI;
+export function IJToST(ij, order, offsets) {
+    const maxSize = 1 << order;
+    return [(ij[0] + offsets[0]) / maxSize, (ij[1] + offsets[1]) / maxSize];
+}
+function singleSTtoUV(st) {
+    if (st >= 0.5) {
+        return (1 / 3.0) * (4 * st * st - 1);
+    }
+    return (1 / 3.0) * (1 - 4 * (1 - st) * (1 - st));
+}
+export function STToUV(st) {
+    return [singleSTtoUV(st[0]), singleSTtoUV(st[1])];
+}
+export function FaceUVToXYZ(face, [u, v]) {
+    switch (face) {
+        case 0:
+            return [1, u, v];
+        case 1:
+            return [-u, 1, v];
+        case 2:
+            return [-u, -v, 1];
+        case 3:
+            return [-1, -v, -u];
+        case 4:
+            return [v, -1, -u];
+        case 5:
+            return [v, u, -1];
+        default:
+            throw new Error('Invalid face');
+    }
+}
+export function XYZToLngLat([x, y, z]) {
+    const lat = Math.atan2(z, Math.sqrt(x * x + y * y));
+    const lng = Math.atan2(y, x);
+    return [lng * RADIAN_TO_DEGREE, lat * RADIAN_TO_DEGREE];
+}
+export function toHilbertQuadkey(idS) {
+    let bin = Long.fromString(idS, true, 10).toString(2);
+    while (bin.length < FACE_BITS + POS_BITS) {
+        // eslint-disable-next-line prefer-template
+        bin = '0' + bin;
+    }
+    // MUST come AFTER binstr has been left-padded with '0's
+    const lsbIndex = bin.lastIndexOf('1');
+    // substr(start, len)
+    // substring(start, end) // includes start, does not include end
+    const faceB = bin.substring(0, 3);
+    // posB will always be a multiple of 2 (or it's invalid)
+    const posB = bin.substring(3, lsbIndex);
+    const levelN = posB.length / 2;
+    const faceS = Long.fromString(faceB, true, 2).toString(10);
+    let posS = Long.fromString(posB, true, 2).toString(4);
+    while (posS.length < levelN) {
+        // eslint-disable-next-line prefer-template
+        posS = '0' + posS;
+    }
+    return `${faceS}/${posS}`;
+}
+function rotateAndFlipQuadrant(n, point, rx, ry) {
+    if (ry === 0) {
+        if (rx === 1) {
+            point[0] = n - 1 - point[0];
+            point[1] = n - 1 - point[1];
+        }
+        const x = point[0];
+        point[0] = point[1];
+        point[1] = x;
+    }
+}
+export function FromHilbertQuadKey(hilbertQuadkey) {
+    const parts = hilbertQuadkey.split('/');
+    const face = parseInt(parts[0], 10);
+    const position = parts[1];
+    const maxLevel = position.length;
+    const point = [0, 0];
+    let level;
+    for (let i = maxLevel - 1; i >= 0; i--) {
+        level = maxLevel - i;
+        const bit = position[i];
+        let rx = 0;
+        let ry = 0;
+        if (bit === '1') {
+            ry = 1;
+        }
+        else if (bit === '2') {
+            rx = 1;
+            ry = 1;
+        }
+        else if (bit === '3') {
+            rx = 1;
+        }
+        const val = Math.pow(2, level - 1);
+        rotateAndFlipQuadrant(val, point, rx, ry);
+        point[0] += val * rx;
+        point[1] += val * ry;
+    }
+    if (face % 2 === 1) {
+        const t = point[0];
+        point[0] = point[1];
+        point[1] = t;
+    }
+    return { face, ij: point, level };
+}

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

@@ -0,0 +1,37 @@
+// 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 GeoCellLayer from '../geo-cell-layer/GeoCellLayer';
+import { getS2Polygon } from './s2-utils';
+const defaultProps = {
+    getS2Token: { type: 'accessor', value: d => d.token }
+};
+export default class S2Layer extends GeoCellLayer {
+    indexToBounds() {
+        const { data, getS2Token } = this.props;
+        return {
+            data,
+            _normalize: false,
+            positionFormat: 'XY',
+            getPolygon: (x, objectInfo) => getS2Polygon(getS2Token(x, objectInfo))
+        };
+    }
+}
+S2Layer.layerName = 'S2Layer';
+S2Layer.defaultProps = defaultProps;

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.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;