@cesium/engine 1.1.0 → 2.1.0

package/Source/Scene/GltfPipeline/removeExtension.js

@@ -5,8 +5,8 @@ import defined from "../../Core/defined.js";
 /**
  * Removes an extension from gltf.extensions, gltf.extensionsUsed, gltf.extensionsRequired, and any other objects in the glTF if it is present.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {String} extension The extension to remove.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {string} extension The extension to remove.
  *
  * @returns {*} The extension data removed from gltf.extensions.
  */

package/Source/Scene/GltfPipeline/removeExtensionsRequired.js

@@ -3,8 +3,8 @@ import defined from "../../Core/defined.js";
 /**
  * Removes an extension from gltf.extensionsRequired if it is present.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {String} extension The extension to remove.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {string} extension The extension to remove.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/removeExtensionsUsed.js

@@ -4,8 +4,8 @@ import defined from "../../Core/defined.js";
 /**
  * Removes an extension from gltf.extensionsUsed and gltf.extensionsRequired if it is present.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {String} extension The extension to remove.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {string} extension The extension to remove.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/removePipelineExtras.js

@@ -4,8 +4,8 @@ import defined from "../../Core/defined.js";
 /**
  * Iterate through the objects within the glTF and delete their pipeline extras object.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @returns {Object} glTF with no pipeline extras.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @returns {object} glTF with no pipeline extras.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/removeUnusedElements.js

@@ -19,8 +19,8 @@ const allElementTypes = [
 /**
  * Removes unused elements from gltf.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {String[]} [elementTypes=['mesh', 'node', 'material', 'accessor', 'bufferView', 'buffer']] Element types to be removed. Needs to be a subset of ['mesh', 'node', 'material', 'accessor', 'bufferView', 'buffer'], other items will be ignored.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {string[]} [elementTypes=['mesh', 'node', 'material', 'accessor', 'bufferView', 'buffer']] Element types to be removed. Needs to be a subset of ['mesh', 'node', 'material', 'accessor', 'bufferView', 'buffer'], other items will be ignored.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/updateAccessorComponentTypes.js

@@ -7,8 +7,8 @@ import WebGLConstants from "../../Core/WebGLConstants.js";
 /**
  * Update accessors referenced by JOINTS_0 and WEIGHTS_0 attributes to use correct component types.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @returns {Object} The glTF asset with compressed meshes.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @returns {object} The glTF asset with compressed meshes.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/updateVersion.js

@@ -30,10 +30,10 @@ const updateFunctions = {
  * Applies changes made to the glTF spec between revisions so that the core library
  * only has to handle the latest version.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {Object} [options] Options for updating the glTF.
- * @param {String} [options.targetVersion] The glTF will be upgraded until it hits the specified version.
- * @returns {Object} The updated glTF asset.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {object} [options] Options for updating the glTF.
+ * @param {string} [options.targetVersion] The glTF will be upgraded until it hits the specified version.
+ * @returns {object} The updated glTF asset.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/usesExtension.js

@@ -3,9 +3,9 @@ import defined from "../../Core/defined.js";
 /**
  * Checks whether the glTF uses the given extension.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {String} extension The name of the extension.
- * @returns {Boolean} Whether the glTF uses the given extension.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {string} extension The name of the extension.
+ * @returns {boolean} Whether the glTF uses the given extension.
  *
  * @private
  */

package/Source/Scene/GltfStructuralMetadataLoader.js

@@ -18,16 +18,16 @@ import ResourceLoaderState from "./ResourceLoaderState.js";
  * @constructor
  * @augments ResourceLoader
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {String} [options.extension] The <code>EXT_structural_metadata</code> extension object. If this is undefined, then extensionLegacy must be defined.
- * @param {String} [options.extensionLegacy] The legacy <code>EXT_feature_metadata</code> extension for backwards compatibility.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {string} [options.extension] The <code>EXT_structural_metadata</code> extension object. If this is undefined, then extensionLegacy must be defined.
+ * @param {string} [options.extensionLegacy] The legacy <code>EXT_feature_metadata</code> extension for backwards compatibility.
  * @param {Resource} options.gltfResource The {@link Resource} containing the glTF.
  * @param {Resource} options.baseResource The {@link Resource} that paths in the glTF JSON are relative to.
  * @param {SupportedImageFormats} options.supportedImageFormats The supported image formats.
  * @param {FrameState} options.frameState The frame state.
- * @param {String} [options.cacheKey] The cache key of the resource.
- * @param {Boolean} [options.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created.
+ * @param {string} [options.cacheKey] The cache key of the resource.
+ * @param {boolean} [options.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created.
  *
  * @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.
@@ -88,7 +88,7 @@ Object.defineProperties(GltfStructuralMetadataLoader.prototype, {
    *
    * @memberof GltfStructuralMetadataLoader.prototype
    *
-   * @type {Promise.<GltfStructuralMetadataLoader>|undefined}
+   * @type {Promise<GltfStructuralMetadataLoader>|undefined}
    * @readonly
    * @private
    */
@@ -102,7 +102,7 @@ Object.defineProperties(GltfStructuralMetadataLoader.prototype, {
    *
    * @memberof GltfStructuralMetadataLoader.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -129,7 +129,7 @@ Object.defineProperties(GltfStructuralMetadataLoader.prototype, {
 
 /**
  * Loads the resource.
- * @returns {Promise.<GltfStructuralMetadataLoader>} A promise which resolves to the loader when the resource loading is completed.
+ * @returns {Promise<GltfStructuralMetadataLoader>} A promise which resolves to the loader when the resource loading is completed.
  * @private
  */
 GltfStructuralMetadataLoader.prototype.load = function () {

package/Source/Scene/GltfTextureLoader.js

@@ -22,15 +22,15 @@ import resizeImageToNextPowerOfTwo from "../Core/resizeImageToNextPowerOfTwo.js"
  * @constructor
  * @augments ResourceLoader
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {ResourceCache} options.resourceCache The {@link ResourceCache} (to avoid circular dependencies).
- * @param {Object} options.gltf The glTF JSON.
- * @param {Object} options.textureInfo The texture info object.
+ * @param {object} options.gltf The glTF JSON.
+ * @param {object} options.textureInfo The texture info object.
  * @param {Resource} options.gltfResource The {@link Resource} containing the glTF.
  * @param {Resource} options.baseResource The {@link Resource} that paths in the glTF JSON are relative to.
  * @param {SupportedImageFormats} options.supportedImageFormats The supported image formats.
- * @param {String} [options.cacheKey] The cache key of the resource.
- * @param {Boolean} [options.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created.
+ * @param {string} [options.cacheKey] The cache key of the resource.
+ * @param {boolean} [options.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created.
  *
  * @private
  */
@@ -92,7 +92,7 @@ Object.defineProperties(GltfTextureLoader.prototype, {
    *
    * @memberof GltfTextureLoader.prototype
    *
-   * @type {Promise.<GltfTextureLoader>|undefined}
+   * @type {Promise<GltfTextureLoader>|undefined}
    * @readonly
    * @private
    */
@@ -106,7 +106,7 @@ Object.defineProperties(GltfTextureLoader.prototype, {
    *
    * @memberof GltfTextureLoader.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -135,7 +135,7 @@ const scratchTextureJob = new CreateTextureJob();
 
 /**
  * Loads the resource.
- * @returns {Promise.<GltfDracoLoader>} A promise which resolves to the loader when the resource loading is completed.
+ * @returns {Promise<GltfDracoLoader>} A promise which resolves to the loader when the resource loading is completed.
  * @private
  */
 GltfTextureLoader.prototype.load = function () {

package/Source/Scene/GltfVertexBufferLoader.js

@@ -20,19 +20,19 @@ import ResourceLoaderState from "./ResourceLoaderState.js";
  * @constructor
  * @augments ResourceLoader
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {ResourceCache} options.resourceCache The {@link ResourceCache} (to avoid circular dependencies).
- * @param {Object} options.gltf The glTF JSON.
+ * @param {object} options.gltf The glTF JSON.
  * @param {Resource} options.gltfResource The {@link Resource} containing the glTF.
  * @param {Resource} options.baseResource The {@link Resource} that paths in the glTF JSON are relative to.
- * @param {Number} [options.bufferViewId] The bufferView ID corresponding to the vertex buffer.
- * @param {Object} [options.draco] The Draco extension object.
- * @param {String} [options.attributeSemantic] The attribute semantic, e.g. POSITION or NORMAL.
- * @param {Number} [options.accessorId] The accessor id.
- * @param {String} [options.cacheKey] The cache key of the resource.
- * @param {Boolean} [options.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created.
- * @param {Boolean} [options.loadBuffer=false] Load vertex buffer as a GPU vertex buffer.
- * @param {Boolean} [options.loadTypedArray=false] Load vertex buffer as a typed array.
+ * @param {number} [options.bufferViewId] The bufferView ID corresponding to the vertex buffer.
+ * @param {object} [options.draco] The Draco extension object.
+ * @param {string} [options.attributeSemantic] The attribute semantic, e.g. POSITION or NORMAL.
+ * @param {number} [options.accessorId] The accessor id.
+ * @param {string} [options.cacheKey] The cache key of the resource.
+ * @param {boolean} [options.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created.
+ * @param {boolean} [options.loadBuffer=false] Load vertex buffer as a GPU vertex buffer.
+ * @param {boolean} [options.loadTypedArray=false] Load vertex buffer as a typed array.
  *
  * @exception {DeveloperError} One of options.bufferViewId and options.draco must be defined.
  * @exception {DeveloperError} When options.draco is defined options.attributeSemantic must also be defined.
@@ -129,7 +129,7 @@ Object.defineProperties(GltfVertexBufferLoader.prototype, {
    *
    * @memberof GltfVertexBufferLoader.prototype
    *
-   * @type {Promise.<GltfVertexBufferLoader>|undefined}
+   * @type {Promise<GltfVertexBufferLoader>|undefined}
    * @readonly
    * @private
    */
@@ -143,7 +143,7 @@ Object.defineProperties(GltfVertexBufferLoader.prototype, {
    *
    * @memberof GltfVertexBufferLoader.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -206,7 +206,7 @@ function hasDracoCompression(draco, semantic) {
 
 /**
  * Loads the resource.
- * @returns {Promise.<GltfVertexBufferLoader>} A promise which resolves to the loader when the resource loading is completed.
+ * @returns {Promise<GltfVertexBufferLoader>} A promise which resolves to the loader when the resource loading is completed.
  * @private
  */
 GltfVertexBufferLoader.prototype.load = function () {

package/Source/Scene/GoogleEarthEnterpriseImageryProvider.js

@@ -24,7 +24,7 @@ function GoogleEarthEnterpriseDiscardPolicy() {
 
 /**
  * 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.
  */
 GoogleEarthEnterpriseDiscardPolicy.prototype.isReady = function () {
   return true;
@@ -34,7 +34,7 @@ GoogleEarthEnterpriseDiscardPolicy.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.
  */
 GoogleEarthEnterpriseDiscardPolicy.prototype.shouldDiscardImage = function (
   image
@@ -43,17 +43,17 @@ GoogleEarthEnterpriseDiscardPolicy.prototype.shouldDiscardImage = function (
 };
 
 /**
- * @typedef {Object} GoogleEarthEnterpriseImageryProvider.ConstructorOptions
+ * @typedef {object} GoogleEarthEnterpriseImageryProvider.ConstructorOptions
  *
  * Initialization options for the GoogleEarthEnterpriseImageryProvider constructor
  *
- * @property {Resource|String} url The url of the Google Earth Enterprise server hosting the imagery.
+ * @property {Resource|string} url The url of the Google Earth Enterprise server hosting the imagery.
  * @property {GoogleEarthEnterpriseMetadata} metadata A metadata object that can be used to share metadata requests with a GoogleEarthEnterpriseTerrainProvider.
  * @property {Ellipsoid} [ellipsoid] The ellipsoid.  If not specified, the WGS84 ellipsoid is used.
  * @property {TileDiscardPolicy} [tileDiscardPolicy] The policy that determines if a tile
  *        is invalid and should be discarded. If this value is not specified, a default
  *        is to discard tiles that fail to download.
- * @property {Credit|String} [credit] A credit for the data source, which is displayed on the canvas.
+ * @property {Credit|string} [credit] A credit for the data source, which is displayed on the canvas.
  */
 
 /**
@@ -99,7 +99,7 @@ function GoogleEarthEnterpriseImageryProvider(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;
@@ -108,7 +108,7 @@ function GoogleEarthEnterpriseImageryProvider(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;
@@ -117,7 +117,7 @@ function GoogleEarthEnterpriseImageryProvider(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;
@@ -126,7 +126,7 @@ function GoogleEarthEnterpriseImageryProvider(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;
@@ -135,7 +135,7 @@ function GoogleEarthEnterpriseImageryProvider(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;
@@ -143,7 +143,7 @@ function GoogleEarthEnterpriseImageryProvider(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;
@@ -152,7 +152,7 @@ function GoogleEarthEnterpriseImageryProvider(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;
@@ -160,7 +160,7 @@ function GoogleEarthEnterpriseImageryProvider(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;
@@ -265,7 +265,7 @@ Object.defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
   /**
    * Gets the name of the Google Earth Enterprise server url hosting the imagery.
    * @memberof GoogleEarthEnterpriseImageryProvider.prototype
-   * @type {String}
+   * @type {string}
    * @readonly
    */
   url: {
@@ -290,7 +290,7 @@ Object.defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
    * Gets the width of each tile, in pixels. This function should
    * not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
    * @memberof GoogleEarthEnterpriseImageryProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   tileWidth: {
@@ -311,7 +311,7 @@ Object.defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
    * Gets the height of each tile, in pixels.  This function should
    * not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
    * @memberof GoogleEarthEnterpriseImageryProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   tileHeight: {
@@ -332,7 +332,7 @@ Object.defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
    * Gets the maximum level-of-detail that can be requested.  This function should
    * not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
    * @memberof GoogleEarthEnterpriseImageryProvider.prototype
-   * @type {Number|undefined}
+   * @type {number|undefined}
    * @readonly
    */
   maximumLevel: {
@@ -353,7 +353,7 @@ Object.defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
    * Gets the minimum level-of-detail that can be requested.  This function should
    * not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
    * @memberof GoogleEarthEnterpriseImageryProvider.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   minimumLevel: {
@@ -452,7 +452,7 @@ Object.defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
   /**
    * Gets a value indicating whether or not the provider is ready for use.
    * @memberof GoogleEarthEnterpriseImageryProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -464,7 +464,7 @@ Object.defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
   /**
    * Gets a promise that resolves to true when the provider is ready for use.
    * @memberof GoogleEarthEnterpriseImageryProvider.prototype
-   * @type {Promise.<Boolean>}
+   * @type {Promise<boolean>}
    * @readonly
    */
   readyPromise: {
@@ -493,7 +493,7 @@ Object.defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
    * as if their alpha is 1.0 everywhere.  Setting this property to false reduces memory usage
    * and texture upload time.
    * @memberof GoogleEarthEnterpriseImageryProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   hasAlphaChannel: {
@@ -506,9 +506,9 @@ Object.defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
 /**
  * Gets the credits to be displayed when a given tile is displayed.
  *
- * @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.
@@ -542,11 +542,11 @@ GoogleEarthEnterpriseImageryProvider.prototype.getTileCredits = function (
  * Requests the image for a given tile.  This function should
  * not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
  *
- * @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.
@@ -631,11 +631,11 @@ GoogleEarthEnterpriseImageryProvider.prototype.requestImage = function (
  * Picking features is not currently supported by this imagery provider, so this function simply returns
  * undefined.
  *
- * @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.
+ * @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 {undefined} Undefined since picking is not supported.
  */
 GoogleEarthEnterpriseImageryProvider.prototype.pickFeatures = function (