@cesium/engine 26.1.0 → 26.3.0

package/Source/Core/HermitePolynomialApproximation.js

@@ -1,9 +1,22 @@
+// @ts-check
+
 import defined from "./defined.js";
 import DeveloperError from "./DeveloperError.js";
 import CesiumMath from "./Math.js";
 
 const factorial = CesiumMath.factorial;
 
+/**
+ * @param {number} x
+ * @param {number[]} zIndices
+ * @param {number[]} xTable
+ * @param {number} derivOrder
+ * @param {number} termOrder
+ * @param {number[]} reservedIndices
+ * @returns {number}
+ *
+ * @private
+ */
 function calculateCoefficientTerm(
   x,
   zIndices,
@@ -61,223 +74,245 @@ function calculateCoefficientTerm(
 }
 
 /**
- * An {@link InterpolationAlgorithm} for performing Hermite interpolation.
+ * @type {number[]}
  *
- * @namespace HermitePolynomialApproximation
+ * @private
  */
-const HermitePolynomialApproximation = {
-  type: "Hermite",
-};
+const arrayScratch = [];
 
 /**
- * Given the desired degree, returns the number of data points required for interpolation.
+ * An {@link InterpolationAlgorithm} for performing Hermite interpolation.
  *
- * @param {number} degree The desired degree of interpolation.
- * @param {number} [inputOrder=0]  The order of the inputs (0 means just the data, 1 means the data and its derivative, etc).
- * @returns {number} The number of required data points needed for the desired degree of interpolation.
- * @exception {DeveloperError} degree must be 0 or greater.
- * @exception {DeveloperError} inputOrder must be 0 or greater.
+ * @namespace HermitePolynomialApproximation
  */
-HermitePolynomialApproximation.getRequiredDataPoints = function (
-  degree,
-  inputOrder,
-) {
-  inputOrder = inputOrder ?? 0;
-
-  //>>includeStart('debug', pragmas.debug);
-  if (!defined(degree)) {
-    throw new DeveloperError("degree is required.");
+class HermitePolynomialApproximation {
+  /**
+   * Gets the name of this interpolation algorithm.
+   * @type {string}
+   */
+  static get type() {
+    return "Hermite";
   }
-  if (degree < 0) {
-    throw new DeveloperError("degree must be 0 or greater.");
-  }
-  if (inputOrder < 0) {
-    throw new DeveloperError("inputOrder must be 0 or greater.");
-  }
-  //>>includeEnd('debug');
 
-  return Math.max(Math.floor((degree + 1) / (inputOrder + 1)), 2);
-};
+  /**
+   * Given the desired degree, returns the number of data points required for interpolation.
+   *
+   * @param {number} degree The desired degree of interpolation.
+   * @param {number} [inputOrder=0]  The order of the inputs (0 means just the data, 1 means the data and its derivative, etc).
+   * @returns {number} The number of required data points needed for the desired degree of interpolation.
+   * @exception {DeveloperError} degree must be 0 or greater.
+   * @exception {DeveloperError} inputOrder must be 0 or greater.
+   */
+  static getRequiredDataPoints(degree, inputOrder) {
+    inputOrder = inputOrder ?? 0;
+
+    //>>includeStart('debug', pragmas.debug);
+    if (!defined(degree)) {
+      throw new DeveloperError("degree is required.");
+    }
+    if (degree < 0) {
+      throw new DeveloperError("degree must be 0 or greater.");
+    }
+    if (inputOrder < 0) {
+      throw new DeveloperError("inputOrder must be 0 or greater.");
+    }
+    //>>includeEnd('debug');
 
-/**
- * Interpolates values using Hermite Polynomial Approximation.
- *
- * @param {number} x The independent variable for which the dependent variables will be interpolated.
- * @param {number[]} xTable The array of independent variables to use to interpolate.  The values
- * in this array must be in increasing order and the same value must not occur twice in the array.
- * @param {number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
- * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}.
- * @param {number} yStride The number of dependent variable values in yTable corresponding to
- * each independent variable value in xTable.
- * @param {number[]} [result] An existing array into which to store the result.
- * @returns {number[]} The array of interpolated values, or the result parameter if one was provided.
- */
-HermitePolynomialApproximation.interpolateOrderZero = function (
-  x,
-  xTable,
-  yTable,
-  yStride,
-  result,
-) {
-  if (!defined(result)) {
-    result = new Array(yStride);
+    return Math.max(Math.floor((degree + 1) / (inputOrder + 1)), 2);
   }
 
-  let i;
-  let j;
-  let d;
-  let s;
-  let len;
-  let index;
-  const length = xTable.length;
-  const coefficients = new Array(yStride);
-
-  for (i = 0; i < yStride; i++) {
-    result[i] = 0;
-
-    const l = new Array(length);
-    coefficients[i] = l;
-    for (j = 0; j < length; j++) {
-      l[j] = [];
+  /**
+   * Interpolates values using Hermite Polynomial Approximation.
+   *
+   * @param {number} x The independent variable for which the dependent variables will be interpolated.
+   * @param {number[]} xTable The array of independent variables to use to interpolate.  The values
+   * in this array must be in increasing order and the same value must not occur twice in the array.
+   * @param {number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
+   * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}.
+   * @param {number} yStride The number of dependent variable values in yTable corresponding to
+   * each independent variable value in xTable.
+   * @param {number[]} [result] An existing array into which to store the result.
+   * @returns {number[]} The array of interpolated values, or the result parameter if one was provided.
+   */
+  static interpolateOrderZero(x, xTable, yTable, yStride, result) {
+    if (!defined(result)) {
+      result = new Array(yStride);
     }
-  }
 
-  const zIndicesLength = length,
-    zIndices = new Array(zIndicesLength);
+    let i;
+    let j;
+    let d;
+    let s;
+    let len;
+    let index;
+    const length = xTable.length;
+    const coefficients = new Array(yStride);
+
+    for (i = 0; i < yStride; i++) {
+      result[i] = 0;
+
+      const l = new Array(length);
+      coefficients[i] = l;
+      for (j = 0; j < length; j++) {
+        l[j] = [];
+      }
+    }
 
-  for (i = 0; i < zIndicesLength; i++) {
-    zIndices[i] = i;
-  }
+    const zIndicesLength = length,
+      zIndices = new Array(zIndicesLength);
 
-  let highestNonZeroCoef = length - 1;
-  for (s = 0; s < yStride; s++) {
-    for (j = 0; j < zIndicesLength; j++) {
-      index = zIndices[j] * yStride + s;
-      coefficients[s][0].push(yTable[index]);
+    for (i = 0; i < zIndicesLength; i++) {
+      zIndices[i] = i;
     }
 
-    for (i = 1; i < zIndicesLength; i++) {
-      let nonZeroCoefficients = false;
-      for (j = 0; j < zIndicesLength - i; j++) {
-        const zj = xTable[zIndices[j]];
-        const zn = xTable[zIndices[j + i]];
+    let highestNonZeroCoef = length - 1;
+    for (s = 0; s < yStride; s++) {
+      for (j = 0; j < zIndicesLength; j++) {
+        index = zIndices[j] * yStride + s;
+        coefficients[s][0].push(yTable[index]);
+      }
 
-        let numerator;
-        if (zn - zj <= 0) {
-          index = zIndices[j] * yStride + yStride * i + s;
-          numerator = yTable[index];
-          coefficients[s][i].push(numerator / factorial(i));
-        } else {
-          numerator = coefficients[s][i - 1][j + 1] - coefficients[s][i - 1][j];
-          coefficients[s][i].push(numerator / (zn - zj));
+      for (i = 1; i < zIndicesLength; i++) {
+        let nonZeroCoefficients = false;
+        for (j = 0; j < zIndicesLength - i; j++) {
+          const zj = xTable[zIndices[j]];
+          const zn = xTable[zIndices[j + i]];
+
+          let numerator;
+          if (zn - zj <= 0) {
+            index = zIndices[j] * yStride + yStride * i + s;
+            numerator = yTable[index];
+            coefficients[s][i].push(numerator / factorial(i));
+          } else {
+            numerator =
+              coefficients[s][i - 1][j + 1] - coefficients[s][i - 1][j];
+            coefficients[s][i].push(numerator / (zn - zj));
+          }
+          nonZeroCoefficients = nonZeroCoefficients || numerator !== 0;
         }
-        nonZeroCoefficients = nonZeroCoefficients || numerator !== 0;
-      }
 
-      if (!nonZeroCoefficients) {
-        highestNonZeroCoef = i - 1;
+        if (!nonZeroCoefficients) {
+          highestNonZeroCoef = i - 1;
+        }
       }
     }
-  }
 
-  for (d = 0, len = 0; d <= len; d++) {
-    for (i = d; i <= highestNonZeroCoef; i++) {
-      const tempTerm = calculateCoefficientTerm(x, zIndices, xTable, d, i, []);
-      for (s = 0; s < yStride; s++) {
-        const coeff = coefficients[s][i][0];
-        result[s + d * yStride] += coeff * tempTerm;
+    for (d = 0, len = 0; d <= len; d++) {
+      for (i = d; i <= highestNonZeroCoef; i++) {
+        const tempTerm = calculateCoefficientTerm(
+          x,
+          zIndices,
+          xTable,
+          d,
+          i,
+          [],
+        );
+        for (s = 0; s < yStride; s++) {
+          const coeff = coefficients[s][i][0];
+          result[s + d * yStride] += coeff * tempTerm;
+        }
       }
     }
-  }
-
-  return result;
-};
-
-const arrayScratch = [];
-
-/**
- * Interpolates values using Hermite Polynomial Approximation.
- *
- * @param {number} x The independent variable for which the dependent variables will be interpolated.
- * @param {number[]} xTable The array of independent variables to use to interpolate.  The values
- * in this array must be in increasing order and the same value must not occur twice in the array.
- * @param {number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
- * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}.
- * @param {number} yStride The number of dependent variable values in yTable corresponding to
- * each independent variable value in xTable.
- * @param {number} inputOrder The number of derivatives supplied for input.
- * @param {number} outputOrder The number of derivatives desired for output.
- * @param {number[]} [result] An existing array into which to store the result.
- *
- * @returns {number[]} The array of interpolated values, or the result parameter if one was provided.
- */
-HermitePolynomialApproximation.interpolate = function (
-  x,
-  xTable,
-  yTable,
-  yStride,
-  inputOrder,
-  outputOrder,
-  result,
-) {
-  const resultLength = yStride * (outputOrder + 1);
-  if (!defined(result)) {
-    result = new Array(resultLength);
-  }
-  for (let r = 0; r < resultLength; r++) {
-    result[r] = 0;
-  }
 
-  const length = xTable.length;
-  // The zIndices array holds copies of the addresses of the xTable values
-  // in the range we're looking at. Even though this just holds information already
-  // available in xTable this is a much more convenient format.
-  const zIndices = new Array(length * (inputOrder + 1));
-  let i;
-  for (i = 0; i < length; i++) {
-    for (let j = 0; j < inputOrder + 1; j++) {
-      zIndices[i * (inputOrder + 1) + j] = i;
-    }
+    return result;
   }
 
-  const zIndiceslength = zIndices.length;
-  const coefficients = arrayScratch;
-  const highestNonZeroCoef = fillCoefficientList(
-    coefficients,
-    zIndices,
+  /**
+   * Interpolates values using Hermite Polynomial Approximation.
+   *
+   * @param {number} x The independent variable for which the dependent variables will be interpolated.
+   * @param {number[]} xTable The array of independent variables to use to interpolate.  The values
+   * in this array must be in increasing order and the same value must not occur twice in the array.
+   * @param {number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
+   * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}.
+   * @param {number} yStride The number of dependent variable values in yTable corresponding to
+   * each independent variable value in xTable.
+   * @param {number} inputOrder The number of derivatives supplied for input.
+   * @param {number} outputOrder The number of derivatives desired for output.
+   * @param {number[]} [result] An existing array into which to store the result.
+   *
+   * @returns {number[]} The array of interpolated values, or the result parameter if one was provided.
+   */
+  static interpolate(
+    x,
     xTable,
     yTable,
     yStride,
     inputOrder,
-  );
-  const reservedIndices = [];
+    outputOrder,
+    result,
+  ) {
+    const resultLength = yStride * (outputOrder + 1);
+    if (!defined(result)) {
+      result = new Array(resultLength);
+    }
+    for (let r = 0; r < resultLength; r++) {
+      result[r] = 0;
+    }
 
-  const tmp = (zIndiceslength * (zIndiceslength + 1)) / 2;
-  const loopStop = Math.min(highestNonZeroCoef, outputOrder);
-  for (let d = 0; d <= loopStop; d++) {
-    for (i = d; i <= highestNonZeroCoef; i++) {
-      reservedIndices.length = 0;
-      const tempTerm = calculateCoefficientTerm(
-        x,
-        zIndices,
-        xTable,
-        d,
-        i,
-        reservedIndices,
-      );
-      const dimTwo = Math.floor((i * (1 - i)) / 2) + zIndiceslength * i;
+    const length = xTable.length;
+    // The zIndices array holds copies of the addresses of the xTable values
+    // in the range we're looking at. Even though this just holds information already
+    // available in xTable this is a much more convenient format.
+    const zIndices = new Array(length * (inputOrder + 1));
+    let i;
+    for (i = 0; i < length; i++) {
+      for (let j = 0; j < inputOrder + 1; j++) {
+        zIndices[i * (inputOrder + 1) + j] = i;
+      }
+    }
 
-      for (let s = 0; s < yStride; s++) {
-        const dimOne = Math.floor(s * tmp);
-        const coef = coefficients[dimOne + dimTwo];
-        result[s + d * yStride] += coef * tempTerm;
+    const zIndiceslength = zIndices.length;
+    const coefficients = arrayScratch;
+    const highestNonZeroCoef = fillCoefficientList(
+      coefficients,
+      zIndices,
+      xTable,
+      yTable,
+      yStride,
+      inputOrder,
+    );
+    /** @type {number[]} */
+    const reservedIndices = [];
+
+    const tmp = (zIndiceslength * (zIndiceslength + 1)) / 2;
+    const loopStop = Math.min(highestNonZeroCoef, outputOrder);
+    for (let d = 0; d <= loopStop; d++) {
+      for (i = d; i <= highestNonZeroCoef; i++) {
+        reservedIndices.length = 0;
+        const tempTerm = calculateCoefficientTerm(
+          x,
+          zIndices,
+          xTable,
+          d,
+          i,
+          reservedIndices,
+        );
+        const dimTwo = Math.floor((i * (1 - i)) / 2) + zIndiceslength * i;
+
+        for (let s = 0; s < yStride; s++) {
+          const dimOne = Math.floor(s * tmp);
+          const coef = coefficients[dimOne + dimTwo];
+          result[s + d * yStride] += coef * tempTerm;
+        }
       }
     }
-  }
 
-  return result;
-};
+    return result;
+  }
+}
 
+/**
+ * @param {number[]} coefficients
+ * @param {number[]} zIndices
+ * @param {number[]} xTable
+ * @param {number[]} yTable
+ * @param {number} yStride
+ * @param {number} inputOrder
+ * @returns {number}
+ *
+ * @private
+ */
 function fillCoefficientList(
   coefficients,
   zIndices,
@@ -338,4 +373,5 @@ function fillCoefficientList(
 
   return highestNonZero;
 }
+
 export default HermitePolynomialApproximation;

package/Source/Core/InterpolationAlgorithm.js

@@ -52,6 +52,7 @@ class InterpolationAlgorithm {
    * if this function remains undefined on implementing objects, interpolateOrderZero will be used instead.
    *
    * @function
+   * @optional
    * @param {number} x The independent variable for which the dependent variables will be interpolated.
    * @param {number[]} xTable The array of independent variables to use to interpolate.  The values
    * in this array must be in increasing order and the same value must not occur twice in the array.

package/Source/Core/Ion.js

@@ -4,7 +4,7 @@ import Resource from "./Resource.js";
 
 let defaultTokenCredit;
 const defaultAccessToken =
-  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzNzRjZTkzNC05M2UwLTRlNDItOWU0My1hYjk5YjFiNTNhYTMiLCJpZCI6MjU5LCJzdWIiOiJDZXNpdW1KUyIsImlzcyI6Imh0dHBzOi8vYXBpLmNlc2l1bS5jb20iLCJhdWQiOiIxLjE0MyBSZWxlYXNlIC0gRGVsZXRlIG9uIFNlcHRlbWJlciAxLCAyMDI2IiwiaWF0IjoxNzgyMzY4NzY4fQ.kDcFqK7jTTloOcBbwb-epSQGd1Lu12_hRuqk1XRE_H8";
+  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJub25jZSI6ImwwendUTkl3UVk5Uk5XdEkiLCJqdGkiOiJjZGFkZDZlNC0wMDI5LTQ5OTMtYWIwMC01ZWY4ZDVlNTBhMzYiLCJpZCI6MjU5LCJzdWIiOiJDZXNpdW1KUyIsImlzcyI6Imh0dHBzOi8vYXBpLmNlc2l1bS5jb20iLCJhdWQiOiIxLjE0NSBSZWxlYXNlIC0gRGVsZXRlIG9uIE5vdmVtYmVyIDEsIDIwMjYiLCJpYXQiOjE3ODc2MzQ3NzV9.3SPieoGxEZ22pnWLETAIFZveR0xXTzvOh8G4NYTxDSo";
 /**
  * Default settings for accessing the Cesium ion API.
  *

package/Source/Core/IonResource.js

@@ -270,6 +270,11 @@ function addClientHeaders(headers = {}) {
   return headers;
 }
 
+/**
+ * @private
+ **/
+IonResource._addClientHeaders = addClientHeaders;
+
 function retryCallback(that, error) {
   const ionRoot = that._ionRoot ?? that;
   const endpointResource = ionRoot._ionEndpointResource;

package/Source/Core/IonSnapGeometryType.js

@@ -0,0 +1,59 @@
+/**
+ * The type of geometry a snap resolved to, reported by {@link IonSnapService#snap}
+ * as {@link IonSnapService.Result} <code>geometryType</code>. Values match the iTwin.js
+ * {@link https://www.itwinjs.org/reference/core-frontend/locatingelements/hitgeomtype/|HitGeomType} enum.
+ *
+ * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ *
+ * @enum {number}
+ */
+const IonSnapGeometryType = {
+  /**
+   * No geometry type.
+   * @type {number}
+   * @constant
+   */
+  NONE: 0,
+  /**
+   * A point.
+   * @type {number}
+   * @constant
+   */
+  POINT: 1,
+  /**
+   * A line segment.
+   * @type {number}
+   * @constant
+   */
+  SEGMENT: 2,
+  /**
+   * A curve.
+   * @type {number}
+   * @constant
+   */
+  CURVE: 3,
+  /**
+   * An arc.
+   * @type {number}
+   * @constant
+   */
+  ARC: 4,
+  /**
+   * A surface.
+   * <p>
+   * With {@link IonSnapMode} <code>NEAREST</code>, this value indicates
+   * the snap tracked the surface under the cursor because no edge was within
+   * the snap aperture. This means the snap point was not pulled to an edge.
+   * Edge snaps report one of the other types along with the edge geometry in
+   * {@link IonSnapService.Result} <code>curve</code>, which is absent when
+   * tracking a surface.
+   * </p>
+   * @type {number}
+   * @constant
+   */
+  SURFACE: 5,
+};
+
+Object.freeze(IonSnapGeometryType);
+
+export default IonSnapGeometryType;

package/Source/Core/IonSnapHeat.js

@@ -0,0 +1,33 @@
+/**
+ * How close a snap result is to the cursor, reported by {@link IonSnapService#snap}
+ * as {@link IonSnapService.Result} <code>heat</code>. Values match the iTwin.js
+ * {@link https://www.itwinjs.org/reference/core-frontend/locatingelements/snapheat/|SnapHeat} enum.
+ *
+ * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ *
+ * @enum {number}
+ */
+const IonSnapHeat = {
+  /**
+   * The snap is not close to the cursor.
+   * @type {number}
+   * @constant
+   */
+  NONE: 0,
+  /**
+   * The snap is of interest, but outside the snap aperture.
+   * @type {number}
+   * @constant
+   */
+  NOT_IN_RANGE: 1,
+  /**
+   * The snap point is within the snap aperture of the close point in view space.
+   * @type {number}
+   * @constant
+   */
+  IN_RANGE: 2,
+};
+
+Object.freeze(IonSnapHeat);
+
+export default IonSnapHeat;

package/Source/Core/IonSnapMode.js

@@ -0,0 +1,45 @@
+/**
+ * The snap modes supported by {@link IonSnapService#snap}. These follow the
+ * MicroStation snap mode semantics; see the
+ * {@link https://docs.bentley.com/LiveContent/web/MicroStation%20Help-v27/en/GUID-77D54C0B-D6FF-13DA-5EC8-3196330F5244.html|MicroStation documentation}
+ * for reference.
+ *
+ * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ *
+ * @enum {number}
+ */
+const IonSnapMode = {
+  /**
+   * Snaps to the point on the element nearest to the cursor. When the cursor
+   * is farther than the snap aperture from an edge, tracks the surface under
+   * the cursor instead.
+   * @type {number}
+   * @constant
+   */
+  NEAREST: 1,
+  /**
+   * Snaps to the nearest of the element's keypoints. Keypoints are defined by
+   * the element's geometry type and the snap divisor.
+   * <p>
+   * On linear elements, keypoints are regularly spaced along each segment:
+   * the number of keypoints on a segment is one greater than the snap
+   * divisor, and a segment's midpoint is a keypoint only when the divisor is
+   * even. The ion API does not currently accept a snap divisor, so the
+   * server's default divisor applies.
+   * </p>
+   * @type {number}
+   * @constant
+   */
+  NEAREST_KEYPOINT: 2,
+  /**
+   * Snaps to the center of elements that have centers (such as circles and
+   * arcs). For other elements, may snap to the centroid.
+   * @type {number}
+   * @constant
+   */
+  CENTER: 8,
+};
+
+Object.freeze(IonSnapMode);
+
+export default IonSnapMode;

package/Source/Core/IonSnapParentGeometryType.js

@@ -0,0 +1,52 @@
+/**
+ * The type of the parent geometry a snap resolved to, reported by
+ * {@link IonSnapService#snap} as {@link IonSnapService.Result} <code>parentGeometryType</code>.
+ * Values match the iTwin.js
+ * {@link https://www.itwinjs.org/reference/core-frontend/locatingelements/hitparentgeomtype/|HitParentGeomType} enum.
+ *
+ * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
+ *
+ * @enum {number}
+ */
+const IonSnapParentGeometryType = {
+  /**
+   * No parent geometry type.
+   * @type {number}
+   * @constant
+   */
+  NONE: 0,
+  /**
+   * A wire body.
+   * @type {number}
+   * @constant
+   */
+  WIRE: 1,
+  /**
+   * A sheet body.
+   * @type {number}
+   * @constant
+   */
+  SHEET: 2,
+  /**
+   * A solid body.
+   * @type {number}
+   * @constant
+   */
+  SOLID: 3,
+  /**
+   * A mesh.
+   * @type {number}
+   * @constant
+   */
+  MESH: 4,
+  /**
+   * Text.
+   * @type {number}
+   * @constant
+   */
+  TEXT: 5,
+};
+
+Object.freeze(IonSnapParentGeometryType);
+
+export default IonSnapParentGeometryType;