@cesium/engine 6.2.0 → 8.0.0

package/Source/DataSources/CzmlDataSource.js

@@ -90,6 +90,7 @@ import VelocityOrientationProperty from "./VelocityOrientationProperty.js";
 import VelocityVectorProperty from "./VelocityVectorProperty.js";
 import WallGraphics from "./WallGraphics.js";
 import Cesium3DTilesetGraphics from "./Cesium3DTilesetGraphics.js";
+import SensorVolumePortionToDisplay from "../Scene/SensorVolumePortionToDisplay.js";
 
 // A marker type to distinguish CZML properties where we need to end up with a unit vector.
 // The data is still loaded into Cartesian3 objects but they are normalized.
@@ -576,6 +577,10 @@ function unwrapInterval(type, czmlInterval, sourceUri) {
       return unwrapQuaternionInterval(czmlInterval);
     case Rotation:
       return defaultValue(czmlInterval.number, czmlInterval);
+    case SensorVolumePortionToDisplay:
+      return SensorVolumePortionToDisplay[
+        defaultValue(czmlInterval.portionToDisplay, czmlInterval)
+      ];
     case ShadowMode:
       return ShadowMode[
         defaultValue(
@@ -598,7 +603,7 @@ function unwrapInterval(type, czmlInterval, sourceUri) {
         defaultValue(czmlInterval.verticalOrigin, czmlInterval)
       ];
     default:
-      throw new RuntimeError(type);
+      throw new RuntimeError(`Unknown CzmlDataSource interval type: ${type}`);
   }
 }
 
@@ -5006,31 +5011,54 @@ Object.defineProperties(CzmlDataSource.prototype, {
  * @type {CzmlDataSource.UpdaterFunction[]}
  */
 CzmlDataSource.updaters = [
-  processBillboard, //
-  processBox, //
-  processCorridor, //
-  processCylinder, //
-  processEllipse, //
-  processEllipsoid, //
-  processLabel, //
-  processModel, //
-  processName, //
-  processDescription, //
-  processPath, //
-  processPoint, //
-  processPolygon, //
-  processPolyline, //
-  processPolylineVolume, //
-  processProperties, //
-  processRectangle, //
-  processPosition, //
-  processTileset, //
-  processViewFrom, //
-  processWall, //
-  processOrientation, //
+  processBillboard,
+  processBox,
+  processCorridor,
+  processCylinder,
+  processEllipse,
+  processEllipsoid,
+  processLabel,
+  processModel,
+  processName,
+  processDescription,
+  processPath,
+  processPoint,
+  processPolygon,
+  processPolyline,
+  processPolylineVolume,
+  processProperties,
+  processRectangle,
+  processPosition,
+  processTileset,
+  processViewFrom,
+  processWall,
+  processOrientation,
   processAvailability,
 ];
 
+/**
+ * Add the provided updater to the list of updaters if not already included
+ * @private
+ * @param {CzmlDataSource.UpdaterFunction} updater
+ */
+CzmlDataSource.registerUpdater = function (updater) {
+  if (!CzmlDataSource.updaters.includes(updater)) {
+    CzmlDataSource.updaters.push(updater);
+  }
+};
+
+/**
+ * Remove the provided updater from the list of updaters if already included
+ * @private
+ * @param {CzmlDataSource.UpdaterFunction} updater
+ */
+CzmlDataSource.unregisterUpdater = function (updater) {
+  if (CzmlDataSource.updaters.includes(updater)) {
+    const index = CzmlDataSource.updaters.indexOf(updater);
+    CzmlDataSource.updaters.splice(index, 1);
+  }
+};
+
 /**
  * Processes the provided url or CZML object without clearing any existing data.
  *

package/Source/DataSources/DataSourceDisplay.js

@@ -120,6 +120,30 @@ function DataSourceDisplay(options) {
   this._ready = false;
 }
 
+const ExtraVisualizers = [];
+/**
+ * Add the provided Visualizer to the default visualizers callback if not already included
+ * @private
+ * @param {Visualizer} visualizer Visualizer class to add
+ */
+DataSourceDisplay.registerVisualizer = function (visualizer) {
+  if (!ExtraVisualizers.includes(visualizer)) {
+    ExtraVisualizers.push(visualizer);
+  }
+};
+
+/**
+ * Remove the provided Visualizer from the default visualizers callback if it's already included
+ * @private
+ * @param {Visualizer} visualizer Visualizer class to remove
+ */
+DataSourceDisplay.unregisterVisualizer = function (visualizer) {
+  if (ExtraVisualizers.includes(visualizer)) {
+    const index = ExtraVisualizers.indexOf(visualizer);
+    ExtraVisualizers.splice(index, 1);
+  }
+};
+
 /**
  * Gets or sets the default function which creates an array of visualizers used for visualization.
  * By default, this function uses all standard visualizers.
@@ -151,6 +175,9 @@ DataSourceDisplay.defaultVisualizersCallback = function (
       dataSource._primitives,
       dataSource._groundPrimitives
     ),
+    ...ExtraVisualizers.map(
+      (VisualizerClass) => new VisualizerClass(scene, entities)
+    ),
   ];
 };
 

package/Source/DataSources/EllipsoidGeometryUpdater.js

@@ -547,11 +547,10 @@ DynamicEllipsoidGeometryUpdater.prototype.update = function (time) {
     options.radii = Cartesian3.clone(in3D ? unitSphere : radii, options.radii);
     if (defined(innerRadii)) {
       if (in3D) {
-        const mag = Cartesian3.magnitude(radii);
         options.innerRadii = Cartesian3.fromElements(
-          innerRadii.x / mag,
-          innerRadii.y / mag,
-          innerRadii.z / mag,
+          innerRadii.x / radii.x,
+          innerRadii.y / radii.y,
+          innerRadii.z / radii.z,
           options.innerRadii
         );
       } else {

package/Source/DataSources/Entity.js

@@ -13,7 +13,9 @@ import Quaternion from "../Core/Quaternion.js";
 import Transforms from "../Core/Transforms.js";
 import GroundPolylinePrimitive from "../Scene/GroundPolylinePrimitive.js";
 import GroundPrimitive from "../Scene/GroundPrimitive.js";
-import HeightReference from "../Scene/HeightReference.js";
+import HeightReference, {
+  isHeightReferenceClamp,
+} from "../Scene/HeightReference.js";
 import BillboardGraphics from "./BillboardGraphics.js";
 import BoxGraphics from "./BoxGraphics.js";
 import ConstantPositionProperty from "./ConstantPositionProperty.js";
@@ -39,6 +41,8 @@ import WallGraphics from "./WallGraphics.js";
 
 const cartoScratch = new Cartographic();
 
+const ExtraPropertyNames = [];
+
 function createConstantPositionProperty(value) {
   return new ConstantPositionProperty(value);
 }
@@ -71,8 +75,8 @@ function createPropertyTypeDescriptor(name, Type) {
  * @property {boolean} [show] A boolean value indicating if the entity and its children are displayed.
  * @property {Property | string} [description] A string Property specifying an HTML description for this entity.
  * @property {PositionProperty | Cartesian3} [position] A Property specifying the entity position.
- * @property {Property} [orientation] A Property specifying the entity orientation.
- * @property {Property} [viewFrom] A suggested initial offset for viewing this object.
+ * @property {Property | Quaternion} [orientation=Transforms.eastNorthUpToFixedFrame(position)] A Property specifying the entity orientation in respect to Earth-fixed-Earth-centered (ECEF). If undefined, east-north-up at entity position is used.
+ * @property {Property | Cartesian3} [viewFrom] A suggested initial offset for viewing this object.
  * @property {Entity} [parent] A parent entity to associate with this entity.
  * @property {BillboardGraphics | BillboardGraphics.ConstructorOptions} [billboard] A billboard to associate with this entity.
  * @property {BoxGraphics | BoxGraphics.ConstructorOptions} [box] A box to associate with this entity.
@@ -125,7 +129,7 @@ function Entity(options) {
     "corridor",
     "cylinder",
     "description",
-    "ellipse", //
+    "ellipse",
     "ellipsoid",
     "label",
     "model",
@@ -134,7 +138,7 @@ function Entity(options) {
     "path",
     "plane",
     "point",
-    "polygon", //
+    "polygon",
     "polyline",
     "polylineVolume",
     "position",
@@ -142,6 +146,7 @@ function Entity(options) {
     "rectangle",
     "viewFrom",
     "wall",
+    ...ExtraPropertyNames,
   ];
 
   this._billboard = undefined;
@@ -413,7 +418,8 @@ Object.defineProperties(Entity.prototype, {
    */
   tileset: createPropertyTypeDescriptor("tileset", Cesium3DTilesetGraphics),
   /**
-   * Gets or sets the orientation.
+   * Gets or sets the orientation in respect to Earth-fixed-Earth-centered (ECEF).
+   * Defaults to east-north-up at entity position.
    * @memberof Entity.prototype
    * @type {Property|undefined}
    */
@@ -491,6 +497,21 @@ Object.defineProperties(Entity.prototype, {
   wall: createPropertyTypeDescriptor("wall", WallGraphics),
 });
 
+/**
+ * Add the specified type and construct the properties for it in the Entity class
+ * @private
+ * @param {string} propertyName name of the property that controls/accesses this entity type
+ * @param {{ constructor: function }} Type The Graphics class to associate with this entity type
+ */
+Entity.registerEntityType = function (propertyName, Type) {
+  Object.defineProperties(Entity.prototype, {
+    [propertyName]: createPropertyTypeDescriptor(propertyName, Type),
+  });
+  if (!ExtraPropertyNames.includes(propertyName)) {
+    ExtraPropertyNames.push(propertyName);
+  }
+};
+
 /**
  * Given a time, returns true if this object should have data during that time.
  *
@@ -706,7 +727,7 @@ Entity.prototype.computeModelMatrixForHeightReference = function (
   }
 
   const carto = ellipsoid.cartesianToCartographic(position, cartoScratch);
-  if (heightReference === HeightReference.CLAMP_TO_GROUND) {
+  if (isHeightReferenceClamp(heightReference)) {
     carto.height = heightOffset;
   } else {
     carto.height += heightOffset;

package/Source/DataSources/EntityCollection.js

@@ -5,7 +5,6 @@ import DeveloperError from "../Core/DeveloperError.js";
 import Event from "../Core/Event.js";
 import Iso8601 from "../Core/Iso8601.js";
 import JulianDate from "../Core/JulianDate.js";
-import RuntimeError from "../Core/RuntimeError.js";
 import TimeInterval from "../Core/TimeInterval.js";
 import Entity from "./Entity.js";
 
@@ -281,7 +280,7 @@ EntityCollection.prototype.add = function (entity) {
   const id = entity.id;
   const entities = this._entities;
   if (entities.contains(id)) {
-    throw new RuntimeError(
+    throw new DeveloperError(
       `An entity with id ${id} already exists in this collection.`
     );
   }

package/Source/DataSources/GeometryUpdater.js

@@ -233,8 +233,7 @@ Object.defineProperties(GeometryUpdater.prototype, {
   },
   /**
    * Gets a value indicating if the geometry is time-varying.
-   * If true, all visualization is delegated to a DynamicGeometryUpdater
-   * returned by GeometryUpdater#createDynamicUpdater.
+   *
    * @memberof GeometryUpdater.prototype
    *
    * @type {boolean}

package/Source/DataSources/GeometryUpdaterSet.js

@@ -0,0 +1,114 @@
+import destroyObject from "../Core/destroyObject.js";
+import Event from "../Core/Event.js";
+import EventHelper from "../Core/EventHelper.js";
+import BoxGeometryUpdater from "./BoxGeometryUpdater.js";
+import CorridorGeometryUpdater from "./CorridorGeometryUpdater.js";
+import CylinderGeometryUpdater from "./CylinderGeometryUpdater.js";
+import EllipseGeometryUpdater from "./EllipseGeometryUpdater.js";
+import EllipsoidGeometryUpdater from "./EllipsoidGeometryUpdater.js";
+import PlaneGeometryUpdater from "./PlaneGeometryUpdater.js";
+import PolygonGeometryUpdater from "./PolygonGeometryUpdater.js";
+import PolylineVolumeGeometryUpdater from "./PolylineVolumeGeometryUpdater.js";
+import RectangleGeometryUpdater from "./RectangleGeometryUpdater.js";
+import WallGeometryUpdater from "./WallGeometryUpdater.js";
+
+/** @type {GeometryUpdater[]} */
+const geometryUpdaters = [
+  BoxGeometryUpdater,
+  CylinderGeometryUpdater,
+  CorridorGeometryUpdater,
+  EllipseGeometryUpdater,
+  EllipsoidGeometryUpdater,
+  PlaneGeometryUpdater,
+  PolygonGeometryUpdater,
+  PolylineVolumeGeometryUpdater,
+  RectangleGeometryUpdater,
+  WallGeometryUpdater,
+];
+
+/**
+ * Manages a set of "updater" classes for the {@link GeometryVisualizer} for each entity
+ *
+ * @private
+ * @param {Entity} entity
+ * @param {Scene} scene
+ */
+function GeometryUpdaterSet(entity, scene) {
+  this.entity = entity;
+  this.scene = scene;
+  const updaters = new Array(geometryUpdaters.length);
+  const geometryChanged = new Event();
+  const eventHelper = new EventHelper();
+  for (let i = 0; i < updaters.length; i++) {
+    const updater = new geometryUpdaters[i](entity, scene);
+    eventHelper.add(updater.geometryChanged, (geometry) => {
+      geometryChanged.raiseEvent(geometry);
+    });
+    updaters[i] = updater;
+  }
+  this.updaters = updaters;
+  this.geometryChanged = geometryChanged;
+  this.eventHelper = eventHelper;
+
+  this._removeEntitySubscription = entity.definitionChanged.addEventListener(
+    GeometryUpdaterSet.prototype._onEntityPropertyChanged,
+    this
+  );
+}
+
+GeometryUpdaterSet.prototype._onEntityPropertyChanged = function (
+  entity,
+  propertyName,
+  newValue,
+  oldValue
+) {
+  const updaters = this.updaters;
+  for (let i = 0; i < updaters.length; i++) {
+    updaters[i]._onEntityPropertyChanged(
+      entity,
+      propertyName,
+      newValue,
+      oldValue
+    );
+  }
+};
+
+GeometryUpdaterSet.prototype.forEach = function (callback) {
+  const updaters = this.updaters;
+  for (let i = 0; i < updaters.length; i++) {
+    callback(updaters[i]);
+  }
+};
+
+GeometryUpdaterSet.prototype.destroy = function () {
+  this.eventHelper.removeAll();
+  const updaters = this.updaters;
+  for (let i = 0; i < updaters.length; i++) {
+    updaters[i].destroy();
+  }
+  this._removeEntitySubscription();
+  destroyObject(this);
+};
+
+/**
+ * Add the provided updater to the default list of updaters if not already included
+ * @param {GeometryUpdater} updater
+ */
+GeometryUpdaterSet.registerUpdater = function (updater) {
+  if (!geometryUpdaters.includes(updater)) {
+    geometryUpdaters.push(updater);
+  }
+};
+
+/**
+ * Remove the provided updater from the default list of updaters if included
+ * @param {GeometryUpdater} updater
+ */
+GeometryUpdaterSet.unregisterUpdater = function (updater) {
+  if (geometryUpdaters.includes(updater)) {
+    const index = geometryUpdaters.indexOf(updater);
+    geometryUpdaters.splice(index, 1);
+  }
+};
+
+export default GeometryUpdaterSet;

package/Source/DataSources/GeometryVisualizer.js

@@ -4,105 +4,23 @@ 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 Event from "../Core/Event.js";
-import EventHelper from "../Core/EventHelper.js";
 import ClassificationType from "../Scene/ClassificationType.js";
 import MaterialAppearance from "../Scene/MaterialAppearance.js";
 import PerInstanceColorAppearance from "../Scene/PerInstanceColorAppearance.js";
 import ShadowMode from "../Scene/ShadowMode.js";
 import BoundingSphereState from "./BoundingSphereState.js";
-import BoxGeometryUpdater from "./BoxGeometryUpdater.js";
 import ColorMaterialProperty from "./ColorMaterialProperty.js";
-import CorridorGeometryUpdater from "./CorridorGeometryUpdater.js";
-import CylinderGeometryUpdater from "./CylinderGeometryUpdater.js";
 import DynamicGeometryBatch from "./DynamicGeometryBatch.js";
-import EllipseGeometryUpdater from "./EllipseGeometryUpdater.js";
-import EllipsoidGeometryUpdater from "./EllipsoidGeometryUpdater.js";
 import Entity from "./Entity.js";
-import PlaneGeometryUpdater from "./PlaneGeometryUpdater.js";
-import PolygonGeometryUpdater from "./PolygonGeometryUpdater.js";
-import PolylineVolumeGeometryUpdater from "./PolylineVolumeGeometryUpdater.js";
-import RectangleGeometryUpdater from "./RectangleGeometryUpdater.js";
+import GeometryUpdaterSet from "./GeometryUpdaterSet.js";
 import StaticGeometryColorBatch from "./StaticGeometryColorBatch.js";
 import StaticGeometryPerMaterialBatch from "./StaticGeometryPerMaterialBatch.js";
 import StaticGroundGeometryColorBatch from "./StaticGroundGeometryColorBatch.js";
 import StaticGroundGeometryPerMaterialBatch from "./StaticGroundGeometryPerMaterialBatch.js";
 import StaticOutlineGeometryBatch from "./StaticOutlineGeometryBatch.js";
-import WallGeometryUpdater from "./WallGeometryUpdater.js";
 
 const emptyArray = [];
 
-const geometryUpdaters = [
-  BoxGeometryUpdater,
-  CylinderGeometryUpdater,
-  CorridorGeometryUpdater,
-  EllipseGeometryUpdater,
-  EllipsoidGeometryUpdater,
-  PlaneGeometryUpdater,
-  PolygonGeometryUpdater,
-  PolylineVolumeGeometryUpdater,
-  RectangleGeometryUpdater,
-  WallGeometryUpdater,
-];
-
-function GeometryUpdaterSet(entity, scene) {
-  this.entity = entity;
-  this.scene = scene;
-  const updaters = new Array(geometryUpdaters.length);
-  const geometryChanged = new Event();
-  function raiseEvent(geometry) {
-    geometryChanged.raiseEvent(geometry);
-  }
-  const eventHelper = new EventHelper();
-  for (let i = 0; i < updaters.length; i++) {
-    const updater = new geometryUpdaters[i](entity, scene);
-    eventHelper.add(updater.geometryChanged, raiseEvent);
-    updaters[i] = updater;
-  }
-  this.updaters = updaters;
-  this.geometryChanged = geometryChanged;
-  this.eventHelper = eventHelper;
-
-  this._removeEntitySubscription = entity.definitionChanged.addEventListener(
-    GeometryUpdaterSet.prototype._onEntityPropertyChanged,
-    this
-  );
-}
-
-GeometryUpdaterSet.prototype._onEntityPropertyChanged = function (
-  entity,
-  propertyName,
-  newValue,
-  oldValue
-) {
-  const updaters = this.updaters;
-  for (let i = 0; i < updaters.length; i++) {
-    updaters[i]._onEntityPropertyChanged(
-      entity,
-      propertyName,
-      newValue,
-      oldValue
-    );
-  }
-};
-
-GeometryUpdaterSet.prototype.forEach = function (callback) {
-  const updaters = this.updaters;
-  for (let i = 0; i < updaters.length; i++) {
-    callback(updaters[i]);
-  }
-};
-
-GeometryUpdaterSet.prototype.destroy = function () {
-  this.eventHelper.removeAll();
-  const updaters = this.updaters;
-  for (let i = 0; i < updaters.length; i++) {
-    updaters[i].destroy();
-  }
-  this._removeEntitySubscription();
-  destroyObject(this);
-};
-
 /**
  * A general purpose visualizer for geometry represented by {@link Primitive} instances.
  * @alias GeometryVisualizer
@@ -293,6 +211,24 @@ function GeometryVisualizer(
   );
 }
 
+/**
+ * Add the provided updater to the default list of updaters if not already included
+ * @private
+ * @param {GeometryUpdater} updater
+ */
+GeometryVisualizer.registerUpdater = function (updater) {
+  GeometryUpdaterSet.registerUpdater(updater);
+};
+
+/**
+ * Remove the provided updater from the default list of updaters if included
+ * @private
+ * @param {GeometryUpdater} updater
+ */
+GeometryVisualizer.unregisterUpdater = function (updater) {
+  GeometryUpdaterSet.unregisterUpdater(updater);
+};
+
 /**
  * Updates all of the primitives created by this visualizer to match their
  * Entity counterpart at the given time.

package/Source/DataSources/GroundGeometryUpdater.js

@@ -5,7 +5,9 @@ import DeveloperError from "../Core/DeveloperError.js";
 import GeometryOffsetAttribute from "../Core/GeometryOffsetAttribute.js";
 import oneTimeWarning from "../Core/oneTimeWarning.js";
 import GroundPrimitive from "../Scene/GroundPrimitive.js";
-import HeightReference from "../Scene/HeightReference.js";
+import HeightReference, {
+  isHeightReferenceClamp,
+} from "../Scene/HeightReference.js";
 import CallbackProperty from "./CallbackProperty.js";
 import ConstantProperty from "./ConstantProperty.js";
 import GeometryUpdater from "./GeometryUpdater.js";
@@ -164,9 +166,10 @@ GroundGeometryUpdater.getGeometryHeight = function (height, heightReference) {
     return;
   }
 
-  if (heightReference !== HeightReference.CLAMP_TO_GROUND) {
+  if (!isHeightReferenceClamp(heightReference)) {
     return height;
   }
+
   return 0.0;
 };
 
@@ -186,7 +189,7 @@ GroundGeometryUpdater.getGeometryExtrudedHeight = function (
     }
     return;
   }
-  if (extrudedHeightReference !== HeightReference.CLAMP_TO_GROUND) {
+  if (!isHeightReferenceClamp(extrudedHeightReference)) {
     return extrudedHeight;
   }