@loaders.gl/mvt 4.0.0-alpha.5 → 4.0.0-alpha.6

package/src/lib/geojson-tiler/geojson-tiler.ts

@@ -0,0 +1,281 @@
+// loaders.gl, MIT license
+// Forked from https://github.com/mapbox/geojson-vt under compatible ISC license
+
+/* eslint-disable no-console, no-continue */
+
+import type {GeoJSONTile, GeoJSONTileFeature} from './tile';
+
+import {convert} from './convert'; // GeoJSON conversion and preprocessing
+import {clip} from './clip'; // stripe clipping algorithm
+import {wrap} from './wrap'; // date line processing
+import {transformTile} from './transform'; // coordinate transformation
+import {createTile} from './tile'; // final simplified tile generation
+
+/** Options to configure tiling */
+export type GeoJSONTilerOptions = {
+  maxZoom?: number /** max zoom to preserve detail on */;
+  indexMaxZoom?: number /** max zoom in the tile index */;
+  indexMaxPoints?: number /** max number of points per tile in the tile index */;
+  tolerance?: number /** simplification tolerance (higher means simpler) */;
+  extent?: number /** tile extent */;
+  buffer?: number /** tile buffer on each side */;
+  lineMetrics?: boolean /** whether to calculate line metrics */;
+  promoteId?: string /** name of a feature property to be promoted to feature.id */;
+  generateId?: boolean /** whether to generate feature ids. Cannot be used with promoteId */;
+  debug?: number /** logging level (0, 1 or 2) */;
+};
+
+const DEFAULT_OPTIONS: Required<GeoJSONTilerOptions> = {
+  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
+  // @ts-expect-error Ensures all these required params have defaults
+  promoteId: undefined, // name of a feature property to be promoted to feature.id
+  generateId: false, // whether to generate feature ids. Cannot be used with promoteId
+  debug: 0 // logging level (0, 1 or 2)
+};
+
+export class GeoJSONTiler {
+  options: Required<GeoJSONTilerOptions>;
+
+  // tiles and tileCoords are part of the public API
+  tiles: Record<string, GeoJSONTile> = {};
+  tileCoords: {x: number; y: number; z: number}[] = [];
+
+  stats: Record<string, number> = {};
+  total: number = 0;
+
+  constructor(data, options?: GeoJSONTilerOptions) {
+    this.options = {...DEFAULT_OPTIONS, ...options};
+    options = this.options;
+
+    const debug = options.debug;
+
+    if (debug) console.time('preprocess data');
+
+    if (this.options.maxZoom < 0 || this.options.maxZoom > 24) {
+      throw new Error('maxZoom should be in the 0-24 range');
+    }
+    if (options.promoteId && this.options.generateId) {
+      throw new Error('promoteId and generateId cannot be used together.');
+    }
+
+    // projects and adds simplification info
+    let features = convert(data, options);
+
+    if (debug) {
+      console.timeEnd('preprocess data');
+      console.log(
+        'index: maxZoom: %d, maxPoints: %d',
+        options.indexMaxZoom,
+        options.indexMaxPoints
+      );
+      console.time('generate tiles');
+    }
+
+    // wraps features (ie extreme west and extreme east)
+    features = wrap(features, this.options);
+
+    // start slicing from the top tile down
+    if (features.length) {
+      this.splitTile(features, 0, 0, 0);
+    }
+
+    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));
+    }
+  }
+
+  /**
+   * Get a tile at the specified index
+   * @param z
+   * @param x
+   * @param y
+   * @returns
+   */
+  // eslint-disable-next-line complexity, max-statements
+  getTile(z: number, x: number, y: number): GeoJSONTile | null {
+    // z = +z;
+    // x = +x;
+    // y = +y;
+
+    const {extent, debug} = this.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 transformTile(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] ? transformTile(this.tiles[id], extent) : null;
+  }
+
+  /**
+   * splits features from a parent tile to sub-tiles.
+   * @param z, x, and y are the coordinates of the parent tile
+   * @param 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.
+   */
+  // eslint-disable-next-line max-params, max-statements, complexity
+  splitTile(
+    features: GeoJSONTileFeature[],
+    z: number,
+    x: number,
+    y: number,
+    cz?: number,
+    cx?: number,
+    cy?: number
+  ): void {
+    const stack: any[] = [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});
+
+        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 === undefined) {
+        // 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 !== undefined) {
+        // stop tiling if it's not an ancestor of the target tile
+        const zoomSteps = cz - z;
+        // @ts-expect-error TODO fix the types of cx cy
+        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: GeoJSONTileFeature[] | null = null;
+      let bl: GeoJSONTileFeature[] | null = null;
+      let tr: GeoJSONTileFeature[] | null = null;
+      let br: GeoJSONTileFeature[] | null = null;
+
+      let left = clip(features, z2, x - k1, x + k3, 0, tile.minX, tile.maxX, options);
+      let right = clip(features, z2, x + k2, x + k4, 0, tile.minX, tile.maxX, options);
+
+      // @ts-expect-error - unclear why this is needed?
+      features = null;
+
+      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);
+        left = null;
+      }
+
+      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);
+        right = null;
+      }
+
+      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);
+    }
+  }
+}
+
+function toID(z, x, y) {
+  return ((1 << z) * y + x) * 32 + z;
+}

package/src/lib/geojson-tiler/simplify.ts

@@ -0,0 +1,77 @@
+// loaders.gl, MIT license
+// Forked from https://github.com/mapbox/geojson-vt under compatible ISC license
+
+/**
+ * Calculate simplification data using optimized Douglas-Peucker algorithm
+ *
+ * @param coords contiguous list of coordinates
+ * @param first first coord to simplify
+ * @param last last coord to simplify
+ * @param sqTolerance tolerance (square distance)
+ */
+export function simplify(coords: number[], first: number, last: number, sqTolerance: number): void {
+  let maxSqDist = sqTolerance;
+  const mid = (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 */
+// eslint-disable-next-line max-params
+function getSqSegDist(
+  px: number,
+  py: number,
+  x: number,
+  y: number,
+  bx: number,
+  by: number
+): number {
+  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/lib/geojson-tiler/tile.ts

@@ -0,0 +1,185 @@
+// loaders.gl, MIT license
+// Forked from https://github.com/mapbox/geojson-vt under compatible ISC license
+
+// import type {Feature} from '@loaders.gl/schema';
+
+export type GeoJSONTileFeature = {
+  type: any;
+  geometry: any;
+
+  // book keeping
+  id?: string;
+  tags?: string[];
+
+  // spatial extents
+  minX: number;
+  maxX: number;
+  minY: number;
+  maxY: number;
+};
+
+export type GeoJSONTile = {
+  features: GeoJSONTileFeature[]; // Feature[]; Doesn't seem JSON compatible??
+  type?: number;
+  tags?: Record<string, string>;
+
+  // tile coordinates
+  x: number;
+  y: number;
+  z: number;
+
+  // spatial extents
+  minX: number;
+  maxX: number;
+  minY: number;
+  maxY: number;
+
+  transformed: boolean;
+  numPoints: number;
+  numSimplified: number;
+  numFeatures: number;
+  source: any | null;
+};
+
+export type CreateTileOptions = {
+  maxZoom?: number;
+  tolerance: number;
+  extent: number;
+  lineMetrics: boolean;
+};
+
+/**
+ * Create a tile from features and tile index
+ */
+export function createTile(features: any[], z, tx, ty, options: CreateTileOptions): GeoJSONTile {
+  const tolerance = z === options.maxZoom ? 0 : options.tolerance / ((1 << z) * options.extent);
+  const tile: GeoJSONTile = {
+    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;
+}
+
+// eslint-disable-next-line complexity, max-statements
+function addFeature(tile: GeoJSONTile, feature, tolerance: number, options: CreateTileOptions) {
+  const geom = feature.geometry;
+  const type = feature.type;
+  const simplified: number[] = [];
+
+  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-next-line camelcase
+      tags.mapbox_clip_start = geom.start / geom.size;
+      // eslint-disable-next-line camelcase
+      tags.mapbox_clip_end = geom.end / geom.size;
+    }
+
+    // @ts-expect-error TODO - create sub type?
+    const tileFeature: GeoJSONTileFeature = {
+      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);
+  }
+}
+
+// eslint-disable-next-line max-params, max-statements
+function addLine(
+  result,
+  geom,
+  tile: GeoJSONTile,
+  tolerance: number,
+  isPolygon: boolean,
+  isOuter: boolean
+): void {
+  const sqTolerance = tolerance * tolerance;
+
+  if (tolerance > 0 && geom.size < (isPolygon ? sqTolerance : tolerance)) {
+    tile.numPoints += geom.length / 3;
+    return;
+  }
+
+  const ring: number[] = [];
+
+  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: number[], clockwise?: boolean): void {
+  let area = 0;
+  for (let i = 0, j = ring.length - 2; i < ring.length; 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/lib/geojson-tiler/transform.ts

@@ -0,0 +1,55 @@
+// loaders.gl, MIT license
+// Forked from https://github.com/mapbox/geojson-vt under compatible ISC license
+
+import type {GeoJSONTile} from './tile';
+
+/**
+ * Transforms the coordinates of each feature in the given tile from
+ * mercator-projected space into (extent x extent) tile space.
+ */
+export function transformTile(tile: GeoJSONTile, extent: number): GeoJSONTile {
+  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: number[][] = [];
+        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;
+}
+
+// eslint-disable-next-line max-params
+function transformPoint(
+  x: number,
+  y: number,
+  extent: number,
+  z2: number,
+  tx: number,
+  ty: number
+): number[] {
+  return [Math.round(extent * (x * z2 - tx)), Math.round(extent * (y * z2 - ty))];
+}

package/src/lib/geojson-tiler/wrap.ts

@@ -0,0 +1,108 @@
+// loaders.gl, MIT license
+// Forked from https://github.com/mapbox/geojson-vt under compatible ISC license
+
+import type {GeoJSONTileFeature} from './tile';
+import {clip} from './clip';
+import {createFeature} from './feature';
+
+/**
+ * Options for wrap()
+ */
+export type WrapOptions = {
+  buffer: number /** number of pixels of buffer for the tile */;
+  extent: number /** extent of each tile */;
+  lineMetrics: boolean;
+};
+
+/**
+ * Wrap across antemeridian, by clipping into two tiles, shifting the overflowing x coordinates
+ * @param features list of features to be wrapped
+ * @param options buffer and extent
+ * @returns
+ */
+export function wrap(features: GeoJSONTileFeature[], options: WrapOptions) {
+  const buffer = options.buffer / options.extent;
+  let merged: GeoJSONTileFeature[] = 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;
+}
+
+/**
+ * Shift the x coordinates of a list of features
+ * @param features list of features to shift x coordinates for
+ * @param offset
+ * @returns
+ */
+function shiftFeatureCoords(features: GeoJSONTileFeature[], offset: number): GeoJSONTileFeature[] {
+  const newFeatures: GeoJSONTileFeature[] = [];
+
+  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: Points = [];
+        for (const line of polygon) {
+          // @ts-expect-error TODO
+          newPolygon.push(shiftCoords(line, offset));
+        }
+        newGeometry.push(newPolygon);
+      }
+    }
+
+    newFeatures.push(createFeature(feature.id, type, newGeometry, feature.tags));
+  }
+
+  return newFeatures;
+}
+
+class Points extends Array<number> {
+  size?: number;
+  start?: number;
+  end?: number;
+}
+
+/**
+ * Shift the x coordinate of every point
+ * @param points
+ * @param offset
+ * @returns
+ */
+function shiftCoords(points: Points, offset: number): Points {
+  const newPoints: Points = [];
+  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;
+}