@cesium/engine 1.1.0 → 2.1.0

package/Source/Scene/DiscardMissingTileImagePolicy.js

@@ -11,11 +11,11 @@ import Resource from "../Core/Resource.js";
  * @alias DiscardMissingTileImagePolicy
  * @constructor
  *
- * @param {Object} options Object with the following properties:
- * @param {Resource|String} options.missingImageUrl The URL of the known missing image.
+ * @param {object} options Object with the following properties:
+ * @param {Resource|string} options.missingImageUrl The URL of the known missing image.
  * @param {Cartesian2[]} options.pixelsToCheck An array of {@link Cartesian2} pixel positions to
  *        compare against the missing image.
- * @param {Boolean} [options.disableCheckIfAllPixelsAreTransparent=false] If true, the discard check will be disabled
+ * @param {boolean} [options.disableCheckIfAllPixelsAreTransparent=false] If true, the discard check will be disabled
  *                  if all of the pixelsToCheck in the missingImageUrl have an alpha value of 0.  If false, the
  *                  discard check will proceed no matter the values of the pixelsToCheck.
  */
@@ -95,7 +95,7 @@ function DiscardMissingTileImagePolicy(options) {
 
 /**
  * Determines if the discard policy is ready to process images.
- * @returns {Boolean} True if the discard policy is ready to process images; otherwise, false.
+ * @returns {boolean} True if the discard policy is ready to process images; otherwise, false.
  */
 DiscardMissingTileImagePolicy.prototype.isReady = function () {
   return this._isReady;
@@ -105,7 +105,7 @@ DiscardMissingTileImagePolicy.prototype.isReady = function () {
  * Given a tile image, decide whether to discard that image.
  *
  * @param {HTMLImageElement} image An image to test.
- * @returns {Boolean} True if the image should be discarded; otherwise, false.
+ * @returns {boolean} True if the image should be discarded; otherwise, false.
  *
  * @exception {DeveloperError} <code>shouldDiscardImage</code> must not be called before the discard policy is ready.
  */

package/Source/Scene/DracoLoader.js

@@ -54,11 +54,11 @@ DracoLoader.decodePointCloud = function (parameters) {
 /**
  * Decodes a buffer view. Returns undefined if the task cannot be scheduled.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Uint8Array} options.array The typed array containing the buffer view data.
- * @param {Object} options.bufferView The glTF buffer view object.
- * @param {Object.<String, Number>} options.compressedAttributes The compressed attributes.
- * @param {Boolean} options.dequantizeInShader Whether POSITION and NORMAL attributes should be dequantized on the GPU.
+ * @param {object} options.bufferView The glTF buffer view object.
+ * @param {Object<string, number>} options.compressedAttributes The compressed attributes.
+ * @param {boolean} options.dequantizeInShader Whether POSITION and NORMAL attributes should be dequantized on the GPU.
  *
  * @returns {Promise} A promise that resolves to the decoded indices and attributes.
  * @private

package/Source/Scene/EllipsoidPrimitive.js

@@ -35,14 +35,14 @@ const attributeLocations = {
  * @alias EllipsoidPrimitive
  * @constructor
  *
- * @param {Object} [options] Object with the following properties:
+ * @param {object} [options] Object with the following properties:
  * @param {Cartesian3} [options.center=Cartesian3.ZERO] The center of the ellipsoid in the ellipsoid's model coordinates.
  * @param {Cartesian3} [options.radii] The radius of the ellipsoid along the <code>x</code>, <code>y</code>, and <code>z</code> axes in the ellipsoid's model coordinates.
  * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms the ellipsoid from model to world coordinates.
- * @param {Boolean} [options.show=true] Determines if this primitive will be shown.
+ * @param {boolean} [options.show=true] Determines if this primitive will be shown.
  * @param {Material} [options.material=Material.ColorType] The surface appearance of the primitive.
- * @param {Object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick}
- * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown.
+ * @param {object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick}
+ * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown.
  *
  * @private
  */
@@ -108,7 +108,7 @@ function EllipsoidPrimitive(options) {
   /**
    * Determines if the ellipsoid primitive will be shown.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   this.show = defaultValue(options.show, true);
@@ -143,7 +143,7 @@ function EllipsoidPrimitive(options) {
   /**
    * User-defined object returned when the ellipsoid is picked.
    *
-   * @type Object
+   * @type {object}
    *
    * @default undefined
    *
@@ -158,7 +158,7 @@ function EllipsoidPrimitive(options) {
    * Draws the bounding sphere for each draw command in the primitive.
    * </p>
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @default false
    */
@@ -238,11 +238,6 @@ function getVertexArray(context) {
   return vertexArray;
 }
 
-const logDepthExtension =
-  "#ifdef GL_EXT_frag_depth \n" +
-  "#extension GL_EXT_frag_depth : enable \n" +
-  "#endif \n\n";
-
 /**
  * Called when {@link Viewer} or {@link CesiumWidget} render the scene to
  * get the draw commands needed to render this primitive.
@@ -378,7 +373,6 @@ EllipsoidPrimitive.prototype.update = function (frameState) {
     if (this._useLogDepth) {
       vs.defines.push("LOG_DEPTH");
       fs.defines.push("LOG_DEPTH");
-      fs.sources.push(logDepthExtension);
     }
 
     this._sp = ShaderProgram.replaceCache({
@@ -443,7 +437,6 @@ EllipsoidPrimitive.prototype.update = function (frameState) {
       if (this._useLogDepth) {
         vs.defines.push("LOG_DEPTH");
         fs.defines.push("LOG_DEPTH");
-        fs.sources.push(logDepthExtension);
       }
 
       this._pickSP = ShaderProgram.replaceCache({
@@ -478,7 +471,7 @@ EllipsoidPrimitive.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 EllipsoidPrimitive#destroy
  */

package/Source/Scene/EllipsoidSurfaceAppearance.js

@@ -16,15 +16,15 @@ import Material from "./Material.js";
  * @alias EllipsoidSurfaceAppearance
  * @constructor
  *
- * @param {Object} [options] Object with the following properties:
- * @param {Boolean} [options.flat=false] When <code>true</code>, flat shading is used in the fragment shader, which means lighting is not taking into account.
- * @param {Boolean} [options.faceForward=options.aboveGround] When <code>true</code>, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots.  This is useful when both sides of a geometry should be shaded like {@link WallGeometry}.
- * @param {Boolean} [options.translucent=true] When <code>true</code>, the geometry is expected to appear translucent so {@link EllipsoidSurfaceAppearance#renderState} has alpha blending enabled.
- * @param {Boolean} [options.aboveGround=false] When <code>true</code>, the geometry is expected to be on the ellipsoid's surface - not at a constant height above it - so {@link EllipsoidSurfaceAppearance#renderState} has backface culling enabled.
+ * @param {object} [options] Object with the following properties:
+ * @param {boolean} [options.flat=false] When <code>true</code>, flat shading is used in the fragment shader, which means lighting is not taking into account.
+ * @param {boolean} [options.faceForward=options.aboveGround] When <code>true</code>, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots.  This is useful when both sides of a geometry should be shaded like {@link WallGeometry}.
+ * @param {boolean} [options.translucent=true] When <code>true</code>, the geometry is expected to appear translucent so {@link EllipsoidSurfaceAppearance#renderState} has alpha blending enabled.
+ * @param {boolean} [options.aboveGround=false] When <code>true</code>, the geometry is expected to be on the ellipsoid's surface - not at a constant height above it - so {@link EllipsoidSurfaceAppearance#renderState} has backface culling enabled.
  * @param {Material} [options.material=Material.ColorType] The material used to determine the fragment color.
- * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader.
- * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader.
- * @param {Object} [options.renderState] Optional render state to override the default render state.
+ * @param {string} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader.
+ * @param {string} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader.
+ * @param {object} [options.renderState] Optional render state to override the default render state.
  *
  * @see {@link https://github.com/CesiumGS/cesium/wiki/Fabric|Fabric}
  *
@@ -64,7 +64,7 @@ function EllipsoidSurfaceAppearance(options) {
   /**
    * When <code>true</code>, the geometry is expected to appear translucent.
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @default true
    */
@@ -98,7 +98,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, {
    *
    * @memberof EllipsoidSurfaceAppearance.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   vertexShaderSource: {
@@ -115,7 +115,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, {
    *
    * @memberof EllipsoidSurfaceAppearance.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   fragmentShaderSource: {
@@ -134,7 +134,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, {
    *
    * @memberof EllipsoidSurfaceAppearance.prototype
    *
-   * @type {Object}
+   * @type {object}
    * @readonly
    */
   renderState: {
@@ -150,7 +150,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, {
    *
    * @memberof EllipsoidSurfaceAppearance.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default false
@@ -185,7 +185,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, {
    *
    * @memberof EllipsoidSurfaceAppearance.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default false
@@ -204,7 +204,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, {
    *
    * @memberof EllipsoidSurfaceAppearance.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default true
@@ -223,7 +223,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, {
    *
    * @memberof EllipsoidSurfaceAppearance.prototype
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @default false
@@ -253,7 +253,7 @@ EllipsoidSurfaceAppearance.VERTEX_FORMAT = VertexFormat.POSITION_AND_ST;
  *
  * @function
  *
- * @returns {String} The full GLSL fragment shader source.
+ * @returns {string} The full GLSL fragment shader source.
  */
 EllipsoidSurfaceAppearance.prototype.getFragmentShaderSource =
   Appearance.prototype.getFragmentShaderSource;
@@ -263,7 +263,7 @@ EllipsoidSurfaceAppearance.prototype.getFragmentShaderSource =
  *
  * @function
  *
- * @returns {Boolean} <code>true</code> if the appearance is translucent.
+ * @returns {boolean} <code>true</code> if the appearance is translucent.
  */
 EllipsoidSurfaceAppearance.prototype.isTranslucent =
   Appearance.prototype.isTranslucent;
@@ -275,7 +275,7 @@ EllipsoidSurfaceAppearance.prototype.isTranslucent =
  *
  * @function
  *
- * @returns {Object} The render state.
+ * @returns {object} The render state.
  */
 EllipsoidSurfaceAppearance.prototype.getRenderState =
   Appearance.prototype.getRenderState;

package/Source/Scene/Expression.js

@@ -23,8 +23,8 @@ import ExpressionNodeType from "./ExpressionNodeType.js";
  * @alias Expression
  * @constructor
  *
- * @param {String} [expression] The expression defined using the 3D Tiles Styling language.
- * @param {Object} [defines] Defines in the style.
+ * @param {string} [expression] The expression defined using the 3D Tiles Styling language.
+ * @param {object} [defines] Defines in the style.
  *
  * @example
  * const expression = new Cesium.Expression('(regExp("^Chest").test(${County})) && (${YearBuilt} >= 1970)');
@@ -63,7 +63,7 @@ Object.defineProperties(Expression.prototype, {
    *
    * @memberof Expression.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    *
    * @default undefined
@@ -131,8 +131,8 @@ const scratchStorage = {
  * a {@link Color}, the {@link Cartesian4} value is converted to a {@link Color} and then returned.
  *
  * @param {Cesium3DTileFeature} feature The feature whose properties may be used as variables in the expression.
- * @param {Object} [result] The object onto which to store the result.
- * @returns {Boolean|Number|String|RegExp|Cartesian2|Cartesian3|Cartesian4|Color} The result of evaluating the expression.
+ * @param {object} [result] The object onto which to store the result.
+ * @returns {boolean|number|string|RegExp|Cartesian2|Cartesian3|Cartesian4|Color} The result of evaluating the expression.
  */
 Expression.prototype.evaluate = function (feature, result) {
   scratchStorage.reset();
@@ -170,12 +170,12 @@ Expression.prototype.evaluateColor = function (feature, result) {
  * Gets the shader function for this expression.
  * Returns undefined if the shader function can't be generated from this expression.
  *
- * @param {String} functionSignature Signature of the generated function.
- * @param {Object} variableSubstitutionMap Maps variable names to shader variable names.
- * @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent.
- * @param {String} returnType The return type of the generated function.
+ * @param {string} functionSignature Signature of the generated function.
+ * @param {object} variableSubstitutionMap Maps variable names to shader variable names.
+ * @param {object} shaderState Stores information about the generated shader function, including whether it is translucent.
+ * @param {string} returnType The return type of the generated function.
  *
- * @returns {String} The shader function.
+ * @returns {string} The shader function.
  *
  * @private
  */
@@ -203,10 +203,10 @@ Expression.prototype.getShaderFunction = function (
  * Gets the shader expression for this expression.
  * Returns undefined if the shader expression can't be generated from this expression.
  *
- * @param {Object} variableSubstitutionMap Maps variable names to shader variable names.
- * @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent.
+ * @param {object} variableSubstitutionMap Maps variable names to shader variable names.
+ * @param {object} shaderState Stores information about the generated shader function, including whether it is translucent.
  *
- * @returns {String} The shader expression.
+ * @returns {string} The shader expression.
  *
  * @private
  */
@@ -223,7 +223,7 @@ Expression.prototype.getShaderExpression = function (
 /**
  * Gets the variables used by the expression.
  *
- * @returns {String[]} The variables used by the expression.
+ * @returns {string[]} The variables used by the expression.
  *
  * @private
  */

package/Source/Scene/Fog.js

@@ -13,14 +13,14 @@ import SceneMode from "./SceneMode.js";
 function Fog() {
   /**
    * <code>true</code> if fog is enabled, <code>false</code> otherwise.
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   this.enabled = true;
   /**
    * <code>true</code> if fog is renderable in shaders, <code>false</code> otherwise.
    * This allows to benefits from optimized tile loading strategy based on fog density without the actual visual rendering.
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   this.renderable = true;
@@ -30,7 +30,7 @@ function Fog() {
    * The more dense the fog is, the more aggressively the terrain is culled. For example, if the camera is a height of
    * 1000.0m above the ellipsoid, increasing the value to 3.0e-3 will cause many tiles close to the viewer be culled.
    * Decreasing the value will push the fog further from the viewer, but decrease performance as more of the terrain is rendered.
-   * @type {Number}
+   * @type {number}
    * @default 2.0e-4
    */
   this.density = 2.0e-4;
@@ -39,14 +39,14 @@ function Fog() {
    * the number of terrain tiles requested for rendering. If set to zero, the feature will be disabled. If the value is increased
    * for mountainous regions, less tiles will need to be requested, but the terrain meshes near the horizon may be a noticeably
    * lower resolution. If the value is increased in a relatively flat area, there will be little noticeable change on the horizon.
-   * @type {Number}
+   * @type {number}
    * @default 2.0
    */
   this.screenSpaceErrorFactor = 2.0;
   /**
    * The minimum brightness of the fog color from lighting. A value of 0.0 can cause the fog to be completely black. A value of 1.0 will not affect
    * the brightness at all.
-   * @type {Number}
+   * @type {number}
    * @default 0.03
    */
   this.minimumBrightness = 0.03;

package/Source/Scene/FrameRateMonitor.js

@@ -15,17 +15,17 @@ import TimeConstants from "../Core/TimeConstants.js";
  * @alias FrameRateMonitor
  * @constructor
  *
- * @param {Object} [options] Object with the following properties:
+ * @param {object} [options] Object with the following properties:
  * @param {Scene} options.scene The Scene instance for which to monitor performance.
- * @param {Number} [options.samplingWindow=5.0] The length of the sliding window over which to compute the average frame rate, in seconds.
- * @param {Number} [options.quietPeriod=2.0] The length of time to wait at startup and each time the page becomes visible (i.e. when the user
+ * @param {number} [options.samplingWindow=5.0] The length of the sliding window over which to compute the average frame rate, in seconds.
+ * @param {number} [options.quietPeriod=2.0] The length of time to wait at startup and each time the page becomes visible (i.e. when the user
  *        switches back to the tab) before starting to measure performance, in seconds.
- * @param {Number} [options.warmupPeriod=5.0] The length of the warmup period, in seconds.  During the warmup period, a separate
+ * @param {number} [options.warmupPeriod=5.0] The length of the warmup period, in seconds.  During the warmup period, a separate
  *        (usually lower) frame rate is required.
- * @param {Number} [options.minimumFrameRateDuringWarmup=4] The minimum frames-per-second that are required for acceptable performance during
+ * @param {number} [options.minimumFrameRateDuringWarmup=4] The minimum frames-per-second that are required for acceptable performance during
  *        the warmup period.  If the frame rate averages less than this during any samplingWindow during the warmupPeriod, the
  *        lowFrameRate event will be raised and the page will redirect to the redirectOnLowFrameRateUrl, if any.
- * @param {Number} [options.minimumFrameRateAfterWarmup=8] The minimum frames-per-second that are required for acceptable performance after
+ * @param {number} [options.minimumFrameRateAfterWarmup=8] The minimum frames-per-second that are required for acceptable performance after
  *        the end of the warmup period.  If the frame rate averages less than this during any samplingWindow after the warmupPeriod, the
  *        lowFrameRate event will be raised and the page will redirect to the redirectOnLowFrameRateUrl, if any.
  */
@@ -40,7 +40,7 @@ function FrameRateMonitor(options) {
 
   /**
    * Gets or sets the length of the sliding window over which to compute the average frame rate, in seconds.
-   * @type {Number}
+   * @type {number}
    */
   this.samplingWindow = defaultValue(
     options.samplingWindow,
@@ -50,7 +50,7 @@ function FrameRateMonitor(options) {
   /**
    * Gets or sets the length of time to wait at startup and each time the page becomes visible (i.e. when the user
    * switches back to the tab) before starting to measure performance, in seconds.
-   * @type {Number}
+   * @type {number}
    */
   this.quietPeriod = defaultValue(
     options.quietPeriod,
@@ -60,7 +60,7 @@ function FrameRateMonitor(options) {
   /**
    * Gets or sets the length of the warmup period, in seconds.  During the warmup period, a separate
    * (usually lower) frame rate is required.
-   * @type {Number}
+   * @type {number}
    */
   this.warmupPeriod = defaultValue(
     options.warmupPeriod,
@@ -71,7 +71,7 @@ function FrameRateMonitor(options) {
    * Gets or sets the minimum frames-per-second that are required for acceptable performance during
    * the warmup period.  If the frame rate averages less than this during any <code>samplingWindow</code> during the <code>warmupPeriod</code>, the
    * <code>lowFrameRate</code> event will be raised and the page will redirect to the <code>redirectOnLowFrameRateUrl</code>, if any.
-   * @type {Number}
+   * @type {number}
    */
   this.minimumFrameRateDuringWarmup = defaultValue(
     options.minimumFrameRateDuringWarmup,
@@ -82,7 +82,7 @@ function FrameRateMonitor(options) {
    * Gets or sets the minimum frames-per-second that are required for acceptable performance after
    * the end of the warmup period.  If the frame rate averages less than this during any <code>samplingWindow</code> after the <code>warmupPeriod</code>, the
    * <code>lowFrameRate</code> event will be raised and the page will redirect to the <code>redirectOnLowFrameRateUrl</code>, if any.
-   * @type {Number}
+   * @type {number}
    */
   this.minimumFrameRateAfterWarmup = defaultValue(
     options.minimumFrameRateAfterWarmup,
@@ -157,7 +157,7 @@ function FrameRateMonitor(options) {
  * {@link FrameRateMonitor} constructor.
  *
  * @memberof FrameRateMonitor
- * @type {Object}
+ * @type {object}
  */
 FrameRateMonitor.defaultSettings = {
   samplingWindow: 5.0,
@@ -235,7 +235,7 @@ Object.defineProperties(FrameRateMonitor.prototype, {
    * Gets the most recently computed average frames-per-second over the last <code>samplingWindow</code>.
    * This property may be undefined if the frame rate has not been computed.
    * @memberof FrameRateMonitor.prototype
-   * @type {Number}
+   * @type {number}
    */
   lastFramesPerSecond: {
     get: function () {
@@ -279,7 +279,7 @@ FrameRateMonitor.prototype.unpause = function () {
  *
  * @memberof FrameRateMonitor
  *
- * @returns {Boolean} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  *
  * @see FrameRateMonitor#destroy
  */