@loaders.gl/3d-tiles 4.2.0-alpha.4 → 4.2.0-alpha.6

package/dist/lib/parsers/parse-3d-tile.js

@@ -1,3 +1,8 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT AND Apache-2.0
+// Copyright vis.gl contributors
+// This file is derived from the Cesium code base under Apache 2 license
+// See LICENSE.md and https://github.com/AnalyticalGraphicsInc/cesium/blob/master/LICENSE.md
 import { TILE3D_TYPE } from "../constants.js";
 import { getMagicString } from "./helpers/parse-utils.js";
 import { parsePointCloud3DTile } from "./parse-3d-tile-point-cloud.js";
@@ -5,28 +10,23 @@ import { parseBatchedModel3DTile } from "./parse-3d-tile-batched-model.js";
 import { parseInstancedModel3DTile } from "./parse-3d-tile-instanced-model.js";
 import { parseComposite3DTile } from "./parse-3d-tile-composite.js";
 import { parseGltf3DTile } from "./parse-3d-tile-gltf.js";
-export async function parse3DTile(arrayBuffer) {
-  let byteOffset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-  let options = arguments.length > 2 ? arguments[2] : undefined;
-  let context = arguments.length > 3 ? arguments[3] : undefined;
-  let tile = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {
-    shape: 'tile3d'
-  };
-  tile.byteOffset = byteOffset;
-  tile.type = getMagicString(arrayBuffer, byteOffset);
-  switch (tile.type) {
-    case TILE3D_TYPE.COMPOSITE:
-      return await parseComposite3DTile(tile, arrayBuffer, byteOffset, options, context, parse3DTile);
-    case TILE3D_TYPE.BATCHED_3D_MODEL:
-      return await parseBatchedModel3DTile(tile, arrayBuffer, byteOffset, options, context);
-    case TILE3D_TYPE.GLTF:
-      return await parseGltf3DTile(tile, arrayBuffer, options, context);
-    case TILE3D_TYPE.INSTANCED_3D_MODEL:
-      return await parseInstancedModel3DTile(tile, arrayBuffer, byteOffset, options, context);
-    case TILE3D_TYPE.POINT_CLOUD:
-      return await parsePointCloud3DTile(tile, arrayBuffer, byteOffset, options, context);
-    default:
-      throw new Error(`3DTileLoader: unknown type ${tile.type}`);
-  }
+// Extracts
+export async function parse3DTile(arrayBuffer, byteOffset = 0, options, context, tile = { shape: 'tile3d' }) {
+    tile.byteOffset = byteOffset;
+    tile.type = getMagicString(arrayBuffer, byteOffset);
+    switch (tile.type) {
+        case TILE3D_TYPE.COMPOSITE:
+            // Note: We pass this function as argument so that embedded tiles can be parsed recursively
+            return await parseComposite3DTile(tile, arrayBuffer, byteOffset, options, context, parse3DTile);
+        case TILE3D_TYPE.BATCHED_3D_MODEL:
+            return await parseBatchedModel3DTile(tile, arrayBuffer, byteOffset, options, context);
+        case TILE3D_TYPE.GLTF:
+            return await parseGltf3DTile(tile, arrayBuffer, options, context);
+        case TILE3D_TYPE.INSTANCED_3D_MODEL:
+            return await parseInstancedModel3DTile(tile, arrayBuffer, byteOffset, options, context);
+        case TILE3D_TYPE.POINT_CLOUD:
+            return await parsePointCloud3DTile(tile, arrayBuffer, byteOffset, options, context);
+        default:
+            throw new Error(`3DTileLoader: unknown type ${tile.type}`); // eslint-disable-line
+    }
 }
-//# sourceMappingURL=parse-3d-tile.js.map

package/dist/lib/utils/obb/s2-corners-to-obb.js

@@ -1,23 +1,36 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright vis.gl contributors
 import { Vector3 } from '@math.gl/core';
 import { makeOrientedBoundingBoxFromPoints } from '@math.gl/culling';
 import { getS2OrientedBoundingBoxCornerPoints } from "../../utils/s2/index.js";
 import { getS2LngLat } from "../../utils/s2/index.js";
 import { Ellipsoid } from '@math.gl/geospatial';
+/**
+ * Converts S2VolumeInfo to OrientedBoundingBox
+ * @param {S2VolumeInfo} s2VolumeInfo - s2 volume to convert
+ * @returns Oriented Bounding Box of type Box
+ */
 export function convertS2BoundingVolumetoOBB(s2VolumeInfo) {
-  const token = s2VolumeInfo.token;
-  const heightInfo = {
-    minimumHeight: s2VolumeInfo.minimumHeight,
-    maximumHeight: s2VolumeInfo.maximumHeight
-  };
-  const corners = getS2OrientedBoundingBoxCornerPoints(token, heightInfo);
-  const center = getS2LngLat(token);
-  const centerLng = center[0];
-  const centerLat = center[1];
-  const point = Ellipsoid.WGS84.cartographicToCartesian([centerLng, centerLat, heightInfo.maximumHeight]);
-  const centerPointAdditional = new Vector3(point[0], point[1], point[2]);
-  corners.push(centerPointAdditional);
-  const obb = makeOrientedBoundingBoxFromPoints(corners);
-  const box = [...obb.center, ...obb.halfAxes];
-  return box;
+    const token = s2VolumeInfo.token;
+    const heightInfo = {
+        minimumHeight: s2VolumeInfo.minimumHeight,
+        maximumHeight: s2VolumeInfo.maximumHeight
+    };
+    const corners = getS2OrientedBoundingBoxCornerPoints(token, heightInfo);
+    // Add a point that doesn't allow the box dive under the Earth
+    const center = getS2LngLat(token);
+    const centerLng = center[0];
+    const centerLat = center[1];
+    const point = Ellipsoid.WGS84.cartographicToCartesian([
+        centerLng,
+        centerLat,
+        heightInfo.maximumHeight
+    ]);
+    const centerPointAdditional = new Vector3(point[0], point[1], point[2]);
+    corners.push(centerPointAdditional);
+    // corners should be an array of Vector3 (XYZ)
+    const obb = makeOrientedBoundingBoxFromPoints(corners);
+    const box = [...obb.center, ...obb.halfAxes];
+    return box;
 }
-//# sourceMappingURL=s2-corners-to-obb.js.map

package/dist/lib/utils/s2/converters/s2-to-boundary.d.ts

@@ -1,4 +1,4 @@
-import type { S2Cell } from '../s2geometry/s2-geometry';
+import type { S2Cell } from "../s2geometry/s2-geometry.js";
 /**
  * Get a polygon with corner coordinates for an S2 cell
  * @param s2cell {S2Cell} S2 cell

package/dist/lib/utils/s2/converters/s2-to-boundary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"s2-to-boundary.d.ts","sourceRoot":"","sources":["../../../../../src/lib/utils/s2/converters/s2-to-boundary.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,2BAA2B,CAAC;AAKtD;;;;;GAKG;AAEH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAsDxE"}
+{"version":3,"file":"s2-to-boundary.d.ts","sourceRoot":"","sources":["../../../../../src/lib/utils/s2/converters/s2-to-boundary.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,qCAAkC;AAKtD;;;;;GAKG;AAEH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAsDxE"}

package/dist/lib/utils/s2/converters/s2-to-boundary.js

@@ -1,40 +1,60 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright vis.gl contributors
 import { IJToST, STToUV, FaceUVToXYZ, XYZToLngLat } from "../s2geometry/s2-geometry.js";
 const MAX_RESOLUTION = 100;
+/**
+ * Get a polygon with corner coordinates for an S2 cell
+ * @param s2cell {S2Cell} S2 cell
+ * @return {Float64Array} - a simple polygon in flat array format: [lng0, lat0, lng1, lat1, ...]
+ *   - the polygon is closed, i.e. last coordinate is a copy of the first coordinate
+ */
+// eslint-disable-next-line max-statements
 export function getS2BoundaryFlatFromS2Cell(s2cell) {
-  const {
-    face,
-    ij,
-    level
-  } = s2cell;
-  const offsets = [[0, 0], [0, 1], [1, 1], [1, 0], [0, 0]];
-  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;
-      const st = IJToST(ij, level, offset);
-      const uv = STToUV(st);
-      const xyz = FaceUVToXYZ(face, uv);
-      const lngLat = XYZToLngLat(xyz);
-      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];
+    const { face, ij, level } = s2cell;
+    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];
+        }
     }
-  }
-  result[ptIndex++] = result[0];
-  result[ptIndex++] = result[1];
-  return result;
+    // close the loop
+    result[ptIndex++] = result[0];
+    result[ptIndex++] = result[1];
+    return result;
 }
-//# sourceMappingURL=s2-to-boundary.js.map

package/dist/lib/utils/s2/converters/s2-to-obb-points.js

@@ -1,24 +1,35 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright vis.gl contributors
 import { getS2Cell } from "../s2geometry/s2-cell-utils.js";
 import { getS2Region } from "./s2-to-region.js";
 import { Vector3 } from '@math.gl/core';
-export function getS2OrientedBoundingBoxCornerPoints(tokenOrKey, heightInfo) {
-  const min = (heightInfo === null || heightInfo === void 0 ? void 0 : heightInfo.minimumHeight) || 0;
-  const max = (heightInfo === null || heightInfo === void 0 ? void 0 : heightInfo.maximumHeight) || 0;
-  const s2cell = getS2Cell(tokenOrKey);
-  const region = getS2Region(s2cell);
-  const W = region.west;
-  const S = region.south;
-  const E = region.east;
-  const N = region.north;
-  const points = [];
-  points.push(new Vector3(W, N, min));
-  points.push(new Vector3(E, N, min));
-  points.push(new Vector3(E, S, min));
-  points.push(new Vector3(W, S, min));
-  points.push(new Vector3(W, N, max));
-  points.push(new Vector3(E, N, max));
-  points.push(new Vector3(E, S, max));
-  points.push(new Vector3(W, S, max));
-  return points;
+/**
+ * Converts S2HeightInfo to corner points of an oriented bounding box
+ * Can be used to constuct an OrientedBoundingBox instance
+ * @param tokenOrKey {string} A string that is the cell's hex token or the Hilbert quad key (containing /)
+ * @param heightInfo {S2HeightInfo} min and max height of the box
+ * @returns corner points of the oriented bounding box
+ */
+export function getS2OrientedBoundingBoxCornerPoints(tokenOrKey, // This can be an S2 key or token
+heightInfo) {
+    const min = heightInfo?.minimumHeight || 0;
+    const max = heightInfo?.maximumHeight || 0;
+    const s2cell = getS2Cell(tokenOrKey);
+    const region = getS2Region(s2cell);
+    // region lng/lat are in degrees
+    const W = region.west;
+    const S = region.south;
+    const E = region.east;
+    const N = region.north;
+    const points = [];
+    points.push(new Vector3(W, N, min));
+    points.push(new Vector3(E, N, min));
+    points.push(new Vector3(E, S, min));
+    points.push(new Vector3(W, S, min));
+    points.push(new Vector3(W, N, max));
+    points.push(new Vector3(E, N, max));
+    points.push(new Vector3(E, S, max));
+    points.push(new Vector3(W, S, max));
+    return points;
 }
-//# sourceMappingURL=s2-to-obb-points.js.map

package/dist/lib/utils/s2/converters/s2-to-region.d.ts

@@ -1,4 +1,4 @@
-import type { S2Cell } from '../s2geometry/s2-geometry';
+import type { S2Cell } from "../s2geometry/s2-geometry.js";
 /**
  * Converts S2 cell to the 2D region
  * @param s2cell {S2Cell} S2 cell to convert to 2D region

package/dist/lib/utils/s2/converters/s2-to-region.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"s2-to-region.d.ts","sourceRoot":"","sources":["../../../../../src/lib/utils/s2/converters/s2-to-region.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,2BAA2B,CAAC;AAItD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAqBA"}
+{"version":3,"file":"s2-to-region.d.ts","sourceRoot":"","sources":["../../../../../src/lib/utils/s2/converters/s2-to-region.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,qCAAkC;AAItD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAqBA"}

package/dist/lib/utils/s2/converters/s2-to-region.js

@@ -1,42 +1,58 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright vis.gl contributors
 import { getS2BoundaryFlatFromS2Cell } from "./s2-to-boundary.js";
 import { getS2Cell } from "../s2geometry/s2-cell-utils.js";
+/**
+ * Converts S2 cell to the 2D region
+ * @param s2cell {S2Cell} S2 cell to convert to 2D region
+ * @returns 2D region as an object containing: west, north, east, south in degrees
+ */
 export function getS2Region(s2cell) {
-  let region;
-  if (s2cell.face === 2 || s2cell.face === 5) {
-    let corners = null;
-    let len = 0;
-    for (let i = 0; i < 4; i++) {
-      const key = `${s2cell.face}/${i}`;
-      const cell = getS2Cell(key);
-      const corns = getS2BoundaryFlatFromS2Cell(cell);
-      if (typeof corners === 'undefined' || corners === null) corners = new Float64Array(4 * corns.length);
-      corners.set(corns, len);
-      len += corns.length;
+    let region;
+    if (s2cell.face === 2 || s2cell.face === 5) {
+        //    let corners: Float64Array;
+        let corners = null;
+        let len = 0;
+        for (let i = 0; i < 4; i++) {
+            const key = `${s2cell.face}/${i}`;
+            const cell = getS2Cell(key);
+            const corns = getS2BoundaryFlatFromS2Cell(cell);
+            if (typeof corners === 'undefined' || corners === null)
+                corners = new Float64Array(4 * corns.length);
+            corners.set(corns, len);
+            len += corns.length;
+        }
+        region = get2DRegionFromS2Corners(corners);
     }
-    region = get2DRegionFromS2Corners(corners);
-  } else {
-    const corners = getS2BoundaryFlatFromS2Cell(s2cell);
-    region = get2DRegionFromS2Corners(corners);
-  }
-  return region;
+    else {
+        const corners = getS2BoundaryFlatFromS2Cell(s2cell);
+        region = get2DRegionFromS2Corners(corners);
+    }
+    return region;
 }
+/**
+ * Converts the S2 cell defined by its corners to the 2D region
+ * @param corners {Float64Array} - a simple polygon in flat array format: [lng0, lat0, lng1, lat1, ...]
+ * @returns 2D region as an object containing: west, north, east, south in degrees
+ */
 function get2DRegionFromS2Corners(corners) {
-  if (corners.length % 2 !== 0) {
-    throw new Error('Invalid corners');
-  }
-  const longitudes = [];
-  const latitudes = [];
-  for (let i = 0; i < corners.length; i += 2) {
-    longitudes.push(corners[i]);
-    latitudes.push(corners[i + 1]);
-  }
-  longitudes.sort((a, b) => a - b);
-  latitudes.sort((a, b) => a - b);
-  return {
-    west: longitudes[0],
-    east: longitudes[longitudes.length - 1],
-    north: latitudes[latitudes.length - 1],
-    south: latitudes[0]
-  };
+    if (corners.length % 2 !== 0) {
+        throw new Error('Invalid corners');
+    }
+    const longitudes = [];
+    const latitudes = [];
+    for (let i = 0; i < corners.length; i += 2) {
+        longitudes.push(corners[i]);
+        latitudes.push(corners[i + 1]);
+    }
+    longitudes.sort((a, b) => a - b);
+    latitudes.sort((a, b) => a - b);
+    // Return the region in degrees
+    return {
+        west: longitudes[0],
+        east: longitudes[longitudes.length - 1],
+        north: latitudes[latitudes.length - 1],
+        south: latitudes[0]
+    };
 }
-//# sourceMappingURL=s2-to-region.js.map

package/dist/lib/utils/s2/index.d.ts

@@ -1,8 +1,8 @@
-export { getS2CellIdFromToken, getS2TokenFromCellId, getS2ChildCellId } from './s2-token-functions';
-export { getS2BoundaryFlat, getS2LngLat } from './s2-geometry-functions';
-export { getS2Cell, getS2QuadKey } from './s2geometry/s2-cell-utils';
-export { getS2QuadkeyFromCellId, getS2CellFromQuadKey, getS2CellIdFromQuadkey, getS2LngLatFromS2Cell } from './s2geometry/s2-geometry';
-export { getS2Region } from './converters/s2-to-region';
-export type { S2HeightInfo } from './converters/s2-to-obb-points';
-export { getS2OrientedBoundingBoxCornerPoints } from './converters/s2-to-obb-points';
+export { getS2CellIdFromToken, getS2TokenFromCellId, getS2ChildCellId } from "./s2-token-functions.js";
+export { getS2BoundaryFlat, getS2LngLat } from "./s2-geometry-functions.js";
+export { getS2Cell, getS2QuadKey } from "./s2geometry/s2-cell-utils.js";
+export { getS2QuadkeyFromCellId, getS2CellFromQuadKey, getS2CellIdFromQuadkey, getS2LngLatFromS2Cell } from "./s2geometry/s2-geometry.js";
+export { getS2Region } from "./converters/s2-to-region.js";
+export type { S2HeightInfo } from "./converters/s2-to-obb-points.js";
+export { getS2OrientedBoundingBoxCornerPoints } from "./converters/s2-to-obb-points.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/s2/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/s2/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,oBAAoB,EAAE,oBAAoB,EAAE,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAClG,OAAO,EAAC,iBAAiB,EAAE,WAAW,EAAC,MAAM,yBAAyB,CAAC;AAEvE,OAAO,EAAC,SAAS,EAAE,YAAY,EAAC,MAAM,4BAA4B,CAAC;AACnE,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACtB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAC,WAAW,EAAC,MAAM,2BAA2B,CAAC;AAEtD,YAAY,EAAC,YAAY,EAAC,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAC,oCAAoC,EAAC,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/s2/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,oBAAoB,EAAE,oBAAoB,EAAE,gBAAgB,EAAC,gCAA6B;AAClG,OAAO,EAAC,iBAAiB,EAAE,WAAW,EAAC,mCAAgC;AAEvE,OAAO,EAAC,SAAS,EAAE,YAAY,EAAC,sCAAmC;AACnE,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACtB,oCAAiC;AAElC,OAAO,EAAC,WAAW,EAAC,qCAAkC;AAEtD,YAAY,EAAC,YAAY,EAAC,yCAAsC;AAChE,OAAO,EAAC,oCAAoC,EAAC,yCAAsC"}

package/dist/lib/utils/s2/index.js

@@ -1,7 +1,9 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright vis.gl contributors
 export { getS2CellIdFromToken, getS2TokenFromCellId, getS2ChildCellId } from "./s2-token-functions.js";
 export { getS2BoundaryFlat, getS2LngLat } from "./s2-geometry-functions.js";
 export { getS2Cell, getS2QuadKey } from "./s2geometry/s2-cell-utils.js";
 export { getS2QuadkeyFromCellId, getS2CellFromQuadKey, getS2CellIdFromQuadkey, getS2LngLatFromS2Cell } from "./s2geometry/s2-geometry.js";
 export { getS2Region } from "./converters/s2-to-region.js";
 export { getS2OrientedBoundingBoxCornerPoints } from "./converters/s2-to-obb-points.js";
-//# sourceMappingURL=index.js.map

package/dist/lib/utils/s2/s2-geometry-functions.js

@@ -1,12 +1,26 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright vis.gl contributors
 import { getS2BoundaryFlatFromS2Cell } from "./converters/s2-to-boundary.js";
 import { getS2LngLatFromS2Cell } from "./s2geometry/s2-geometry.js";
 import { getS2Cell } from "./s2geometry/s2-cell-utils.js";
+// GEOMETRY
+/**
+ * Retrieve S2 geometry center
+ * @param s2Token {string} A string that is the cell's hex token
+ * @returns {[number, number]} Longitude and Latitude coordinates of the S2 cell's center
+ */
 export function getS2LngLat(s2Token) {
-  const s2cell = getS2Cell(s2Token);
-  return getS2LngLatFromS2Cell(s2cell);
+    const s2cell = getS2Cell(s2Token);
+    return getS2LngLatFromS2Cell(s2cell);
 }
+/**
+ * Get a polygon with corner coordinates for an s2 cell
+ * @param tokenOrKey {string} A string that is the cell's hex token or the Hilbert quad key (containing /)
+ * @return {Float64Array} - a simple polygon in flat array format: [lng0, lat0, lng1, lat1, ...]
+ *   - the polygon is closed, i.e. last coordinate is a copy of the first coordinate
+ */
 export function getS2BoundaryFlat(tokenOrKey) {
-  const s2cell = getS2Cell(tokenOrKey);
-  return getS2BoundaryFlatFromS2Cell(s2cell);
+    const s2cell = getS2Cell(tokenOrKey);
+    return getS2BoundaryFlatFromS2Cell(s2cell);
 }
-//# sourceMappingURL=s2-geometry-functions.js.map

package/dist/lib/utils/s2/s2-token-functions.js

@@ -1,32 +1,61 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright vis.gl contributors
 import Long from 'long';
 const MAXIMUM_TOKEN_LENGTH = 16;
+/**
+ * Convert the S2 token to the S2 cell ID
+ * @param token {string} A string that is the cell's hex token. Zero cell ID is represented as 'X'.
+ * @returns {Long} Cell id that is a 64-bit encoding of a face and a Hilbert curve parameter on that face.
+ * See {@link https://github.com/google/s2-geometry-library-java/blob/c04b68bf3197a9c34082327eeb3aec7ab7c85da1/src/com/google/common/geometry/S2CellId.java#L439} for more information
+ */
 export function getS2CellIdFromToken(token) {
-  if (token === 'X') {
-    token = '';
-  }
-  const paddedToken = token.padEnd(MAXIMUM_TOKEN_LENGTH, '0');
-  return Long.fromString(paddedToken, true, 16);
+    if (token === 'X') {
+        token = '';
+    }
+    // pad token with zeros to make the length 16 that is defined in MAXIMUM_TOKEN_LENGTH
+    const paddedToken = token.padEnd(MAXIMUM_TOKEN_LENGTH, '0');
+    return Long.fromString(paddedToken, true, 16); // Hex base
 }
+/**
+ * Convert the S2 cell ID to the S2 token
+ * @param cellId {Long} A 64-bit encoding of a face and a Hilbert curve parameter on that face.
+ * @returns {string} A string that is the cell's hex token. Zero cell ID is represented as 'X'.
+ */
 export function getS2TokenFromCellId(cellId) {
-  if (cellId.isZero()) {
-    return 'X';
-  }
-  let numZeroDigits = cellId.countTrailingZeros();
-  const remainder = numZeroDigits % 4;
-  numZeroDigits = (numZeroDigits - remainder) / 4;
-  const trailingZeroHexChars = numZeroDigits;
-  numZeroDigits *= 4;
-  const x = cellId.shiftRightUnsigned(numZeroDigits);
-  const hexString = x.toString(16).replace(/0+$/, '');
-  const zeroString = Array(17 - trailingZeroHexChars - hexString.length).join('0');
-  return zeroString + hexString;
+    if (cellId.isZero()) {
+        return 'X';
+    }
+    let numZeroDigits = cellId.countTrailingZeros();
+    const remainder = numZeroDigits % 4;
+    numZeroDigits = (numZeroDigits - remainder) / 4;
+    const trailingZeroHexChars = numZeroDigits;
+    numZeroDigits *= 4;
+    const x = cellId.shiftRightUnsigned(numZeroDigits);
+    const hexString = x.toString(16).replace(/0+$/, '');
+    const zeroString = Array(17 - trailingZeroHexChars - hexString.length).join('0');
+    return zeroString + hexString;
 }
+/**
+ * Get one of four S2 cell's children.
+ * @param cellId {Long} A 64-bit encoding of a face and a Hilbert curve parameter on that face.
+ * The cell must NOT be a leaf one. So, the cell's level is in the range [0-29].
+ * @param index {number} Child index defines one of four S2 cell's children. Must be in the range [0-3].
+ * @returns The ID of the cell's child.
+ */
 export function getS2ChildCellId(cellId, index) {
-  const newLsb = lsb(cellId).shiftRightUnsigned(2);
-  const childCellId = cellId.add(Long.fromNumber(2 * index + 1 - 4).multiply(newLsb));
-  return childCellId;
+    // Shift sentinel bit 2 positions to the right.
+    const newLsb = lsb(cellId).shiftRightUnsigned(2);
+    // Insert child index before the sentinel bit.
+    const childCellId = cellId.add(Long.fromNumber(2 * index + 1 - 4).multiply(newLsb));
+    return childCellId;
 }
+/**
+ * Return the lowest-numbered bit that is on for this cell id.
+ * @private
+ * @param cellId {Long} Cell id.
+ * @returns {Long} The lowest-numbered bit that is on for this cell id.
+ */
 function lsb(cellId) {
-  return cellId.and(cellId.not().add(1));
+    return cellId.and(cellId.not().add(1)); // eslint-disable-line
 }
-//# sourceMappingURL=s2-token-functions.js.map

package/dist/lib/utils/s2/s2geometry/s2-cell-utils.d.ts

@@ -1,4 +1,4 @@
-import type { S2Cell } from './s2-geometry';
+import type { S2Cell } from "./s2-geometry.js";
 /**
  * Return the S2Cell from the cell's hex token or the Hilbert quad key
  * @param tokenOrKey {string} A string that is the cell's hex token or the Hilbert quad key (containing /)

package/dist/lib/utils/s2/s2geometry/s2-cell-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"s2-cell-utils.d.ts","sourceRoot":"","sources":["../../../../../src/lib/utils/s2/s2geometry/s2-cell-utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,eAAe,CAAC;AAM1C;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAIpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAQvD"}
+{"version":3,"file":"s2-cell-utils.d.ts","sourceRoot":"","sources":["../../../../../src/lib/utils/s2/s2geometry/s2-cell-utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,yBAAsB;AAM1C;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAIpD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAQvD"}

package/dist/lib/utils/s2/s2geometry/s2-cell-utils.js

@@ -1,15 +1,29 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright vis.gl contributors
 import { getS2CellFromQuadKey, getS2QuadkeyFromCellId } from "./s2-geometry.js";
 import { getS2CellIdFromToken } from "../s2-token-functions.js";
+/**
+ * Return the S2Cell from the cell's hex token or the Hilbert quad key
+ * @param tokenOrKey {string} A string that is the cell's hex token or the Hilbert quad key (containing /)
+ * @returns {@link S2Cell}
+ */
 export function getS2Cell(tokenOrKey) {
-  const key = getS2QuadKey(tokenOrKey);
-  const s2cell = getS2CellFromQuadKey(key);
-  return s2cell;
+    const key = getS2QuadKey(tokenOrKey);
+    const s2cell = getS2CellFromQuadKey(key);
+    return s2cell;
 }
+/**
+ * Get the underlying Hilbert quad key
+ * @param tokenOrKey {string} A string that is the cell's hex token or the Hilbert quad key (containing /)
+ * @returns Hilbert quad key
+ */
 export function getS2QuadKey(tokenOrKey) {
-  if (tokenOrKey.indexOf('/') > 0) {
-    return tokenOrKey;
-  }
-  const id = getS2CellIdFromToken(tokenOrKey);
-  return getS2QuadkeyFromCellId(id);
+    if (tokenOrKey.indexOf('/') > 0) {
+        // is Hilbert quad key
+        return tokenOrKey;
+    }
+    // is S2 cell's hex token
+    const id = getS2CellIdFromToken(tokenOrKey);
+    return getS2QuadkeyFromCellId(id);
 }
-//# sourceMappingURL=s2-cell-utils.js.map