Add extensibility to various classes

CHANGES.md

@@ -21,6 +21,8 @@
 ##### Additions :tada:
 
 - Added `Scene.pickVoxel` to pick individual cells from a `VoxelPrimitive`, and `VoxelCell` to report information about the picked cell. [#11828](https://github.com/CesiumGS/cesium/pull/11828)
+- Added `Scene.defaultLogDepthbuffer` to allow changing the default behavior of the `logDepthBuffer` for newly created `Scene` instances. [#11859](https://github.com/CesiumGS/cesium/pull/11859)
+- Added `SensorVolumePortionToDisplay` to assist `CzmlDataSource` in parsing CZML. [#11859](https://github.com/CesiumGS/cesium/pull/11859)
 - Added support for I3S Building Scene Layer. [#11678](https://github.com/CesiumGS/cesium/pull/11678)
 
 ##### Deprecated :hourglass_flowing_sand:

packages/engine/Source/Core/IntersectionTests.js

@@ -508,7 +508,10 @@ function addWithCancellationCheck(left, right, tolerance) {
   return difference;
 }
 
-function quadraticVectorExpression(A, b, c, x, w) {
+/**
+ * @private
+ */
+IntersectionTests.quadraticVectorExpression = function (A, b, c, x, w) {
   const xSquared = x * x;
   const wSquared = w * w;
 
@@ -634,7 +637,7 @@ function quadraticVectorExpression(A, b, c, x, w) {
   }
 
   return solutions;
-}
+};
 
 const firstAxisScratch = new Cartesian3();
 const secondAxisScratch = new Cartesian3();
@@ -740,7 +743,7 @@ IntersectionTests.grazingAltitudeLocation = function (ray, ellipsoid) {
   const b = Matrix3.multiplyByVector(temp, position, bCart);
 
   // Solve for the solutions to the expression in standard form:
-  const solutions = quadraticVectorExpression(
+  const solutions = IntersectionTests.quadraticVectorExpression(
     A,
     Cartesian3.negate(b, firstAxisScratch),
     0.0,

packages/engine/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.
  *

packages/engine/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)
+    ),
   ];
 };
 

packages/engine/Source/DataSources/Entity.js

@@ -41,6 +41,8 @@ import WallGraphics from "./WallGraphics.js";
 
 const cartoScratch = new Cartographic();
 
+const ExtraPropertyNames = [];
+
 function createConstantPositionProperty(value) {
   return new ConstantPositionProperty(value);
 }
@@ -127,7 +129,7 @@ function Entity(options) {
     "corridor",
     "cylinder",
     "description",
-    "ellipse", //
+    "ellipse",
     "ellipsoid",
     "label",
     "model",
@@ -136,14 +138,15 @@ function Entity(options) {
     "path",
     "plane",
     "point",
-    "polygon", //
+    "polygon",
     "polyline",
     "polylineVolume",
     "position",
     "properties",
     "rectangle",
     "viewFrom",
     "wall",
+    ...ExtraPropertyNames,
   ];
 
   this._billboard = undefined;
@@ -494,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.
  *

packages/engine/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;