@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/TilesetMetadata.js

@@ -9,8 +9,8 @@ import MetadataEntity from "./MetadataEntity.js";
  * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles
  * </p>
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.tileset The tileset metadata JSON object.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.tileset The tileset metadata JSON object.
  * @param {MetadataClass} options.class The class that tileset metadata conforms to.
  *
  * @alias TilesetMetadata
@@ -69,7 +69,7 @@ Object.defineProperties(TilesetMetadata.prototype, {
    * An object containing extensions.
    *
    * @memberof TilesetMetadata.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    * @private
    */
@@ -83,8 +83,8 @@ Object.defineProperties(TilesetMetadata.prototype, {
 /**
  * Returns whether the tileset has this property.
  *
- * @param {String} propertyId The case-sensitive ID of the property.
- * @returns {Boolean} Whether the tileset has this property.
+ * @param {string} propertyId The case-sensitive ID of the property.
+ * @returns {boolean} Whether the tileset has this property.
  * @private
  */
 TilesetMetadata.prototype.hasProperty = function (propertyId) {
@@ -94,8 +94,8 @@ TilesetMetadata.prototype.hasProperty = function (propertyId) {
 /**
  * Returns whether the tileset has a property with the given semantic.
  *
- * @param {String} semantic The case-sensitive semantic of the property.
- * @returns {Boolean} Whether the tileset has a property with the given semantic.
+ * @param {string} semantic The case-sensitive semantic of the property.
+ * @returns {boolean} Whether the tileset has a property with the given semantic.
  * @private
  */
 TilesetMetadata.prototype.hasPropertyBySemantic = function (semantic) {
@@ -109,8 +109,8 @@ TilesetMetadata.prototype.hasPropertyBySemantic = function (semantic) {
 /**
  * Returns an array of property IDs.
  *
- * @param {String[]} [results] An array into which to store the results.
- * @returns {String[]} The property IDs.
+ * @param {string[]} [results] An array into which to store the results.
+ * @returns {string[]} The property IDs.
  * @private
  */
 TilesetMetadata.prototype.getPropertyIds = function (results) {
@@ -123,7 +123,7 @@ TilesetMetadata.prototype.getPropertyIds = function (results) {
  * If the property is normalized the normalized value is returned.
  * </p>
  *
- * @param {String} propertyId The case-sensitive ID of the property.
+ * @param {string} propertyId The case-sensitive ID of the property.
  * @returns {*} The value of the property or <code>undefined</code> if the tileset does not have this property.
  * @private
  */
@@ -137,9 +137,9 @@ TilesetMetadata.prototype.getProperty = function (propertyId) {
  * If the property is normalized a normalized value must be provided to this function.
  * </p>
  *
- * @param {String} propertyId The case-sensitive ID of the property.
+ * @param {string} propertyId The case-sensitive ID of the property.
  * @param {*} value The value of the property that will be copied.
- * @returns {Boolean} <code>true</code> if the property was set, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if the property was set, <code>false</code> otherwise.
  * @private
  */
 TilesetMetadata.prototype.setProperty = function (propertyId, value) {
@@ -154,7 +154,7 @@ TilesetMetadata.prototype.setProperty = function (propertyId, value) {
 /**
  * Returns a copy of the value of the property with the given semantic.
  *
- * @param {String} semantic The case-sensitive semantic of the property.
+ * @param {string} semantic The case-sensitive semantic of the property.
  * @returns {*} The value of the property or <code>undefined</code> if the tileset does not have this semantic.
  * @private
  */
@@ -169,9 +169,9 @@ TilesetMetadata.prototype.getPropertyBySemantic = function (semantic) {
 /**
  * Sets the value of the property with the given semantic.
  *
- * @param {String} semantic The case-sensitive semantic of the property.
+ * @param {string} semantic The case-sensitive semantic of the property.
  * @param {*} value The value of the property that will be copied.
- * @returns {Boolean} <code>true</code> if the property was set, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if the property was set, <code>false</code> otherwise.
  * @private
  */
 TilesetMetadata.prototype.setPropertyBySemantic = function (semantic, value) {

package/Source/Scene/TimeDynamicImagery.js

@@ -12,7 +12,7 @@ import RequestType from "../Core/RequestType.js";
  * @alias TimeDynamicImagery
  * @constructor
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Clock} options.clock A Clock instance that is used when determining the value for the time dimension. Required when <code>options.times</code> is specified.
  * @param {TimeIntervalCollection} options.times TimeIntervalCollection with its <code>data</code> property being an object containing time dynamic dimension and their values.
  * @param {Function} options.requestImageFunction A function that will request imagery tiles.
@@ -106,12 +106,12 @@ Object.defineProperties(TimeDynamicImagery.prototype, {
 /**
  * Gets the tile from the cache if its available.
  *
- * @param {Number} x The tile X coordinate.
- * @param {Number} y The tile Y coordinate.
- * @param {Number} level The tile level.
+ * @param {number} x The tile X coordinate.
+ * @param {number} y The tile Y coordinate.
+ * @param {number} level The tile level.
  * @param {Request} [request] The request object. Intended for internal use only.
  *
- * @returns {Promise.<HTMLImageElement>|undefined} A promise for the image that will resolve when the image is available, or
+ * @returns {Promise<HTMLImageElement>|undefined} A promise for the image that will resolve when the image is available, or
  *          undefined if the tile is not in the cache.
  */
 TimeDynamicImagery.prototype.getFromCache = function (x, y, level, request) {
@@ -135,9 +135,9 @@ TimeDynamicImagery.prototype.getFromCache = function (x, y, level, request) {
  * Checks if the next interval is approaching and will start preload the tile if necessary. Otherwise it will
  * just add the tile to a list to preload when we approach the next interval.
  *
- * @param {Number} x The tile X coordinate.
- * @param {Number} y The tile Y coordinate.
- * @param {Number} level The tile level.
+ * @param {number} x The tile X coordinate.
+ * @param {number} y The tile Y coordinate.
+ * @param {number} level The tile level.
  * @param {Request} [request] The request object. Intended for internal use only.
  */
 TimeDynamicImagery.prototype.checkApproachingInterval = function (

package/Source/Scene/TimeDynamicPointCloud.js

@@ -3,6 +3,7 @@ import combine from "../Core/combine.js";
 import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import destroyObject from "../Core/destroyObject.js";
+import deprecationWarning from "../Core/deprecationWarning.js";
 import Event from "../Core/Event.js";
 import getTimestamp from "../Core/getTimestamp.js";
 import JulianDate from "../Core/JulianDate.js";
@@ -27,14 +28,14 @@ import ShadowMode from "./ShadowMode.js";
  * @alias TimeDynamicPointCloud
  * @constructor
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Clock} options.clock A {@link Clock} instance that is used when determining the value for the time dimension.
  * @param {TimeIntervalCollection} options.intervals A {@link TimeIntervalCollection} with its data property being an object containing a <code>uri</code> to a 3D Tiles Point Cloud tile and an optional <code>transform</code>.
- * @param {Boolean} [options.show=true] Determines if the point cloud will be shown.
+ * @param {boolean} [options.show=true] Determines if the point cloud will be shown.
  * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] A 4x4 transformation matrix that transforms the point cloud.
  * @param {ShadowMode} [options.shadows=ShadowMode.ENABLED] Determines whether the point cloud casts or receives shadows from light sources.
- * @param {Number} [options.maximumMemoryUsage=256] The maximum amount of memory in MB that can be used by the point cloud.
- * @param {Object} [options.shading] Options for constructing a {@link PointCloudShading} object to control point attenuation and eye dome lighting.
+ * @param {number} [options.maximumMemoryUsage=256] The maximum amount of memory in MB that can be used by the point cloud.
+ * @param {object} [options.shading] Options for constructing a {@link PointCloudShading} object to control point attenuation and eye dome lighting.
  * @param {Cesium3DTileStyle} [options.style] The style, defined using the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}, applied to each point in the point cloud.
  * @param {ClippingPlaneCollection} [options.clippingPlanes] The {@link ClippingPlaneCollection} used to selectively disable rendering the point cloud.
  */
@@ -49,7 +50,7 @@ function TimeDynamicPointCloud(options) {
   /**
    * Determines if the point cloud will be shown.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   this.show = defaultValue(options.show, true);
@@ -87,7 +88,7 @@ function TimeDynamicPointCloud(options) {
    * If decreasing this value results in unloading tiles, the tiles are unloaded the next frame.
    * </p>
    *
-   * @type {Number}
+   * @type {number}
    * @default 256
    *
    * @see TimeDynamicPointCloud#totalMemoryUsageInBytes
@@ -183,6 +184,7 @@ function TimeDynamicPointCloud(options) {
   this._clockMultiplier = 0.0;
   this._resolveReadyPromise = undefined;
   const that = this;
+  // This is here for backwards compatibility and can be removed when readyPromise is removed.
   this._readyPromise = new Promise(function (resolve) {
     that._resolveReadyPromise = resolve;
   });
@@ -217,7 +219,7 @@ Object.defineProperties(TimeDynamicPointCloud.prototype, {
    *
    * @memberof TimeDynamicPointCloud.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @see TimeDynamicPointCloud#maximumMemoryUsage
@@ -250,11 +252,16 @@ Object.defineProperties(TimeDynamicPointCloud.prototype, {
    *
    * @memberof TimeDynamicPointCloud.prototype
    *
-   * @type {Promise.<TimeDynamicPointCloud>}
+   * @type {Promise<TimeDynamicPointCloud>}
    * @readonly
+   * @deprecated
    */
   readyPromise: {
     get: function () {
+      deprecationWarning(
+        "TimeDynamicPointCloud.readyPromise",
+        "TimeDynamicPointCloud.readyPromise was deprecated in CesiumJS 1.104. It will be removed in 1.107. Use TimeDynamicPointCloud.frameFailed instead."
+      );
       return this._readyPromise;
     },
   },
@@ -395,6 +402,7 @@ function requestFrame(that, interval, frameState) {
       sequential: true,
       ready: false,
       touchedFrameNumber: frameState.frameNumber,
+      uri: uri,
     };
     frames[index] = frame;
     Resource.fetchArrayBuffer({
@@ -410,7 +418,6 @@ function requestFrame(that, interval, frameState) {
           uniformMapLoaded: getUniformMapLoaded(that),
           pickIdLoaded: getPickIdLoaded,
         });
-        return frame.pointCloud.readyPromise;
       })
       .catch(handleFrameFailure(that, uri));
   }
@@ -507,7 +514,12 @@ function renderFrame(that, frame, updateState, frameState) {
   pointCloud.geometricErrorScale = shading.geometricErrorScale;
   pointCloud.maximumAttenuation = getMaximumAttenuation(that);
 
-  pointCloud.update(frameState);
+  try {
+    pointCloud.update(frameState);
+  } catch (error) {
+    handleFrameFailure(that, frame.uri)(error);
+  }
+
   frame.touchedFrameNumber = frameState.frameNumber;
 }
 
@@ -738,6 +750,7 @@ TimeDynamicPointCloud.prototype.update = function (frameState) {
   const that = this;
   if (defined(frame) && !defined(this._lastRenderedFrame)) {
     frameState.afterRender.push(function () {
+      // This is here for backwards compatibility and can be removed when readyPromise is removed.
       that._resolveReadyPromise(that);
       return true;
     });
@@ -787,7 +800,7 @@ TimeDynamicPointCloud.prototype.update = function (frameState) {
  * If this object was destroyed, it should not be used; calling any function other than
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  *
- * @returns {Boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see TimeDynamicPointCloud#destroy
  */

package/Source/Scene/Tonemapper.js

@@ -1,14 +1,14 @@
 /**
  * A tonemapping algorithm when rendering with high dynamic range.
  *
- * @enum {Number}
+ * @enum {number}
  * @private
  */
 const Tonemapper = {
   /**
    * Use the Reinhard tonemapping operator.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   REINHARD: 0,
@@ -16,7 +16,7 @@ const Tonemapper = {
   /**
    * Use the modified Reinhard tonemapping operator.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   MODIFIED_REINHARD: 1,
@@ -24,7 +24,7 @@ const Tonemapper = {
   /**
    * Use the Filmic tonemapping operator.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   FILMIC: 2,
@@ -32,7 +32,7 @@ const Tonemapper = {
   /**
    * Use the ACES tonemapping operator.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ACES: 3,

package/Source/Scene/TranslucentTileClassification.js

@@ -76,7 +76,7 @@ Object.defineProperties(TranslucentTileClassification.prototype, {
    * Gets whether or not translucent depth was rendered.
    * @memberof TranslucentTileClassification.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   hasTranslucentDepth: {

package/Source/Scene/TweenCollection.js

@@ -60,7 +60,7 @@ Object.defineProperties(Tween.prototype, {
    * An object with properties for initial values of the tween.  The properties of this object are changed during the tween's animation.
    * @memberof Tween.prototype
    *
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   startObject: {
@@ -73,7 +73,7 @@ Object.defineProperties(Tween.prototype, {
    * An object with properties for the final values of the tween.
    * @memberof Tween.prototype
    *
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   stopObject: {
@@ -86,7 +86,7 @@ Object.defineProperties(Tween.prototype, {
    * The duration, in seconds, for the tween.  The tween is automatically removed from the collection when it stops.
    * @memberof Tween.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   duration: {
@@ -99,7 +99,7 @@ Object.defineProperties(Tween.prototype, {
    * The delay, in seconds, before the tween starts animating.
    * @memberof Tween.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   delay: {
@@ -184,7 +184,7 @@ Object.defineProperties(TweenCollection.prototype, {
    * The number of tweens in the collection.
    * @memberof TweenCollection.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   length: {
@@ -198,11 +198,11 @@ Object.defineProperties(TweenCollection.prototype, {
  * Creates a tween for animating between two sets of properties.  The tween starts animating at the next call to {@link TweenCollection#update}, which
  * is implicit when {@link Viewer} or {@link CesiumWidget} render the scene.
  *
- * @param {Object} [options] Object with the following properties:
- * @param {Object} options.startObject An object with properties for initial values of the tween.  The properties of this object are changed during the tween's animation.
- * @param {Object} options.stopObject An object with properties for the final values of the tween.
- * @param {Number} options.duration The duration, in seconds, for the tween.  The tween is automatically removed from the collection when it stops.
- * @param {Number} [options.delay=0.0] The delay, in seconds, before the tween starts animating.
+ * @param {object} [options] Object with the following properties:
+ * @param {object} options.startObject An object with properties for initial values of the tween.  The properties of this object are changed during the tween's animation.
+ * @param {object} options.stopObject An object with properties for the final values of the tween.
+ * @param {number} options.duration The duration, in seconds, for the tween.  The tween is automatically removed from the collection when it stops.
+ * @param {number} [options.delay=0.0] The delay, in seconds, before the tween starts animating.
  * @param {EasingFunction} [options.easingFunction=EasingFunction.LINEAR_NONE] Determines the curve for animtion.
  * @param {TweenCollection.TweenUpdateCallback} [options.update] The callback to call at each animation update (usually tied to the a rendered frame).
  * @param {TweenCollection.TweenCompleteCallback} [options.complete] The callback to call when the tween finishes animating.
@@ -276,13 +276,13 @@ TweenCollection.prototype.add = function (options) {
  * Creates a tween for animating a scalar property on the given object.  The tween starts animating at the next call to {@link TweenCollection#update}, which
  * is implicit when {@link Viewer} or {@link CesiumWidget} render the scene.
  *
- * @param {Object} [options] Object with the following properties:
- * @param {Object} options.object The object containing the property to animate.
- * @param {String} options.property The name of the property to animate.
- * @param {Number} options.startValue The initial value.
- * @param {Number} options.stopValue The final value.
- * @param {Number} [options.duration=3.0] The duration, in seconds, for the tween.  The tween is automatically removed from the collection when it stops.
- * @param {Number} [options.delay=0.0] The delay, in seconds, before the tween starts animating.
+ * @param {object} [options] Object with the following properties:
+ * @param {object} options.object The object containing the property to animate.
+ * @param {string} options.property The name of the property to animate.
+ * @param {number} options.startValue The initial value.
+ * @param {number} options.stopValue The final value.
+ * @param {number} [options.duration=3.0] The duration, in seconds, for the tween.  The tween is automatically removed from the collection when it stops.
+ * @param {number} [options.delay=0.0] The delay, in seconds, before the tween starts animating.
  * @param {EasingFunction} [options.easingFunction=EasingFunction.LINEAR_NONE] Determines the curve for animtion.
  * @param {TweenCollection.TweenUpdateCallback} [options.update] The callback to call at each animation update (usually tied to the a rendered frame).
  * @param {TweenCollection.TweenCompleteCallback} [options.complete] The callback to call when the tween finishes animating.
@@ -343,12 +343,12 @@ TweenCollection.prototype.addProperty = function (options) {
  * Creates a tween for animating the alpha of all color uniforms on a {@link Material}.  The tween starts animating at the next call to {@link TweenCollection#update}, which
  * is implicit when {@link Viewer} or {@link CesiumWidget} render the scene.
  *
- * @param {Object} [options] Object with the following properties:
+ * @param {object} [options] Object with the following properties:
  * @param {Material} options.material The material to animate.
- * @param {Number} [options.startValue=0.0] The initial alpha value.
- * @param {Number} [options.stopValue=1.0] The final alpha value.
- * @param {Number} [options.duration=3.0] The duration, in seconds, for the tween.  The tween is automatically removed from the collection when it stops.
- * @param {Number} [options.delay=0.0] The delay, in seconds, before the tween starts animating.
+ * @param {number} [options.startValue=0.0] The initial alpha value.
+ * @param {number} [options.stopValue=1.0] The final alpha value.
+ * @param {number} [options.duration=3.0] The duration, in seconds, for the tween.  The tween is automatically removed from the collection when it stops.
+ * @param {number} [options.delay=0.0] The delay, in seconds, before the tween starts animating.
  * @param {EasingFunction} [options.easingFunction=EasingFunction.LINEAR_NONE] Determines the curve for animtion.
  * @param {TweenCollection.TweenUpdateCallback} [options.update] The callback to call at each animation update (usually tied to the a rendered frame).
  * @param {TweenCollection.TweenCompleteCallback} [options.complete] The callback to call when the tween finishes animating.
@@ -416,12 +416,12 @@ TweenCollection.prototype.addAlpha = function (options) {
  * Creates a tween for animating the offset uniform of a {@link Material}.  The tween starts animating at the next call to {@link TweenCollection#update}, which
  * is implicit when {@link Viewer} or {@link CesiumWidget} render the scene.
  *
- * @param {Object} [options] Object with the following properties:
+ * @param {object} [options] Object with the following properties:
  * @param {Material} options.material The material to animate.
- * @param {Number} options.startValue The initial alpha value.
- * @param {Number} options.stopValue The final alpha value.
- * @param {Number} [options.duration=3.0] The duration, in seconds, for the tween.  The tween is automatically removed from the collection when it stops.
- * @param {Number} [options.delay=0.0] The delay, in seconds, before the tween starts animating.
+ * @param {number} options.startValue The initial alpha value.
+ * @param {number} options.stopValue The final alpha value.
+ * @param {number} [options.duration=3.0] The duration, in seconds, for the tween.  The tween is automatically removed from the collection when it stops.
+ * @param {number} [options.delay=0.0] The delay, in seconds, before the tween starts animating.
  * @param {EasingFunction} [options.easingFunction=EasingFunction.LINEAR_NONE] Determines the curve for animtion.
  * @param {TweenCollection.TweenUpdateCallback} [options.update] The callback to call at each animation update (usually tied to the a rendered frame).
  * @param {TweenCollection.TweenCancelledCallback} [options.cancel] The callback to call if the tween is canceled either because {@link Tween#cancelTween} was called or because the tween was removed from the collection.
@@ -466,7 +466,7 @@ TweenCollection.prototype.addOffsetIncrement = function (options) {
  * </p>
  *
  * @param {Tween} tween The tween to remove.
- * @returns {Boolean} <code>true</code> if the tween was removed; <code>false</code> if the tween was not found in the collection.
+ * @returns {boolean} <code>true</code> if the tween was removed; <code>false</code> if the tween was not found in the collection.
  */
 TweenCollection.prototype.remove = function (tween) {
   if (!defined(tween)) {
@@ -509,7 +509,7 @@ TweenCollection.prototype.removeAll = function () {
  * Determines whether this collection contains a given tween.
  *
  * @param {Tween} tween The tween to check for.
- * @returns {Boolean} <code>true</code> if this collection contains the tween, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if this collection contains the tween, <code>false</code> otherwise.
  */
 TweenCollection.prototype.contains = function (tween) {
   return defined(tween) && this._tweens.indexOf(tween) !== -1;
@@ -521,7 +521,7 @@ TweenCollection.prototype.contains = function (tween) {
  * it to the left, changing their indices.  This function is commonly used to iterate over
  * all the tween in the collection.
  *
- * @param {Number} index The zero-based index of the tween.
+ * @param {number} index The zero-based index of the tween.
  * @returns {Tween} The tween at the specified index.
  *
  * @example
@@ -546,7 +546,7 @@ TweenCollection.prototype.get = function (index) {
  * Updates the tweens in the collection to be at the provide time.  When a tween finishes, it is removed
  * from the collection.
  *
- * @param {Number} [time=getTimestamp()] The time in seconds.  By default tweens are synced to the system clock.
+ * @param {number} [time=getTimestamp()] The time in seconds.  By default tweens are synced to the system clock.
  */
 TweenCollection.prototype.update = function (time) {
   const tweens = this._tweens;