@cesium/engine 2.0.0 → 2.1.0

package/Source/Scene/HorizontalOrigin.js

@@ -8,7 +8,7 @@
  * <img src='Images/Billboard.setHorizontalOrigin.png' width='648' height='196' /><br />
  * </div>
  *
- * @enum {Number}
+ * @enum {number}
  *
  * @see Billboard#horizontalOrigin
  * @see Label#horizontalOrigin
@@ -17,7 +17,7 @@ const HorizontalOrigin = {
   /**
    * The origin is at the horizontal center of the object.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   CENTER: 0,
@@ -25,7 +25,7 @@ const HorizontalOrigin = {
   /**
    * The origin is on the left side of the object.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   LEFT: 1,
@@ -33,7 +33,7 @@ const HorizontalOrigin = {
   /**
    * The origin is on the right side of the object.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   RIGHT: -1,

package/Source/Scene/I3SDataProvider.js

@@ -70,13 +70,13 @@ import Rectangle from "../Core/Rectangle.js";
  * @alias I3SDataProvider
  * @constructor
  *
- * @param {Object} options Object with the following properties:
- * @param {Resource|String} options.url The url of the I3S dataset.
- * @param {String} [options.name] The name of the I3S dataset.
- * @param {Boolean} [options.show=true] Determines if the dataset will be shown.
+ * @param {object} options Object with the following properties:
+ * @param {Resource|string} options.url The url of the I3S dataset.
+ * @param {string} [options.name] The name of the I3S dataset.
+ * @param {boolean} [options.show=true] Determines if the dataset will be shown.
  * @param {ArcGISTiledElevationTerrainProvider} [options.geoidTiledTerrainProvider] Tiled elevation provider describing an Earth Gravitational Model. If defined, geometry will be shifted based on the offsets given by this provider. Required to position I3S data sets with gravity-related height at the correct location.
- * @param {Boolean} [options.traceFetches=false] Debug option. When true, log a message whenever an I3S tile is fetched.
- * @param {Object} [options.cesium3dTilesetOptions] Object containing options to pass to an internally created {@link Cesium3DTileset}. See {@link Cesium3DTileset} for list of valid properties. All options can be used with the exception of <code>url</code> and <code>show</code> which are overridden by values from I3SDataProvider.
+ * @param {boolean} [options.traceFetches=false] Debug option. When true, log a message whenever an I3S tile is fetched.
+ * @param {object} [options.cesium3dTilesetOptions] Object containing options to pass to an internally created {@link Cesium3DTileset}. See {@link Cesium3DTileset} for list of valid properties. All options can be used with the exception of <code>url</code> and <code>show</code> which are overridden by values from I3SDataProvider.
  *
  * @example
  * const i3sData = new I3SDataProvider({
@@ -130,7 +130,7 @@ Object.defineProperties(I3SDataProvider.prototype, {
   /**
    * Gets a human-readable name for this dataset.
    * @memberof I3SDataProvider.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   name: {
@@ -142,7 +142,7 @@ Object.defineProperties(I3SDataProvider.prototype, {
   /**
    * Determines if the dataset will be shown.
    * @memberof I3SDataProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   show: {
     get: function () {
@@ -165,7 +165,7 @@ Object.defineProperties(I3SDataProvider.prototype, {
   /**
    * Gets or sets debugging and tracing of I3S fetches.
    * @memberof I3SDataProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   traceFetches: {
     get: function () {
@@ -215,7 +215,7 @@ Object.defineProperties(I3SDataProvider.prototype, {
   /**
    * Gets the I3S data for this object.
    * @memberof I3SDataProvider.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   data: {
@@ -255,7 +255,7 @@ Object.defineProperties(I3SDataProvider.prototype, {
   /**
    * Gets the promise that will be resolved when the I3S scene is loaded.
    * @memberof I3SDataProvider.prototype
-   * @type {Promise.<I3SDataProvider>}
+   * @type {Promise<I3SDataProvider>}
    * @readonly
    */
   readyPromise: {
@@ -268,7 +268,7 @@ Object.defineProperties(I3SDataProvider.prototype, {
    * When <code>true</code>, the I3S scene is loaded.
    * This is set to <code>true</code> right before {@link I3SDataProvider#readyPromise} is resolved.
    * @memberof I3SDataProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -320,7 +320,7 @@ I3SDataProvider.prototype.destroy = function () {
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  * </p>
  *
- * @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 I3SDataProvider#destroy
  */

package/Source/Scene/I3SFeature.js

@@ -37,7 +37,7 @@ Object.defineProperties(I3SFeature.prototype, {
   /**
    * Gets the I3S data for this object.
    * @memberof I3SFeature.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   data: {

package/Source/Scene/I3SField.js

@@ -6,7 +6,7 @@ import defined from "../Core/defined.js";
  * @alias I3SField
  * @internalConstructor
  * @privateParam {I3SNode} parent The parent of that geometry
- * @privateParam {Object} storageInfo The structure containing the storage info of the field
+ * @privateParam {object} storageInfo The structure containing the storage info of the field
  */
 function I3SField(parent, storageInfo) {
   this._storageInfo = storageInfo;
@@ -38,7 +38,7 @@ Object.defineProperties(I3SField.prototype, {
   /**
    * Gets the header for this field.
    * @memberof I3SField.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   header: {
@@ -49,7 +49,7 @@ Object.defineProperties(I3SField.prototype, {
   /**
    * Gets the values for this field.
    * @memberof I3SField.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   values: {
@@ -62,7 +62,7 @@ Object.defineProperties(I3SField.prototype, {
   /**
    * Gets the name for the field.
    * @memberof I3SField.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   name: {
@@ -94,7 +94,7 @@ function getNumericTypeSize(type) {
 
 /**
  * Loads the content.
- * @returns {Promise.<void>} A promise that is resolved when the field data is loaded
+ * @returns {Promise<void>} A promise that is resolved when the field data is loaded
  */
 I3SField.prototype.load = function () {
   const that = this;

package/Source/Scene/I3SGeometry.js

@@ -11,7 +11,7 @@ import Matrix3 from "../Core/Matrix3.js";
  * @alias I3SGeometry
  * @internalConstructor
  * @privateParam {I3SNode} parent The parent of that geometry
- * @privateParam {String} uri The uri to load the data from
+ * @privateParam {string} uri The uri to load the data from
  */
 function I3SGeometry(parent, uri) {
   const dataProvider = parent._dataProvider;
@@ -51,7 +51,7 @@ Object.defineProperties(I3SGeometry.prototype, {
   /**
    * Gets the I3S data for this object.
    * @memberof I3SGeometry.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   data: {
@@ -62,7 +62,7 @@ Object.defineProperties(I3SGeometry.prototype, {
   /**
    * Gets the custom attributes of the geometry.
    * @memberof I3SGeometry.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   customAttributes: {
@@ -74,7 +74,7 @@ Object.defineProperties(I3SGeometry.prototype, {
 
 /**
  * Loads the content.
- * @returns {Promise.<Object>} A promise that is resolved when the geometry data is loaded
+ * @returns {Promise<object>} A promise that is resolved when the geometry data is loaded
  * @private
  */
 I3SGeometry.prototype.load = function () {
@@ -121,10 +121,10 @@ const scratchV2p = new Cartesian3();
 
 /**
  * Find a triangle touching the point [px, py, pz], then return the vertex closest to the search point
- * @param {Number} px The x component of the point to query
- * @param {Number} py The y component of the point to query
- * @param {Number} pz The z component of the point to query
- * @returns {Object} A structure containing the index of the closest point,
+ * @param {number} px The x component of the point to query
+ * @param {number} py The y component of the point to query
+ * @param {number} pz The z component of the point to query
+ * @returns {object} A structure containing the index of the closest point,
  * the squared distance from the queried point to the point that is found,
  * the distance from the queried point to the point that is found,
  * the queried position in local space,

package/Source/Scene/I3SLayer.js

@@ -12,8 +12,8 @@ import I3SNode from "./I3SNode.js";
  * @alias I3SLayer
  * @internalConstructor
  * @privateParam {I3SDataProvider} dataProvider The i3s data provider
- * @privateParam {Object} layerData The layer data that is loaded from the scene layer
- * @privateParam {Number} index The index of the layer to be reflected
+ * @privateParam {object} layerData The layer data that is loaded from the scene layer
+ * @privateParam {number} index The index of the layer to be reflected
  */
 function I3SLayer(dataProvider, layerData, index) {
   this._dataProvider = dataProvider;
@@ -95,7 +95,7 @@ Object.defineProperties(I3SLayer.prototype, {
   /**
    * Gets the I3S data for this object.
    * @memberof I3SLayer.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   data: {
@@ -107,7 +107,7 @@ Object.defineProperties(I3SLayer.prototype, {
   /**
    * The version string of the loaded I3S dataset
    * @memberof I3SLayer.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   version: {
@@ -119,7 +119,7 @@ Object.defineProperties(I3SLayer.prototype, {
   /**
    * The major version number of the loaded I3S dataset
    * @memberof I3SLayer.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   majorVersion: {
@@ -131,7 +131,7 @@ Object.defineProperties(I3SLayer.prototype, {
   /**
    * The minor version number of the loaded I3S dataset
    * @memberof I3SLayer.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   minorVersion: {
@@ -143,7 +143,7 @@ Object.defineProperties(I3SLayer.prototype, {
   /**
    * When <code>true</code>, when the loaded I3S version is 1.6 or older
    * @memberof I3SLayer.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   legacyVersion16: {

package/Source/Scene/I3SNode.js

@@ -157,7 +157,7 @@ Object.defineProperties(I3SNode.prototype, {
   /**
    * Gets the I3S data for this object.
    * @memberof I3SNode.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   data: {
@@ -217,7 +217,7 @@ I3SNode.prototype.load = function () {
 
 /**
  * Loads the node fields.
- * @returns {Promise.<void>} A promise that is resolved when the I3S Node fields are loaded
+ * @returns {Promise<void>} A promise that is resolved when the I3S Node fields are loaded
  */
 I3SNode.prototype.loadFields = function () {
   // Check if we must load fields
@@ -243,7 +243,7 @@ I3SNode.prototype.loadFields = function () {
 /**
  * Returns the fields for a given picked position
  * @param {Cartesian3} pickedPosition The picked position
- * @returns {Object} Object containing field names and their values
+ * @returns {object} Object containing field names and their values
  */
 I3SNode.prototype.getFieldsForPickedPosition = function (pickedPosition) {
   const geometry = this.geometryData[0];
@@ -270,8 +270,8 @@ I3SNode.prototype.getFieldsForPickedPosition = function (pickedPosition) {
 
 /**
  * Returns the fields for a given feature
- * @param {Number} featureIndex Index of the feature whose attributes we want to get
- * @returns {Object} Object containing field names and their values
+ * @param {number} featureIndex Index of the feature whose attributes we want to get
+ * @returns {object} Object containing field names and their values
  */
 I3SNode.prototype.getFieldsForFeature = function (featureIndex) {
   const featureFields = {};
@@ -848,7 +848,7 @@ Object.defineProperties(Cesium3DTile.prototype, {
   /**
    * Gets the I3S Node for the tile.
    * @memberof Cesium3DTile.prototype
-   * @type {String}
+   * @type {string}
    */
   i3sNode: {
     get: function () {

package/Source/Scene/I3dmParser.js

@@ -21,8 +21,8 @@ const sizeOfUint32 = Uint32Array.BYTES_PER_ELEMENT;
  * @private
  *
  * @param {ArrayBuffer} arrayBuffer The array buffer containing the i3dm.
- * @param {Number} [byteOffset=0] The byte offset of the beginning of the i3dm in the array buffer.
- * @returns {Object} Returns an object with the glTF format, feature table (binary and json), batch table (binary and json) and glTF parts of the i3dm.
+ * @param {number} [byteOffset=0] The byte offset of the beginning of the i3dm in the array buffer.
+ * @returns {object} Returns an object with the glTF format, feature table (binary and json), batch table (binary and json) and glTF parts of the i3dm.
  */
 I3dmParser.parse = function (arrayBuffer, byteOffset) {
   //>>includeStart('debug', pragmas.debug);

package/Source/Scene/ImageBasedLighting.js

@@ -20,9 +20,9 @@ import OctahedralProjectedCubeMap from "./OctahedralProjectedCubeMap.js";
  * @constructor
  *
  * @param {Cartesian2} [options.imageBasedLightingFactor=Cartesian2(1.0, 1.0)] Scales diffuse and specular image-based lighting from the earth, sky, atmosphere and star skybox.
- * @param {Number} [options.luminanceAtZenith=0.2] The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.
+ * @param {number} [options.luminanceAtZenith=0.2] The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.
  * @param {Cartesian3[]} [options.sphericalHarmonicCoefficients] The third order spherical harmonic coefficients used for the diffuse color of image-based lighting.
- * @param {String} [options.specularEnvironmentMaps] A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
+ * @param {string} [options.specularEnvironmentMaps] A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
  */
 function ImageBasedLighting(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
@@ -102,6 +102,7 @@ function ImageBasedLighting(options) {
   );
   this._previousLuminanceAtZenith = luminanceAtZenith;
   this._previousSphericalHarmonicCoefficients = sphericalHarmonicCoefficients;
+  this._removeErrorListener = undefined;
 }
 
 Object.defineProperties(ImageBasedLighting.prototype, {
@@ -163,7 +164,7 @@ Object.defineProperties(ImageBasedLighting.prototype, {
    *
    * @memberof ImageBasedLighting.prototype
    *
-   * @type {Number}
+   * @type {number}
    * @default 0.2
    */
   luminanceAtZenith: {
@@ -216,7 +217,7 @@ Object.defineProperties(ImageBasedLighting.prototype, {
    *
    * @memberof ImageBasedLighting.prototype
    * @demo {@link https://sandcastle.cesium.com/index.html?src=Image-Based Lighting.html|Sandcastle Image Based Lighting Demo}
-   * @type {String}
+   * @type {string}
    * @see ImageBasedLighting#sphericalHarmonicCoefficients
    */
   specularEnvironmentMaps: {
@@ -238,7 +239,7 @@ Object.defineProperties(ImageBasedLighting.prototype, {
    * Whether or not image-based lighting is enabled.
    *
    * @memberof ImageBasedLighting.prototype
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @private
    */
@@ -256,7 +257,7 @@ Object.defineProperties(ImageBasedLighting.prototype, {
    * based on the properties and resources have changed.
    *
    * @memberof ImageBasedLighting.prototype
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @private
    */
@@ -270,7 +271,7 @@ Object.defineProperties(ImageBasedLighting.prototype, {
    * Whether or not to use the default spherical harmonic coefficients.
    *
    * @memberof ImageBasedLighting.prototype
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @private
    */
@@ -284,7 +285,7 @@ Object.defineProperties(ImageBasedLighting.prototype, {
    * Whether or not the image-based lighting settings use spherical harmonic coefficients.
    *
    * @memberof ImageBasedLighting.prototype
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @private
    */
@@ -315,7 +316,7 @@ Object.defineProperties(ImageBasedLighting.prototype, {
    * Whether or not to use the default specular environment maps.
    *
    * @memberof ImageBasedLighting.prototype
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @private
    */
@@ -329,7 +330,7 @@ Object.defineProperties(ImageBasedLighting.prototype, {
    * Whether or not the image-based lighting settings use specular environment maps.
    *
    * @memberof ImageBasedLighting.prototype
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @private
    */
@@ -359,13 +360,11 @@ function createSpecularEnvironmentMapAtlas(imageBasedLighting, context) {
     );
     imageBasedLighting._specularEnvironmentMapAtlas = atlas;
 
-    atlas.readyPromise
-      .then(function () {
-        imageBasedLighting._specularEnvironmentMapLoaded = true;
-      })
-      .catch(function (error) {
+    imageBasedLighting._removeErrorListener = atlas.errorEvent.addEventListener(
+      (error) => {
         console.error(`Error loading specularEnvironmentMaps: ${error}`);
-      });
+      }
+    );
   }
 
   // Regenerate shaders so they do not use an environment map.
@@ -436,6 +435,9 @@ ImageBasedLighting.prototype.update = function (frameState) {
 
   if (defined(this._specularEnvironmentMapAtlas)) {
     this._specularEnvironmentMapAtlas.update(frameState);
+    if (this._specularEnvironmentMapAtlas.ready) {
+      this._specularEnvironmentMapLoaded = true;
+    }
   }
 
   const recompileWithDefaultAtlas =
@@ -475,7 +477,7 @@ ImageBasedLighting.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} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  *
  * @see ImageBasedLighting#destroy
  * @private
@@ -504,6 +506,8 @@ ImageBasedLighting.prototype.destroy = function () {
   this._specularEnvironmentMapAtlas =
     this._specularEnvironmentMapAtlas &&
     this._specularEnvironmentMapAtlas.destroy();
+  this._removeErrorListener =
+    this._removeErrorListener && this._removeErrorListener();
   return destroyObject(this);
 };