@cesium/engine 15.0.0 → 17.0.0

package/Source/Scene/PolylineMaterialAppearance.js

@@ -1,4 +1,4 @@
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import FeatureDetection from "../Core/FeatureDetection.js";
 import VertexFormat from "../Core/VertexFormat.js";
@@ -48,9 +48,9 @@ if (!FeatureDetection.isInternetExplorer()) {
  * });
  */
 function PolylineMaterialAppearance(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
-  const translucent = defaultValue(options.translucent, true);
+  const translucent = options.translucent ?? true;
   const closed = false;
   const vertexFormat = PolylineMaterialAppearance.VERTEX_FORMAT;
 
@@ -78,14 +78,10 @@ function PolylineMaterialAppearance(options) {
    */
   this.translucent = translucent;
 
-  this._vertexShaderSource = defaultValue(
-    options.vertexShaderSource,
-    defaultVertexShaderSource,
-  );
-  this._fragmentShaderSource = defaultValue(
-    options.fragmentShaderSource,
-    defaultFragmentShaderSource,
-  );
+  this._vertexShaderSource =
+    options.vertexShaderSource ?? defaultVertexShaderSource;
+  this._fragmentShaderSource =
+    options.fragmentShaderSource ?? defaultFragmentShaderSource;
   this._renderState = Appearance.getDefaultRenderState(
     translucent,
     closed,

package/Source/Scene/PostProcessStage.js

@@ -3,7 +3,7 @@ import Check from "../Core/Check.js";
 import Color from "../Core/Color.js";
 import combine from "../Core/combine.js";
 import createGuid from "../Core/createGuid.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";
@@ -92,7 +92,7 @@ import PostProcessStageSampleMode from "./PostProcessStageSampleMode.js";
  * stage.selected = [cesium3DTileFeature];
  */
 function PostProcessStage(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
   const {
     name = createGuid(),
     fragmentShader,

package/Source/Scene/PostProcessStageComposite.js

@@ -1,6 +1,6 @@
 import Check from "../Core/Check.js";
 import createGuid from "../Core/createGuid.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";
 
@@ -74,7 +74,7 @@ import destroyObject from "../Core/destroyObject.js";
  * }));
  */
 function PostProcessStageComposite(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
   //>>includeStart('debug', pragmas.debug);
   Check.defined("options.stages", options.stages);
@@ -86,10 +86,7 @@ function PostProcessStageComposite(options) {
   //>>includeEnd('debug');
 
   this._stages = options.stages;
-  this._inputPreviousStageTexture = defaultValue(
-    options.inputPreviousStageTexture,
-    true,
-  );
+  this._inputPreviousStageTexture = options.inputPreviousStageTexture ?? true;
 
   let name = options.name;
   if (!defined(name)) {

package/Source/Scene/Primitive.js

@@ -7,7 +7,7 @@ import clone from "../Core/clone.js";
 import Color from "../Core/Color.js";
 import combine from "../Core/combine.js";
 import ComponentDatatype from "../Core/ComponentDatatype.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";
@@ -152,7 +152,7 @@ import ShadowMode from "./ShadowMode.js";
  * @see GroundPrimitive
  */
 function Primitive(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
   /**
    * The geometry instances rendered with this primitive.  This may
@@ -224,9 +224,7 @@ function Primitive(options) {
    * const origin = Cesium.Cartesian3.fromDegrees(-95.0, 40.0, 200000.0);
    * p.modelMatrix = Cesium.Transforms.eastNorthUpToFixedFrame(origin);
    */
-  this.modelMatrix = Matrix4.clone(
-    defaultValue(options.modelMatrix, Matrix4.IDENTITY),
-  );
+  this.modelMatrix = Matrix4.clone(options.modelMatrix ?? Matrix4.IDENTITY);
   this._modelMatrix = new Matrix4();
 
   /**
@@ -237,17 +235,14 @@ function Primitive(options) {
    *
    * @default true
    */
-  this.show = defaultValue(options.show, true);
+  this.show = options.show ?? true;
 
-  this._vertexCacheOptimize = defaultValue(options.vertexCacheOptimize, false);
-  this._interleave = defaultValue(options.interleave, false);
-  this._releaseGeometryInstances = defaultValue(
-    options.releaseGeometryInstances,
-    true,
-  );
-  this._allowPicking = defaultValue(options.allowPicking, true);
-  this._asynchronous = defaultValue(options.asynchronous, true);
-  this._compressVertices = defaultValue(options.compressVertices, true);
+  this._vertexCacheOptimize = options.vertexCacheOptimize ?? false;
+  this._interleave = options.interleave ?? false;
+  this._releaseGeometryInstances = options.releaseGeometryInstances ?? true;
+  this._allowPicking = options.allowPicking ?? true;
+  this._asynchronous = options.asynchronous ?? true;
+  this._compressVertices = options.compressVertices ?? true;
 
   /**
    * When <code>true</code>, the renderer frustum culls and horizon culls the primitive's commands
@@ -258,7 +253,7 @@ function Primitive(options) {
    *
    * @default true
    */
-  this.cull = defaultValue(options.cull, true);
+  this.cull = options.cull ?? true;
 
   /**
    * This property is for debugging only; it is not for production use nor is it optimized.
@@ -270,10 +265,7 @@ function Primitive(options) {
    *
    * @default false
    */
-  this.debugShowBoundingVolume = defaultValue(
-    options.debugShowBoundingVolume,
-    false,
-  );
+  this.debugShowBoundingVolume = options.debugShowBoundingVolume ?? false;
 
   /**
    * @private
@@ -300,7 +292,7 @@ function Primitive(options) {
    *
    * @default ShadowMode.DISABLED
    */
-  this.shadows = defaultValue(options.shadows, ShadowMode.DISABLED);
+  this.shadows = options.shadows ?? ShadowMode.DISABLED;
 
   this._translucent = undefined;
 
@@ -648,7 +640,7 @@ function createBatchTable(primitive, context) {
     }
 
     const pickObject = {
-      primitive: defaultValue(instance.pickPrimitive, primitive),
+      primitive: instance.pickPrimitive ?? primitive,
     };
 
     if (defined(instance.id)) {
@@ -1211,10 +1203,8 @@ function loadAsynchronous(primitive, frameState) {
         geometry = subTask.geometry;
         if (defined(geometry.constructor.pack)) {
           subTask.offset = packedLength;
-          packedLength += defaultValue(
-            geometry.constructor.packedLength,
-            geometry.packedLength,
-          );
+          packedLength +=
+            geometry.constructor.packedLength ?? geometry.packedLength;
         }
       }
 
@@ -2201,26 +2191,17 @@ Primitive.prototype.update = function (frameState) {
   const twoPasses = appearance.closed && translucent;
 
   if (createRS) {
-    const rsFunc = defaultValue(
-      this._createRenderStatesFunction,
-      createRenderStates,
-    );
+    const rsFunc = this._createRenderStatesFunction ?? createRenderStates;
     rsFunc(this, context, appearance, twoPasses);
   }
 
   if (createSP) {
-    const spFunc = defaultValue(
-      this._createShaderProgramFunction,
-      createShaderProgram,
-    );
+    const spFunc = this._createShaderProgramFunction ?? createShaderProgram;
     spFunc(this, frameState, appearance);
   }
 
   if (createRS || createSP) {
-    const commandFunc = defaultValue(
-      this._createCommandsFunction,
-      createCommands,
-    );
+    const commandFunc = this._createCommandsFunction ?? createCommands;
     commandFunc(
       this,
       appearance,
@@ -2233,10 +2214,8 @@ Primitive.prototype.update = function (frameState) {
     );
   }
 
-  const updateAndQueueCommandsFunc = defaultValue(
-    this._updateAndQueueCommandsFunction,
-    updateAndQueueCommands,
-  );
+  const updateAndQueueCommandsFunc =
+    this._updateAndQueueCommandsFunction ?? updateAndQueueCommands;
   updateAndQueueCommandsFunc(
     this,
     frameState,

package/Source/Scene/PrimitiveCollection.js

@@ -1,5 +1,5 @@
 import createGuid from "../Core/createGuid.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";
@@ -28,7 +28,7 @@ import Event from "../Core/Event.js";
  * scene.primitives.add(labels);      // Add regular primitive
  */
 function PrimitiveCollection(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
   this._primitives = [];
   this._guid = createGuid();
@@ -44,7 +44,7 @@ function PrimitiveCollection(options) {
    * @type {boolean}
    * @default true
    */
-  this.show = defaultValue(options.show, true);
+  this.show = options.show ?? true;
 
   /**
    * Determines if primitives in the collection are destroyed when they are removed by
@@ -70,7 +70,7 @@ function PrimitiveCollection(options) {
    * const b = labels.isDestroyed(); // false
    * labels = labels.destroy();    // explicitly destroy
    */
-  this.destroyPrimitives = defaultValue(options.destroyPrimitives, true);
+  this.destroyPrimitives = options.destroyPrimitives ?? true;
 }
 
 Object.defineProperties(PrimitiveCollection.prototype, {

package/Source/Scene/PrimitivePipeline.js

@@ -1,6 +1,5 @@
 import BoundingSphere from "../Core/BoundingSphere.js";
 import ComponentDatatype from "../Core/ComponentDatatype.js";
-import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import DeveloperError from "../Core/DeveloperError.js";
 import Ellipsoid from "../Core/Ellipsoid.js";
@@ -472,7 +471,7 @@ PrimitivePipeline.packCreateGeometryResults = function (
 
     packedData[count++] = geometry.primitiveType;
     packedData[count++] = geometry.geometryType;
-    packedData[count++] = defaultValue(geometry.offsetAttribute, -1);
+    packedData[count++] = geometry.offsetAttribute ?? -1;
 
     const validBoundingSphere = defined(geometry.boundingSphere) ? 1.0 : 0.0;
     packedData[count++] = validBoundingSphere;

package/Source/Scene/PropertyAttribute.js

@@ -1,5 +1,5 @@
 import Check from "../Core/Check.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import PropertyAttributeProperty from "./PropertyAttributeProperty.js";
 
@@ -23,7 +23,7 @@ import PropertyAttributeProperty from "./PropertyAttributeProperty.js";
  * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
  */
 function PropertyAttribute(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
   const propertyAttribute = options.propertyAttribute;
   const classDefinition = options.class;
 

package/Source/Scene/PropertyAttributeProperty.js

@@ -1,5 +1,5 @@
 import Check from "../Core/Check.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 
 /**
@@ -20,7 +20,7 @@ import defined from "../Core/defined.js";
  * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
  */
 function PropertyAttributeProperty(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
   const property = options.property;
   const classProperty = options.classProperty;
 
@@ -45,8 +45,8 @@ function PropertyAttributeProperty(options) {
   // the class property. The class property handles setting the default of
   // identity: (offset 0, scale 1) with the same scalar/vector/matrix types.
   // array types are disallowed by the spec.
-  offset = defaultValue(offset, classProperty.offset);
-  scale = defaultValue(scale, classProperty.scale);
+  offset = offset ?? classProperty.offset;
+  scale = scale ?? classProperty.scale;
 
   // offset and scale are applied on the GPU, so unpack the values
   // as math types we can use in uniform callbacks.

package/Source/Scene/PropertyTable.js

@@ -1,5 +1,5 @@
 import Check from "../Core/Check.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import DeveloperError from "../Core/DeveloperError.js";
 import defined from "../Core/defined.js";
 import JsonMetadataTable from "./JsonMetadataTable.js";
@@ -38,7 +38,7 @@ import JsonMetadataTable from "./JsonMetadataTable.js";
  * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
  */
 function PropertyTable(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.number("options.count", options.count);

package/Source/Scene/PropertyTexture.js

@@ -1,5 +1,5 @@
 import Check from "../Core/Check.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import PropertyTextureProperty from "./PropertyTextureProperty.js";
 
@@ -24,7 +24,7 @@ import PropertyTextureProperty from "./PropertyTextureProperty.js";
  * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
  */
 function PropertyTexture(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
   const propertyTexture = options.propertyTexture;
   const classDefinition = options.class;
   const textures = options.textures;

package/Source/Scene/PropertyTextureProperty.js

@@ -1,5 +1,5 @@
 import Check from "../Core/Check.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import GltfLoaderUtil from "./GltfLoaderUtil.js";
 import MetadataType from "./MetadataType.js";
@@ -26,7 +26,7 @@ import oneTimeWarning from "../Core/oneTimeWarning.js";
  * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
  */
 function PropertyTextureProperty(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
   const property = options.property;
   const classProperty = options.classProperty;
   const textures = options.textures;
@@ -60,8 +60,8 @@ function PropertyTextureProperty(options) {
   // the class property. The class property handles setting the default of
   // identity: (offset 0, scale 1) with the same scalar/vector/matrix types.
   // array types are disallowed by the spec.
-  offset = defaultValue(offset, classProperty.offset);
-  scale = defaultValue(scale, classProperty.scale);
+  offset = offset ?? classProperty.offset;
+  scale = scale ?? classProperty.scale;
 
   // offset and scale are applied on the GPU, so unpack the values
   // as math types we can use in uniform callbacks.

package/Source/Scene/QuadtreePrimitive.js

@@ -1,6 +1,5 @@
 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 DeveloperError from "../Core/DeveloperError.js";
 import Event from "../Core/Event.js";
@@ -108,10 +107,7 @@ function QuadtreePrimitive(options) {
    * @type {number}
    * @default 2
    */
-  this.maximumScreenSpaceError = defaultValue(
-    options.maximumScreenSpaceError,
-    2,
-  );
+  this.maximumScreenSpaceError = options.maximumScreenSpaceError ?? 2;
 
   /**
    * Gets or sets the maximum number of tiles that will be retained in the tile cache.
@@ -121,7 +117,7 @@ function QuadtreePrimitive(options) {
    * @type {number}
    * @default 100
    */
-  this.tileCacheSize = defaultValue(options.tileCacheSize, 100);
+  this.tileCacheSize = options.tileCacheSize ?? 100;
 
   /**
    * Gets or sets the number of loading descendant tiles that is considered "too many".
@@ -1418,6 +1414,8 @@ function updateHeights(primitive, frameState) {
       ) {
         tryNextFrame.push(tile);
       }
+      // Ensure stale position cache is cleared
+      tile.clearPositionCache();
       tilesToUpdateHeights.shift();
       primitive._lastTileIndex = 0;
       continue;
@@ -1435,80 +1433,104 @@ function updateHeights(primitive, frameState) {
         defined(terrainData) && terrainData.wasCreatedByUpsampling();
 
       if (tile.level > data.level && !upsampledGeometryFromParent) {
-        if (!defined(data.positionOnEllipsoidSurface)) {
-          // cartesian has to be on the ellipsoid surface for `ellipsoid.geodeticSurfaceNormal`
-          data.positionOnEllipsoidSurface = Cartesian3.fromRadians(
-            data.positionCartographic.longitude,
-            data.positionCartographic.latitude,
-            0.0,
-            ellipsoid,
-          );
-        }
-
-        if (mode === SceneMode.SCENE3D) {
-          const surfaceNormal = ellipsoid.geodeticSurfaceNormal(
-            data.positionOnEllipsoidSurface,
-            scratchRay.direction,
-          );
+        let position;
+        // find cached entry
+        const cachedData = tile.getPositionCacheEntry(
+          data.positionCartographic,
+          primitive.maximumScreenSpaceError,
+        );
+        if (defined(cachedData)) {
+          // cache hit
+          position = cachedData;
+        } else {
+          if (!defined(data.positionOnEllipsoidSurface)) {
+            // cartesian has to be on the ellipsoid surface for `ellipsoid.geodeticSurfaceNormal`
+            data.positionOnEllipsoidSurface = Cartesian3.fromRadians(
+              data.positionCartographic.longitude,
+              data.positionCartographic.latitude,
+              0.0,
+              ellipsoid,
+            );
+          }
 
-          // compute origin point
+          if (mode === SceneMode.SCENE3D) {
+            const surfaceNormal = ellipsoid.geodeticSurfaceNormal(
+              data.positionOnEllipsoidSurface,
+              scratchRay.direction,
+            );
 
-          // Try to find the intersection point between the surface normal and z-axis.
-          // minimum height (-11500.0) for the terrain set, need to get this information from the terrain provider
-          const rayOrigin = ellipsoid.getSurfaceNormalIntersectionWithZAxis(
-            data.positionOnEllipsoidSurface,
-            11500.0,
-            scratchRay.origin,
-          );
+            // compute origin point
 
-          // Theoretically, not with Earth datums, the intersection point can be outside the ellipsoid
-          if (!defined(rayOrigin)) {
-            // intersection point is outside the ellipsoid, try other value
+            // Try to find the intersection point between the surface normal and z-axis.
             // minimum height (-11500.0) for the terrain set, need to get this information from the terrain provider
-            let minimumHeight = 0.0;
-            if (defined(tile.data.tileBoundingRegion)) {
-              minimumHeight = tile.data.tileBoundingRegion.minimumHeight;
-            }
-            const magnitude = Math.min(minimumHeight, -11500.0);
-
-            // multiply by the *positive* value of the magnitude
-            const vectorToMinimumPoint = Cartesian3.multiplyByScalar(
-              surfaceNormal,
-              Math.abs(magnitude) + 1,
-              scratchPosition,
-            );
-            Cartesian3.subtract(
+            const rayOrigin = ellipsoid.getSurfaceNormalIntersectionWithZAxis(
               data.positionOnEllipsoidSurface,
-              vectorToMinimumPoint,
+              11500.0,
               scratchRay.origin,
             );
+
+            // Theoretically, not with Earth datums, the intersection point can be outside the ellipsoid
+            if (!defined(rayOrigin)) {
+              // intersection point is outside the ellipsoid, try other value
+              // minimum height (-11500.0) for the terrain set, need to get this information from the terrain provider
+              let minimumHeight = 0.0;
+              if (defined(tile.data.tileBoundingRegion)) {
+                minimumHeight = tile.data.tileBoundingRegion.minimumHeight;
+              }
+              const magnitude = Math.min(minimumHeight, -11500.0);
+
+              // multiply by the *positive* value of the magnitude
+              const vectorToMinimumPoint = Cartesian3.multiplyByScalar(
+                surfaceNormal,
+                Math.abs(magnitude) + 1,
+                scratchPosition,
+              );
+              Cartesian3.subtract(
+                data.positionOnEllipsoidSurface,
+                vectorToMinimumPoint,
+                scratchRay.origin,
+              );
+            }
+          } else {
+            Cartographic.clone(data.positionCartographic, scratchCartographic);
+
+            // minimum height for the terrain set, need to get this information from the terrain provider
+            scratchCartographic.height = -11500.0;
+            projection.project(scratchCartographic, scratchPosition);
+            Cartesian3.fromElements(
+              scratchPosition.z,
+              scratchPosition.x,
+              scratchPosition.y,
+              scratchPosition,
+            );
+            Cartesian3.clone(scratchPosition, scratchRay.origin);
+            Cartesian3.clone(Cartesian3.UNIT_X, scratchRay.direction);
           }
-        } else {
-          Cartographic.clone(data.positionCartographic, scratchCartographic);
-
-          // minimum height for the terrain set, need to get this information from the terrain provider
-          scratchCartographic.height = -11500.0;
-          projection.project(scratchCartographic, scratchPosition);
-          Cartesian3.fromElements(
-            scratchPosition.z,
-            scratchPosition.x,
-            scratchPosition.y,
+
+          position = tile.data.pick(
+            scratchRay,
+            mode,
+            projection,
+            false,
             scratchPosition,
           );
-          Cartesian3.clone(scratchPosition, scratchRay.origin);
-          Cartesian3.clone(Cartesian3.UNIT_X, scratchRay.direction);
-        }
 
-        const position = tile.data.pick(
-          scratchRay,
-          mode,
-          projection,
-          false,
-          scratchPosition,
-        );
+          if (defined(position)) {
+            // Store the computed position in the cache for future reuse
+            tile.setPositionCacheEntry(
+              data.positionCartographic,
+              primitive.maximumScreenSpaceError,
+              position,
+            );
+          }
+        }
         if (defined(position)) {
           if (defined(data.callback)) {
-            data.callback(position);
+            const positionCarto = ellipsoid.cartesianToCartographic(
+              position,
+              scratchCartographic,
+            );
+            data.callback(positionCarto);
           }
           data.level = tile.level;
         }