@cesium/engine 3.0.2 → 5.0.0

package/Source/Scene/I3SNode.js

@@ -3,7 +3,6 @@ import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import Ellipsoid from "../Core/Ellipsoid.js";
 import HeadingPitchRoll from "../Core/HeadingPitchRoll.js";
-import CesiumMath from "../Core/Math.js";
 import Matrix3 from "../Core/Matrix3.js";
 import Matrix4 from "../Core/Matrix4.js";
 import Resource from "../Core/Resource.js";
@@ -11,6 +10,7 @@ import Quaternion from "../Core/Quaternion.js";
 import Transforms from "../Core/Transforms.js";
 import Cesium3DTile from "./Cesium3DTile.js";
 import I3SDataProvider from "./I3SDataProvider.js";
+import I3SDecoder from "./I3SDecoder.js";
 import I3SFeature from "./I3SFeature.js";
 import I3SField from "./I3SField.js";
 import I3SGeometry from "./I3SGeometry.js";
@@ -608,71 +608,6 @@ I3SNode.prototype._create3DTileDefinition = function () {
   return inPlaceTileDefinition;
 };
 
-/**
- * @private
- */
-I3SNode.prototype._createI3SDecoderTask = async function (
-  decodeI3STaskProcessor,
-  data
-) {
-  // Prepare the data to send to the worker
-  const parentData = data.geometryData._parent._data;
-  const parentRotationInverseMatrix =
-    data.geometryData._parent._inverseRotationMatrix;
-
-  let longitude = 0.0;
-  let latitude = 0.0;
-  let height = 0.0;
-
-  if (defined(parentData.obb)) {
-    longitude = parentData.obb.center[0];
-    latitude = parentData.obb.center[1];
-    height = parentData.obb.center[2];
-  } else if (defined(parentData.mbs)) {
-    longitude = parentData.mbs[0];
-    latitude = parentData.mbs[1];
-    height = parentData.mbs[2];
-  }
-
-  const axisFlipRotation = Matrix3.fromRotationX(-CesiumMath.PI_OVER_TWO);
-  const parentRotation = new Matrix3();
-
-  Matrix3.multiply(
-    axisFlipRotation,
-    parentRotationInverseMatrix,
-    parentRotation
-  );
-
-  const cartographicCenter = Cartographic.fromDegrees(
-    longitude,
-    latitude,
-    height
-  );
-
-  const cartesianCenter = Ellipsoid.WGS84.cartographicToCartesian(
-    cartographicCenter
-  );
-
-  const payload = {
-    binaryData: data.geometryData._data,
-    featureData:
-      defined(data.featureData) && defined(data.featureData[0])
-        ? data.featureData[0].data
-        : undefined,
-    schema: data.defaultGeometrySchema,
-    bufferInfo: data.geometryData._geometryBufferInfo,
-    ellipsoidRadiiSquare: Ellipsoid.WGS84.radiiSquared,
-    url: data.url,
-    geoidDataList: data.geometryData._dataProvider._geoidDataList,
-    cartographicCenter: cartographicCenter,
-    cartesianCenter: cartesianCenter,
-    parentRotation: parentRotation,
-  };
-
-  const transferrableObjects = [];
-  return decodeI3STaskProcessor.scheduleTask(payload, transferrableObjects);
-};
-
 /**
  * @private
  */
@@ -702,59 +637,46 @@ I3SNode.prototype._createContentURL = async function () {
     },
   };
 
-  const decodeI3STaskProcessor = await this._dataProvider.getDecoderTaskProcessor();
-
   // Load the geometry data
   const dataPromises = [this._loadGeometryData()];
   if (this._dataProvider.legacyVersion16) {
     dataPromises.push(this._loadFeatureData());
   }
 
-  const that = this;
-  return Promise.all(dataPromises).then(function () {
-    // Binary glTF
-    let generateGltfPromise = Promise.resolve();
-    if (defined(that._geometryData) && that._geometryData.length > 0) {
-      const parameters = {
-        geometryData: that._geometryData[0],
-        featureData: that._featureData,
-        defaultGeometrySchema: that._layer._data.store.defaultGeometrySchema,
-        url: that._geometryData[0].resource.url,
-        tile: that._tile,
-      };
-
-      const promise = that._createI3SDecoderTask(
-        decodeI3STaskProcessor,
-        parameters
-      );
-      if (!defined(promise)) {
-        // Postponed
-        return;
-      }
-
-      generateGltfPromise = promise.then(function (result) {
-        rawGltf = parameters.geometryData._generateGltf(
-          result.meshData.nodesInScene,
-          result.meshData.nodes,
-          result.meshData.meshes,
-          result.meshData.buffers,
-          result.meshData.bufferViews,
-          result.meshData.accessors
-        );
-
-        that._geometryData[0]._customAttributes =
-          result.meshData._customAttributes;
-      });
+  await Promise.all(dataPromises);
+  // Binary glTF
+  if (defined(this._geometryData) && this._geometryData.length > 0) {
+    const url = this._geometryData[0].resource.url;
+    const geometrySchema = this._layer._data.store.defaultGeometrySchema;
+    const geometryData = this._geometryData[0];
+    const result = await I3SDecoder.decode(
+      url,
+      geometrySchema,
+      geometryData,
+      this._featureData[0]
+    );
+    if (!defined(result)) {
+      // Postponed
+      return;
     }
 
-    return generateGltfPromise.then(function () {
-      const binaryGltfData = that._dataProvider._binarizeGltf(rawGltf);
-      const glbDataBlob = new Blob([binaryGltfData], {
-        type: "application/binary",
-      });
-      return URL.createObjectURL(glbDataBlob);
-    });
+    rawGltf = geometryData._generateGltf(
+      result.meshData.nodesInScene,
+      result.meshData.nodes,
+      result.meshData.meshes,
+      result.meshData.buffers,
+      result.meshData.bufferViews,
+      result.meshData.accessors
+    );
+
+    this._geometryData[0]._customAttributes = result.meshData._customAttributes;
+  }
+
+  const binaryGltfData = this._dataProvider._binarizeGltf(rawGltf);
+  const glbDataBlob = new Blob([binaryGltfData], {
+    type: "application/binary",
   });
+  return URL.createObjectURL(glbDataBlob);
 };
 
 // Reimplement Cesium3DTile.prototype.requestContent so that

package/Source/Scene/Implicit3DTileContent.js

@@ -536,8 +536,21 @@ function deriveChildTile(
   // user specified such as extras or extensions.
   const deep = true;
   const rootHeader = clone(implicitTileset.tileHeader, deep);
+  // The bounding volume was computed above since it may come from metadata
+  // in the subtree file.
   delete rootHeader.boundingVolume;
+  // Copying the transform to all the transcoded tiles would cause the transform
+  // to be applied multiple times. Removing it from the header avoids this issue.
   delete rootHeader.transform;
+  // The implicit tiling spec does not specify what should happen if explicit
+  // tile metadata is added to the placeholder tile. Since implicit tile
+  // metadata comes from the subtree file, ignore the explicit version.
+  //
+  // Also, when a property with the semantic TILE_BOUNDING_VOLUME is added to
+  // the placeholder tile to set a tight bounding volume (See Cesium3DTile.js)
+  // propagating it to transcoded tiles causes transcoded tiles to use the
+  // wrong bounding volume, this can lead to loading far too many tiles.
+  delete rootHeader.metadata;
   const combinedTileJson = combine(tileJson, rootHeader, deep);
 
   const childTile = makeTile(

package/Source/Scene/ImplicitTileset.js

@@ -60,6 +60,11 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
    */
   this.metadataSchema = metadataSchema;
 
+  // Due to using explicit tile metadata to store a tight bounding box
+  // in some cases (see https://github.com/CesiumGS/cesium/pull/11365)
+  // it's important that this bounding volume is computed from the tile JSON
+  // (which is the original, possibly loose bounding volume) rather than
+  // tile.boundingVolume which is the tighter one.
   const boundingVolume = tileJson.boundingVolume;
   if (
     !defined(boundingVolume.box) &&

package/Source/Scene/LabelCollection.js

@@ -56,7 +56,7 @@ function addWhitePixelCanvas(textureAtlas) {
 
   // Canvas operations take a frame to draw. Use the asynchronous add function which resolves a promise and allows the draw to complete,
   // but there's no need to wait on the promise before operation can continue
-  textureAtlas.addImage(whitePixelCanvasId, canvas);
+  return textureAtlas.addImage(whitePixelCanvasId, canvas);
 }
 
 // reusable object for calling writeTextToCanvas
@@ -911,6 +911,8 @@ LabelCollection.prototype.update = function (frameState) {
       initialSize: whitePixelSize,
     });
     backgroundBillboardCollection.textureAtlas = this._backgroundTextureAtlas;
+
+    // Request a new render in request render mode after the next frame renders
     addWhitePixelCanvas(this._backgroundTextureAtlas);
   }
 

package/Source/Scene/Model/I3dmLoader.js

@@ -423,7 +423,11 @@ function createInstances(loader, components, frameState) {
   // For I3DMs that do not define an RTC center, we manually compute a BoundingSphere and store
   // positions relative to the center, to be uploaded to the GPU. This avoids jittering at higher
   // precisions.
-  if (!defined(rtcCenter)) {
+  // Also manually compute if RTC center equals Cartesian3.ZERO
+  if (
+    !defined(rtcCenter) ||
+    Cartesian3.equals(Cartesian3.unpack(rtcCenter), Cartesian3.ZERO)
+  ) {
     const positionBoundingSphere = BoundingSphere.fromPoints(instancePositions);
 
     for (i = 0; i < instancePositions.length; i++) {

package/Source/Scene/Model/Model.js

@@ -408,6 +408,7 @@ function Model(options) {
     credit = new Credit(credit);
   }
 
+  this._credits = [];
   this._credit = credit;
 
   // Credits to be added from the Resource (if it is an IonResource)
@@ -1838,7 +1839,10 @@ Model.prototype.update = function (frameState) {
 };
 
 function processLoader(model, frameState) {
-  if (!model._resourcesLoaded || !model._texturesLoaded) {
+  if (
+    !model._resourcesLoaded ||
+    (model._loader.incrementallyLoadTextures && !model._texturesLoaded)
+  ) {
     // Ensures frames continue to render in requestRender mode while resources are processing
     frameState.afterRender.push(() => true);
     return model._loader.process(frameState);
@@ -2255,24 +2259,29 @@ function updateShowCreditsOnScreen(model) {
     return;
   }
   model._showCreditsOnScreenDirty = false;
+  model._credits.length = 0;
 
   const showOnScreen = model._showCreditsOnScreen;
   if (defined(model._credit)) {
-    model._credit.showOnScreen = showOnScreen || model._credit._isDefaultToken;
+    const credit = Credit.clone(model._credit);
+    credit.showOnScreen = credit.showOnScreen || showOnScreen;
+    model._credits.push(credit);
   }
 
   const resourceCredits = model._resourceCredits;
   const resourceCreditsLength = resourceCredits.length;
   for (let i = 0; i < resourceCreditsLength; i++) {
-    resourceCredits[i].showOnScreen =
-      showOnScreen || resourceCredits[i]._isDefaultToken;
+    const credit = Credit.clone(resourceCredits[i]);
+    credit.showOnScreen = credit.showOnScreen || showOnScreen;
+    model._credits.push(credit);
   }
 
   const gltfCredits = model._gltfCredits;
   const gltfCreditsLength = gltfCredits.length;
   for (let i = 0; i < gltfCreditsLength; i++) {
-    gltfCredits[i].showOnScreen =
-      showOnScreen || gltfCredits[i]._isDefaultToken;
+    const credit = Credit.clone(gltfCredits[i]);
+    credit.showOnScreen = credit.showOnScreen || showOnScreen;
+    model._credits.push(credit);
   }
 }
 
@@ -2382,22 +2391,10 @@ function passesDistanceDisplayCondition(model, frameState) {
 
 function addCreditsToCreditDisplay(model, frameState) {
   const creditDisplay = frameState.creditDisplay;
-  // Add all credits to the credit display.
-  const credit = model._credit;
-  if (defined(credit)) {
-    creditDisplay.addCreditToNextFrame(credit);
-  }
-
-  const resourceCredits = model._resourceCredits;
-  const resourceCreditsLength = resourceCredits.length;
-  for (let c = 0; c < resourceCreditsLength; c++) {
-    creditDisplay.addCreditToNextFrame(resourceCredits[c]);
-  }
-
-  const gltfCredits = model._gltfCredits;
-  const gltfCreditsLength = gltfCredits.length;
-  for (let c = 0; c < gltfCreditsLength; c++) {
-    creditDisplay.addCreditToNextFrame(gltfCredits[c]);
+  const credits = model._credits;
+  const creditsLength = credits.length;
+  for (let c = 0; c < creditsLength; c++) {
+    creditDisplay.addCreditToNextFrame(credits[c]);
   }
 }
 
@@ -2792,7 +2789,7 @@ Model.fromGltfAsync = async function (options) {
   if (defined(resourceCredits)) {
     const length = resourceCredits.length;
     for (let i = 0; i < length; i++) {
-      model._resourceCredits.push(resourceCredits[i]);
+      model._resourceCredits.push(Credit.clone(resourceCredits[i]));
     }
   }
 

package/Source/Scene/OpenStreetMapImageryProvider.js

@@ -18,6 +18,7 @@ const defaultCredit = new Credit(
  *
  * @property {string} [url='https://tile.openstreetmap.org'] The OpenStreetMap server url.
  * @property {string} [fileExtension='png'] The file extension for images on the server.
+ * @property {boolean} [retinaTiles=false] When true, request tiles at the 2x resolution for retina displays.
  * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle of the layer.
  * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider.
  * @property {number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
@@ -62,7 +63,9 @@ function OpenStreetMapImageryProvider(options) {
     defaultValue(options.url, "https://tile.openstreetmap.org/")
   );
   resource.appendForwardSlash();
-  resource.url += `{z}/{x}/{y}.${defaultValue(options.fileExtension, "png")}`;
+  resource.url += `{z}/{x}/{y}${
+    options.retinaTiles ? "@2x" : ""
+  }.${defaultValue(options.fileExtension, "png")}`;
 
   const tilingScheme = new WebMercatorTilingScheme({
     ellipsoid: options.ellipsoid,

package/Source/Scene/PostProcessStageLibrary.js

@@ -226,16 +226,16 @@ PostProcessStageLibrary.isDepthOfFieldSupported = function (scene) {
  *
  * @example
  * // multiple silhouette effects
- * const yellowEdge = Cesium.PostProcessLibrary.createEdgeDetectionStage();
+ * const yellowEdge = Cesium.PostProcessStageLibrary.createEdgeDetectionStage();
  * yellowEdge.uniforms.color = Cesium.Color.YELLOW;
  * yellowEdge.selected = [feature0];
  *
- * const greenEdge = Cesium.PostProcessLibrary.createEdgeDetectionStage();
+ * const greenEdge = Cesium.PostProcessStageLibrary.createEdgeDetectionStage();
  * greenEdge.uniforms.color = Cesium.Color.LIME;
  * greenEdge.selected = [feature1];
  *
  * // draw edges around feature0 and feature1
- * postProcessStages.add(Cesium.PostProcessLibrary.createSilhouetteStage([yellowEdge, greenEdge]);
+ * postProcessStages.add(Cesium.PostProcessStageLibrary.createSilhouetteStage([yellowEdge, greenEdge]);
  */
 PostProcessStageLibrary.createEdgeDetectionStage = function () {
   // unique name generated on call so more than one effect can be added

package/Source/Scene/PrimitiveCollection.js

@@ -3,6 +3,7 @@ import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
 import destroyObject from "../Core/destroyObject.js";
 import DeveloperError from "../Core/DeveloperError.js";
+import Event from "../Core/Event.js";
 
 /**
  * A collection of primitives.  This is most often used with {@link Scene#primitives},
@@ -31,6 +32,8 @@ function PrimitiveCollection(options) {
 
   this._primitives = [];
   this._guid = createGuid();
+  this._primitiveAdded = new Event();
+  this._primitiveRemoved = new Event();
 
   // Used by the OrderedGroundPrimitiveCollection
   this._zIndex = undefined;
@@ -84,6 +87,35 @@ Object.defineProperties(PrimitiveCollection.prototype, {
       return this._primitives.length;
     },
   },
+
+  /**
+   * An event that is raised when a primitive is added to the collection.
+   * Event handlers are passed the primitive that was added.
+   * @memberof PrimitiveCollection.prototype
+   * @type {Event}
+   * @readonly
+   */
+  primitiveAdded: {
+    get: function () {
+      return this._primitiveAdded;
+    },
+  },
+
+  /**
+   * An event that is raised when a primitive is removed from the collection.
+   * Event handlers are passed the primitive that was removed.
+   * <p>
+   * Note: Depending on the destroyPrimitives constructor option, the primitive may already be destroyed.
+   * </p>
+   * @memberof PrimitiveCollection.prototype
+   * @type {Event}
+   * @readonly
+   */
+  primitiveRemoved: {
+    get: function () {
+      return this._primitiveRemoved;
+    },
+  },
 });
 
 /**
@@ -128,6 +160,8 @@ PrimitiveCollection.prototype.add = function (primitive, index) {
     this._primitives.splice(index, 0, primitive);
   }
 
+  this._primitiveAdded.raiseEvent(primitive);
+
   return primitive;
 };
 
@@ -159,6 +193,8 @@ PrimitiveCollection.prototype.remove = function (primitive) {
         primitive.destroy();
       }
 
+      this._primitiveRemoved.raiseEvent(primitive);
+
       return true;
     }
     // else ... this is not possible, I swear.
@@ -191,9 +227,12 @@ PrimitiveCollection.prototype.removeAll = function () {
   const length = primitives.length;
   for (let i = 0; i < length; ++i) {
     delete primitives[i]._external._composites[this._guid];
+
     if (this.destroyPrimitives) {
       primitives[i].destroy();
     }
+
+    this._primitiveRemoved.raiseEvent(primitives[i]);
   }
   this._primitives = [];
 };

package/Source/Scene/Scene.js

@@ -3166,7 +3166,10 @@ Scene.prototype.updateEnvironment = function () {
         );
         environmentState.isReadyForAtmosphere =
           environmentState.isReadyForAtmosphere ||
+          !globe.show ||
           globe._surface._tilesToRender.length > 0;
+      } else {
+        environmentState.isReadyForAtmosphere = true;
       }
       environmentState.skyAtmosphereCommand = skyAtmosphere.update(
         frameState,

package/Source/Scene/SingleTileImageryProvider.js

@@ -24,8 +24,9 @@ import ImageryProvider from "./ImageryProvider.js";
  */
 
 /**
- * Provides a single, top-level imagery tile.  The single image is assumed to use a
- * {@link GeographicTilingScheme}.
+ * Provides a single, top-level imagery tile.  The single image is assumed to be in
+ * the Geographic projection (i.e. WGS84 / EPSG:4326),
+ * and will be rendered using a {@link GeographicTilingScheme}.
  *
  * @alias SingleTileImageryProvider
  * @constructor
@@ -295,6 +296,7 @@ async function doRequest(resource, provider, previousError) {
  * Creates a provider for a single, top-level imagery tile.  The single image is assumed to use a
  * @param {Resource|String} url The url for the tile
  * @param {SingleTileImageryProvider.fromUrlOptions} [options] Object describing initialization options.
+ * @returns {Promise.<SingleTileImageryProvider>} The resolved SingleTileImageryProvider.
  *
  * @example
  * const provider = await SingleTileImageryProvider.fromUrl("https://yoururl.com/image.png");