@cesium/engine 12.0.1 → 13.1.0

package/Source/Scene/Model/ModelStatistics.js

@@ -61,7 +61,15 @@ function ModelStatistics() {
   // Sets of buffers and textures that have already been counted.
   // This is to prevent double-counting cached assets.
   this._bufferIdSet = {};
-  this._textureIdSet = {};
+
+  /**
+   * The mapping from `texture.id` strings to the byte length of the
+   * respective texture
+   *
+   * @type {object}
+   * @private
+   */
+  this._textureIdByteLengths = {};
 
   // Associated array of batch textures that have already been counted.
   // This allows for quick look-up to check if a texture has been counted,
@@ -111,7 +119,7 @@ ModelStatistics.prototype.clear = function () {
   this.propertyTablesByteLength = 0;
 
   this._bufferIdSet = {};
-  this._textureIdSet = {};
+  this._textureIdByteLengths = {};
   this._batchTextureIdMap.removeAll();
 };
 
@@ -160,12 +168,32 @@ ModelStatistics.prototype.addTexture = function (texture) {
   Check.typeOf.object("texture", texture);
   //>>includeEnd('debug');
 
-  if (!this._textureIdSet.hasOwnProperty(texture._id)) {
+  if (!this._textureIdByteLengths.hasOwnProperty(texture._id)) {
     this.texturesByteLength += texture.sizeInBytes;
+    this._textureIdByteLengths[texture._id] = texture.sizeInBytes;
   }
+};
 
-  // Simulate set insertion.
-  this._textureIdSet[texture._id] = true;
+/**
+ * Returns an array containing the `texture.id` values for all textures
+ * that are part of the model.
+ *
+ * @returns {string[]} The texture IDs
+ */
+ModelStatistics.prototype.getTextureIds = function () {
+  return Object.keys(this._textureIdByteLengths);
+};
+
+/**
+ * Returns the length, in bytes, of the texture data for the texture with
+ * the given ID that is part of the model, or `undefined` if the model
+ * does not contain the texture with the given ID.
+ *
+ * @param {string} textureId The texture ID
+ * @returns {number|undefined} The texture byte length
+ */
+ModelStatistics.prototype.getTextureByteLengthById = function (textureId) {
+  return this._textureIdByteLengths[textureId];
 };
 
 /**

package/Source/Scene/Model/PointCloudStylingPipelineStage.js

@@ -333,9 +333,10 @@ function addShaderFunctionsAndDefines(shaderBuilder, shaderFunctionInfo) {
     shaderBuilder.addDefine(
       "HAS_POINT_CLOUD_SHOW_STYLE",
       undefined,
-      ShaderDestination.VERTEX,
+      ShaderDestination.BOTH,
     );
     shaderBuilder.addVertexLines(showStyleFunction);
+    shaderBuilder.addVarying("float", "v_pointCloudShow");
   }
 
   const pointSizeStyleFunction = shaderFunctionInfo.pointSizeStyleFunction;

package/Source/Scene/PickedMetadataInfo.js

@@ -6,11 +6,17 @@
  * the metadata values of an object into the picking frame buffer. The
  * raw values are read from that buffer, and are then translated back into
  * proper metadata values in `Picking.pickMetadata`, using the structural
- * information about the metadata `classProperty` that is stored here.
+ * information about the metadata that is stored here.
  *
  * @private
  */
-function PickedMetadataInfo(schemaId, className, propertyName, classProperty) {
+function PickedMetadataInfo(
+  schemaId,
+  className,
+  propertyName,
+  classProperty,
+  metadataProperty,
+) {
   /**
    * The optional ID of the metadata schema
    *
@@ -29,11 +35,23 @@ function PickedMetadataInfo(schemaId, className, propertyName, classProperty) {
    * @type {string}
    */
   this.propertyName = propertyName;
+
   /**
-   * The optional ID of the metadata schema
+   * The the `MetadataClassProperty` that is described by this
+   * structure, as obtained from the `MetadataSchema`
    *
    * @type {MetadataClassProperty}
    */
   this.classProperty = classProperty;
+
+  /**
+   * The `PropertyTextureProperty` or `PropertyAttributeProperty` that
+   * is described by this structure, as obtained from the property texture
+   * or property attribute of the `StructuralMetadata` that matches the
+   * class name and property name.
+   *
+   * @type {object}
+   */
+  this.metadataProperty = metadataProperty;
 }
 export default PickedMetadataInfo;

package/Source/Scene/Picking.js

@@ -426,9 +426,14 @@ Picking.prototype.pickVoxelCoordinate = function (
  * - For `VEC3`, the return type will be a `Cartesian3`
  * - For `VEC4`, the return type will be a `Cartesian4`
  *
+ * Future implementations may additionally return `string`- or
+ * `boolean` types, and `MATn` values as `MatrixN` objects,
+ * and arrays of the respective types.
+ *
  * @param {Cartesian2} windowPosition Window coordinates to perform picking on.
  * @param {PickedMetadataInfo} pickedMetadataInfo Information about the picked metadata.
- * @returns {any} The metadata values
+ * @returns {MetadataValue|undefined} The metadata value, or `undefined`
+ * when no matching metadata value could be picked at the given position
  *
  * @private
  */
@@ -517,6 +522,7 @@ Picking.prototype.pickMetadata = function (
 
   const metadataValue = MetadataPicking.decodeMetadataValues(
     pickedMetadataInfo.classProperty,
+    pickedMetadataInfo.metadataProperty,
     rawMetadataPixel,
   );
 

package/Source/Scene/PostProcessStage.js

@@ -94,9 +94,16 @@ import PostProcessStageSampleMode from "./PostProcessStageSampleMode.js";
 function PostProcessStage(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
   const {
+    name = createGuid(),
     fragmentShader,
+    uniforms,
     textureScale = 1.0,
+    forcePowerOfTwo = false,
+    sampleMode = PostProcessStageSampleMode.NEAREST,
     pixelFormat = PixelFormat.RGBA,
+    pixelDatatype = PixelDatatype.UNSIGNED_BYTE,
+    clearColor = Color.BLACK,
+    scissorRectangle,
   } = options;
 
   //>>includeStart('debug', pragmas.debug);
@@ -113,19 +120,13 @@ function PostProcessStage(options) {
   //>>includeEnd('debug');
 
   this._fragmentShader = fragmentShader;
-  this._uniforms = options.uniforms;
+  this._uniforms = uniforms;
   this._textureScale = textureScale;
-  this._forcePowerOfTwo = defaultValue(options.forcePowerOfTwo, false);
-  this._sampleMode = defaultValue(
-    options.sampleMode,
-    PostProcessStageSampleMode.NEAREST,
-  );
+  this._forcePowerOfTwo = forcePowerOfTwo;
+  this._sampleMode = sampleMode;
   this._pixelFormat = pixelFormat;
-  this._pixelDatatype = defaultValue(
-    options.pixelDatatype,
-    PixelDatatype.UNSIGNED_BYTE,
-  );
-  this._clearColor = defaultValue(options.clearColor, Color.BLACK);
+  this._pixelDatatype = pixelDatatype;
+  this._clearColor = clearColor;
 
   this._uniformMap = undefined;
   this._command = undefined;
@@ -143,18 +144,14 @@ function PostProcessStage(options) {
   const passState = new PassState();
   passState.scissorTest = {
     enabled: true,
-    rectangle: defined(options.scissorRectangle)
-      ? BoundingRectangle.clone(options.scissorRectangle)
+    rectangle: defined(scissorRectangle)
+      ? BoundingRectangle.clone(scissorRectangle)
       : new BoundingRectangle(),
   };
   this._passState = passState;
 
   this._ready = false;
 
-  let name = options.name;
-  if (!defined(name)) {
-    name = createGuid();
-  }
   this._name = name;
 
   this._logDepthChanged = undefined;

package/Source/Scene/PostProcessStageCollection.js

@@ -155,32 +155,20 @@ Object.defineProperties(PostProcessStageCollection.prototype, {
    * surface receives light and regardless of the light's position.
    * </p>
    * <p>
-   * The uniforms have the following properties: <code>intensity</code>, <code>bias</code>, <code>lengthCap</code>,
-   * <code>stepSize</code>, <code>frustumLength</code>, <code>ambientOcclusionOnly</code>,
-   * <code>delta</code>, <code>sigma</code>, and <code>blurStepSize</code>.
-   * </p>
+   * The uniforms have the following properties:
    * <ul>
    * <li><code>intensity</code> is a scalar value used to lighten or darken the shadows exponentially. Higher values make the shadows darker. The default value is <code>3.0</code>.</li>
-   *
    * <li><code>bias</code> is a scalar value representing an angle in radians. If the dot product between the normal of the sample and the vector to the camera is less than this value,
    * sampling stops in the current direction. This is used to remove shadows from near planar edges. The default value is <code>0.1</code>.</li>
-   *
    * <li><code>lengthCap</code> is a scalar value representing a length in meters. If the distance from the current sample to first sample is greater than this value,
    * sampling stops in the current direction. The default value is <code>0.26</code>.</li>
-   *
-   * <li><code>stepSize</code> is a scalar value indicating the distance to the next texel sample in the current direction. The default value is <code>1.95</code>.</li>
-   *
-   * <li><code>frustumLength</code> is a scalar value in meters. If the current fragment has a distance from the camera greater than this value, ambient occlusion is not computed for the fragment.
-   * The default value is <code>1000.0</code>.</li>
-   *
+   * <li><code>directionCount</code> is the number of directions along which the ray marching will search for occluders. The default value is <code>8</code>.</li>
+   * <li><code>stepCount</code> is the number of steps the ray marching will take along each direction. The default value is <code>32</code>.</li>
+   * <li><code>randomTexture</code> is a texture where the red channel is a random value in [0.0, 1.0]. The default value is <code>undefined</code>. This texture needs to be set.</li>
    * <li><code>ambientOcclusionOnly</code> is a boolean value. When <code>true</code>, only the shadows generated are written to the output. When <code>false</code>, the input texture is modulated
    * with the ambient occlusion. This is a useful debug option for seeing the effects of changing the uniform values. The default value is <code>false</code>.</li>
    * </ul>
    * <p>
-   * <code>delta</code>, <code>sigma</code>, and <code>blurStepSize</code> are the same properties as {@link PostProcessStageLibrary#createBlurStage}.
-   * The blur is applied to the shadows generated from the image to make them smoother.
-   * </p>
-   * <p>
    * When enabled, this stage will execute before all others.
    * </p>
    *

package/Source/Scene/PostProcessStageLibrary.js

@@ -476,27 +476,19 @@ PostProcessStageLibrary.createBloomStage = function () {
  * surface receives light and regardless of the light's position.
  * </p>
  * <p>
- * The uniforms have the following properties: <code>intensity</code>, <code>bias</code>, <code>lengthCap</code>,
- * <code>stepSize</code>, <code>frustumLength</code>, <code>randomTexture</code>, <code>ambientOcclusionOnly</code>,
- * <code>delta</code>, <code>sigma</code>, and <code>blurStepSize</code>.
- * </p>
+ * The uniforms have the following properties:
  * <ul>
  * <li><code>intensity</code> is a scalar value used to lighten or darken the shadows exponentially. Higher values make the shadows darker. The default value is <code>3.0</code>.</li>
  * <li><code>bias</code> is a scalar value representing an angle in radians. If the dot product between the normal of the sample and the vector to the camera is less than this value,
  * sampling stops in the current direction. This is used to remove shadows from near planar edges. The default value is <code>0.1</code>.</li>
  * <li><code>lengthCap</code> is a scalar value representing a length in meters. If the distance from the current sample to first sample is greater than this value,
  * sampling stops in the current direction. The default value is <code>0.26</code>.</li>
- * <li><code>stepSize</code> is a scalar value indicating the distance to the next texel sample in the current direction. The default value is <code>1.95</code>.</li>
- * <li><code>frustumLength</code> is a scalar value in meters. If the current fragment has a distance from the camera greater than this value, ambient occlusion is not computed for the fragment.
- * The default value is <code>1000.0</code>.</li>
+ * <li><code>directionCount</code> is the number of directions along which the ray marching will search for occluders. The default value is <code>8</code>.</li>
+ * <li><code>stepCount</code> is the number of steps the ray marching will take along each direction. The default value is <code>32</code>.</li>
  * <li><code>randomTexture</code> is a texture where the red channel is a random value in [0.0, 1.0]. The default value is <code>undefined</code>. This texture needs to be set.</li>
  * <li><code>ambientOcclusionOnly</code> is a boolean value. When <code>true</code>, only the shadows generated are written to the output. When <code>false</code>, the input texture is modulated
  * with the ambient occlusion. This is a useful debug option for seeing the effects of changing the uniform values. The default value is <code>false</code>.</li>
  * </ul>
- * <p>
- * <code>delta</code>, <code>sigma</code>, and <code>blurStepSize</code> are the same properties as {@link PostProcessStageLibrary#createBlurStage}.
- * The blur is applied to the shadows generated from the image to make them smoother.
- * </p>
  * @return {PostProcessStageComposite} A post-process stage that applies an ambient occlusion effect.
  *
  * @private
@@ -509,24 +501,18 @@ PostProcessStageLibrary.createAmbientOcclusionStage = function () {
       intensity: 3.0,
       bias: 0.1,
       lengthCap: 0.26,
-      stepSize: 1.95,
-      frustumLength: 1000.0,
+      directionCount: 8,
+      stepCount: 32,
       randomTexture: undefined,
     },
   });
-  const blur = createBlur("czm_ambient_occlusion_blur");
-  blur.uniforms.stepSize = 0.86;
-  const generateAndBlur = new PostProcessStageComposite({
-    name: "czm_ambient_occlusion_generate_blur",
-    stages: [generate, blur],
-  });
 
   const ambientOcclusionModulate = new PostProcessStage({
     name: "czm_ambient_occlusion_composite",
     fragmentShader: AmbientOcclusionModulate,
     uniforms: {
       ambientOcclusionOnly: false,
-      ambientOcclusionTexture: generateAndBlur.name,
+      ambientOcclusionTexture: generate.name,
     },
   });
 
@@ -556,20 +542,20 @@ PostProcessStageLibrary.createAmbientOcclusionStage = function () {
         generate.uniforms.lengthCap = value;
       },
     },
-    stepSize: {
+    directionCount: {
       get: function () {
-        return generate.uniforms.stepSize;
+        return generate.uniforms.directionCount;
       },
       set: function (value) {
-        generate.uniforms.stepSize = value;
+        generate.uniforms.directionCount = value;
       },
     },
-    frustumLength: {
+    stepCount: {
       get: function () {
-        return generate.uniforms.frustumLength;
+        return generate.uniforms.stepCount;
       },
       set: function (value) {
-        generate.uniforms.frustumLength = value;
+        generate.uniforms.stepCount = value;
       },
     },
     randomTexture: {
@@ -580,30 +566,6 @@ PostProcessStageLibrary.createAmbientOcclusionStage = function () {
         generate.uniforms.randomTexture = value;
       },
     },
-    delta: {
-      get: function () {
-        return blur.uniforms.delta;
-      },
-      set: function (value) {
-        blur.uniforms.delta = value;
-      },
-    },
-    sigma: {
-      get: function () {
-        return blur.uniforms.sigma;
-      },
-      set: function (value) {
-        blur.uniforms.sigma = value;
-      },
-    },
-    blurStepSize: {
-      get: function () {
-        return blur.uniforms.stepSize;
-      },
-      set: function (value) {
-        blur.uniforms.stepSize = value;
-      },
-    },
     ambientOcclusionOnly: {
       get: function () {
         return ambientOcclusionModulate.uniforms.ambientOcclusionOnly;
@@ -616,7 +578,7 @@ PostProcessStageLibrary.createAmbientOcclusionStage = function () {
 
   return new PostProcessStageComposite({
     name: "czm_ambient_occlusion",
-    stages: [generateAndBlur, ambientOcclusionModulate],
+    stages: [generate, ambientOcclusionModulate],
     inputPreviousStageTexture: false,
     uniforms: uniforms,
   });

package/Source/Scene/PropertyAttributeProperty.js

@@ -80,7 +80,7 @@ Object.defineProperties(PropertyAttributeProperty.prototype, {
    * True if offset/scale should be applied. If both offset/scale were
    * undefined, they default to identity so this property is set false
    *
-   * @memberof MetadataClassProperty.prototype
+   * @memberof PropertyAttributeProperty.prototype
    * @type {boolean}
    * @readonly
    * @private
@@ -94,7 +94,13 @@ Object.defineProperties(PropertyAttributeProperty.prototype, {
   /**
    * The offset to be added to property values as part of the value transform.
    *
-   * @memberof MetadataClassProperty.prototype
+   * This is always defined, even when `hasValueTransform` is `false`. If
+   * the property JSON itself did not define it, then it will inherit the
+   * value from the `MetadataClassProperty`. There, it also is always
+   * defined, and initialized to the default value if it was not contained
+   * in the class property JSON.
+   *
+   * @memberof PropertyAttributeProperty.prototype
    * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4}
    * @readonly
    * @private
@@ -108,7 +114,13 @@ Object.defineProperties(PropertyAttributeProperty.prototype, {
   /**
    * The scale to be multiplied to property values as part of the value transform.
    *
-   * @memberof MetadataClassProperty.prototype
+   * This is always defined, even when `hasValueTransform` is `false`. If
+   * the property JSON itself did not define it, then it will inherit the
+   * value from the `MetadataClassProperty`. There, it also is always
+   * defined, and initialized to the default value if it was not contained
+   * in the class property JSON.
+   *
+   * @memberof PropertyAttributeProperty.prototype
    * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4}
    * @readonly
    * @private

package/Source/Scene/PropertyTextureProperty.js

@@ -111,6 +111,12 @@ Object.defineProperties(PropertyTextureProperty.prototype, {
   /**
    * The offset to be added to property values as part of the value transform.
    *
+   * This is always defined, even when `hasValueTransform` is `false`. If
+   * the property JSON itself did not define it, then it will inherit the
+   * value from the `MetadataClassProperty`. There, it also is always
+   * defined, and initialized to the default value if it was not contained
+   * in the class property JSON.
+   *
    * @memberof PropertyTextureProperty.prototype
    * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4}
    * @readonly
@@ -125,6 +131,12 @@ Object.defineProperties(PropertyTextureProperty.prototype, {
   /**
    * The scale to be multiplied to property values as part of the value transform.
    *
+   * This is always defined, even when `hasValueTransform` is `false`. If
+   * the property JSON itself did not define it, then it will inherit the
+   * value from the `MetadataClassProperty`. There, it also is always
+   * defined, and initialized to the default value if it was not contained
+   * in the class property JSON.
+   *
    * @memberof PropertyTextureProperty.prototype
    * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4}
    * @readonly

package/Source/Scene/Scene.js

@@ -79,6 +79,7 @@ import VoxelCell from "./VoxelCell.js";
 import VoxelPrimitive from "./VoxelPrimitive.js";
 import getMetadataClassProperty from "./getMetadataClassProperty.js";
 import PickedMetadataInfo from "./PickedMetadataInfo.js";
+import getMetadataProperty from "./getMetadataProperty.js";
 
 const requestRenderAfterFrame = function (scene) {
   return function () {
@@ -4402,7 +4403,8 @@ Scene.prototype.pickVoxel = function (windowPosition, width, height) {
  * values from
  * @param {string} propertyName The name of the metadata property to pick
  * values from
- * @returns The metadata value
+ * @returns {MetadataValue|undefined} The metadata value, or `undefined` when
+ * no matching metadata was found at the given position
  *
  * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
  */
@@ -4426,7 +4428,11 @@ Scene.prototype.pickMetadata = function (
   // Check if the picked object is a model that has structural
   // metadata, with a schema that contains the specified
   // property.
-  const schema = pickedObject.detail?.model?.structuralMetadata?.schema;
+  const structuralMetadata = pickedObject.detail?.model?.structuralMetadata;
+  if (!defined(structuralMetadata)) {
+    return undefined;
+  }
+  const schema = structuralMetadata.schema;
   const classProperty = getMetadataClassProperty(
     schema,
     schemaId,
@@ -4436,12 +4442,21 @@ Scene.prototype.pickMetadata = function (
   if (!defined(classProperty)) {
     return undefined;
   }
+  const metadataProperty = getMetadataProperty(
+    structuralMetadata,
+    className,
+    propertyName,
+  );
+  if (!defined(metadataProperty)) {
+    return undefined;
+  }
 
   const pickedMetadataInfo = new PickedMetadataInfo(
     schemaId,
     className,
     propertyName,
     classProperty,
+    metadataProperty,
   );
 
   const pickedMetadataValues = this._picking.pickMetadata(

package/Source/Scene/SkyBox.js

@@ -81,6 +81,8 @@ function SkyBox(options) {
 
   this._attributeLocations = undefined;
   this._useHdr = undefined;
+  this._hasError = false;
+  this._error = undefined;
 }
 
 /**
@@ -111,6 +113,15 @@ SkyBox.prototype.update = function (frameState, useHdr) {
     return undefined;
   }
 
+  // Throw any errors that had previously occurred asynchronously so they aren't
+  // ignored when running.  See https://github.com/CesiumGS/cesium/pull/12307
+  if (this._hasError) {
+    const error = this._error;
+    this._hasError = false;
+    this._error = undefined;
+    throw error;
+  }
+
   if (this._sources !== this.sources) {
     this._sources = this.sources;
     const sources = this.sources;
@@ -141,10 +152,18 @@ SkyBox.prototype.update = function (frameState, useHdr) {
 
     if (typeof sources.positiveX === "string") {
       // Given urls for cube-map images.  Load them.
-      loadCubeMap(context, this._sources).then(function (cubeMap) {
-        that._cubeMap = that._cubeMap && that._cubeMap.destroy();
-        that._cubeMap = cubeMap;
-      });
+      loadCubeMap(context, this._sources)
+        .then(function (cubeMap) {
+          that._cubeMap = that._cubeMap && that._cubeMap.destroy();
+          that._cubeMap = cubeMap;
+        })
+        .catch((error) => {
+          // Defer throwing the error until the next call to update to prevent
+          // test from failing in `afterAll` if this is rejected after the test
+          // using the Skybox ends.  See https://github.com/CesiumGS/cesium/pull/12307
+          this._hasError = true;
+          this._error = error;
+        });
     } else {
       this._cubeMap = this._cubeMap && this._cubeMap.destroy();
       this._cubeMap = new CubeMap({

package/Source/Scene/UrlTemplateImageryProvider.js

@@ -159,13 +159,13 @@ const pickFeaturesTags = combine(tags, {
  * });
  * // Access a Web Map Service (WMS) server.
  * const wms = new Cesium.UrlTemplateImageryProvider({
- *    url : 'https://programs.communications.gov.au/geoserver/ows?tiled=true&' +
- *          'transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
- *          'styles=&service=WMS&version=1.1.1&request=GetMap&' +
- *          'layers=public%3AMyBroadband_Availability&srs=EPSG%3A3857&' +
+ *    url : 'https://services.ga.gov.au/gis/services/NM_Hydrology_and_Marine_Points/MapServer/WMSServer?' +
+ *          'tiled=true&transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
+ *          'styles=&service=WMS&version=1.3.0&request=GetMap&' +
+ *          'layers=Bores&crs=EPSG%3A3857&' +
  *          'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&' +
  *          'width=256&height=256',
- *    rectangle : Cesium.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
+ *    rectangle : Cesium.Rectangle.fromDegrees(95.0, -55.0, 170.0, -1.0)  // From GetCapabilities EX_GeographicBoundingBox
  * });
  * // Using custom tags in your template url.
  * const custom = new Cesium.UrlTemplateImageryProvider({