@cesium/engine 15.0.0 → 17.0.0

package/Source/Widget/CesiumWidget.js

@@ -2,7 +2,7 @@ import BoundingSphere from "../Core/BoundingSphere.js";
 import Cartesian3 from "../Core/Cartesian3.js";
 import Cartographic from "../Core/Cartographic.js";
 import Clock from "../Core/Clock.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import destroyObject from "../Core/destroyObject.js";
 import DeveloperError from "../Core/DeveloperError.js";
@@ -212,7 +212,7 @@ function CesiumWidget(container, options) {
 
   container = getElement(container);
 
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
   //Configure the widget DOM elements
   const element = document.createElement("div");
@@ -248,10 +248,8 @@ function CesiumWidget(container, options) {
     }
   }
 
-  const blurActiveElementOnCanvasFocus = defaultValue(
-    options.blurActiveElementOnCanvasFocus,
-    true,
-  );
+  const blurActiveElementOnCanvasFocus =
+    options.blurActiveElementOnCanvasFocus ?? true;
 
   if (blurActiveElementOnCanvasFocus) {
     canvas.addEventListener("mousedown", blurActiveElement);
@@ -272,12 +270,10 @@ function CesiumWidget(container, options) {
     ? getElement(options.creditViewport)
     : element;
 
-  const showRenderLoopErrors = defaultValue(options.showRenderLoopErrors, true);
+  const showRenderLoopErrors = options.showRenderLoopErrors ?? true;
 
-  const useBrowserRecommendedResolution = defaultValue(
-    options.useBrowserRecommendedResolution,
-    true,
-  );
+  const useBrowserRecommendedResolution =
+    options.useBrowserRecommendedResolution ?? true;
 
   this._element = element;
   this._container = container;
@@ -314,7 +310,7 @@ function CesiumWidget(container, options) {
   configureCanvasSize(this);
 
   try {
-    const ellipsoid = defaultValue(options.ellipsoid, Ellipsoid.default);
+    const ellipsoid = options.ellipsoid ?? Ellipsoid.default;
 
     const scene = new Scene({
       canvas: canvas,
@@ -324,7 +320,7 @@ function CesiumWidget(container, options) {
       ellipsoid: ellipsoid,
       mapProjection: options.mapProjection,
       orderIndependentTranslucency: options.orderIndependentTranslucency,
-      scene3DOnly: defaultValue(options.scene3DOnly, false),
+      scene3DOnly: options.scene3DOnly ?? false,
       shadows: options.shadows,
       mapMode2D: options.mapMode2D,
       requestRenderMode: options.requestRenderMode,
@@ -345,10 +341,7 @@ function CesiumWidget(container, options) {
     }
     if (globe !== false) {
       scene.globe = globe;
-      scene.globe.shadows = defaultValue(
-        options.terrainShadows,
-        ShadowMode.RECEIVE_ONLY,
-      );
+      scene.globe.shadows = options.terrainShadows ?? ShadowMode.RECEIVE_ONLY;
     }
 
     let skyBox = options.skyBox;
@@ -395,7 +388,7 @@ function CesiumWidget(container, options) {
           "Specify either options.terrainProvider or options.terrain.",
         );
       }
-      //>>includeEnd('debug')
+      //>>includeEnd('debug');
 
       scene.setTerrain(options.terrain);
     }
@@ -412,10 +405,7 @@ function CesiumWidget(container, options) {
     }
 
     this._useDefaultRenderLoop = undefined;
-    this.useDefaultRenderLoop = defaultValue(
-      options.useDefaultRenderLoop,
-      true,
-    );
+    this.useDefaultRenderLoop = options.useDefaultRenderLoop ?? true;
 
     this._targetFrameRate = undefined;
     this.targetFrameRate = options.targetFrameRate;
@@ -1134,6 +1124,8 @@ CesiumWidget.prototype._updateCanAnimate = function (isUpdated) {
   this._clock.canAnimate = isUpdated;
 };
 
+const boundingSphereScratch = new BoundingSphere();
+
 /**
  * @private
  */
@@ -1146,15 +1138,15 @@ CesiumWidget.prototype._onTick = function (clock) {
   }
 
   const entityView = this._entityView;
-  if (defined(entityView) && defined(entityView.boundingSphere)) {
+  if (defined(entityView)) {
     const trackedEntity = this._trackedEntity;
     const trackedState = this._dataSourceDisplay.getBoundingSphere(
       trackedEntity,
       false,
-      entityView.boundingSphere,
+      entityView.boundingSphere ?? boundingSphereScratch,
     );
     if (trackedState === BoundingSphereState.DONE) {
-      entityView.update(time, entityView.boundingSphere);
+      entityView.update(time);
     }
   }
 };

package/Source/Workers/createGeometry.js

@@ -1,5 +1,4 @@
 import DeveloperError from "../Core/DeveloperError.js";
-import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import PrimitivePipeline from "../Scene/PrimitivePipeline.js";
 import createTaskProcessorWorker from "./createTaskProcessorWorker.js";
@@ -8,7 +7,7 @@ import createTaskProcessorWorker from "./createTaskProcessorWorker.js";
 const moduleCache = {};
 
 async function getModule(moduleName, modulePath) {
-  let module = defaultValue(moduleCache[modulePath], moduleCache[moduleName]);
+  let module = moduleCache[modulePath] ?? moduleCache[moduleName];
 
   if (defined(module)) {
     return module;

package/Source/Workers/createVerticesFromGoogleEarthEnterpriseBuffer.js

@@ -3,7 +3,6 @@ import BoundingSphere from "../Core/BoundingSphere.js";
 import Cartesian2 from "../Core/Cartesian2.js";
 import Cartesian3 from "../Core/Cartesian3.js";
 import Cartographic from "../Core/Cartographic.js";
-import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import Ellipsoid from "../Core/Ellipsoid.js";
 import EllipsoidalOccluder from "../Core/EllipsoidalOccluder.js";
@@ -24,7 +23,7 @@ const sizeOfFloat = Float32Array.BYTES_PER_ELEMENT;
 const sizeOfDouble = Float64Array.BYTES_PER_ELEMENT;
 
 function indexOfEpsilon(arr, elem, elemType) {
-  elemType = defaultValue(elemType, CesiumMath);
+  elemType = elemType ?? CesiumMath;
   const count = arr.length;
   for (let i = 0; i < count; ++i) {
     if (elemType.equalsEpsilon(arr[i], elem, CesiumMath.EPSILON12)) {

package/Source/Workers/decodeI3S.js

@@ -1,5 +1,4 @@
 import createTaskProcessorWorker from "./createTaskProcessorWorker.js";
-import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import WebMercatorProjection from "../Core/WebMercatorProjection.js";
 import Ellipsoid from "../Core/Ellipsoid.js";
@@ -274,10 +273,7 @@ function getFeatureHash(symbologyData, outlinesHash, featureIndex) {
     indices: {},
     edges: {},
   });
-  const featureSymbology = defaultValue(
-    symbologyData[featureIndex],
-    symbologyData.default,
-  );
+  const featureSymbology = symbologyData[featureIndex] ?? symbologyData.default;
   newFeatureHash.hasOutline = defined(featureSymbology?.edges);
   return newFeatureHash;
 }

package/Source/Workers/transcodeKTX2.js

@@ -1,4 +1,3 @@
-import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import Check from "../Core/Check.js";
 import PixelFormat from "../Core/PixelFormat.js";
@@ -285,7 +284,7 @@ function transcodeCompressed(
 async function initWorker(parameters, transferableObjects) {
   // Require and compile WebAssembly module, or use fallback if not supported
   const wasmConfig = parameters.webAssemblyConfig;
-  const basisTranscoder = defaultValue(basis, self.BASIS);
+  const basisTranscoder = basis ?? self.BASIS;
   if (defined(wasmConfig.wasmBinaryFile)) {
     transcoderModule = await basisTranscoder(wasmConfig);
   } else {

package/index.d.ts

@@ -653,7 +653,7 @@ export class ArcGISTiledElevationTerrainProvider {
      * at points and in rectangles. This property may be undefined if availability
      * information is not available.
      */
-    readonly availability: TileAvailability;
+    readonly availability: TileAvailability | undefined;
     /**
      * Creates a {@link TerrainProvider} that produces terrain geometry by tessellating height maps
      * retrieved from Elevation Tiles of an an ArcGIS ImageService.
@@ -2912,7 +2912,7 @@ export class CesiumTerrainProvider {
      * exists deeper in the tree rather than it all being discoverable at the root. However, a tile that
      * is available now will not become unavailable in the future.
      */
-    readonly availability: TileAvailability;
+    readonly availability: TileAvailability | undefined;
     /**
      * Gets the maximum geometric error allowed in a tile at a given level.
      * @param level - The tile level for which to get the maximum geometric error.
@@ -3023,7 +3023,10 @@ export const Check: {
      * @param {*} test The value to test
      * @exception {DeveloperError} test must be typeof 'object'
      */
-    object(name: string, test: any): asserts test is object;
+    object(
+      name: string,
+      test: any,
+    ): asserts test is Record<string | number | symbol, any>;
     /**
      * Throws if test is not typeof 'boolean'
      *
@@ -6367,7 +6370,7 @@ export class EllipsoidTerrainProvider {
      * at points and in rectangles. This property may be undefined if availability
      * information is not available.
      */
-    readonly availability: TileAvailability;
+    readonly availability: TileAvailability | undefined;
     /**
      * Requests the geometry for a given tile. The result includes terrain
      * data and indicates that all child tiles are available.
@@ -6571,6 +6574,22 @@ export namespace FeatureDetection {
     function supportsEsmWebWorkers(): boolean;
 }
 
+/**
+ * Utilities helpful for setting a default value for a parameter.
+ */
+export namespace Frozen {
+    /**
+     * A frozen empty object that can be used as the default value for options passed as
+     * an object literal.
+     */
+    var EMPTY_OBJECT: any;
+    /**
+     * A frozen empty array that can be used as the default value for options passed as
+     * an array literal.
+     */
+    var EMPTY_ARRAY: any[];
+}
+
 /**
  * Describes a frustum at the given the origin and orientation.
  * @param options - Object with the following properties:
@@ -7568,7 +7587,7 @@ export class GoogleEarthEnterpriseTerrainData {
      * Uint8Array or image where a value of 255 indicates water and a value of 0 indicates land.
      * Values in between 0 and 255 are allowed as well to smoothly blend between land and water.
      */
-    waterMask: Uint8Array | HTMLImageElement | HTMLCanvasElement;
+    waterMask: Uint8Array | HTMLImageElement | HTMLCanvasElement | undefined;
     /**
      * Computes the terrain height at a specified longitude and latitude.
      * @param rectangle - The rectangle covered by this terrain data.
@@ -7679,7 +7698,7 @@ export class GoogleEarthEnterpriseTerrainProvider {
      * at points and in rectangles. This property may be undefined if availability
      * information is not available.
      */
-    readonly availability: TileAvailability;
+    readonly availability: TileAvailability | undefined;
     /**
      * Creates a GoogleEarthTerrainProvider from GoogleEarthEnterpriseMetadata
      * @example
@@ -8109,7 +8128,7 @@ export class HeightmapTerrainData {
      * Uint8Array or image where a value of 255 indicates water and a value of 0 indicates land.
      * Values in between 0 and 255 are allowed as well to smoothly blend between land and water.
      */
-    waterMask: Uint8Array | HTMLImageElement | HTMLCanvasElement;
+    waterMask: Uint8Array | HTMLImageElement | HTMLCanvasElement | undefined;
     /**
      * Computes the terrain height at a specified longitude and latitude.
      * @param rectangle - The rectangle covered by this terrain data.
@@ -8407,8 +8426,17 @@ export namespace ITwinPlatform {
     }
     /**
      * Gets or sets the default iTwin access token. This token should have the <code>itwin-platform</code> scope.
+     *
+     * This value will be ignored if {@link ITwinPlatform.defaultShareKey} is defined.
      */
     var defaultAccessToken: string | undefined;
+    /**
+     * Gets or sets the default iTwin share key. If this value is provided it will override {@link ITwinPlatform.defaultAccessToken} in all requests.
+     *
+     * Share keys can be generated using the iTwin Shares api
+     * https://developer.bentley.com/apis/access-control-v2/operations/create-itwin-share/
+     */
+    var defaultShareKey: string | undefined;
     /**
      * Gets or sets the default iTwin API endpoint.
      */
@@ -13109,8 +13137,9 @@ export class PolygonGeometry {
      * @param array - The packed array.
      * @param [startingIndex = 0] - The starting index of the element to be unpacked.
      * @param [result] - The object into which to store the result.
+     * @returns The modified result parameter or a new PolygonGeometry instance if one was not provided.
      */
-    static unpack(array: number[], startingIndex?: number, result?: PolygonGeometry): void;
+    static unpack(array: number[], startingIndex?: number, result?: PolygonGeometry): PolygonGeometry;
     /**
      * Computes a rectangle which encloses the polygon defined by the list of positions, including cases over the international date line and the poles.
      * @param positions - A linear ring defining the outer boundary of the polygon.
@@ -13658,7 +13687,7 @@ export class QuantizedMeshTerrainData {
      * Uint8Array or image where a value of 255 indicates water and a value of 0 indicates land.
      * Values in between 0 and 255 are allowed as well to smoothly blend between land and water.
      */
-    waterMask: Uint8Array | HTMLImageElement | HTMLCanvasElement;
+    waterMask: Uint8Array | HTMLImageElement | HTMLCanvasElement | undefined;
     /**
      * Upsamples this terrain data for use by a descendant tile.  The resulting instance will contain a subset of the
      * vertices in this instance, interpolated if necessary.
@@ -13685,7 +13714,7 @@ export class QuantizedMeshTerrainData {
     interpolateHeight(rectangle: Rectangle, longitude: number, latitude: number): number;
     /**
      * Determines if a given child tile is available, based on the
-     * {@link HeightmapTerrainData.childTileMask}.  The given child tile coordinates are assumed
+     * {@link QuantizedMeshTerrainData.childTileMask}.  The given child tile coordinates are assumed
      * to be one of the four children of this tile.  If non-child tile coordinates are
      * given, the availability of the southeast child tile is returned.
      * @param thisX - The tile X coordinate of this (the parent) tile.
@@ -14602,7 +14631,7 @@ export class RectangleOutlineGeometry {
      * @param array - The packed array.
      * @param [startingIndex = 0] - The starting index of the element to be unpacked.
      * @param [result] - The object into which to store the result.
-     * @returns The modified result parameter or a new Quaternion instance if one was not provided.
+     * @returns The modified result parameter or a new RectangleOutlineGeometry instance if one was not provided.
      */
     static unpack(array: number[], startingIndex?: number, result?: RectangleOutlineGeometry): RectangleOutlineGeometry;
     /**
@@ -16412,7 +16441,7 @@ export class TerrainData {
      * Uint8Array or image where a value of 255 indicates water and a value of 0 indicates land.
      * Values in between 0 and 255 are allowed as well to smoothly blend between land and water.
      */
-    waterMask: Uint8Array | HTMLImageElement | HTMLCanvasElement;
+    waterMask: Uint8Array | HTMLImageElement | HTMLCanvasElement | undefined;
     /**
      * Computes the terrain height at a specified longitude and latitude.
      * @param rectangle - The rectangle covered by this terrain data.
@@ -16504,7 +16533,7 @@ export class TerrainProvider {
      * at points and in rectangles. This property may be undefined if availability
      * information is not available.
      */
-    readonly availability: TileAvailability;
+    readonly availability: TileAvailability | undefined;
     /**
      * Gets a list of indices for a triangle mesh representing a regular grid.  Calling
      * this function multiple times with the same grid width and height returns the
@@ -17705,7 +17734,7 @@ export class VRTheWorldTerrainProvider {
      * at points and in rectangles. This property may be undefined if availability
      * information is not available.
      */
-    readonly availability: TileAvailability;
+    readonly availability: TileAvailability | undefined;
     /**
      * Creates a {@link TerrainProvider} that produces terrain geometry by tessellating height maps
      * retrieved from a {@link http://vr-theworld.com/|VT MÄK VR-TheWorld server}.
@@ -29213,10 +29242,6 @@ export class Cesium3DTilesVoxelProvider extends VoxelProvider {
      * Gets the metadata component types.
      */
     readonly componentTypes: MetadataComponentType[];
-    /**
-     * Gets the ordering of the metadata in the buffers.
-     */
-    readonly metadataOrder: VoxelMetadataOrder;
     /**
      * Gets the metadata minimum values.
      */
@@ -34202,7 +34227,7 @@ export namespace ImageryLayer {
      *                          <code>function(frameState, layer, x, y, level)</code>.  The function is passed the
      *                          current frame state, this layer, and the x, y, and level coordinates
      *                          of the imagery tile for which the hue is required, and it is expected to return
-     *                          the contrast value to use for the tile.  The function is executed for every
+     *                          the hue value to use for the tile.  The function is executed for every
      *                          frame and for every tile, so it must be fast.
      * @property [saturation = 1.0] - The saturation of this layer.  1.0 uses the unmodified imagery color.
      *                          Less than 1.0 reduces the saturation while greater than 1.0 increases it.
@@ -34210,7 +34235,7 @@ export namespace ImageryLayer {
      *                          <code>function(frameState, layer, x, y, level)</code>.  The function is passed the
      *                          current frame state, this layer, and the x, y, and level coordinates
      *                          of the imagery tile for which the saturation is required, and it is expected to return
-     *                          the contrast value to use for the tile.  The function is executed for every
+     *                          the saturation value to use for the tile.  The function is executed for every
      *                          frame and for every tile, so it must be fast.
      * @property [gamma = 1.0] - The gamma correction to apply to this layer.  1.0 uses the unmodified imagery color.
      *                          This can either be a simple number or a function with the signature
@@ -38520,9 +38545,9 @@ export enum VaryingType {
     /**
      * A 3x3 matrix of floating point values.
      */
-    MAT3 = "mat2",
+    MAT3 = "mat3",
     /**
-     * A 3x3 matrix of floating point values.
+     * A 4x4 matrix of floating point values.
      */
     MAT4 = "mat4"
 }
@@ -40983,6 +41008,42 @@ export class PrimitiveCollection {
     destroy(): void;
 }
 
+/**
+ * A simple Least Recently Used (LRU) cache implementation.
+ */
+export class LRUCache {
+}
+
+/**
+ * Creates a spatial hash key for the given longitude, latitude, and tile level.
+ * The precision is adjusted based on the tile level and extent to achieve finer precision at higher levels.
+ *
+ * This function calculates the spatial hash key by first determining the precision at the given tile for the current maximum screenspace error (MAX_ERROR_PX),
+ * and then rounding the longitude and latitude to that precision for consistency.
+ *
+ * The steps for computing the level precision are as follows:
+ *
+ * 1. Compute the resolution (meters per pixel) at the given level:
+ *      level_resolution_m = (2 * PI * RADIUS) / (2^level * TILE_SIZE)
+ *
+ * 2. Compute the target precision in meters:
+ *      level_precision_m = level_resolution_m * MAX_ERROR_PX
+ *
+ * 3. Compute the target precision to radians:
+ *      level_precision_rad = level_precision_m / BODY_RADIUS
+ *
+ * This simplifies to:
+ *      level_precision_rad = (2 * PI * MAX_ERROR_PX) / (2^level * TILE_SIZE)
+ * which can also be written as:
+ *      level_precision_rad = (PI * MAX_ERROR_PX) / (2^(level-1) * TILE_SIZE)
+ *
+ * The computed level_precision_rad is then used to round the input longitude and latitude,
+ * ensuring that positions that fall within the same spatial bin produce the same hash key.
+ *
+ * The constants below are computed once since they are fixed for the given configuration.
+ */
+export const TILE_SIZE = 256;
+
 /**
  * The container for all 3D graphical objects and state in a Cesium virtual scene.  Generally,
  * a scene is not created directly; instead, it is implicitly created by {@link CesiumWidget}.
@@ -43612,17 +43673,6 @@ export class VoxelContent {
  */
 export const metadata: Int8Array[] | Uint8Array[] | Int16Array[] | Uint16Array[] | Int32Array[] | Uint32Array[] | Float32Array[] | Float64Array[];
 
-/**
- * Metadata ordering for voxel content.
- * In all cases, x data is contiguous in strides along the y axis,
- * and each group of y strides represents a z slice.
- * However, the orientation of the axes follows different conventions.
- */
-export enum VoxelMetadataOrder {
-    XYZ = 0,
-    GLTF = 1
-}
-
 /**
  * A primitive that renders voxel data from a {@link VoxelProvider}.
  * @param [options] - Object with the following properties:
@@ -43913,10 +43963,6 @@ export class VoxelProvider {
      * Gets the metadata component types.
      */
     readonly componentTypes: MetadataComponentType[];
-    /**
-     * Gets the ordering of the metadata in the buffers.
-     */
-    readonly metadataOrder: VoxelMetadataOrder;
     /**
      * Gets the metadata minimum values.
      */