@cesium/engine 15.0.0 → 16.0.0

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.
@@ -6367,7 +6367,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 +6571,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 +7584,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 +7695,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 +8125,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 +8423,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.
      */
@@ -13658,7 +13683,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 +13710,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.
@@ -16412,7 +16437,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 +16529,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 +17730,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 +29238,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.
      */
@@ -38520,9 +38541,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 +41004,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 +43669,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 +43959,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.
      */