@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/GltfLoaderUtil.js

@@ -25,12 +25,12 @@ const GltfLoaderUtil = {};
  * WebP images the WebP image ID is returned.
  * </p>
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Number} options.textureId The texture ID.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {number} options.textureId The texture ID.
  * @param {SupportedImageFormats} options.supportedImageFormats The supported image formats.
  *
- * @returns {Number} The image ID.
+ * @returns {number} The image ID.
  * @private
  */
 GltfLoaderUtil.getImageIdFromTexture = function (options) {
@@ -63,10 +63,10 @@ GltfLoaderUtil.getImageIdFromTexture = function (options) {
 /**
  * Create a sampler for a texture.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.gltf The glTF JSON.
- * @param {Object} options.textureInfo The texture info object.
- * @param {Boolean} [options.compressedTextureNoMipmap=false] True when the texture is compressed and does not have an embedded mipmap.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.gltf The glTF JSON.
+ * @param {object} options.textureInfo The texture info object.
+ * @param {boolean} [options.compressedTextureNoMipmap=false] True when the texture is compressed and does not have an embedded mipmap.
  *
  * @returns {Sampler} The sampler.
  * @private
@@ -137,9 +137,9 @@ const defaultScale = new Cartesian2(1.0, 1.0);
 /**
  * Create a model texture reader.
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.textureInfo The texture info JSON.
- * @param {String} [options.channels] The texture channels to read from.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.textureInfo The texture info JSON.
+ * @param {string} [options.channels] The texture channels to read from.
  * @param {Texture} [options.texture] The texture object.
  *
  * @returns {ModelComponents.TextureReader} The texture reader for this model.

package/Source/Scene/GltfPipeline/addBuffer.js

@@ -3,9 +3,9 @@ import addToArray from "./addToArray.js";
 /**
  * Adds buffer to gltf.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
+ * @param {object} gltf A javascript object containing a glTF asset.
  * @param {Buffer} buffer A Buffer object which will be added to gltf.buffers.
- * @returns {Number} The bufferView id of the newly added bufferView.
+ * @returns {number} The bufferView id of the newly added bufferView.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/addDefaults.js

@@ -8,8 +8,8 @@ import WebGLConstants from "../../Core/WebGLConstants.js";
 /**
  * Adds default glTF values if they don't exist.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @returns {Object} The modified glTF.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @returns {object} The modified glTF.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/addExtensionsRequired.js

@@ -6,8 +6,8 @@ import defined from "../../Core/defined.js";
  * Adds an extension to gltf.extensionsRequired if it does not already exist.
  * Initializes extensionsRequired if it is not defined.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {String} extension The extension to add.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {string} extension The extension to add.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/addExtensionsUsed.js

@@ -5,8 +5,8 @@ import defined from "../../Core/defined.js";
  * Adds an extension to gltf.extensionsUsed if it does not already exist.
  * Initializes extensionsUsed if it is not defined.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {String} extension The extension to add.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {string} extension The extension to add.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/addPipelineExtras.js

@@ -5,8 +5,8 @@ import defined from "../../Core/defined.js";
  * Adds extras._pipeline to each object that can have extras in the glTF asset.
  * This stage runs before updateVersion and handles both glTF 1.0 and glTF 2.0 assets.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @returns {Object} The glTF asset with the added pipeline extras.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @returns {object} The glTF asset with the added pipeline extras.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/addToArray.js

@@ -4,8 +4,8 @@ import defaultValue from "../../Core/defaultValue.js";
  * Adds an element to an array and returns the element's index.
  *
  * @param {Array} array The array to add to.
- * @param {Object} element The element to add.
- * @param {Boolean} [checkDuplicates=false] When <code>true</code>, if a duplicate element is found its index is returned and <code>element</code> is not added to the array.
+ * @param {object} element The element to add.
+ * @param {boolean} [checkDuplicates=false] When <code>true</code>, if a duplicate element is found its index is returned and <code>element</code> is not added to the array.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/findAccessorMinMax.js

@@ -7,8 +7,8 @@ import defined from "../../Core/defined.js";
 /**
  * Finds the min and max values of the accessor.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {Object} accessor The accessor object from the glTF asset to read.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {object} accessor The accessor object from the glTF asset to read.
  * @returns {{min: Array, max: Array}} min holding the array of minimum values and max holding the array of maximum values.
  *
  * @private

package/Source/Scene/GltfPipeline/forEachTextureInMaterial.js

@@ -5,7 +5,7 @@ import defined from "../../Core/defined.js";
 /**
  * Calls the provider handler function on each texture used by the material.
  * Mimics the behavior of functions in gltf-pipeline ForEach.
- * @param {Object} material The glTF material.
+ * @param {object} material The glTF material.
  * @param {forEachTextureInMaterial~handler} handler Function that is called for each texture in the material.
  *
  * @private
@@ -130,8 +130,8 @@ function forEachTextureInMaterial(material, handler) {
 /**
  * Function that is called for each texture in the material. If this function returns a value the for each stops and returns that value.
  * @callback forEachTextureInMaterial~handler
- * @param {Number} The texture index.
- * @param {Object} The texture info object.
+ * @param {number} The texture index.
+ * @param {object} The texture info object.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/getAccessorByteStride.js

@@ -6,9 +6,9 @@ import defined from "../../Core/defined.js";
  * Returns the byte stride of the provided accessor.
  * If the byteStride is 0, it is calculated based on type and componentType
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {Object} accessor The accessor.
- * @returns {Number} The byte stride of the accessor.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {object} accessor The accessor.
+ * @returns {number} The byte stride of the accessor.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/getComponentReader.js

@@ -3,7 +3,7 @@ import ComponentDatatype from "../../Core/ComponentDatatype.js";
 /**
  * Returns a function to read and convert data from a DataView into an array.
  *
- * @param {Number} componentType Type to convert the data to.
+ * @param {number} componentType Type to convert the data to.
  * @returns {ComponentReader} Function that reads and converts data.
  *
  * @private
@@ -136,10 +136,10 @@ function getComponentReader(componentType) {
  * @callback ComponentReader
  *
  * @param {DataView} dataView The data view to read from.
- * @param {Number} byteOffset The byte offset applied when reading from the data view.
- * @param {Number} numberOfComponents The number of components to read.
- * @param {Number} componentTypeByteLength The byte length of each component.
- * @param {Number} result An array storing the components that are read.
+ * @param {number} byteOffset The byte offset applied when reading from the data view.
+ * @param {number} numberOfComponents The number of components to read.
+ * @param {number} componentTypeByteLength The byte length of each component.
+ * @param {number} result An array storing the components that are read.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/moveTechniqueRenderStates.js

@@ -53,8 +53,8 @@ function getSupportedBlendFactors(value, defaultValue) {
 /**
  * Move glTF 1.0 technique render states to glTF 2.0 materials properties and KHR_blend extension.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @returns {Object} The updated glTF asset.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @returns {object} The updated glTF asset.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/moveTechniquesToExtension.js

@@ -7,8 +7,8 @@ import defined from "../../Core/defined.js";
 /**
  * Move glTF 1.0 material techniques to glTF 2.0 KHR_techniques_webgl extension.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @returns {Object} The updated glTF asset.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @returns {object} The updated glTF asset.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/numberOfComponentsForType.js

@@ -3,8 +3,8 @@
 /**
  * Utility function for retrieving the number of components in a given type.
  *
- * @param {String} type glTF type
- * @returns {Number} The number of components in that type.
+ * @param {string} type glTF type
+ * @returns {number} The number of components in that type.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/parseGlb.js

@@ -14,7 +14,7 @@ const sizeOfUint32 = 4;
  * The returned glTF has pipeline extras included. The embedded binary data is stored in gltf.buffers[0].extras._pipeline.source.
  *
  * @param {Buffer} glb The glb data to parse.
- * @returns {Object} A javascript object containing a glTF asset with pipeline extras included.
+ * @returns {object} A javascript object containing a glTF asset with pipeline extras included.
  *
  * @private
  */

package/Source/Scene/GltfPipeline/readAccessorPacked.js

@@ -7,8 +7,8 @@ import defined from "../../Core/defined.js";
 /**
  * Returns the accessor data in a contiguous array.
  *
- * @param {Object} gltf A javascript object containing a glTF asset.
- * @param {Object} accessor The accessor.
+ * @param {object} gltf A javascript object containing a glTF asset.
+ * @param {object} accessor The accessor.
  * @returns {Array} The accessor values in a contiguous array.
  *
  * @private

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
  */