@cesium/engine 1.1.0 → 2.1.0

package/Source/Scene/PropertyTable.js

@@ -21,15 +21,15 @@ import JsonMetadataTable from "./JsonMetadataTable.js";
  * previous {@link https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata|EXT_feature_metadata Extension} for glTF.
  * </p>
  *
- * @param {Object} options Object with the following properties:
- * @param {String} [options.name] Human-readable name to describe the table
- * @param {String|Number} [options.id] A unique id to identify the property table, useful for debugging. For <code>EXT_structural_metadata</code>, this is the array index in the property tables array, for <code>EXT_feature_metadata</code> this is the dictionary key in the property tables dictionary.
- * @param {Number} options.count The number of features in the table.
+ * @param {object} options Object with the following properties:
+ * @param {string} [options.name] Human-readable name to describe the table
+ * @param {string|number} [options.id] A unique id to identify the property table, useful for debugging. For <code>EXT_structural_metadata</code>, this is the array index in the property tables array, for <code>EXT_feature_metadata</code> this is the dictionary key in the property tables dictionary.
+ * @param {number} options.count The number of features in the table.
  * @param {MetadataTable} [options.metadataTable] A table of binary properties.
  * @param {JsonMetadataTable} [options.jsonMetadataTable] For compatibility with the old batch table, free-form JSON properties can be passed in.
  * @param {BatchTableHierarchy} [options.batchTableHierarchy] For compatibility with the <code>3DTILES_batch_table_hierarchy</code> extension, a hierarchy can be provided.
- * @param {Object} [options.extras] Extra user-defined properties
- * @param {Object} [options.extensions] An object containing extensions
+ * @param {object} [options.extras] Extra user-defined properties
+ * @param {object} [options.extensions] An object containing extensions
  *
  * @alias PropertyTable
  * @constructor
@@ -59,7 +59,7 @@ Object.defineProperties(PropertyTable.prototype, {
    * A human-readable name for this table
    *
    * @memberof PropertyTable.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -72,7 +72,7 @@ Object.defineProperties(PropertyTable.prototype, {
    * An identifier for this table. Useful for debugging.
    *
    * @memberof PropertyTable.prototype
-   * @type {String|Number}
+   * @type {string|number}
    * @readonly
    * @private
    */
@@ -85,7 +85,7 @@ Object.defineProperties(PropertyTable.prototype, {
    * The number of features in the table.
    *
    * @memberof PropertyTable.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    * @private
    */
@@ -130,7 +130,7 @@ Object.defineProperties(PropertyTable.prototype, {
    * An object containing extensions.
    *
    * @memberof PropertyTable.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    * @private
    */
@@ -145,7 +145,7 @@ Object.defineProperties(PropertyTable.prototype, {
    * not include JSON metadata
    *
    * @memberof PropertyTable.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    * @private
    */
@@ -168,9 +168,9 @@ Object.defineProperties(PropertyTable.prototype, {
 /**
  * Returns whether the feature has this property. For compatibility with the <code>3DTILES_batch_table_hierarchy</code> extension, this is computed for a specific feature.
  *
- * @param {Number} index The index of the feature.
- * @param {String} propertyId The case-sensitive ID of the property.
- * @returns {Boolean} Whether the feature has this property.
+ * @param {number} index The index of the feature.
+ * @param {string} propertyId The case-sensitive ID of the property.
+ * @returns {boolean} Whether the feature has this property.
  * @private
  */
 PropertyTable.prototype.hasProperty = function (index, propertyId) {
@@ -206,8 +206,8 @@ PropertyTable.prototype.hasProperty = function (index, propertyId) {
 /**
  * Returns whether the feature has a property with the given semantic.
  *
- * @param {String} semantic The case-sensitive semantic of the property.
- * @returns {Boolean} Whether the feature has a property with the given semantic.
+ * @param {string} semantic The case-sensitive semantic of the property.
+ * @returns {boolean} Whether the feature has a property with the given semantic.
  * @private
  */
 PropertyTable.prototype.hasPropertyBySemantic = function (index, semantic) {
@@ -228,8 +228,8 @@ PropertyTable.prototype.hasPropertyBySemantic = function (index, semantic) {
  * This is mainly useful for checking whether a property exists in the class
  * hierarchy when using the <code>3DTILES_batch_table_hierarchy</code> extension.
  *
- * @param {String} propertyId The case-sensitive ID of the property.
- * @returns {Boolean} Whether any feature has this property.
+ * @param {string} propertyId The case-sensitive ID of the property.
+ * @returns {boolean} Whether any feature has this property.
  * @private
  */
 PropertyTable.prototype.propertyExists = function (propertyId) {
@@ -264,8 +264,8 @@ PropertyTable.prototype.propertyExists = function (propertyId) {
 /**
  * Returns whether any feature has a property with the given semantic.
  *
- * @param {String} semantic The case-sensitive semantic of the property.
- * @returns {Boolean} Whether any feature has a property with the given semantic.
+ * @param {string} semantic The case-sensitive semantic of the property.
+ * @returns {boolean} Whether any feature has a property with the given semantic.
  * @private
  */
 PropertyTable.prototype.propertyExistsBySemantic = function (semantic) {
@@ -285,9 +285,9 @@ const scratchResults = [];
 /**
  * Returns an array of property IDs. For compatibility with the <code>3DTILES_batch_table_hierarchy</code> extension, this is computed for a specific feature.
  *
- * @param {Number} index The index of the feature.
- * @param {String[]} [results] An array into which to store the results.
- * @returns {String[]} The property IDs.
+ * @param {number} index The index of the feature.
+ * @param {string[]} [results] An array into which to store the results.
+ * @returns {string[]} The property IDs.
  * @private
  */
 PropertyTable.prototype.getPropertyIds = function (index, results) {
@@ -325,8 +325,8 @@ PropertyTable.prototype.getPropertyIds = function (index, results) {
  * If the property is normalized the normalized value is returned.
  * </p>
  *
- * @param {Number} index The index of the feature.
- * @param {String} propertyId The case-sensitive ID of the property.
+ * @param {number} index The index of the feature.
+ * @param {string} propertyId The case-sensitive ID of the property.
  * @returns {*} The value of the property or <code>undefined</code> if the feature does not have this property.
  * @private
  */
@@ -364,8 +364,8 @@ PropertyTable.prototype.getProperty = function (index, propertyId) {
  * If the property is normalized a normalized value must be provided to this function.
  * </p>
  *
- * @param {Number} index The index of the feature.
- * @param {String} propertyId The case-sensitive ID of the property.
+ * @param {number} index The index of the feature.
+ * @param {string} propertyId The case-sensitive ID of the property.
  * @param {*} value The value of the property that will be copied.
  * @private
  */
@@ -404,8 +404,8 @@ PropertyTable.prototype.setProperty = function (index, propertyId, value) {
  * semantics.
  * </p>
  *
- * @param {Number} index The index of the feature.
- * @param {String} semantic The case-sensitive semantic of the property.
+ * @param {number} index The index of the feature.
+ * @param {string} semantic The case-sensitive semantic of the property.
  * @returns {*} The value of the property or <code>undefined</code> if the feature does not have this semantic.
  * @private
  */
@@ -425,10 +425,10 @@ PropertyTable.prototype.getPropertyBySemantic = function (index, semantic) {
  * semantics.
  * </p>
  *
- * @param {Number} index The index of the feature.
- * @param {String} semantic The case-sensitive semantic of the property.
+ * @param {number} index The index of the feature.
+ * @param {string} semantic The case-sensitive semantic of the property.
  * @param {*} value The value of the property that will be copied.
- * @returns {Boolean} <code>true</code> if the property was set, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if the property was set, <code>false</code> otherwise.
  * @private
  */
 PropertyTable.prototype.setPropertyBySemantic = function (
@@ -451,7 +451,7 @@ PropertyTable.prototype.setPropertyBySemantic = function (
  * values in typed arrays.
  * </p>
  *
- * @param {String} propertyId The case-sensitive ID of the property.
+ * @param {string} propertyId The case-sensitive ID of the property.
  * @returns {*} The typed array containing the property values or <code>undefined</code> if the property values are not stored in a typed array.
  *
  * @private
@@ -476,7 +476,7 @@ PropertyTable.prototype.getPropertyTypedArray = function (propertyId) {
  * semantics.
  * </p>
  *
- * @param {String} semantic The case-sensitive semantic of the property.
+ * @param {string} semantic The case-sensitive semantic of the property.
  * @returns {*} The typed array containing the property values or <code>undefined</code> if the property values are not stored in a typed array.
  *
  * @private

package/Source/Scene/PropertyTexture.js

@@ -10,12 +10,12 @@ import PropertyTextureProperty from "./PropertyTextureProperty.js";
  * previous {@link https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata|EXT_feature_metadata Extension} for glTF.
  * </p>
  *
- * @param {Object} options Object with the following properties:
- * @param {String} [options.name] Optional human-readable name to describe the texture
- * @param {String|Number} [options.id] A unique id to identify the property texture, useful for debugging. For <code>EXT_structural_metadata</code>, this is the array index in the property textures array, for <code>EXT_feature_metadata</code> this is the dictionary key in the property textures dictionary.
- * @param {Object} options.propertyTexture The property texture JSON, following the EXT_structural_metadata schema.
+ * @param {object} options Object with the following properties:
+ * @param {string} [options.name] Optional human-readable name to describe the texture
+ * @param {string|number} [options.id] A unique id to identify the property texture, useful for debugging. For <code>EXT_structural_metadata</code>, this is the array index in the property textures array, for <code>EXT_feature_metadata</code> this is the dictionary key in the property textures dictionary.
+ * @param {object} options.propertyTexture The property texture JSON, following the EXT_structural_metadata schema.
  * @param {MetadataClass} options.class The class that properties conform to.
- * @param {Object.<String, Texture>} options.textures An object mapping texture IDs to {@link Texture} objects.
+ * @param {Object<string, Texture>} options.textures An object mapping texture IDs to {@link Texture} objects.
  *
  * @alias PropertyTexture
  * @constructor
@@ -64,7 +64,7 @@ Object.defineProperties(PropertyTexture.prototype, {
    * A human-readable name for this texture
    *
    * @memberof PropertyTexture.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -77,7 +77,7 @@ Object.defineProperties(PropertyTexture.prototype, {
    * An identifier for this texture. Useful for debugging.
    *
    * @memberof PropertyTexture.prototype
-   * @type {String|Number}
+   * @type {string|number}
    * @readonly
    * @private
    */
@@ -133,7 +133,7 @@ Object.defineProperties(PropertyTexture.prototype, {
    * An object containing extensions.
    *
    * @memberof PropertyTexture.prototype
-   * @type {Object}
+   * @type {object}
    * @readonly
    * @private
    */
@@ -147,7 +147,7 @@ Object.defineProperties(PropertyTexture.prototype, {
 /**
  * Gets the property with the given property ID.
  *
- * @param {String} propertyId The case-sensitive ID of the property.
+ * @param {string} propertyId The case-sensitive ID of the property.
  * @returns {PropertyTextureProperty|undefined} The property, or <code>undefined</code> if the property does not exist.
  * @private
  */

package/Source/Scene/PropertyTextureProperty.js

@@ -13,10 +13,10 @@ import MetadataComponentType from "./MetadataComponentType.js";
  * previous {@link https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata|EXT_feature_metadata Extension} for glTF.
  * </p>
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.property The property JSON object.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.property The property JSON object.
  * @param {MetadataClassProperty} options.classProperty The class property.
- * @param {Object.<Number, Texture>} options.textures An object mapping texture IDs to {@link Texture} objects.
+ * @param {Object<number, Texture>} options.textures An object mapping texture IDs to {@link Texture} objects.
  *
  * @alias PropertyTextureProperty
  * @constructor
@@ -97,7 +97,7 @@ Object.defineProperties(PropertyTextureProperty.prototype, {
    * undefined, they default to identity so this property is set false
    *
    * @memberof PropertyTextureProperty.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    * @private
    */
@@ -111,7 +111,7 @@ Object.defineProperties(PropertyTextureProperty.prototype, {
    * The offset to be added to property values as part of the value transform.
    *
    * @memberof PropertyTextureProperty.prototype
-   * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4}
+   * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4}
    * @readonly
    * @private
    */
@@ -125,7 +125,7 @@ Object.defineProperties(PropertyTextureProperty.prototype, {
    * The scale to be multiplied to property values as part of the value transform.
    *
    * @memberof PropertyTextureProperty.prototype
-   * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4}
+   * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4}
    * @readonly
    * @private
    */
@@ -248,8 +248,8 @@ PropertyTextureProperty.prototype.unpackInShader = function (packedValueGlsl) {
  * Reformat from an array of channel indices like <code>[0, 1]</code> to a
  * string of channels as would be used in GLSL swizzling (e.g. "rg")
  *
- * @param {Number[]} channels the channel indices
- * @return {String} The channels as a string of "r", "g", "b" or "a" characters.
+ * @param {number[]} channels the channel indices
+ * @return {string} The channels as a string of "r", "g", "b" or "a" characters.
  * @private
  */
 function reformatChannels(channels) {

package/Source/Scene/QuadtreePrimitive.js

@@ -32,10 +32,10 @@ import TileSelectionResult from "./TileSelectionResult.js";
  *
  * @param {QuadtreeTileProvider} options.tileProvider The tile provider that loads, renders, and estimates
  *        the distance to individual tiles.
- * @param {Number} [options.maximumScreenSpaceError=2] The maximum screen-space error, in pixels, that is allowed.
+ * @param {number} [options.maximumScreenSpaceError=2] The maximum screen-space error, in pixels, that is allowed.
  *        A higher maximum error will render fewer tiles and improve performance, while a lower
  *        value will improve visual quality.
- * @param {Number} [options.tileCacheSize=100] The maximum number of tiles that will be retained in the tile cache.
+ * @param {number} [options.tileCacheSize=100] The maximum number of tiles that will be retained in the tile cache.
  *        Note that tiles will never be unloaded if they were used for rendering the last
  *        frame, so the actual number of resident tiles may be higher.  The value of
  *        this property will not affect visual quality.
@@ -105,7 +105,7 @@ function QuadtreePrimitive(options) {
    * Gets or sets the maximum screen-space error, in pixels, that is allowed.
    * A higher maximum error will render fewer tiles and improve performance, while a lower
    * value will improve visual quality.
-   * @type {Number}
+   * @type {number}
    * @default 2
    */
   this.maximumScreenSpaceError = defaultValue(
@@ -118,7 +118,7 @@ function QuadtreePrimitive(options) {
    * Note that tiles will never be unloaded if they were used for rendering the last
    * frame, so the actual number of resident tiles may be higher.  The value of
    * this property will not affect visual quality.
-   * @type {Number}
+   * @type {number}
    * @default 100
    */
   this.tileCacheSize = defaultValue(options.tileCacheSize, 100);
@@ -131,7 +131,7 @@ function QuadtreePrimitive(options) {
    * tile level to be loaded successively, significantly increasing load time. Setting it to a large
    * number (e.g. 1000) will minimize the number of tiles that are loaded but tend to make
    * detail appear all at once after a long wait.
-   * @type {Number}
+   * @type {number}
    * @default 20
    */
   this.loadingDescendantLimit = 20;
@@ -140,7 +140,7 @@ function QuadtreePrimitive(options) {
    * Gets or sets a value indicating whether the ancestors of rendered tiles should be preloaded.
    * Setting this to true optimizes the zoom-out experience and provides more detail in
    * newly-exposed areas when panning. The down side is that it requires loading more tiles.
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   this.preloadAncestors = true;
@@ -150,7 +150,7 @@ function QuadtreePrimitive(options) {
    * Setting this to true causes tiles with the same parent as a rendered tile to be loaded, even
    * if they are culled. Setting this to true may provide a better panning experience at the
    * cost of loading more tiles.
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    */
   this.preloadSiblings = false;
@@ -459,7 +459,7 @@ QuadtreePrimitive.prototype.endFrame = function (frameState) {
  *
  * @memberof QuadtreePrimitive
  *
- * @returns {Boolean} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  *
  * @see QuadtreePrimitive#destroy
  */
@@ -704,7 +704,7 @@ for (let i = 0; i < traversalQuadsByLevel.length; ++i) {
  * @param {Primitive} primitive The QuadtreePrimitive.
  * @param {FrameState} frameState The frame state.
  * @param {QuadtreeTile} tile The tile to visit
- * @param {Boolean} ancestorMeetsSse True if a tile higher in the tile tree already met the SSE and we're refining further only
+ * @param {boolean} ancestorMeetsSse True if a tile higher in the tile tree already met the SSE and we're refining further only
  *                  to maintain detail while that higher tile loads.
  * @param {TraversalDetails} traveralDetails On return, populated with details of how the traversal of this tile went.
  */

package/Source/Scene/QuadtreeTile.js

@@ -11,9 +11,9 @@ import TileSelectionResult from "./TileSelectionResult.js";
  * @constructor
  * @private
  *
- * @param {Number} options.level The level of the tile in the quadtree.
- * @param {Number} options.x The X coordinate of the tile in the quadtree.  0 is the westernmost tile.
- * @param {Number} options.y The Y coordinate of the tile in the quadtree.  0 is the northernmost tile.
+ * @param {number} options.level The level of the tile in the quadtree.
+ * @param {number} options.x The X coordinate of the tile in the quadtree.  0 is the westernmost tile.
+ * @param {number} options.y The Y coordinate of the tile in the quadtree.  0 is the northernmost tile.
  * @param {TilingScheme} options.tilingScheme The tiling scheme in which this tile exists.
  * @param {QuadtreeTile} [options.parent] This tile's parent, or undefined if this is a root tile.
  */
@@ -83,7 +83,7 @@ function QuadtreeTile(options) {
 
   /**
    * Gets or sets a value indicating whether or not the tile is currently renderable.
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    */
   this.renderable = false;
@@ -93,7 +93,7 @@ function QuadtreeTile(options) {
    * parent tile.  If all four children of a parent tile were upsampled from the parent,
    * we will render the parent instead of the children even if the LOD indicates that
    * the children would be preferable.
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    */
   this.upsampledFromParent = false;
@@ -101,7 +101,7 @@ function QuadtreeTile(options) {
   /**
    * Gets or sets the additional data associated with this tile.  The exact content is specific to the
    * {@link QuadtreeTileProvider}.
-   * @type {Object}
+   * @type {object}
    * @default undefined
    */
   this.data = undefined;
@@ -204,7 +204,7 @@ Object.defineProperties(QuadtreeTile.prototype, {
   /**
    * Gets the tile X coordinate.
    * @memberof QuadtreeTile.prototype
-   * @type {Number}
+   * @type {number}
    */
   x: {
     get: function () {
@@ -215,7 +215,7 @@ Object.defineProperties(QuadtreeTile.prototype, {
   /**
    * Gets the tile Y coordinate.
    * @memberof QuadtreeTile.prototype
-   * @type {Number}
+   * @type {number}
    */
   y: {
     get: function () {
@@ -226,7 +226,7 @@ Object.defineProperties(QuadtreeTile.prototype, {
   /**
    * Gets the level-of-detail, where zero is the coarsest, least-detailed.
    * @memberof QuadtreeTile.prototype
-   * @type {Number}
+   * @type {number}
    */
   level: {
     get: function () {
@@ -369,7 +369,7 @@ Object.defineProperties(QuadtreeTile.prototype, {
    * This property will return true if the {@link QuadtreeTile#state} is
    * <code>START</code> or <code>LOADING</code>.
    * @memberof QuadtreeTile.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   needsLoading: {
     get: function () {
@@ -386,7 +386,7 @@ Object.defineProperties(QuadtreeTile.prototype, {
    * <code>eligibleForUnloading</code> property, the value of that property is returned.
    * Otherwise, this property returns true.
    * @memberof QuadtreeTile.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   eligibleForUnloading: {
     get: function () {

package/Source/Scene/QuadtreeTileLoadState.js

@@ -1,6 +1,6 @@
 /**
  * The state of a {@link QuadtreeTile} in the tile load pipeline.
- * @enum {Number}
+ * @enum {number}
  * @private
  */
 const QuadtreeTileLoadState = {

package/Source/Scene/QuadtreeTileProvider.js

@@ -19,7 +19,7 @@ function QuadtreeTileProvider() {
  * @memberof QuadtreeTileProvider
  *
  * @param {TilingScheme} tilingScheme The tiling scheme for which to compute the geometric error.
- * @returns {Number} The maximum geometric error at level zero, in meters.
+ * @returns {number} The maximum geometric error at level zero, in meters.
  */
 QuadtreeTileProvider.computeDefaultLevelZeroMaximumGeometricError = function (
   tilingScheme
@@ -45,7 +45,7 @@ Object.defineProperties(QuadtreeTileProvider.prototype, {
   /**
    * Gets a value indicating whether or not the provider is ready for use.
    * @memberof QuadtreeTileProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   ready: {
     get: DeveloperError.throwInstantiationError,
@@ -120,8 +120,8 @@ QuadtreeTileProvider.prototype.endUpdate =
  * @memberof QuadtreeTileProvider
  * @function
  *
- * @param {Number} level The tile level for which to get the maximum geometric error.
- * @returns {Number} The maximum geometric error in meters.
+ * @param {number} level The tile level for which to get the maximum geometric error.
+ * @returns {number} The maximum geometric error in meters.
  */
 QuadtreeTileProvider.prototype.getLevelMaximumGeometricError =
   DeveloperError.throwInstantiationError;
@@ -184,7 +184,7 @@ QuadtreeTileProvider.prototype.showTileThisFrame =
  * @param {QuadtreeTile} tile The tile instance.
  * @param {FrameState} frameState The state information of the current rendering frame.
  *
- * @returns {Number} The distance from the camera to the closest point on the tile, in meters.
+ * @returns {number} The distance from the camera to the closest point on the tile, in meters.
  */
 QuadtreeTileProvider.prototype.computeDistanceToTile =
   DeveloperError.throwInstantiationError;
@@ -197,7 +197,7 @@ QuadtreeTileProvider.prototype.computeDistanceToTile =
  *
  * @memberof QuadtreeTileProvider
  *
- * @returns {Boolean} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  *
  * @see QuadtreeTileProvider#destroy
  */