@cesium/engine 11.0.0 → 11.1.0

package/Source/DataSources/CallbackPositionProperty.js

@@ -0,0 +1,173 @@
+import defaultValue from "../Core/defaultValue.js";
+import defined from "../Core/defined.js";
+import DeveloperError from "../Core/DeveloperError.js";
+import Event from "../Core/Event.js";
+import JulianDate from "../Core/JulianDate.js";
+import ReferenceFrame from "../Core/ReferenceFrame.js";
+import PositionProperty from "./PositionProperty.js";
+
+/**
+ * A {@link PositionProperty} whose value is lazily evaluated by a callback function.
+ *
+ * @alias CallbackPositionProperty
+ * @constructor
+ *
+ * @param {CallbackPositionProperty.Callback} callback The function to be called when the position property is evaluated.
+ * @param {boolean} isConstant <code>true</code> when the callback function returns the same value every time, <code>false</code> if the value will change.
+ * @param {ReferenceFrame} [referenceFrame=ReferenceFrame.FIXED] The reference frame in which the position is defined.
+ *
+ * @demo {@link https://sandcastle.cesium.com/index.html?src=Callback%20Position%20Property.html|Cesium Sandcastle Callback Position Property Demo}
+ */
+function CallbackPositionProperty(callback, isConstant, referenceFrame) {
+  this._callback = undefined;
+  this._isConstant = undefined;
+  this._referenceFrame = defaultValue(referenceFrame, ReferenceFrame.FIXED);
+  this._definitionChanged = new Event();
+  this.setCallback(callback, isConstant);
+}
+
+Object.defineProperties(CallbackPositionProperty.prototype, {
+  /**
+   * Gets a value indicating if this property is constant.
+   * @memberof CallbackPositionProperty.prototype
+   *
+   * @type {boolean}
+   * @readonly
+   */
+  isConstant: {
+    get: function () {
+      return this._isConstant;
+    },
+  },
+  /**
+   * Gets the event that is raised whenever the definition of this property changes.
+   * The definition is considered to have changed if a call to getValue would return
+   * a different result for the same time.
+   * @memberof CallbackPositionProperty.prototype
+   *
+   * @type {Event}
+   * @readonly
+   */
+  definitionChanged: {
+    get: function () {
+      return this._definitionChanged;
+    },
+  },
+  /**
+   * Gets the reference frame in which the position is defined.
+   * @memberof CallbackPositionProperty.prototype
+   * @type {ReferenceFrame}
+   * @default ReferenceFrame.FIXED;
+   */
+  referenceFrame: {
+    get: function () {
+      return this._referenceFrame;
+    },
+  },
+});
+
+const timeScratch = new JulianDate();
+
+/**
+ * Gets the value of the property at the provided time in the fixed frame.
+ *
+ * @param {JulianDate} [time=JulianDate.now()] The time for which to retrieve the value. If omitted, the current system time is used.
+ * @param {Cartesian3} [result] The object to store the value into, if omitted, a new instance is created and returned.
+ * @returns {Cartesian3 | undefined} The modified result parameter or a new instance if the result parameter was not supplied.
+ */
+CallbackPositionProperty.prototype.getValue = function (time, result) {
+  if (!defined(time)) {
+    time = JulianDate.now(timeScratch);
+  }
+  return this.getValueInReferenceFrame(time, ReferenceFrame.FIXED, result);
+};
+
+/**
+ * Sets the callback to be used.
+ *
+ * @param {CallbackPositionProperty.Callback} callback The function to be called when the property is evaluated.
+ * @param {boolean} isConstant <code>true</code> when the callback function returns the same value every time, <code>false</code> if the value will change.
+ */
+CallbackPositionProperty.prototype.setCallback = function (
+  callback,
+  isConstant,
+) {
+  //>>includeStart('debug', pragmas.debug);
+  if (!defined(callback)) {
+    throw new DeveloperError("callback is required.");
+  }
+  if (!defined(isConstant)) {
+    throw new DeveloperError("isConstant is required.");
+  }
+  //>>includeEnd('debug');
+
+  const changed =
+    this._callback !== callback || this._isConstant !== isConstant;
+
+  this._callback = callback;
+  this._isConstant = isConstant;
+
+  if (changed) {
+    this._definitionChanged.raiseEvent(this);
+  }
+};
+
+/**
+ * Gets the value of the property at the provided time and in the provided reference frame.
+ *
+ * @param {JulianDate} time The time for which to retrieve the value.
+ * @param {ReferenceFrame} referenceFrame The desired referenceFrame of the result.
+ * @param {Cartesian3} [result] The object to store the value into, if omitted, a new instance is created and returned.
+ * @returns {Cartesian3 | undefined} The modified result parameter or a new instance if the result parameter was not supplied.
+ */
+CallbackPositionProperty.prototype.getValueInReferenceFrame = function (
+  time,
+  referenceFrame,
+  result,
+) {
+  //>>includeStart('debug', pragmas.debug);
+  if (!defined(time)) {
+    throw new DeveloperError("time is required.");
+  }
+  if (!defined(referenceFrame)) {
+    throw new DeveloperError("referenceFrame is required.");
+  }
+  //>>includeEnd('debug');
+
+  const value = this._callback(time, result);
+
+  return PositionProperty.convertToReferenceFrame(
+    time,
+    value,
+    this._referenceFrame,
+    referenceFrame,
+    result,
+  );
+};
+
+/**
+ * Compares this property to the provided property and returns
+ * <code>true</code> if they are equal, <code>false</code> otherwise.
+ *
+ * @param {Property} [other] The other property.
+ * @returns {boolean} <code>true</code> if left and right are equal, <code>false</code> otherwise.
+ */
+CallbackPositionProperty.prototype.equals = function (other) {
+  return (
+    this === other ||
+    (other instanceof CallbackPositionProperty &&
+      this._callback === other._callback &&
+      this._isConstant === other._isConstant &&
+      this._referenceFrame === other._referenceFrame)
+  );
+};
+
+/**
+ * A function that returns the value of the position property.
+ * @callback CallbackPositionProperty.Callback
+ *
+ * @param {JulianDate} [time=JulianDate.now()] The time for which to retrieve the value. If omitted, the current system time is used.
+ * @param {Cartesian3} [result] The object to store the value into. If omitted, the function must create and return a new instance.
+ * @returns {Cartesian3 | undefined} The modified result parameter, or a new instance if the result parameter was not supplied or is unsupported.
+ */
+export default CallbackPositionProperty;

package/Source/DataSources/Cesium3DTilesetGraphics.js

@@ -106,7 +106,7 @@ Cesium3DTilesetGraphics.prototype.merge = function (source) {
   this.uri = defaultValue(this.uri, source.uri);
   this.maximumScreenSpaceError = defaultValue(
     this.maximumScreenSpaceError,
-    source.maximumScreenSpaceError
+    source.maximumScreenSpaceError,
   );
 };
 

package/Source/DataSources/Cesium3DTilesetVisualizer.js

@@ -31,7 +31,7 @@ function Cesium3DTilesetVisualizer(scene, entityCollection) {
 
   entityCollection.collectionChanged.addEventListener(
     Cesium3DTilesetVisualizer.prototype._onCollectionChanged,
-    this
+    this,
   );
 
   this._scene = scene;
@@ -75,7 +75,7 @@ Cesium3DTilesetVisualizer.prototype.update = function (time) {
     if (show) {
       modelMatrix = entity.computeModelMatrix(time, modelMatrixScratch);
       resource = Resource.createIfNeeded(
-        Property.getValueOrUndefined(tilesetGraphics._uri, time)
+        Property.getValueOrUndefined(tilesetGraphics._uri, time),
       );
     }
 
@@ -111,7 +111,7 @@ Cesium3DTilesetVisualizer.prototype.update = function (time) {
     tileset.maximumScreenSpaceError = Property.getValueOrDefault(
       tilesetGraphics.maximumScreenSpaceError,
       time,
-      tileset.maximumScreenSpaceError
+      tileset.maximumScreenSpaceError,
     );
   }
 
@@ -133,7 +133,7 @@ Cesium3DTilesetVisualizer.prototype.isDestroyed = function () {
 Cesium3DTilesetVisualizer.prototype.destroy = function () {
   this._entityCollection.collectionChanged.removeEventListener(
     Cesium3DTilesetVisualizer.prototype._onCollectionChanged,
-    this
+    this,
   );
   const entities = this._entitiesToVisualize.values;
   const tilesetHash = this._tilesetHash;
@@ -157,7 +157,7 @@ Cesium3DTilesetVisualizer.prototype.destroy = function () {
  */
 Cesium3DTilesetVisualizer.prototype.getBoundingSphere = function (
   entity,
-  result
+  result,
 ) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(entity)) {
@@ -194,7 +194,7 @@ Cesium3DTilesetVisualizer.prototype._onCollectionChanged = function (
   entityCollection,
   added,
   removed,
-  changed
+  changed,
 ) {
   let i;
   let entity;

package/Source/DataSources/CheckerboardMaterialProperty.js

@@ -126,13 +126,13 @@ CheckerboardMaterialProperty.prototype.getValue = function (time, result) {
     this._evenColor,
     time,
     defaultEvenColor,
-    result.lightColor
+    result.lightColor,
   );
   result.darkColor = Property.getValueOrClonedDefault(
     this._oddColor,
     time,
     defaultOddColor,
-    result.darkColor
+    result.darkColor,
   );
   result.repeat = Property.getValueOrDefault(this._repeat, time, defaultRepeat);
   return result;

package/Source/DataSources/ColorMaterialProperty.js

@@ -90,7 +90,7 @@ ColorMaterialProperty.prototype.getValue = function (time, result) {
     this._color,
     time,
     Color.WHITE,
-    result.color
+    result.color,
   );
   return result;
 };

package/Source/DataSources/CompositeEntityCollection.js

@@ -23,12 +23,11 @@ function clean(entity) {
 function subscribeToEntity(that, eventHash, collectionId, entity) {
   entityIdScratch[0] = collectionId;
   entityIdScratch[1] = entity.id;
-  eventHash[
-    JSON.stringify(entityIdScratch)
-  ] = entity.definitionChanged.addEventListener(
-    CompositeEntityCollection.prototype._onDefinitionChanged,
-    that
-  );
+  eventHash[JSON.stringify(entityIdScratch)] =
+    entity.definitionChanged.addEventListener(
+      CompositeEntityCollection.prototype._onDefinitionChanged,
+      that,
+    );
 }
 
 function unsubscribeFromEntity(that, eventHash, collectionId, entity) {
@@ -65,7 +64,7 @@ function recomposite(that) {
     collection = collectionsCopy[i];
     collection.collectionChanged.removeEventListener(
       CompositeEntityCollection.prototype._onCollectionChanged,
-      that
+      that,
     );
     entities = collection.values;
     collectionId = collection.id;
@@ -79,7 +78,7 @@ function recomposite(that) {
     collection = collections[i];
     collection.collectionChanged.addEventListener(
       CompositeEntityCollection.prototype._onCollectionChanged,
-      that
+      that,
     );
 
     //Merge all of the existing entities.
@@ -200,7 +199,7 @@ Object.defineProperties(CompositeEntityCollection.prototype, {
  */
 CompositeEntityCollection.prototype.addCollection = function (
   collection,
-  index
+  index,
 ) {
   const hasIndex = defined(index);
   //>>includeStart('debug', pragmas.debug);
@@ -212,7 +211,7 @@ CompositeEntityCollection.prototype.addCollection = function (
       throw new DeveloperError("index must be greater than or equal to zero.");
     } else if (index > this._collections.length) {
       throw new DeveloperError(
-        "index must be less than or equal to the number of collections."
+        "index must be less than or equal to the number of collections.",
       );
     }
   }
@@ -371,7 +370,7 @@ CompositeEntityCollection.prototype.lowerCollection = function (collection) {
  * @exception {DeveloperError} collection is not in this composite.
  */
 CompositeEntityCollection.prototype.raiseCollectionToTop = function (
-  collection
+  collection,
 ) {
   const index = getCollectionIndex(this._collections, collection);
   if (index === this._collections.length - 1) {
@@ -391,7 +390,7 @@ CompositeEntityCollection.prototype.raiseCollectionToTop = function (
  * @exception {DeveloperError} collection is not in this composite.
  */
 CompositeEntityCollection.prototype.lowerCollectionToBottom = function (
-  collection
+  collection,
 ) {
   const index = getCollectionIndex(this._collections, collection);
   if (index === 0) {
@@ -432,7 +431,7 @@ CompositeEntityCollection.prototype.resumeEvents = function () {
   //>>includeStart('debug', pragmas.debug);
   if (this._suspendCount === 0) {
     throw new DeveloperError(
-      "resumeEvents can not be called before suspendEvents."
+      "resumeEvents can not be called before suspendEvents.",
     );
   }
   //>>includeEnd('debug');
@@ -472,7 +471,7 @@ CompositeEntityCollection.prototype.getById = function (id) {
 CompositeEntityCollection.prototype._onCollectionChanged = function (
   collection,
   added,
-  removed
+  removed,
 ) {
   const collections = this._collectionsCopy;
   const collectionsLength = collections.length;
@@ -546,7 +545,7 @@ CompositeEntityCollection.prototype._onDefinitionChanged = function (
   entity,
   propertyName,
   newValue,
-  oldValue
+  oldValue,
 ) {
   const collections = this._collections;
   const composite = this._composite;

package/Source/DataSources/CompositeMaterialProperty.js

@@ -16,7 +16,7 @@ function CompositeMaterialProperty() {
   this._composite = new CompositeProperty();
   this._composite.definitionChanged.addEventListener(
     CompositeMaterialProperty.prototype._raiseDefinitionChanged,
-    this
+    this,
   );
 }
 
@@ -74,9 +74,8 @@ CompositeMaterialProperty.prototype.getType = function (time) {
   }
   //>>includeEnd('debug');
 
-  const innerProperty = this._composite._intervals.findDataForIntervalContainingDate(
-    time
-  );
+  const innerProperty =
+    this._composite._intervals.findDataForIntervalContainingDate(time);
   if (defined(innerProperty)) {
     return innerProperty.getType(time);
   }
@@ -97,9 +96,8 @@ CompositeMaterialProperty.prototype.getValue = function (time, result) {
     time = JulianDate.now(timeScratch);
   }
 
-  const innerProperty = this._composite._intervals.findDataForIntervalContainingDate(
-    time
-  );
+  const innerProperty =
+    this._composite._intervals.findDataForIntervalContainingDate(time);
   if (defined(innerProperty)) {
     return innerProperty.getValue(time, result);
   }

package/Source/DataSources/CompositePositionProperty.js

@@ -21,7 +21,7 @@ function CompositePositionProperty(referenceFrame) {
   this._composite = new CompositeProperty();
   this._composite.definitionChanged.addEventListener(
     CompositePositionProperty.prototype._raiseDefinitionChanged,
-    this
+    this,
   );
 }
 
@@ -110,7 +110,7 @@ CompositePositionProperty.prototype.getValue = function (time, result) {
 CompositePositionProperty.prototype.getValueInReferenceFrame = function (
   time,
   referenceFrame,
-  result
+  result,
 ) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(time)) {
@@ -121,9 +121,8 @@ CompositePositionProperty.prototype.getValueInReferenceFrame = function (
   }
   //>>includeEnd('debug');
 
-  const innerProperty = this._composite._intervals.findDataForIntervalContainingDate(
-    time
-  );
+  const innerProperty =
+    this._composite._intervals.findDataForIntervalContainingDate(time);
   if (defined(innerProperty)) {
     return innerProperty.getValueInReferenceFrame(time, referenceFrame, result);
   }

package/Source/DataSources/CompositeProperty.js

@@ -58,7 +58,7 @@ function CompositeProperty() {
   this._intervals = new TimeIntervalCollection();
   this._intervals.changedEvent.addEventListener(
     CompositeProperty.prototype._intervalsChanged,
-    this
+    this,
   );
 }
 
@@ -147,7 +147,7 @@ CompositeProperty.prototype._intervalsChanged = function () {
     this,
     this._eventHelper,
     this._definitionChanged,
-    this._intervals
+    this._intervals,
   );
   this._definitionChanged.raiseEvent(this);
 };

package/Source/DataSources/ConstantPositionProperty.js

@@ -114,7 +114,7 @@ ConstantPositionProperty.prototype.setValue = function (value, referenceFrame) {
 ConstantPositionProperty.prototype.getValueInReferenceFrame = function (
   time,
   referenceFrame,
-  result
+  result,
 ) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(time)) {
@@ -130,7 +130,7 @@ ConstantPositionProperty.prototype.getValueInReferenceFrame = function (
     this._value,
     this._referenceFrame,
     referenceFrame,
-    result
+    result,
   );
 };