@cesium/engine 1.1.0 → 2.1.0

package/Source/Scene/ImplicitTileset.js

@@ -17,7 +17,7 @@ import ImplicitSubdivisionScheme from "./ImplicitSubdivisionScheme.js";
  * @constructor
  *
  * @param {Resource} baseResource The base resource for the tileset
- * @param {Object} tileJson The JSON header of the tile with either implicit tiling (3D Tiles 1.1) or the 3DTILES_implicit_tiling extension.
+ * @param {object} tileJson The JSON header of the tile with either implicit tiling (3D Tiles 1.1) or the 3DTILES_implicit_tiling extension.
  * @param {MetadataSchema} [metadataSchema] The metadata schema containing the implicit tile metadata class.
  * @private
  * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
@@ -45,7 +45,7 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
   /**
    * The geometric error of the root tile
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    * @private
    */
@@ -76,7 +76,7 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
    * The JSON representation of a bounding volume. This is either a box or a
    * region.
    *
-   * @type {Object}
+   * @type {object}
    * @readonly
    * @private
    */
@@ -85,7 +85,7 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
   /**
    * The refine strategy as a string, either 'ADD' or 'REPLACE'
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -141,7 +141,7 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
    * The maximum number of contents as well as content availability bitstreams.
    * This is used for loop bounds when checking content availability.
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    * @private
    */
@@ -160,7 +160,7 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
    * <li><code>tile.extensions["3DTILES_multiple_contents"]</code>, if used instead of tile.contents or tile.content</li>
    * </ul>
    *
-   * @type {Object}
+   * @type {object}
    * @readonly
    * @private
    */
@@ -180,7 +180,7 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
    * The branching factor for this tileset. Either 4 for quadtrees or 8 for
    * octrees.
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    * @private
    */
@@ -192,7 +192,7 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
    * How many distinct levels within each subtree. For example, a quadtree
    * with subtreeLevels = 2 will have 5 nodes per quadtree (1 root + 4 children)
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    * @private
    */
@@ -201,7 +201,7 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
   /**
    * The number of levels containing available tiles in the tileset.
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    * @private
    */
@@ -217,7 +217,7 @@ function ImplicitTileset(baseResource, tileJson, metadataSchema) {
  * This handles both regular tiles and tiles with multiple contents, either
  * in the contents array (3D Tiles 1.1) or the `3DTILES_multiple_contents` extension
  *
- * @param {Object} tileJson The JSON header of the tile with either implicit tiling (3D Tiles 1.1) or the 3DTILES_implicit_tiling extension.
+ * @param {object} tileJson The JSON header of the tile with either implicit tiling (3D Tiles 1.1) or the 3DTILES_implicit_tiling extension.
  * @return {Object[]} An array of JSON headers for the contents of each tile
  * @private
  */

package/Source/Scene/InstanceAttributeSemantic.js

@@ -3,7 +3,7 @@ import Check from "../Core/Check.js";
 /**
  * An enum describing the built-in instance attribute semantics.
  *
- * @enum {String}
+ * @enum {string}
  *
  * @private
  */
@@ -11,7 +11,7 @@ const InstanceAttributeSemantic = {
   /**
    * Per-instance translation.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   TRANSLATION: "TRANSLATION",
@@ -19,7 +19,7 @@ const InstanceAttributeSemantic = {
   /**
    * Per-instance rotation.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   ROTATION: "ROTATION",
@@ -27,7 +27,7 @@ const InstanceAttributeSemantic = {
   /**
    * Per-instance scale.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   SCALE: "SCALE",
@@ -35,7 +35,7 @@ const InstanceAttributeSemantic = {
   /**
    * Per-instance feature ID.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   FEATURE_ID: "_FEATURE_ID",

package/Source/Scene/InvertClassification.js

@@ -126,19 +126,18 @@ const rsDefault = {
 };
 
 const translucentFS =
-  "#extension GL_EXT_frag_depth : enable\n" +
   "uniform sampler2D colorTexture;\n" +
   "uniform sampler2D depthTexture;\n" +
   "uniform sampler2D classifiedTexture;\n" +
-  "varying vec2 v_textureCoordinates;\n" +
+  "in vec2 v_textureCoordinates;\n" +
   "void main()\n" +
   "{\n" +
-  "    vec4 color = texture2D(colorTexture, v_textureCoordinates);\n" +
+  "    vec4 color = texture(colorTexture, v_textureCoordinates);\n" +
   "    if (color.a == 0.0)\n" +
   "    {\n" +
   "        discard;\n" +
   "    }\n" +
-  "    bool isClassified = all(equal(texture2D(classifiedTexture, v_textureCoordinates), vec4(0.0)));\n" +
+  "    bool isClassified = all(equal(texture(classifiedTexture, v_textureCoordinates), vec4(0.0)));\n" +
   "#ifdef UNCLASSIFIED\n" +
   "    vec4 highlightColor = czm_invertClassificationColor;\n" +
   "    if (isClassified)\n" +
@@ -152,24 +151,24 @@ const translucentFS =
   "        discard;\n" +
   "    }\n" +
   "#endif\n" +
-  "    gl_FragColor = color * highlightColor;\n" +
-  "    gl_FragDepthEXT = texture2D(depthTexture, v_textureCoordinates).r;\n" +
+  "    out_FragColor = color * highlightColor;\n" +
+  "    gl_FragDepth = texture(depthTexture, v_textureCoordinates).r;\n" +
   "}\n";
 
 const opaqueFS =
   "uniform sampler2D colorTexture;\n" +
-  "varying vec2 v_textureCoordinates;\n" +
+  "in vec2 v_textureCoordinates;\n" +
   "void main()\n" +
   "{\n" +
-  "    vec4 color = texture2D(colorTexture, v_textureCoordinates);\n" +
+  "    vec4 color = texture(colorTexture, v_textureCoordinates);\n" +
   "    if (color.a == 0.0)\n" +
   "    {\n" +
   "        discard;\n" +
   "    }\n" +
   "#ifdef UNCLASSIFIED\n" +
-  "    gl_FragColor = color * czm_invertClassificationColor;\n" +
+  "    out_FragColor = color * czm_invertClassificationColor;\n" +
   "#else\n" +
-  "    gl_FragColor = color;\n" +
+  "    out_FragColor = color;\n" +
   "#endif\n" +
   "}\n";
 

package/Source/Scene/IonImageryProvider.js

@@ -36,13 +36,13 @@ const ImageryProviderMapping = {
 };
 
 /**
- * @typedef {Object} IonImageryProvider.ConstructorOptions
+ * @typedef {object} IonImageryProvider.ConstructorOptions
  *
  * Initialization options for the TileMapServiceImageryProvider constructor
  *
- * @property {Number} assetId An ion imagery asset ID
- * @property {String} [accessToken=Ion.defaultAccessToken] The access token to use.
- * @property {String|Resource} [server=Ion.defaultServer] The resource to the Cesium ion API server.
+ * @property {number} assetId An ion imagery asset ID
+ * @property {string} [accessToken=Ion.defaultAccessToken] The access token to use.
+ * @property {string|Resource} [server=Ion.defaultServer] The resource to the Cesium ion API server.
  */
 
 /**
@@ -68,7 +68,7 @@ function IonImageryProvider(options) {
    * The default alpha blending value of this provider, with 0.0 representing fully transparent and
    * 1.0 representing fully opaque.
    *
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @default undefined
    */
   this.defaultAlpha = undefined;
@@ -77,7 +77,7 @@ function IonImageryProvider(options) {
    * The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and
    * 1.0 representing fully opaque.
    *
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @default undefined
    */
   this.defaultNightAlpha = undefined;
@@ -86,7 +86,7 @@ function IonImageryProvider(options) {
    * The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and
    * 1.0 representing fully opaque.
    *
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @default undefined
    */
   this.defaultDayAlpha = undefined;
@@ -95,7 +95,7 @@ function IonImageryProvider(options) {
    * The default brightness of this provider.  1.0 uses the unmodified imagery color.  Less than 1.0
    * makes the imagery darker while greater than 1.0 makes it brighter.
    *
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @default undefined
    */
   this.defaultBrightness = undefined;
@@ -104,7 +104,7 @@ function IonImageryProvider(options) {
    * The default contrast of this provider.  1.0 uses the unmodified imagery color.  Less than 1.0 reduces
    * the contrast while greater than 1.0 increases it.
    *
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @default undefined
    */
   this.defaultContrast = undefined;
@@ -112,7 +112,7 @@ function IonImageryProvider(options) {
   /**
    * The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
    *
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @default undefined
    */
   this.defaultHue = undefined;
@@ -121,7 +121,7 @@ function IonImageryProvider(options) {
    * The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
    * saturation while greater than 1.0 increases it.
    *
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @default undefined
    */
   this.defaultSaturation = undefined;
@@ -129,7 +129,7 @@ function IonImageryProvider(options) {
   /**
    * The default gamma correction to apply to this provider.  1.0 uses the unmodified imagery color.
    *
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @default undefined
    */
   this.defaultGamma = undefined;
@@ -222,7 +222,7 @@ Object.defineProperties(IonImageryProvider.prototype, {
   /**
    * Gets a value indicating whether or not the provider is ready for use.
    * @memberof IonImageryProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -234,7 +234,7 @@ Object.defineProperties(IonImageryProvider.prototype, {
   /**
    * Gets a promise that resolves to true when the provider is ready for use.
    * @memberof IonImageryProvider.prototype
-   * @type {Promise.<Boolean>}
+   * @type {Promise<boolean>}
    * @readonly
    */
   readyPromise: {
@@ -267,7 +267,7 @@ Object.defineProperties(IonImageryProvider.prototype, {
    * Gets the width of each tile, in pixels.  This function should
    * not be called before {@link IonImageryProvider#ready} returns true.
    * @memberof IonImageryProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   tileWidth: {
@@ -287,7 +287,7 @@ Object.defineProperties(IonImageryProvider.prototype, {
    * Gets the height of each tile, in pixels.  This function should
    * not be called before {@link IonImageryProvider#ready} returns true.
    * @memberof IonImageryProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   tileHeight: {
@@ -307,7 +307,7 @@ Object.defineProperties(IonImageryProvider.prototype, {
    * Gets the maximum level-of-detail that can be requested.  This function should
    * not be called before {@link IonImageryProvider#ready} returns true.
    * @memberof IonImageryProvider.prototype
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @readonly
    */
   maximumLevel: {
@@ -331,7 +331,7 @@ Object.defineProperties(IonImageryProvider.prototype, {
    * provider with more than a few tiles at the minimum level will lead to
    * rendering problems.
    * @memberof IonImageryProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   minimumLevel: {
@@ -431,7 +431,7 @@ Object.defineProperties(IonImageryProvider.prototype, {
    * as if their alpha is 1.0 everywhere.  When this property is false, memory usage
    * and texture upload time are reduced.
    * @memberof IonImageryProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   hasAlphaChannel: {
@@ -465,9 +465,9 @@ Object.defineProperties(IonImageryProvider.prototype, {
  * Gets the credits to be displayed when a given tile is displayed.
  * @function
  *
- * @param {Number} x The tile X coordinate.
- * @param {Number} y The tile Y coordinate.
- * @param {Number} level The tile level;
+ * @param {number} x The tile X coordinate.
+ * @param {number} y The tile Y coordinate.
+ * @param {number} level The tile level;
  * @returns {Credit[]} The credits to be displayed when the tile is displayed.
  *
  * @exception {DeveloperError} <code>getTileCredits</code> must not be called before the imagery provider is ready.
@@ -494,11 +494,11 @@ IonImageryProvider.prototype.getTileCredits = function (x, y, level) {
  * not be called before {@link IonImageryProvider#ready} returns true.
  * @function
  *
- * @param {Number} x The tile X coordinate.
- * @param {Number} y The tile Y coordinate.
- * @param {Number} level The tile level.
+ * @param {number} x The tile X coordinate.
+ * @param {number} y The tile Y coordinate.
+ * @param {number} level The tile level.
  * @param {Request} [request] The request object. Intended for internal use only.
- * @returns {Promise.<ImageryTypes>|undefined} A promise for the image that will resolve when the image is available, or
+ * @returns {Promise<ImageryTypes>|undefined} A promise for the image that will resolve when the image is available, or
  *          undefined if there are too many active requests to the server, and the request should be retried later.
  *
  * @exception {DeveloperError} <code>requestImage</code> must not be called before the imagery provider is ready.
@@ -521,12 +521,12 @@ IonImageryProvider.prototype.requestImage = function (x, y, level, request) {
  *
  * @function
  *
- * @param {Number} x The tile X coordinate.
- * @param {Number} y The tile Y coordinate.
- * @param {Number} level The tile level.
- * @param {Number} longitude The longitude at which to pick features.
- * @param {Number} latitude  The latitude at which to pick features.
- * @return {Promise.<ImageryLayerFeatureInfo[]>|undefined} A promise for the picked features that will resolve when the asynchronous
+ * @param {number} x The tile X coordinate.
+ * @param {number} y The tile Y coordinate.
+ * @param {number} level The tile level.
+ * @param {number} longitude The longitude at which to pick features.
+ * @param {number} latitude  The latitude at which to pick features.
+ * @return {Promise<ImageryLayerFeatureInfo[]>|undefined} A promise for the picked features that will resolve when the asynchronous
  *                   picking completes.  The resolved value is an array of {@link ImageryLayerFeatureInfo}
  *                   instances.  The array may be empty if no features are found at the given location.
  *                   It may also be undefined if picking is not supported.

package/Source/Scene/IonWorldImageryStyle.js

@@ -3,13 +3,13 @@
 /**
  * The types of imagery provided by {@link createWorldImagery}.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const IonWorldImageryStyle = {
   /**
    * Aerial imagery.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   AERIAL: 2,
@@ -17,7 +17,7 @@ const IonWorldImageryStyle = {
   /**
    * Aerial imagery with a road overlay.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   AERIAL_WITH_LABELS: 3,
@@ -25,7 +25,7 @@ const IonWorldImageryStyle = {
   /**
    * Roads without additional imagery.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   ROAD: 4,

package/Source/Scene/JsonMetadataTable.js

@@ -7,9 +7,9 @@ import MetadataEntity from "./MetadataEntity.js";
 /**
  * A table for storing free-form JSON metadata, as in the 3D Tiles batch table.
  *
- * @param {Object} options Object with the following properties:
- * @param {Number} options.count The number of entities in the table.
- * @param {Object.<String, Array>} options.properties The JSON representation of the metadata table. All the arrays must have exactly options.count elements.
+ * @param {object} options Object with the following properties:
+ * @param {number} options.count The number of entities in the table.
+ * @param {Object<string, Array>} options.properties The JSON representation of the metadata table. All the arrays must have exactly options.count elements.
  *
  * @alias JsonMetadataTable
  * @constructor
@@ -33,8 +33,8 @@ function JsonMetadataTable(options) {
 /**
  * Returns whether the table has this property.
  *
- * @param {String} propertyId The case-sensitive ID of the property.
- * @returns {Boolean} Whether the table has this property.
+ * @param {string} propertyId The case-sensitive ID of the property.
+ * @returns {boolean} Whether the table has this property.
  * @private
  */
 JsonMetadataTable.prototype.hasProperty = function (propertyId) {
@@ -44,8 +44,8 @@ JsonMetadataTable.prototype.hasProperty = function (propertyId) {
 /**
  * Returns an array of property IDs.
  *
- * @param {String[]} [results] An array into which to store the results.
- * @returns {String[]} The property IDs.
+ * @param {string[]} [results] An array into which to store the results.
+ * @returns {string[]} The property IDs.
  * @private
  */
 JsonMetadataTable.prototype.getPropertyIds = function (results) {
@@ -55,8 +55,8 @@ JsonMetadataTable.prototype.getPropertyIds = function (results) {
 /**
  * Returns a copy of the value of the property with the given ID.
  *
- * @param {Number} index The index of the entity.
- * @param {String} propertyId The case-sensitive ID of the property.
+ * @param {number} index The index of the entity.
+ * @param {string} propertyId The case-sensitive ID of the property.
  * @returns {*} The value of the property or <code>undefined</code> if the entity does not have this property.
  *
  * @exception {DeveloperError} index is out of bounds
@@ -84,8 +84,8 @@ JsonMetadataTable.prototype.getProperty = function (index, propertyId) {
  * Sets the value of the property with the given ID. If the property did not
  * exist, it will be created.
  *
- * @param {Number} index The index of the entity.
- * @param {String} propertyId The case-sensitive ID of the property.
+ * @param {number} index The index of the entity.
+ * @param {string} propertyId The case-sensitive ID of the property.
  * @param {*} value The value of the property that will be copied.
  *
  * @exception {DeveloperError} index is out of bounds

package/Source/Scene/KeyframeNode.js

@@ -12,7 +12,7 @@ const LoadState = Object.freeze({
  * @constructor
  *
  * @param {SpatialNode} spatialNode
- * @param {Number} keyframe
+ * @param {number} keyframe
  *
  * @private
  */

package/Source/Scene/Label.js

@@ -240,7 +240,7 @@ Object.defineProperties(Label.prototype, {
    * Determines if this label will be shown.  Use this to hide or show a label, instead
    * of removing it and re-adding it to the collection.
    * @memberof Label.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   show: {
@@ -351,7 +351,7 @@ Object.defineProperties(Label.prototype, {
   /**
    * Gets or sets the text of this label.
    * @memberof Label.prototype
-   * @type {String}
+   * @type {string}
    */
   text: {
     get: function () {
@@ -380,7 +380,7 @@ Object.defineProperties(Label.prototype, {
   /**
    * Gets or sets the font used to draw this label. Fonts are specified using the same syntax as the CSS 'font' property.
    * @memberof Label.prototype
-   * @type {String}
+   * @type {string}
    * @default '30px sans-serif'
    * @see {@link http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#text-styles|HTML canvas 2D context text styles}
    */
@@ -458,7 +458,7 @@ Object.defineProperties(Label.prototype, {
   /**
    * Gets or sets the outline width of this label.
    * @memberof Label.prototype
-   * @type {Number}
+   * @type {number}
    * @default 1.0
    * @see {@link http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#fill-and-stroke-styles|HTML canvas 2D context fill and stroke styles}
    */
@@ -484,7 +484,7 @@ Object.defineProperties(Label.prototype, {
    * Determines if a background behind this label will be shown.
    * @memberof Label.prototype
    * @default false
-   * @type {Boolean}
+   * @type {boolean}
    */
   showBackground: {
     get: function () {
@@ -946,7 +946,7 @@ Object.defineProperties(Label.prototype, {
    * and <code>2.0</code>.
    * </div>
    * @memberof Label.prototype
-   * @type {Number}
+   * @type {number}
    * @default 1.0
    */
   scale: {
@@ -984,7 +984,7 @@ Object.defineProperties(Label.prototype, {
    * Gets the total scale of the label, which is the label's scale multiplied by the computed relative size
    * of the desired font compared to the generated glyph size.
    * @memberof Label.prototype
-   * @type {Number}
+   * @type {number}
    * @default 1.0
    */
   totalScale: {
@@ -1036,7 +1036,7 @@ Object.defineProperties(Label.prototype, {
    * Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
    * When set to zero, the depth test is always applied. When set to Number.POSITIVE_INFINITY, the depth test is never applied.
    * @memberof Label.prototype
-   * @type {Number}
+   * @type {number}
    */
   disableDepthTestDistance: {
     get: function () {
@@ -1143,7 +1143,7 @@ Object.defineProperties(Label.prototype, {
   /**
    * Determines whether or not this label will be shown or hidden because it was clustered.
    * @memberof Label.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    * @private
    */
@@ -1318,7 +1318,7 @@ Label.getScreenSpaceBoundingBox = function (
  * are equal.  Labels in different collections can be equal.
  *
  * @param {Label} other The label to compare for equality.
- * @returns {Boolean} <code>true</code> if the labels are equal; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if the labels are equal; otherwise, <code>false</code>.
  */
 Label.prototype.equals = function (other) {
   return (
@@ -1365,7 +1365,7 @@ Label.prototype.equals = function (other) {
  * 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.
  */
 Label.prototype.isDestroyed = function () {
   return false;
@@ -1374,7 +1374,7 @@ Label.prototype.isDestroyed = function () {
 /**
  * Determines whether or not run the algorithm, that match the text of the label to right-to-left languages
  * @memberof Label
- * @type {Boolean}
+ * @type {boolean}
  * @default false
  *
  * @example
@@ -1476,8 +1476,8 @@ const rtlChars = new RegExp(`[${hebrew}${arabic}]`);
 
 /**
  *
- * @param {String} value the text to parse and reorder
- * @returns {String} the text as rightToLeft direction
+ * @param {string} value the text to parse and reorder
+ * @returns {string} the text as rightToLeft direction
  * @private
  */
 function reverseRtl(value) {