@cesium/engine 14.0.0 → 16.0.0

package/Source/DataSources/EntityCluster.js

@@ -1,7 +1,7 @@
 import BoundingRectangle from "../Core/BoundingRectangle.js";
 import Cartesian2 from "../Core/Cartesian2.js";
 import Cartesian3 from "../Core/Cartesian3.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import EllipsoidalOccluder from "../Core/EllipsoidalOccluder.js";
 import Event from "../Core/Event.js";
@@ -33,14 +33,14 @@ import KDBush from "kdbush";
  * @demo {@link https://sandcastle.cesium.com/index.html?src=Clustering.html|Cesium Sandcastle Clustering Demo}
  */
 function EntityCluster(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
-  this._enabled = defaultValue(options.enabled, false);
-  this._pixelRange = defaultValue(options.pixelRange, 80);
-  this._minimumClusterSize = defaultValue(options.minimumClusterSize, 2);
-  this._clusterBillboards = defaultValue(options.clusterBillboards, true);
-  this._clusterLabels = defaultValue(options.clusterLabels, true);
-  this._clusterPoints = defaultValue(options.clusterPoints, true);
+  this._enabled = options.enabled ?? false;
+  this._pixelRange = options.pixelRange ?? 80;
+  this._minimumClusterSize = options.minimumClusterSize ?? 2;
+  this._clusterBillboards = options.clusterBillboards ?? true;
+  this._clusterLabels = options.clusterLabels ?? true;
+  this._clusterPoints = options.clusterPoints ?? true;
 
   this._labelCollection = undefined;
   this._billboardCollection = undefined;
@@ -73,7 +73,7 @@ function EntityCluster(options) {
    * @type {boolean}
    * @default true
    */
-  this.show = defaultValue(options.show, true);
+  this.show = options.show ?? true;
 }
 
 function expandBoundingBox(bbox, pixelRange) {
@@ -610,6 +610,25 @@ Object.defineProperties(EntityCluster.prototype, {
       this._clusterPoints = value;
     },
   },
+
+  /**
+   * Returns true when all clustered data has been rendered.
+   * @memberof EntityCluster.prototype
+   * @type {boolean}
+   * @readonly
+   * @private
+   */
+  ready: {
+    get: function () {
+      return (
+        !this._enabledDirty &&
+        !this._clusterDirty &&
+        (!defined(this._billboardCollection) ||
+          this._billboardCollection.ready) &&
+        (!defined(this._labelCollection) || this._labelCollection.ready)
+      );
+    },
+  },
 });
 
 function createGetEntity(
@@ -866,28 +885,30 @@ EntityCluster.prototype.update = function (frameState) {
   // the glyphs haven't been created so the screen space bounding boxes
   // are incorrect.
   let commandList;
+  const labelCollection = this._labelCollection;
   if (
-    defined(this._labelCollection) &&
-    this._labelCollection.length > 0 &&
-    this._labelCollection.get(0)._glyphs.length === 0
+    defined(labelCollection) &&
+    labelCollection.length > 0 &&
+    !labelCollection.ready
   ) {
     commandList = frameState.commandList;
     frameState.commandList = [];
-    this._labelCollection.update(frameState);
+    labelCollection.update(frameState);
     frameState.commandList = commandList;
   }
 
-  // If clustering is enabled before the billboard collection is updated,
+  // If clustering is enabled before the billboard collections are updated,
   // the images haven't been added to the image atlas so the screen space bounding boxes
   // are incorrect.
+  const billboardCollection = this._billboardCollection;
   if (
-    defined(this._billboardCollection) &&
-    this._billboardCollection.length > 0 &&
-    !defined(this._billboardCollection.get(0).width)
+    defined(billboardCollection) &&
+    billboardCollection.length > 0 &&
+    !billboardCollection.ready
   ) {
     commandList = frameState.commandList;
     frameState.commandList = [];
-    this._billboardCollection.update(frameState);
+    billboardCollection.update(frameState);
     frameState.commandList = commandList;
   }
 
@@ -898,8 +919,12 @@ EntityCluster.prototype.update = function (frameState) {
   }
 
   if (this._clusterDirty) {
-    this._clusterDirty = false;
     this._cluster();
+
+    // Unless all existing billboards and labels were clustered, clustering will need to execute again next frame
+    this._clusterDirty =
+      (defined(labelCollection) && !labelCollection.ready) ||
+      (defined(billboardCollection) && !billboardCollection.ready);
   }
 
   if (defined(this._clusterLabelCollection)) {
@@ -912,11 +937,11 @@ EntityCluster.prototype.update = function (frameState) {
     this._clusterPointCollection.update(frameState);
   }
 
-  if (defined(this._labelCollection)) {
-    this._labelCollection.update(frameState);
+  if (defined(labelCollection)) {
+    labelCollection.update(frameState);
   }
-  if (defined(this._billboardCollection)) {
-    this._billboardCollection.update(frameState);
+  if (defined(billboardCollection)) {
+    billboardCollection.update(frameState);
   }
   if (defined(this._pointCollection)) {
     this._pointCollection.update(frameState);
@@ -932,6 +957,11 @@ EntityCluster.prototype.update = function (frameState) {
  * </p>
  */
 EntityCluster.prototype.destroy = function () {
+  if (defined(this._removeEventListener)) {
+    this._removeEventListener();
+    this._removeEventListener = undefined;
+  }
+
   this._labelCollection =
     this._labelCollection && this._labelCollection.destroy();
   this._billboardCollection =
@@ -947,11 +977,6 @@ EntityCluster.prototype.destroy = function () {
   this._clusterPointCollection =
     this._clusterPointCollection && this._clusterPointCollection.destroy();
 
-  if (defined(this._removeEventListener)) {
-    this._removeEventListener();
-    this._removeEventListener = undefined;
-  }
-
   this._labelCollection = undefined;
   this._billboardCollection = undefined;
   this._pointCollection = undefined;

package/Source/DataSources/EntityView.js

@@ -1,6 +1,5 @@
 import Cartesian3 from "../Core/Cartesian3.js";
 import Check from "../Core/Check.js";
-import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import Ellipsoid from "../Core/Ellipsoid.js";
 import HeadingPitchRange from "../Core/HeadingPitchRange.js";
@@ -344,7 +343,7 @@ function EntityView(entity, scene, ellipsoid) {
    * The ellipsoid to use for orienting the camera.
    * @type {Ellipsoid}
    */
-  this.ellipsoid = defaultValue(ellipsoid, Ellipsoid.default);
+  this.ellipsoid = ellipsoid ?? Ellipsoid.default;
 
   /**
    * The bounding sphere of the object.

package/Source/DataSources/GeoJsonDataSource.js

@@ -3,7 +3,7 @@ import Cartesian3 from "../Core/Cartesian3.js";
 import Color from "../Core/Color.js";
 import createGuid from "../Core/createGuid.js";
 import Credit from "../Core/Credit.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import DeveloperError from "../Core/DeveloperError.js";
 import Event from "../Core/Event.js";
@@ -275,7 +275,7 @@ function createPoint(dataSource, geoJson, crsFunction, coordinates, options) {
       color = Color.fromCssColorString(cssColor);
     }
 
-    size = defaultValue(sizes[properties["marker-size"]], size);
+    size = sizes[properties["marker-size"]] ?? size;
     const markerSymbol = properties["marker-symbol"];
     if (defined(markerSymbol)) {
       symbol = markerSymbol;
@@ -914,7 +914,7 @@ function preload(that, data, options, clear) {
   //>>includeEnd('debug');
 
   DataSource.setLoading(that, true);
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
   // User specified credit
   let credit = options.credit;
@@ -928,7 +928,7 @@ function preload(that, data, options, clear) {
   if (typeof data === "string" || data instanceof Resource) {
     data = Resource.createIfNeeded(data);
     promise = data.fetchJson();
-    sourceUri = defaultValue(sourceUri, data.getUrlComponent());
+    sourceUri = sourceUri ?? data.getUrlComponent();
 
     // Add resource credits to our list of credits to display
     const resourceCredits = that._resourceCredits;
@@ -942,20 +942,20 @@ function preload(that, data, options, clear) {
   }
 
   options = {
-    describe: defaultValue(options.describe, defaultDescribeProperty),
-    markerSize: defaultValue(options.markerSize, defaultMarkerSize),
-    markerSymbol: defaultValue(options.markerSymbol, defaultMarkerSymbol),
-    markerColor: defaultValue(options.markerColor, defaultMarkerColor),
+    describe: options.describe ?? defaultDescribeProperty,
+    markerSize: options.markerSize ?? defaultMarkerSize,
+    markerSymbol: options.markerSymbol ?? defaultMarkerSymbol,
+    markerColor: options.markerColor ?? defaultMarkerColor,
     strokeWidthProperty: new ConstantProperty(
-      defaultValue(options.strokeWidth, defaultStrokeWidth),
+      options.strokeWidth ?? defaultStrokeWidth,
     ),
     strokeMaterialProperty: new ColorMaterialProperty(
-      defaultValue(options.stroke, defaultStroke),
+      options.stroke ?? defaultStroke,
     ),
     fillMaterialProperty: new ColorMaterialProperty(
-      defaultValue(options.fill, defaultFill),
+      options.fill ?? defaultFill,
     ),
-    clampToGround: defaultValue(options.clampToGround, defaultClampToGround),
+    clampToGround: options.clampToGround ?? defaultClampToGround,
   };
 
   return Promise.resolve(promise)

package/Source/DataSources/GeometryUpdater.js

@@ -1,6 +1,5 @@
 import Check from "../Core/Check.js";
 import Color from "../Core/Color.js";
-import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import destroyObject from "../Core/destroyObject.js";
 import DeveloperError from "../Core/DeveloperError.js";
@@ -296,7 +295,7 @@ GeometryUpdater.prototype.isOutlineVisible = function (time) {
     entity.isAvailable(time) &&
     this._showProperty.getValue(time) &&
     this._showOutlineProperty.getValue(time);
-  return defaultValue(visible, false);
+  return visible ?? false;
 };
 
 /**
@@ -312,7 +311,7 @@ GeometryUpdater.prototype.isFilled = function (time) {
     entity.isAvailable(time) &&
     this._showProperty.getValue(time) &&
     this._fillProperty.getValue(time);
-  return defaultValue(visible, false);
+  return visible ?? false;
 };
 
 /**
@@ -459,22 +458,18 @@ GeometryUpdater.prototype._onEntityPropertyChanged = function (
     return;
   }
 
-  this._materialProperty = defaultValue(geometry.material, defaultMaterial);
-  this._fillProperty = defaultValue(fillProperty, defaultFill);
-  this._showProperty = defaultValue(show, defaultShow);
-  this._showOutlineProperty = defaultValue(geometry.outline, defaultOutline);
+  this._materialProperty = geometry.material ?? defaultMaterial;
+  this._fillProperty = fillProperty ?? defaultFill;
+  this._showProperty = show ?? defaultShow;
+  this._showOutlineProperty = geometry.outline ?? defaultOutline;
   this._outlineColorProperty = outlineEnabled
-    ? defaultValue(geometry.outlineColor, defaultOutlineColor)
+    ? (geometry.outlineColor ?? defaultOutlineColor)
     : undefined;
-  this._shadowsProperty = defaultValue(geometry.shadows, defaultShadows);
-  this._distanceDisplayConditionProperty = defaultValue(
-    geometry.distanceDisplayCondition,
-    defaultDistanceDisplayCondition,
-  );
-  this._classificationTypeProperty = defaultValue(
-    geometry.classificationType,
-    defaultClassificationType,
-  );
+  this._shadowsProperty = geometry.shadows ?? defaultShadows;
+  this._distanceDisplayConditionProperty =
+    geometry.distanceDisplayCondition ?? defaultDistanceDisplayCondition;
+  this._classificationTypeProperty =
+    geometry.classificationType ?? defaultClassificationType;
 
   this._fillEnabled = fillEnabled;
 

package/Source/DataSources/GeometryVisualizer.js

@@ -1,7 +1,6 @@
 import AssociativeArray from "../Core/AssociativeArray.js";
 import BoundingSphere from "../Core/BoundingSphere.js";
 import Check from "../Core/Check.js";
-import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import destroyObject from "../Core/destroyObject.js";
 import ClassificationType from "../Scene/ClassificationType.js";
@@ -42,8 +41,8 @@ function GeometryVisualizer(
   Check.defined("entityCollection", entityCollection);
   //>>includeEnd('debug');
 
-  primitives = defaultValue(primitives, scene.primitives);
-  groundPrimitives = defaultValue(groundPrimitives, scene.groundPrimitives);
+  primitives = primitives ?? scene.primitives;
+  groundPrimitives = groundPrimitives ?? scene.groundPrimitives;
 
   this._scene = scene;
   this._primitives = primitives;

package/Source/DataSources/GpxDataSource.js

@@ -4,7 +4,7 @@ import ClockRange from "../Core/ClockRange.js";
 import ClockStep from "../Core/ClockStep.js";
 import Color from "../Core/Color.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 DeveloperError from "../Core/DeveloperError.js";
 import Event from "../Core/Event.js";
@@ -246,10 +246,7 @@ function processDescription(node, entity) {
   for (i = 0; i < length; i++) {
     const infoTypeName = infoTypeNames[i];
     const infoType = descriptiveInfoTypes[infoTypeName];
-    infoType.value = defaultValue(
-      queryStringValue(node, infoType.tag, namespaces.gpx),
-      "",
-    );
+    infoType.value = queryStringValue(node, infoType.tag, namespaces.gpx) ?? "";
     if (defined(infoType.value) && infoType.value !== "") {
       text = `${text}<p>${infoType.text}: ${infoType.value}</p>`;
     }
@@ -668,7 +665,7 @@ function metadataChanged(old, current) {
 }
 
 function load(dataSource, entityCollection, data, options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
   let promise = data;
   if (typeof data === "string" || data instanceof Resource) {
     data = Resource.createIfNeeded(data);
@@ -947,7 +944,7 @@ GpxDataSource.prototype.load = function (data, options) {
     throw new DeveloperError("data is required.");
   }
 
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
   DataSource.setLoading(this, true);
   const oldName = this._name;
   const that = this;

package/Source/DataSources/GridMaterialProperty.js

@@ -1,6 +1,6 @@
 import Cartesian2 from "../Core/Cartesian2.js";
 import Color from "../Core/Color.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import Event from "../Core/Event.js";
 import JulianDate from "../Core/JulianDate.js";
@@ -27,7 +27,7 @@ const defaultLineThickness = new Cartesian2(1, 1);
  * @constructor
  */
 function GridMaterialProperty(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
   this._definitionChanged = new Event();
   this._color = undefined;

package/Source/DataSources/GroundGeometryUpdater.js

@@ -1,5 +1,4 @@
 import Check from "../Core/Check.js";
-import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import DeveloperError from "../Core/DeveloperError.js";
 import GeometryOffsetAttribute from "../Core/GeometryOffsetAttribute.js";
@@ -111,7 +110,7 @@ GroundGeometryUpdater.prototype._onEntityPropertyChanged = function (
     oneTimeWarning(oneTimeWarning.geometryZIndex);
   }
 
-  this._zIndex = defaultValue(geometry.zIndex, defaultZIndex);
+  this._zIndex = geometry.zIndex ?? defaultZIndex;
 
   if (defined(this._terrainOffsetProperty)) {
     this._terrainOffsetProperty.destroy();

package/Source/DataSources/ImageMaterialProperty.js

@@ -1,6 +1,6 @@
 import Cartesian2 from "../Core/Cartesian2.js";
 import Color from "../Core/Color.js";
-import defaultValue from "../Core/defaultValue.js";
+import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
 import Event from "../Core/Event.js";
 import JulianDate from "../Core/JulianDate.js";
@@ -23,7 +23,7 @@ const defaultColor = Color.WHITE;
  * @param {Property|boolean} [options.transparent=false] Set to true when the image has transparency (for example, when a png has transparent sections)
  */
 function ImageMaterialProperty(options) {
-  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+  options = options ?? Frozen.EMPTY_OBJECT;
 
   this._definitionChanged = new Event();
   this._image = undefined;