@maplibre/geojson-vt 5.0.0

package/src/index.js

@@ -0,0 +1,334 @@
+
+import convert from './convert.js';              // GeoJSON conversion and preprocessing
+import clip from './clip.js';                    // stripe clipping algorithm
+import wrap from './wrap.js';                    // date line processing
+import transform from './transform.js';          // coordinate transformation
+import createTile from './tile.js';              // final simplified tile generation
+import {applySourceDiff} from './difference.js'; // diff utilities
+
+const defaultOptions = {
+    maxZoom: 14,            // max zoom to preserve detail on
+    indexMaxZoom: 5,        // max zoom in the tile index
+    indexMaxPoints: 100000, // max number of points per tile in the tile index
+    tolerance: 3,           // simplification tolerance (higher means simpler)
+    extent: 4096,           // tile extent
+    buffer: 64,             // tile buffer on each side
+    lineMetrics: false,     // whether to calculate line metrics
+    promoteId: null,        // name of a feature property to be promoted to feature.id
+    generateId: false,      // whether to generate feature ids. Cannot be used with promoteId
+    updateable: false,      // whether geojson can be updated (with caveat of a stored simplified copy)
+    debug: 0                // logging level (0, 1 or 2)
+};
+
+class GeoJSONVT {
+    constructor(data, options) {
+        options = this.options = extend(Object.create(defaultOptions), options);
+
+        const debug = options.debug;
+
+        if (debug) console.time('preprocess data');
+
+        if (options.maxZoom < 0 || options.maxZoom > 24) throw new Error('maxZoom should be in the 0-24 range');
+        if (options.promoteId && options.generateId) throw new Error('promoteId and generateId cannot be used together.');
+
+        // projects and adds simplification info
+        let features = convert(data, options);
+
+        // tiles and tileCoords are part of the public API
+        this.tiles = {};
+        this.tileCoords = [];
+
+        if (debug) {
+            console.timeEnd('preprocess data');
+            console.log('index: maxZoom: %d, maxPoints: %d', options.indexMaxZoom, options.indexMaxPoints);
+            console.time('generate tiles');
+            this.stats = {};
+            this.total = 0;
+        }
+
+        // wraps features (ie extreme west and extreme east)
+        features = wrap(features, options);
+
+        // start slicing from the top tile down
+        if (features.length) this.splitTile(features, 0, 0, 0);
+
+        // for updateable indexes, store a copy of the original simplified features
+        if (options.updateable) {
+            this.source = features;
+        }
+
+        if (debug) {
+            if (features.length) console.log('features: %d, points: %d', this.tiles[0].numFeatures, this.tiles[0].numPoints);
+            console.timeEnd('generate tiles');
+            console.log('tiles generated:', this.total, JSON.stringify(this.stats));
+        }
+    }
+
+    // splits features from a parent tile to sub-tiles.
+    // z, x, and y are the coordinates of the parent tile
+    // cz, cx, and cy are the coordinates of the target tile
+    //
+    // If no target tile is specified, splitting stops when we reach the maximum
+    // zoom or the number of points is low as specified in the options.
+    splitTile(features, z, x, y, cz, cx, cy) {
+
+        const stack = [features, z, x, y];
+        const options = this.options;
+        const debug = options.debug;
+
+        // avoid recursion by using a processing queue
+        while (stack.length) {
+            y = stack.pop();
+            x = stack.pop();
+            z = stack.pop();
+            features = stack.pop();
+
+            const z2 = 1 << z;
+            const id = toID(z, x, y);
+            let tile = this.tiles[id];
+
+            if (!tile) {
+                if (debug > 1) console.time('creation');
+
+                tile = this.tiles[id] = createTile(features, z, x, y, options);
+                this.tileCoords.push({z, x, y, id});
+
+                if (debug) {
+                    if (debug > 1) {
+                        console.log('tile z%d-%d-%d (features: %d, points: %d, simplified: %d)',
+                            z, x, y, tile.numFeatures, tile.numPoints, tile.numSimplified);
+                        console.timeEnd('creation');
+                    }
+                    const key = `z${  z}`;
+                    this.stats[key] = (this.stats[key] || 0) + 1;
+                    this.total++;
+                }
+            }
+
+            // save reference to original geometry in tile so that we can drill down later if we stop now
+            tile.source = features;
+
+            // if it's the first-pass tiling
+            if (cz == null) {
+                // stop tiling if we reached max zoom, or if the tile is too simple
+                if (z === options.indexMaxZoom || tile.numPoints <= options.indexMaxPoints) continue;
+            // if a drilldown to a specific tile
+            } else if (z === options.maxZoom || z === cz) {
+                // stop tiling if we reached base zoom or our target tile zoom
+                continue;
+            } else if (cz != null) {
+                // stop tiling if it's not an ancestor of the target tile
+                const zoomSteps = cz - z;
+                if (x !== cx >> zoomSteps || y !== cy >> zoomSteps) continue;
+            }
+
+            // if we slice further down, no need to keep source geometry
+            tile.source = null;
+
+            if (features.length === 0) continue;
+
+            if (debug > 1) console.time('clipping');
+
+            // values we'll use for clipping
+            const k1 = 0.5 * options.buffer / options.extent;
+            const k2 = 0.5 - k1;
+            const k3 = 0.5 + k1;
+            const k4 = 1 + k1;
+
+            let tl = null;
+            let bl = null;
+            let tr = null;
+            let br = null;
+
+            const left  = clip(features, z2, x - k1, x + k3, 0, tile.minX, tile.maxX, options);
+            const right = clip(features, z2, x + k2, x + k4, 0, tile.minX, tile.maxX, options);
+
+            if (left) {
+                tl = clip(left, z2, y - k1, y + k3, 1, tile.minY, tile.maxY, options);
+                bl = clip(left, z2, y + k2, y + k4, 1, tile.minY, tile.maxY, options);
+            }
+
+            if (right) {
+                tr = clip(right, z2, y - k1, y + k3, 1, tile.minY, tile.maxY, options);
+                br = clip(right, z2, y + k2, y + k4, 1, tile.minY, tile.maxY, options);
+            }
+
+            if (debug > 1) console.timeEnd('clipping');
+
+            stack.push(tl || [], z + 1, x * 2,     y * 2);
+            stack.push(bl || [], z + 1, x * 2,     y * 2 + 1);
+            stack.push(tr || [], z + 1, x * 2 + 1, y * 2);
+            stack.push(br || [], z + 1, x * 2 + 1, y * 2 + 1);
+        }
+    }
+
+    getTile(z, x, y) {
+        z = +z;
+        x = +x;
+        y = +y;
+
+        const options = this.options;
+        const {extent, debug} = options;
+
+        if (z < 0 || z > 24) return null;
+
+        const z2 = 1 << z;
+        x = (x + z2) & (z2 - 1); // wrap tile x coordinate
+
+        const id = toID(z, x, y);
+        if (this.tiles[id]) return transform(this.tiles[id], extent);
+
+        if (debug > 1) console.log('drilling down to z%d-%d-%d', z, x, y);
+
+        let z0 = z;
+        let x0 = x;
+        let y0 = y;
+        let parent;
+
+        while (!parent && z0 > 0) {
+            z0--;
+            x0 = x0 >> 1;
+            y0 = y0 >> 1;
+            parent = this.tiles[toID(z0, x0, y0)];
+        }
+
+        if (!parent || !parent.source) return null;
+
+        // if we found a parent tile containing the original geometry, we can drill down from it
+        if (debug > 1) {
+            console.log('found parent tile z%d-%d-%d', z0, x0, y0);
+            console.time('drilling down');
+        }
+        this.splitTile(parent.source, z0, x0, y0, z, x, y);
+        if (debug > 1) console.timeEnd('drilling down');
+
+        return this.tiles[id] ? transform(this.tiles[id], extent) : null;
+    }
+
+    // invalidates (removes) tiles affected by the provided features
+    invalidateTiles(features) {
+        const options = this.options;
+        const {debug} = options;
+
+        // calculate bounding box of all features for trivial reject
+        let minX = Infinity;
+        let maxX = -Infinity;
+        let minY = Infinity;
+        let maxY = -Infinity;
+
+        for (const feature of features) {
+            minX = Math.min(minX, feature.minX);
+            maxX = Math.max(maxX, feature.maxX);
+            minY = Math.min(minY, feature.minY);
+            maxY = Math.max(maxY, feature.maxY);
+        }
+
+        // tile buffer clipping value - not halved as in splitTile above because checking against tile's own extent
+        const k1 = options.buffer / options.extent;
+
+        // track removed tile ids for o(1) lookup
+        const removedLookup = new Set();
+
+        // iterate through existing tiles and remove ones that are affected by features
+        for (const id in this.tiles) {
+            const tile = this.tiles[id];
+
+            // calculate tile bounds including buffer
+            const z2 = 1 << tile.z;
+            const tileMinX = (tile.x     - k1) / z2;
+            const tileMaxX = (tile.x + 1 + k1) / z2;
+            const tileMinY = (tile.y     - k1) / z2;
+            const tileMaxY = (tile.y + 1 + k1) / z2;
+
+            // trivial reject if feature bounds don't intersect tile
+            if (maxX < tileMinX || minX >= tileMaxX ||
+                maxY < tileMinY || minY >= tileMaxY) {
+                continue;
+            }
+
+            // check if any feature intersects with the tile
+            let intersects = false;
+            for (const feature of features) {
+                if (feature.maxX >= tileMinX && feature.minX < tileMaxX &&
+                    feature.maxY >= tileMinY && feature.minY < tileMaxY) {
+                    intersects = true;
+                    break;
+                }
+            }
+            if (!intersects) continue;
+
+            if (debug) {
+                if (debug > 1) {
+                    console.log('invalidate tile z%d-%d-%d (features: %d, points: %d, simplified: %d)',
+                        tile.z, tile.x, tile.y, tile.numFeatures, tile.numPoints, tile.numSimplified);
+                }
+                const key = `z${  tile.z}`;
+                this.stats[key] = (this.stats[key] || 0) - 1;
+                this.total--;
+            }
+
+            delete this.tiles[id];
+            removedLookup.add(id);
+        }
+
+        // remove tile coords that are no longer in the index
+        if (removedLookup.size) this.tileCoords = this.tileCoords.filter(c => !removedLookup.has(c.id));
+    }
+
+    // updates the tile index by adding and/or removing geojson features
+    // invalidates tiles that are affected by the update for regeneration on next getTile call
+    // diff is an object with properties specified in difference.js
+    updateData(diff) {
+        const options = this.options;
+        const debug = options.debug;
+
+        if (!options.updateable) throw new Error('to update tile geojson `updateable` option must be set to true');
+
+        // apply diff and collect affected features and updated source that will be used to invalidate tiles
+        const {affected, source} = applySourceDiff(this.source, diff, options);
+
+        // nothing has changed
+        if (!affected.length) return;
+
+        // update source with new simplified feature set
+        this.source = source;
+
+        if (debug > 1) {
+            console.log('invalidating tiles');
+            console.time('invalidating');
+        }
+
+        this.invalidateTiles(affected);
+
+        if (debug > 1) console.timeEnd('invalidating');
+
+        // re-generate root tile with updated feature set
+        const [z, x, y] = [0, 0, 0];
+        const rootTile = createTile(this.source, z, x, y, this.options);
+        rootTile.source = this.source;
+
+        // update tile index with new root tile - ready for getTile calls
+        const id = toID(z, x, y);
+        this.tiles[id] = rootTile;
+        this.tileCoords.push({z, x, y, id});
+
+        if (debug) {
+            const key = `z${  z}`;
+            this.stats[key] = (this.stats[key] || 0) + 1;
+            this.total++;
+        }
+    }
+}
+
+function toID(z, x, y) {
+    return (((1 << z) * y + x) * 32) + z;
+}
+
+function extend(dest, src) {
+    for (const i in src) dest[i] = src[i];
+    return dest;
+}
+
+export default function geojsonvt(data, options) {
+    return new GeoJSONVT(data, options);
+}

package/src/simplify.js

@@ -0,0 +1,65 @@
+
+// calculate simplification data using optimized Douglas-Peucker algorithm
+
+export default function simplify(coords, first, last, sqTolerance) {
+    let maxSqDist = sqTolerance;
+    const mid = first + ((last - first) >> 1);
+    let minPosToMid = last - first;
+    let index;
+
+    const ax = coords[first];
+    const ay = coords[first + 1];
+    const bx = coords[last];
+    const by = coords[last + 1];
+
+    for (let i = first + 3; i < last; i += 3) {
+        const d = getSqSegDist(coords[i], coords[i + 1], ax, ay, bx, by);
+
+        if (d > maxSqDist) {
+            index = i;
+            maxSqDist = d;
+
+        } else if (d === maxSqDist) {
+            // a workaround to ensure we choose a pivot close to the middle of the list,
+            // reducing recursion depth, for certain degenerate inputs
+            // https://github.com/mapbox/geojson-vt/issues/104
+            const posToMid = Math.abs(i - mid);
+            if (posToMid < minPosToMid) {
+                index = i;
+                minPosToMid = posToMid;
+            }
+        }
+    }
+
+    if (maxSqDist > sqTolerance) {
+        if (index - first > 3) simplify(coords, first, index, sqTolerance);
+        coords[index + 2] = maxSqDist;
+        if (last - index > 3) simplify(coords, index, last, sqTolerance);
+    }
+}
+
+// square distance from a point to a segment
+function getSqSegDist(px, py, x, y, bx, by) {
+
+    let dx = bx - x;
+    let dy = by - y;
+
+    if (dx !== 0 || dy !== 0) {
+
+        const t = ((px - x) * dx + (py - y) * dy) / (dx * dx + dy * dy);
+
+        if (t > 1) {
+            x = bx;
+            y = by;
+
+        } else if (t > 0) {
+            x += dx * t;
+            y += dy * t;
+        }
+    }
+
+    dx = px - x;
+    dy = py - y;
+
+    return dx * dx + dy * dy;
+}

package/src/tile.js

@@ -0,0 +1,123 @@
+
+export default function createTile(features, z, tx, ty, options) {
+    const tolerance = z === options.maxZoom ? 0 : options.tolerance / ((1 << z) * options.extent);
+    const tile = {
+        features: [],
+        numPoints: 0,
+        numSimplified: 0,
+        numFeatures: features.length,
+        source: null,
+        x: tx,
+        y: ty,
+        z,
+        transformed: false,
+        minX: 2,
+        minY: 1,
+        maxX: -1,
+        maxY: 0
+    };
+    for (const feature of features) {
+        addFeature(tile, feature, tolerance, options);
+    }
+    return tile;
+}
+
+function addFeature(tile, feature, tolerance, options) {
+    const geom = feature.geometry;
+    const type = feature.type;
+    const simplified = [];
+
+    tile.minX = Math.min(tile.minX, feature.minX);
+    tile.minY = Math.min(tile.minY, feature.minY);
+    tile.maxX = Math.max(tile.maxX, feature.maxX);
+    tile.maxY = Math.max(tile.maxY, feature.maxY);
+
+    if (type === 'Point' || type === 'MultiPoint') {
+        for (let i = 0; i < geom.length; i += 3) {
+            simplified.push(geom[i], geom[i + 1]);
+            tile.numPoints++;
+            tile.numSimplified++;
+        }
+
+    } else if (type === 'LineString') {
+        addLine(simplified, geom, tile, tolerance, false, false);
+
+    } else if (type === 'MultiLineString' || type === 'Polygon') {
+        for (let i = 0; i < geom.length; i++) {
+            addLine(simplified, geom[i], tile, tolerance, type === 'Polygon', i === 0);
+        }
+
+    } else if (type === 'MultiPolygon') {
+
+        for (let k = 0; k < geom.length; k++) {
+            const polygon = geom[k];
+            for (let i = 0; i < polygon.length; i++) {
+                addLine(simplified, polygon[i], tile, tolerance, true, i === 0);
+            }
+        }
+    }
+
+    if (simplified.length) {
+        let tags = feature.tags || null;
+
+        if (type === 'LineString' && options.lineMetrics) {
+            tags = {};
+            for (const key in feature.tags) tags[key] = feature.tags[key];
+            /* eslint-disable dot-notation */
+            tags['mapbox_clip_start'] = geom.start / geom.size;
+            tags['mapbox_clip_end'] = geom.end / geom.size;
+            /* eslint-enable dot-notation */
+        }
+
+        const tileFeature = {
+            geometry: simplified,
+            type: type === 'Polygon' || type === 'MultiPolygon' ? 3 :
+            (type === 'LineString' || type === 'MultiLineString' ? 2 : 1),
+            tags
+        };
+        if (feature.id !== null) {
+            tileFeature.id = feature.id;
+        }
+        tile.features.push(tileFeature);
+    }
+}
+
+function addLine(result, geom, tile, tolerance, isPolygon, isOuter) {
+    const sqTolerance = tolerance * tolerance;
+
+    if (tolerance > 0 && (geom.size < (isPolygon ? sqTolerance : tolerance))) {
+        tile.numPoints += geom.length / 3;
+        return;
+    }
+
+    const ring = [];
+
+    for (let i = 0; i < geom.length; i += 3) {
+        if (tolerance === 0 || geom[i + 2] > sqTolerance) {
+            tile.numSimplified++;
+            ring.push(geom[i], geom[i + 1]);
+        }
+        tile.numPoints++;
+    }
+
+    if (isPolygon) rewind(ring, isOuter);
+
+    result.push(ring);
+}
+
+function rewind(ring, clockwise) {
+    let area = 0;
+    for (let i = 0, len = ring.length, j = len - 2; i < len; j = i, i += 2) {
+        area += (ring[i] - ring[j]) * (ring[i + 1] + ring[j + 1]);
+    }
+    if (area > 0 === clockwise) {
+        for (let i = 0, len = ring.length; i < len / 2; i += 2) {
+            const x = ring[i];
+            const y = ring[i + 1];
+            ring[i] = ring[len - 2 - i];
+            ring[i + 1] = ring[len - 1 - i];
+            ring[len - 2 - i] = x;
+            ring[len - 1 - i] = y;
+        }
+    }
+}

package/src/transform.js

@@ -0,0 +1,41 @@
+
+// Transforms the coordinates of each feature in the given tile from
+// mercator-projected space into (extent x extent) tile space.
+export default function transformTile(tile, extent) {
+    if (tile.transformed) return tile;
+
+    const z2 = 1 << tile.z;
+    const tx = tile.x;
+    const ty = tile.y;
+
+    for (const feature of tile.features) {
+        const geom = feature.geometry;
+        const type = feature.type;
+
+        feature.geometry = [];
+
+        if (type === 1) {
+            for (let j = 0; j < geom.length; j += 2) {
+                feature.geometry.push(transformPoint(geom[j], geom[j + 1], extent, z2, tx, ty));
+            }
+        } else {
+            for (let j = 0; j < geom.length; j++) {
+                const ring = [];
+                for (let k = 0; k < geom[j].length; k += 2) {
+                    ring.push(transformPoint(geom[j][k], geom[j][k + 1], extent, z2, tx, ty));
+                }
+                feature.geometry.push(ring);
+            }
+        }
+    }
+
+    tile.transformed = true;
+
+    return tile;
+}
+
+function transformPoint(x, y, extent, z2, tx, ty) {
+    return [
+        Math.round(extent * (x * z2 - tx)),
+        Math.round(extent * (y * z2 - ty))];
+}

package/src/wrap.js

@@ -0,0 +1,68 @@
+
+import clip from './clip.js';
+import createFeature from './feature.js';
+
+export default function wrap(features, options) {
+    const buffer = options.buffer / options.extent;
+    let merged = features;
+    const left  = clip(features, 1, -1 - buffer, buffer,     0, -1, 2, options); // left world copy
+    const right = clip(features, 1,  1 - buffer, 2 + buffer, 0, -1, 2, options); // right world copy
+
+    if (left || right) {
+        merged = clip(features, 1, -buffer, 1 + buffer, 0, -1, 2, options) || []; // center world copy
+
+        if (left) merged = shiftFeatureCoords(left, 1).concat(merged); // merge left into center
+        if (right) merged = merged.concat(shiftFeatureCoords(right, -1)); // merge right into center
+    }
+
+    return merged;
+}
+
+function shiftFeatureCoords(features, offset) {
+    const newFeatures = [];
+
+    for (let i = 0; i < features.length; i++) {
+        const feature = features[i];
+        const type = feature.type;
+
+        let newGeometry;
+
+        if (type === 'Point' || type === 'MultiPoint' || type === 'LineString') {
+            newGeometry = shiftCoords(feature.geometry, offset);
+
+        } else if (type === 'MultiLineString' || type === 'Polygon') {
+            newGeometry = [];
+            for (const line of feature.geometry) {
+                newGeometry.push(shiftCoords(line, offset));
+            }
+        } else if (type === 'MultiPolygon') {
+            newGeometry = [];
+            for (const polygon of feature.geometry) {
+                const newPolygon = [];
+                for (const line of polygon) {
+                    newPolygon.push(shiftCoords(line, offset));
+                }
+                newGeometry.push(newPolygon);
+            }
+        }
+
+        newFeatures.push(createFeature(feature.id, type, newGeometry, feature.tags));
+    }
+
+    return newFeatures;
+}
+
+function shiftCoords(points, offset) {
+    const newPoints = [];
+    newPoints.size = points.size;
+
+    if (points.start !== undefined) {
+        newPoints.start = points.start;
+        newPoints.end = points.end;
+    }
+
+    for (let i = 0; i < points.length; i += 3) {
+        newPoints.push(points[i] + offset, points[i + 1], points[i + 2]);
+    }
+    return newPoints;
+}