@cesium/engine 1.1.0 → 2.1.0

package/Source/Scene/ResourceCache.js

@@ -50,7 +50,7 @@ function CacheEntry(resourceLoader) {
  * Gets a resource from the cache. If the resource exists its reference count is
  * incremented. Otherwise, if no resource loader exists, undefined is returned.
  *
- * @param {String} cacheKey The cache key of the resource.
+ * @param {string} cacheKey The cache key of the resource.
  *
  * @returns {ResourceLoader|undefined} The resource.
  * @private
@@ -71,7 +71,7 @@ ResourceCache.get = function (cacheKey) {
 /**
  * Loads a resource and adds it to the cache.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {ResourceLoader} options.resourceLoader The resource.
  *
  * @exception {DeveloperError} Resource with this cacheKey is already in the cach
@@ -138,8 +138,8 @@ ResourceCache.unload = function (resourceLoader) {
 /**
  * Loads a schema from the cache.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} [options.schema] An object that explicitly defines a schema JSON. Mutually exclusive with options.resource.
+ * @param {object} options Object with the following properties:
+ * @param {object} [options.schema] An object that explicitly defines a schema JSON. Mutually exclusive with options.resource.
  * @param {Resource} [options.resource] The {@link Resource} pointing to the schema JSON. Mutually exclusive with options.schema.
  *
  * @returns {MetadataSchemaLoader} The schema resource.
@@ -186,9 +186,9 @@ ResourceCache.loadSchema = function (options) {
 /**
  * Load an embedded buffer from the cache.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Resource} options.parentResource The {@link Resource} containing the embedded buffer.
- * @param {Number} options.bufferId A unique identifier of the embedded buffer within the parent resource.
+ * @param {number} options.bufferId A unique identifier of the embedded buffer within the parent resource.
  * @param {Uint8Array} [options.typedArray] The typed array containing the embedded buffer contents.
  *
  * @returns {BufferLoader} The buffer loader.
@@ -234,7 +234,7 @@ ResourceCache.loadEmbeddedBuffer = function (options) {
 /**
  * Loads an external buffer from the cache.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Resource} options.resource The {@link Resource} pointing to the external buffer.
  *
  * @returns {BufferLoader} The buffer loader.
@@ -272,11 +272,11 @@ ResourceCache.loadExternalBuffer = function (options) {
 /**
  * Loads a glTF JSON from the cache.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @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 {Uint8Array} [options.typedArray] The typed array containing the glTF contents.
- * @param {Object} [options.gltfJson] The parsed glTF JSON contents.
+ * @param {object} [options.gltfJson] The parsed glTF JSON contents.
  *
  * @returns {GltfJsonLoader} The glTF JSON.
  * @private
@@ -321,9 +321,9 @@ ResourceCache.loadGltfJson = function (options) {
 /**
  * Loads a glTF buffer view from the cache.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Number} options.bufferViewId The bufferView ID.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {number} options.bufferViewId The bufferView ID.
  * @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.
  *
@@ -375,9 +375,9 @@ ResourceCache.loadBufferView = function (options) {
 /**
  * Loads Draco data from the cache.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Object} options.draco The Draco extension object.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {object} options.draco The Draco extension 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.
  *
@@ -429,19 +429,19 @@ ResourceCache.loadDraco = function (options) {
 /**
  * Loads a glTF vertex buffer from the cache.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
+ * @param {object} options Object with the following properties:
+ * @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 {FrameState} options.frameState The frame state.
- * @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 {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.dequantize=false] Determines whether or not the vertex buffer will be dequantized on the CPU.
- * @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 {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.dequantize=false] Determines whether or not the vertex buffer will be dequantized on the CPU.
+ * @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.
  * @exception {DeveloperError} When options.draco is defined options.accessorId must also be defined.
@@ -564,16 +564,16 @@ function hasDracoCompression(draco, semantic) {
 /**
  * Loads a glTF index buffer from the cache.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Number} options.accessorId The accessor ID corresponding to the index buffer.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {number} options.accessorId The accessor ID corresponding to the index buffer.
  * @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 {FrameState} options.frameState The frame state.
- * @param {Object} [options.draco] The Draco extension object.
- * @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 index buffer as a GPU index buffer.
- * @param {Boolean} [options.loadTypedArray=false] Load index buffer as a typed array.
+ * @param {object} [options.draco] The Draco extension object.
+ * @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 index buffer as a GPU index buffer.
+ * @param {boolean} [options.loadTypedArray=false] Load index buffer as a typed array.
  * @returns {GltfIndexBufferLoader} The index buffer loader.
  * @private
  */
@@ -645,9 +645,9 @@ ResourceCache.loadIndexBuffer = function (options) {
 /**
  * Loads a glTF image from the cache.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Number} options.imageId The image ID.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {number} options.imageId The image ID.
  * @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.
  *
@@ -699,14 +699,14 @@ ResourceCache.loadImage = function (options) {
 /**
  * Loads a glTF texture from the cache.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Object} options.textureInfo The texture info object.
+ * @param {object} options Object with the following properties:
+ * @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 {FrameState} options.frameState The frame state.
- * @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.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created.
  *
  * @returns {GltfTextureLoader} The texture loader.
  * @private

package/Source/Scene/ResourceCacheKey.js

@@ -118,11 +118,11 @@ function getSamplerCacheKey(gltf, textureInfo) {
 /**
  * Gets the schema cache key.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} [options.schema] An object that explicitly defines a schema JSON. Mutually exclusive with options.resource.
+ * @param {object} options Object with the following properties:
+ * @param {object} [options.schema] An object that explicitly defines a schema JSON. Mutually exclusive with options.resource.
  * @param {Resource} [options.resource] The {@link Resource} pointing to the schema JSON. Mutually exclusive with options.schema.
  *
- * @returns {String} The schema cache key.
+ * @returns {string} The schema cache key.
  *
  * @exception {DeveloperError} One of options.schema and options.resource must be defined.
  * @private
@@ -149,10 +149,10 @@ ResourceCacheKey.getSchemaCacheKey = function (options) {
 /**
  * Gets the external buffer cache key.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Resource} options.resource The {@link Resource} pointing to the external buffer.
  *
- * @returns {String} The external buffer cache key.
+ * @returns {string} The external buffer cache key.
  * @private
  */
 ResourceCacheKey.getExternalBufferCacheKey = function (options) {
@@ -169,11 +169,11 @@ ResourceCacheKey.getExternalBufferCacheKey = function (options) {
 /**
  * Gets the embedded buffer cache key.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Resource} options.parentResource The {@link Resource} containing the embedded buffer.
- * @param {Number} options.bufferId A unique identifier of the embedded buffer within the parent resource.
+ * @param {number} options.bufferId A unique identifier of the embedded buffer within the parent resource.
  *
- * @returns {String} The embedded buffer cache key.
+ * @returns {string} The embedded buffer cache key.
  * @private
  */
 ResourceCacheKey.getEmbeddedBufferCacheKey = function (options) {
@@ -195,10 +195,10 @@ ResourceCacheKey.getEmbeddedBufferCacheKey = function (options) {
 /**
  * Gets the glTF cache key.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Resource} options.gltfResource The {@link Resource} containing the glTF.
  *
- * @returns {String} The glTF cache key.
+ * @returns {string} The glTF cache key.
  * @private
  */
 ResourceCacheKey.getGltfCacheKey = function (options) {
@@ -215,13 +215,13 @@ ResourceCacheKey.getGltfCacheKey = function (options) {
 /**
  * Gets the buffer view cache key.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Number} options.bufferViewId The bufferView ID.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {number} options.bufferViewId The bufferView ID.
  * @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.
  *
- * @returns {String} The buffer view cache key.
+ * @returns {string} The buffer view cache key.
  * @private
  */
 ResourceCacheKey.getBufferViewCacheKey = function (options) {
@@ -261,13 +261,13 @@ ResourceCacheKey.getBufferViewCacheKey = function (options) {
 /**
  * Gets the Draco cache key.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Object} options.draco The Draco extension object.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {object} options.draco The Draco extension 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.
  *
- * @returns {String} The Draco cache key.
+ * @returns {string} The Draco cache key.
  * @private
  */
 ResourceCacheKey.getDracoCacheKey = function (options) {
@@ -290,21 +290,21 @@ ResourceCacheKey.getDracoCacheKey = function (options) {
 /**
  * Gets the vertex buffer cache key.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
+ * @param {object} options Object with the following properties:
+ * @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 {FrameState} options.frameState The frame state.
- * @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 {Boolean} [options.dequantize=false] Determines whether or not the vertex buffer will be dequantized on the CPU.
- * @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 {boolean} [options.dequantize=false] Determines whether or not the vertex buffer will be dequantized on the CPU.
+ * @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.
  *
- * @returns {String} The vertex buffer cache key.
+ * @returns {string} The vertex buffer cache key.
  * @private
  */
 ResourceCacheKey.getVertexBufferCacheKey = function (options) {
@@ -405,17 +405,17 @@ function hasDracoCompression(draco, semantic) {
 /**
  * Gets the index buffer cache key.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Number} options.accessorId The accessor ID corresponding to the index buffer.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {number} options.accessorId The accessor ID corresponding to the index buffer.
  * @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 {FrameState} options.frameState The frame state.
- * @param {Object} [options.draco] The Draco extension object.
- * @param {Boolean} [options.loadBuffer=false] Load index buffer as a GPU index buffer.
- * @param {Boolean} [options.loadTypedArray=false] Load index buffer as a typed array.
+ * @param {object} [options.draco] The Draco extension object.
+ * @param {boolean} [options.loadBuffer=false] Load index buffer as a GPU index buffer.
+ * @param {boolean} [options.loadTypedArray=false] Load index buffer as a typed array.
  *
- * @returns {String} The index buffer cache key.
+ * @returns {string} The index buffer cache key.
  * @private
  */
 ResourceCacheKey.getIndexBufferCacheKey = function (options) {
@@ -484,13 +484,13 @@ ResourceCacheKey.getIndexBufferCacheKey = function (options) {
 /**
  * Gets the image cache key.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Number} options.imageId The image ID.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {number} options.imageId The image ID.
  * @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.
  *
- * @returns {String} The image cache key.
+ * @returns {string} The image cache key.
  * @private
  */
 ResourceCacheKey.getImageCacheKey = function (options) {
@@ -520,15 +520,15 @@ ResourceCacheKey.getImageCacheKey = function (options) {
 /**
  * Gets the texture cache key.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Object} options.textureInfo The texture info object.
+ * @param {object} options Object with the following properties:
+ * @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 {FrameState} options.frameState The frame state.
  *
- * @returns {String} The texture cache key.
+ * @returns {string} The texture cache key.
  * @private
  */
 ResourceCacheKey.getTextureCacheKey = function (options) {

package/Source/Scene/ResourceCacheStatistics.js

@@ -14,7 +14,7 @@ function ResourceCacheStatistics() {
   /**
    * The size of vertex buffers and index buffers loaded in the cache in bytes.
    *
-   * @type {Number}
+   * @type {number}
    * @private
    */
   this.geometryByteLength = 0;
@@ -22,7 +22,7 @@ function ResourceCacheStatistics() {
   /**
    * The size of all textures loaded in the cache in bytes
    *
-   * @type {Number}
+   * @type {number}
    * @private
    */
   this.texturesByteLength = 0;

package/Source/Scene/ResourceLoader.js

@@ -25,7 +25,7 @@ Object.defineProperties(ResourceLoader.prototype, {
    *
    * @memberof ResourceLoader.prototype
    *
-   * @type {Promise.<ResourceLoader>|undefined}
+   * @type {Promise<ResourceLoader>|undefined}
    * @readonly
    * @private
    */
@@ -40,7 +40,7 @@ Object.defineProperties(ResourceLoader.prototype, {
    *
    * @memberof ResourceLoader.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -54,7 +54,7 @@ Object.defineProperties(ResourceLoader.prototype, {
 
 /**
  * Loads the resource.
- * @returns {Promise.<ResourceLoader>} A promise which resolves to the loader when the resource loading is completed.
+ * @returns {Promise<ResourceLoader>} A promise which resolves to the loader when the resource loading is completed.
  * @private
  */
 ResourceLoader.prototype.load = function () {
@@ -78,7 +78,7 @@ ResourceLoader.prototype.process = function (frameState) {};
 /**
  * Constructs a {@link RuntimeError} from an errorMessage and an error.
  *
- * @param {String} errorMessage The error message.
+ * @param {string} errorMessage The error message.
  * @param {Error} [error] The error.
  *
  * @returns {RuntimeError} The runtime error.
@@ -107,7 +107,7 @@ ResourceLoader.prototype.getError = function (errorMessage, error) {
  * 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 ResourceLoader#destroy
  * @private

package/Source/Scene/ResourceLoaderState.js

@@ -7,7 +7,7 @@ const ResourceLoaderState = {
   /**
    * The resource has not yet been loaded.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    * @private
    */
@@ -15,7 +15,7 @@ const ResourceLoaderState = {
   /**
    * The resource is loading. In this state, external resources are fetched as needed.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    * @private
    */
@@ -23,7 +23,7 @@ const ResourceLoaderState = {
   /**
    * The resource has finished loading, but requires further processing. GPU resources are allocated in this state as needed.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    * @private
    */
@@ -31,7 +31,7 @@ const ResourceLoaderState = {
   /**
    * The resource has finished loading and processing; the results are ready to be used.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    * @private
    */
@@ -39,7 +39,7 @@ const ResourceLoaderState = {
   /**
    * The resource loading or processing has failed due to an error.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    * @private
    */

package/Source/Scene/SDFSettings.js

@@ -7,7 +7,7 @@ const SDFSettings = {
   /**
    * The font size in pixels
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   FONT_SIZE: 48.0,
@@ -15,7 +15,7 @@ const SDFSettings = {
   /**
    * Whitespace padding around glyphs.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   PADDING: 10.0,
@@ -23,7 +23,7 @@ const SDFSettings = {
   /**
    * How many pixels around the glyph shape to use for encoding distance
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   RADIUS: 8.0,
@@ -31,7 +31,7 @@ const SDFSettings = {
   /**
    * How much of the radius (relative) is used for the inside part the glyph.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   CUTOFF: 0.25,