@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/I3SLayer.js

@@ -1,6 +1,7 @@
 import defined from "../Core/defined.js";
 import Rectangle from "../Core/Rectangle.js";
 import Resource from "../Core/Resource.js";
+import RuntimeError from "../Core/RuntimeError.js";
 import Cesium3DTileset from "./Cesium3DTileset.js";
 import I3SNode from "./I3SNode.js";
 
@@ -12,8 +13,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;
@@ -84,7 +85,7 @@ Object.defineProperties(I3SLayer.prototype, {
   /**
    * Gets the Cesium3DTileset for this layer.
    * @memberof I3SLayer.prototype
-   * @type {Cesium3DTileset}
+   * @type {Cesium3DTileset|undefined}
    * @readonly
    */
   tileset: {
@@ -95,7 +96,7 @@ Object.defineProperties(I3SLayer.prototype, {
   /**
    * Gets the I3S data for this object.
    * @memberof I3SLayer.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   data: {
@@ -107,7 +108,7 @@ Object.defineProperties(I3SLayer.prototype, {
   /**
    * The version string of the loaded I3S dataset
    * @memberof I3SLayer.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   version: {
@@ -119,7 +120,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 +132,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 +144,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: {
@@ -167,28 +168,22 @@ Object.defineProperties(I3SLayer.prototype, {
  * @returns {Promise} A promise that is resolved when the layer data is loaded
  * @private
  */
-I3SLayer.prototype.load = function () {
-  const that = this;
-
+I3SLayer.prototype.load = async function () {
   if (this._data.spatialReference.wkid !== 4326) {
-    console.log(
+    throw new RuntimeError(
       `Unsupported spatial reference: ${this._data.spatialReference.wkid}`
     );
-    return Promise.reject();
   }
 
-  return this._dataProvider._geoidDataIsReadyPromise.then(function () {
-    return that._loadRootNode().then(function () {
-      that._create3DTileset();
-      return that._tileset.readyPromise.then(function () {
-        that._rootNode._tile = that._tileset._root;
-        that._tileset._root._i3sNode = that._rootNode;
-        if (that.legacyVersion16) {
-          return that._rootNode._loadChildren();
-        }
-      });
-    });
-  });
+  await this._dataProvider.loadGeoidData();
+  await this._loadRootNode();
+  await this._create3DTileset();
+
+  this._rootNode._tile = this._tileset._root;
+  this._tileset._root._i3sNode = this._rootNode;
+  if (this.legacyVersion16) {
+    return this._rootNode._loadChildren();
+  }
 };
 
 /**
@@ -378,7 +373,7 @@ I3SLayer.prototype._computeExtent = function () {
 /**
  * @private
  */
-I3SLayer.prototype._create3DTileset = function () {
+I3SLayer.prototype._create3DTileset = async function () {
   const inPlaceTileset = {
     asset: {
       version: "1.0",
@@ -391,7 +386,7 @@ I3SLayer.prototype._create3DTileset = function () {
     type: "application/json",
   });
 
-  const inPlaceTilesetURL = URL.createObjectURL(tilesetBlob);
+  const tilesetUrl = URL.createObjectURL(tilesetBlob);
 
   const tilesetOptions = {};
   if (defined(this._dataProvider._cesium3dTilesetOptions)) {
@@ -401,26 +396,20 @@ I3SLayer.prototype._create3DTileset = function () {
       }
     }
   }
-  tilesetOptions.url = inPlaceTilesetURL;
-  tilesetOptions.show = this._dataProvider.show;
-
-  this._tileset = new Cesium3DTileset(tilesetOptions);
 
+  this._tileset = await Cesium3DTileset.fromUrl(tilesetUrl, tilesetOptions);
+  this._tileset.show = this._dataProvider.show;
   this._tileset._isI3STileSet = true;
+  this._tileset.tileUnload.addEventListener(function (tile) {
+    tile._i3sNode._clearGeometryData();
+    URL.revokeObjectURL(tile._contentResource._url);
+    tile._contentResource = tile._i3sNode.resource;
+  });
 
-  const that = this;
-  this._tileset.readyPromise.then(function () {
-    that._tileset.tileUnload.addEventListener(function (tile) {
-      tile._i3sNode._clearGeometryData();
-      URL.revokeObjectURL(tile._contentResource._url);
-      tile._contentResource = tile._i3sNode.resource;
-    });
-
-    that._tileset.tileVisible.addEventListener(function (tile) {
-      if (defined(tile._i3sNode)) {
-        tile._i3sNode._loadChildren();
-      }
-    });
+  this._tileset.tileVisible.addEventListener(function (tile) {
+    if (defined(tile._i3sNode)) {
+      tile._i3sNode._loadChildren();
+    }
   });
 };
 

package/Source/Scene/I3SNode.js

@@ -1,6 +1,5 @@
 import Cartographic from "../Core/Cartographic.js";
 import defaultValue from "../Core/defaultValue.js";
-import defer from "../Core/defer.js";
 import defined from "../Core/defined.js";
 import Ellipsoid from "../Core/Ellipsoid.js";
 import HeadingPitchRoll from "../Core/HeadingPitchRoll.js";
@@ -11,6 +10,7 @@ import Resource from "../Core/Resource.js";
 import Quaternion from "../Core/Quaternion.js";
 import Transforms from "../Core/Transforms.js";
 import Cesium3DTile from "./Cesium3DTile.js";
+import I3SDataProvider from "./I3SDataProvider.js";
 import I3SFeature from "./I3SFeature.js";
 import I3SField from "./I3SField.js";
 import I3SGeometry from "./I3SGeometry.js";
@@ -52,6 +52,7 @@ function I3SNode(parent, ref, isRoot) {
   this._layer = layer;
   this._nodeIndex = nodeIndex;
   this._resource = resource;
+  this._isLoading = false;
 
   this._tile = undefined;
   this._data = undefined;
@@ -157,7 +158,7 @@ Object.defineProperties(I3SNode.prototype, {
   /**
    * Gets the I3S data for this object.
    * @memberof I3SNode.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   data: {
@@ -170,7 +171,7 @@ Object.defineProperties(I3SNode.prototype, {
 /**
  * @private
  */
-I3SNode.prototype.load = function () {
+I3SNode.prototype.load = async function () {
   const that = this;
 
   function processData() {
@@ -191,33 +192,34 @@ I3SNode.prototype.load = function () {
 
   // If we don't have a nodepage index load from json
   if (!defined(this._nodeIndex)) {
-    return this._dataProvider._loadJson(this._resource).then(function (data) {
-      // Success
-      that._data = data;
-      processData();
-    });
+    const data = await I3SDataProvider.loadJson(
+      this._resource,
+      this._dataProvider._traceFetches
+    );
+    that._data = data;
+    processData();
+    return;
   }
 
-  return this._layer._getNodeInNodePages(this._nodeIndex).then(function (node) {
-    that._data = node;
-    let uri;
-    if (that._isRoot) {
-      uri = "nodes/root/";
-    } else if (defined(node.mesh)) {
-      const uriIndex = node.mesh.geometry.resource;
-      uri = `../${uriIndex}/`;
-    }
-    if (defined(uri)) {
-      that._resource = that._parent.resource.getDerivedResource({ url: uri });
-    }
+  const node = await this._layer._getNodeInNodePages(this._nodeIndex);
+  that._data = node;
+  let uri;
+  if (that._isRoot) {
+    uri = "nodes/root/";
+  } else if (defined(node.mesh)) {
+    const uriIndex = node.mesh.geometry.resource;
+    uri = `../${uriIndex}/`;
+  }
+  if (defined(uri)) {
+    that._resource = that._parent.resource.getDerivedResource({ url: uri });
+  }
 
-    processData();
-  });
+  processData();
 };
 
 /**
  * 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 +245,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 +272,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 = {};
@@ -609,7 +611,10 @@ I3SNode.prototype._create3DTileDefinition = function () {
 /**
  * @private
  */
-I3SNode.prototype._createI3SDecoderTask = function (dataProvider, data) {
+I3SNode.prototype._createI3SDecoderTask = async function (
+  decodeI3STaskProcessor,
+  data
+) {
   // Prepare the data to send to the worker
   const parentData = data.geometryData._parent._data;
   const parentRotationInverseMatrix =
@@ -664,18 +669,14 @@ I3SNode.prototype._createI3SDecoderTask = function (dataProvider, data) {
     parentRotation: parentRotation,
   };
 
-  const decodeI3STaskProcessor = dataProvider._getDecoderTaskProcessor();
-
   const transferrableObjects = [];
-  return dataProvider._taskProcessorReadyPromise.then(function () {
-    return decodeI3STaskProcessor.scheduleTask(payload, transferrableObjects);
-  });
+  return decodeI3STaskProcessor.scheduleTask(payload, transferrableObjects);
 };
 
 /**
  * @private
  */
-I3SNode.prototype._createContentURL = function () {
+I3SNode.prototype._createContentURL = async function () {
   let rawGltf = {
     scene: 0,
     scenes: [
@@ -701,6 +702,8 @@ I3SNode.prototype._createContentURL = function () {
     },
   };
 
+  const decodeI3STaskProcessor = await this._dataProvider.getDecoderTaskProcessor();
+
   // Load the geometry data
   const dataPromises = [this._loadGeometryData()];
   if (this._dataProvider.legacyVersion16) {
@@ -720,13 +723,16 @@ I3SNode.prototype._createContentURL = function () {
         tile: that._tile,
       };
 
-      const task = that._createI3SDecoderTask(that._dataProvider, parameters);
-      if (!defined(task)) {
+      const promise = that._createI3SDecoderTask(
+        decodeI3STaskProcessor,
+        parameters
+      );
+      if (!defined(promise)) {
         // Postponed
         return;
       }
 
-      generateGltfPromise = task.then(function (result) {
+      generateGltfPromise = promise.then(function (result) {
         rawGltf = parameters.geometryData._generateGltf(
           result.meshData.nodesInScene,
           result.meshData.nodes,
@@ -746,7 +752,7 @@ I3SNode.prototype._createContentURL = function () {
       const glbDataBlob = new Blob([binaryGltfData], {
         type: "application/binary",
       });
-      that._glbURL = URL.createObjectURL(glbDataBlob);
+      return URL.createObjectURL(glbDataBlob);
     });
   });
 };
@@ -757,50 +763,37 @@ Cesium3DTile.prototype._hookedRequestContent =
   Cesium3DTile.prototype.requestContent;
 
 /**
+ * Requests the tile's content.
+ * <p>
+ * The request may not be made if the Cesium Request Scheduler can't prioritize it.
+ * </p>
+ *
+ * @return {Promise<Cesium3DTileContent>|undefined} A promise that resolves when the request completes, or undefined if there is no request needed, or the request cannot be scheduled.
  * @private
  */
-Cesium3DTile.prototype._resolveHookedObject = function () {
-  const that = this;
-  // Keep a handle on the early promises
-  // Call the real requestContent function
-  this._hookedRequestContent();
-
-  // Fulfill the promises
-  this._contentReadyToProcessPromise.then(function () {
-    that._contentReadyToProcessDefer.resolve();
-  });
-
-  this._contentReadyPromise.then(function (content) {
-    that._isLoading = false;
-    that._contentReadyDefer.resolve(content);
-  });
-};
-
 Cesium3DTile.prototype.requestContent = function () {
-  const that = this;
   if (!this.tileset._isI3STileSet) {
     return this._hookedRequestContent();
   }
 
   if (!this._isLoading) {
     this._isLoading = true;
-
-    // Create early promises that will be fulfilled later
-    this._contentReadyToProcessDefer = defer();
-    this._contentReadyDefer = defer();
-    this._contentReadyToProcessPromise = this._contentReadyToProcessDefer.promise;
-    this._contentReadyPromise = this._contentReadyDefer.promise;
-
-    this._i3sNode._createContentURL().then(function () {
-      that._contentResource = new Resource({ url: that._i3sNode._glbURL });
-      that._resolveHookedObject();
-    });
-
-    // Returns the number of requests
-    return 0;
+    return this._i3sNode
+      ._createContentURL()
+      .then((url) => {
+        if (!defined(url)) {
+          this._isLoading = false;
+          return;
+        }
+
+        this._contentResource = new Resource({ url: url });
+        return this._hookedRequestContent();
+      })
+      .then((content) => {
+        this._isLoading = false;
+        return content;
+      });
   }
-
-  return 1;
 };
 
 function bilinearInterpolate(tx, ty, h00, h10, h01, h11) {
@@ -848,7 +841,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);
 };
 

package/Source/Scene/Imagery.js

@@ -34,7 +34,12 @@ function Imagery(imageryLayer, x, y, level, rectangle) {
   this.credits = undefined;
   this.referenceCount = 0;
 
-  if (!defined(rectangle) && imageryLayer.imageryProvider.ready) {
+  // imageryProvider._ready is deprecated; This is here for backward compatibility
+  if (
+    !defined(rectangle) &&
+    imageryLayer.ready &&
+    imageryLayer.imageryProvider._ready
+  ) {
     const tilingScheme = imageryLayer.imageryProvider.tilingScheme;
     rectangle = tilingScheme.tileXYToRectangle(x, y, level);
   }