diff --git a/Apps/Sandcastle/gallery/Custom DataSource.html b/Apps/Sandcastle/gallery/Custom DataSource.html index 991d384e2c3b..af5670d6ce76 100644 --- a/Apps/Sandcastle/gallery/Custom DataSource.html +++ b/Apps/Sandcastle/gallery/Custom DataSource.html @@ -41,7 +41,7 @@ * @alias WebGLGlobeDataSource * @constructor * - * @param {String} [name] The name of this data source. If undefined, a name + * @param {string} [name] The name of this data source. If undefined, a name * will be derived from the url. * * @example @@ -144,7 +144,7 @@ /** * Gets the array of series names. * @memberof WebGLGlobeDataSource.prototype - * @type {String[]} + * @type {string[]} */ seriesNames: { get: function () { @@ -226,7 +226,7 @@ /** * Asynchronously loads the GeoJSON at the provided url, replacing any existing data. - * @param {Object} url The url to be processed. + * @param {object} url The url to be processed. * @returns {Promise} a promise that will resolve when the GeoJSON is loaded. */ WebGLGlobeDataSource.prototype.loadUrl = function (url) { diff --git a/Apps/Sandcastle/gallery/Custom Geocoder.html b/Apps/Sandcastle/gallery/Custom Geocoder.html index 2804297cf80e..11a11fd48442 100644 --- a/Apps/Sandcastle/gallery/Custom Geocoder.html +++ b/Apps/Sandcastle/gallery/Custom Geocoder.html @@ -55,7 +55,7 @@ /** * The function called to geocode using this geocoder service. * - * @param {String} input The query to be sent to the geocoder service + * @param {string} input The query to be sent to the geocoder service * @returns {Promise} */ OpenStreetMapNominatimGeocoder.prototype.geocode = function (input) { diff --git a/CHANGES.md b/CHANGES.md index 38aab2d19c43..a2f3f687680b 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -6,12 +6,11 @@ #### Major Announcements :loudspeaker: -##### Additions :tada: - ##### Fixes :wrench: - Fixed Primitive.getGeometryInstanceAttributes cache acquisition speed. [#11066](https://github.com/CesiumGS/cesium/issues/11066) - Fixed requestWebgl1 hint error in context. [#11082](https://github.com/CesiumGS/cesium/issues/11082) +- Replace constructor types with primitive types in JSDoc. [#11080](https://github.com/CesiumGS/cesium/pull/11080) ### 1.102 - 2023-02-01 diff --git a/Documentation/Contributors/DocumentationGuide/README.md b/Documentation/Contributors/DocumentationGuide/README.md index 1f38dc85e7a8..d5b9946158a9 100644 --- a/Documentation/Contributors/DocumentationGuide/README.md +++ b/Documentation/Contributors/DocumentationGuide/README.md @@ -57,7 +57,7 @@ Consider one of the simplest functions in CesiumJS, `defined`: * @function * * @param {*} value The object. - * @returns {Boolean} Returns true if the object is defined, returns false otherwise. + * @returns {boolean} Returns true if the object is defined, returns false otherwise. * * @example * if (Cesium.defined(positions)) { @@ -88,7 +88,7 @@ This guide describes best practices for writing doc. For complete details on JSD - Use `[]` for optional parameters and include the default value, e.g., ```javascript -* @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. +* @param {number} [startingIndex=0] The index into the array at which to start packing the elements. ``` @@ -130,12 +130,12 @@ The CesiumJS classes in the `Type` column are links to their doc. Each property of an `options` parameter (see the [Coding Guide](https://github.com/CesiumGS/cesium/true/main/Documentation/Contributors/CodingGuide/README.md#options-parameters)) should be documented with a separate `@param` tag, e.g., ```javascript - * @param {Object} [options] Object with the following properties: - * @param {Number} [options.length=10000000.0] The length of the axes in meters. - * @param {Number} [options.width=2.0] The width of the axes in pixels. + * @param {object} [options] Object with the following properties: + * @param {number} [options.length=10000000.0] The length of the axes in meters. + * @param {number} [options.width=2.0] The width of the axes in pixels. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 matrix that defines the reference frame, i.e., origin plus axes, to visualize. - * @param {Boolean} [options.show=true] Determines if this primitive will be shown. - * @param {Object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} + * @param {boolean} [options.show=true] Determines if this primitive will be shown. + * @param {object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} ``` generates @@ -168,7 +168,7 @@ Matrix4.computePerspectiveFieldOfView = function(fovY, aspectRatio, near, far, r /** * Computes a Matrix4 instance from a column-major order array. * - * @param {Number[]} values The column-major order array. + * @param {number[]} values The column-major order array. * @param {Matrix4} [result] The object in which the result will be stored. If undefined a new instance will be created. * @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided. */ @@ -287,7 +287,7 @@ function Cartesian3(x, y) { /** * The X component. * - * @type {Number} + * @type {number} * @default 0.0 */ this.x = defaultValue(x, 0.0); @@ -295,25 +295,25 @@ function Cartesian3(x, y) { // ... ``` -- Use `@memberOf` when documenting property getter/setters, e.g., +- Use `@memberof` when documenting property getter/setters, e.g., ```javascript Object.defineProperties(Entity.prototype, { - /** - * Gets or sets whether this entity should be displayed. When set to true, - * the entity is only displayed if the parent entity's show property is also true. - * - * @memberof Entity.prototype - * @type {Boolean} - */ - show : { - get : function() { - // ... - }, - set : function(value) { - // ... - } + /** + * Gets or sets whether this entity should be displayed. When set to true, + * the entity is only displayed if the parent entity's show property is also true. + * + * @memberof Entity.prototype + * @type {boolean} + */ + show: { + get: function() { + // ... }, + set: function(value) { + // ... + } + }, // ... ``` @@ -321,19 +321,19 @@ Object.defineProperties(Entity.prototype, { ```javascript Object.defineProperties(Entity.prototype, { - /** - * Gets the unique ID associated with this object. - * - * @memberof Entity.prototype - * @type {String} - * @readonly - */ - id : { - get : function() { - return this._id; - } - }, - // ... + /** + * Gets the unique ID associated with this object. + * + * @memberof Entity.prototype + * @type {string} + * @readonly + */ + id: { + get: function() { + return this._id; + } + }, + // ... ``` - The description for readonly properties should start with "Gets", and the description for read/write properties should start with "Gets or sets." @@ -358,8 +358,8 @@ Cartesian3.ZERO = Object.freeze(new Cartesian3(0.0, 0.0, 0.0)); * Creates a Cartesian4 from four consecutive elements in an array. * @function * - * @param {Number[]} array The array whose four consecutive elements correspond to the x, y, z, and w components, respectively. - * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. + * @param {number[]} array The array whose four consecutive elements correspond to the x, y, z, and w components, respectively. + * @param {number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. * @param {Cartesian4} [result] The object on which to store the result. * @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided. * @@ -399,13 +399,13 @@ Queue.prototype.sort = function (compareFunction) { * * @param {*} a An item in the array. * @param {*} b An item in the array. - * @returns {Number} Returns a negative value if a is less than b, + * @returns {number} Returns a negative value if a is less than b, * a positive value if a is greater than b, or * 0 if a is equal to b. * * @example * function compareNumbers(a, b) { - * return a - b; + * return a - b; * } */ ``` diff --git a/Specs/ImplicitTilingTester.js b/Specs/ImplicitTilingTester.js index f361813f8dc4..7513a4b497de 100644 --- a/Specs/ImplicitTilingTester.js +++ b/Specs/ImplicitTilingTester.js @@ -10,38 +10,38 @@ function ImplicitTilingTester() {} /** * Description of a single availability bitstream - * @typedef {Object} AvailabilityDescription - * @property {String|Number} descriptor Either a string of 0s and 1s representing the bitstream values, or an integer 0 or 1 to indicate a constant value. - * @property {Number} lengthBits How many bits are in the bitstream. This must be specified, even if descriptor is a string of 0s and 1s - * @property {Boolean} isInternal true if an internal bufferView should be created. false indicates the bufferview is stored in an external buffer instead. - * @property {Boolean} [shareBuffer=false] This is only used for content availability. If true, then the content availability will share the same buffer as the tile availaibility, as this is a common optimization - * @property {Boolean} [includeAvailableCount=false] If true, set availableCount + * @typedef {object} AvailabilityDescription + * @property {string|number} descriptor Either a string of 0s and 1s representing the bitstream values, or an integer 0 or 1 to indicate a constant value. + * @property {number} lengthBits How many bits are in the bitstream. This must be specified, even if descriptor is a string of 0s and 1s + * @property {boolean} isInternal true if an internal bufferView should be created. false indicates the bufferview is stored in an external buffer instead. + * @property {boolean} [shareBuffer=false] This is only used for content availability. If true, then the content availability will share the same buffer as the tile availaibility, as this is a common optimization + * @property {boolean} [includeAvailableCount=false] If true, set availableCount */ /** * A description of metadata properties stored in the subtree. - * @typedef {Object} MetadataDescription - * @property {Boolean} isInternal True if the metadata should be stored in the subtree file, false if the metadata should be stored in an external buffer. + * @typedef {object} MetadataDescription + * @property {boolean} isInternal True if the metadata should be stored in the subtree file, false if the metadata should be stored in an external buffer. * @property {Array} propertyTables Array of property table objects to pass into {@link MetadataTester.createPropertyTables} in order to create the property table buffer views. * @private */ /** * A JSON description of a subtree file for easier generation - * @typedef {Object} SubtreeDescription - * @property {Boolean} [useLegacySchema=false] If true, the resulting JSON chunk will use the legacy schema for subtrees and metadata (e.g. use bufferViews rather than bitstream, use 3DTILES_metadata extension rather than tileMetadata or contentMetadata, use 3DTILES_multiple_contents extension rather than contents). Used to test backwards compatibility. + * @typedef {object} SubtreeDescription + * @property {boolean} [useLegacySchema=false] If true, the resulting JSON chunk will use the legacy schema for subtrees and metadata (e.g. use bufferViews rather than bitstream, use 3DTILES_metadata extension rather than tileMetadata or contentMetadata, use 3DTILES_multiple_contents extension rather than contents). Used to test backwards compatibility. * @property {AvailabilityDescription} tileAvailability A description of the tile availability bitstream to generate * @property {AvailabilityDescription} contentAvailability A description of the content availability bitstream to generate * @property {AvailabilityDescription} childSubtreeAvailability A description of the child subtree availability bitstream to generate * @property {AvailabilityDescription} other A description of another bitstream. This is not used for availability, but rather to simulate extra buffer views. * @property {MetadataDescription} [metadata] For testing metadata, additional options can be passed in here. - * @property {Boolean} [json] If true, return the result as a JSON with external buffers. Should not be true if any of the availability buffers are internal. + * @property {boolean} [json] If true, return the result as a JSON with external buffers. Should not be true if any of the availability buffers are internal. * @private */ /** * Results of procedurally generating a subtree. - * @typedef {Object} GeneratedSubtree + * @typedef {object} GeneratedSubtree * @property {Uint8Array} [subtreeJson] The JSON portion of the subtree file. Mutually exclusive with subtreeBuffer. * @property {Uint8Array} [subtreeBuffer] A typed array storing the contents of the subtree file (including the internal buffer). Mutually exclusive with subtreeJson. * @property {Uint8Array} externalBuffer A typed array representing an external .bin file. This is always returned, but it may be an empty typed array. @@ -51,7 +51,7 @@ function ImplicitTilingTester() {} /** * Generate a subtree buffer * @param {SubtreeDescription} subtreeDescription A JSON description of the subtree's structure and values - * @param {Boolean} constantOnly true if all the bitstreams are constant, i.e. no buffers/bufferViews are needed. + * @param {boolean} constantOnly true if all the bitstreams are constant, i.e. no buffers/bufferViews are needed. * @return {GeneratedSubtree} The procedurally generated subtree and an external buffer. * * @example diff --git a/build.js b/build.js index f14aed2b94ba..b91e0cb4808f 100644 --- a/build.js +++ b/build.js @@ -144,24 +144,24 @@ export async function getFilesFromWorkspaceGlobs(workspaceGlobs) { } /** - * @typedef {Object} CesiumBundles - * @property {Object} esmBundle The ESM bundle. - * @property {Object} iifeBundle The IIFE bundle, for use in browsers. - * @property {Object} nodeBundle The CommonJS bundle, for use in NodeJS. + * @typedef {object} CesiumBundles + * @property {object} esmBundle The ESM bundle. + * @property {object} iifeBundle The IIFE bundle, for use in browsers. + * @property {object} nodeBundle The CommonJS bundle, for use in NodeJS. */ /** * Bundles all individual modules, optionally minifying and stripping out debug pragmas. - * @param {Object} options - * @param {String} options.path Directory where build artifacts are output - * @param {Boolean} [options.minify=false] true if the output should be minified - * @param {Boolean} [options.removePragmas=false] true if the output should have debug pragmas stripped out - * @param {Boolean} [options.sourcemap=false] true if an external sourcemap should be generated - * @param {Boolean} [options.iife=false] true if an IIFE style module should be built - * @param {Boolean} [options.node=false] true if a CJS style node module should be built - * @param {Boolean} [options.incremental=false] true if build output should be cached for repeated builds - * @param {Boolean} [options.write=true] true if build output should be written to disk. If false, the files that would have been written as in-memory buffers - * @returns {Promise.} + * @param {object} options + * @param {string} options.path Directory where build artifacts are output + * @param {boolean} [options.minify=false] true if the output should be minified + * @param {boolean} [options.removePragmas=false] true if the output should have debug pragmas stripped out + * @param {boolean} [options.sourcemap=false] true if an external sourcemap should be generated + * @param {boolean} [options.iife=false] true if an IIFE style module should be built + * @param {boolean} [options.node=false] true if a CJS style node module should be built + * @param {boolean} [options.incremental=false] true if build output should be cached for repeated builds + * @param {boolean} [options.write=true] true if build output should be written to disk. If false, the files that would have been written as in-memory buffers + * @returns {Promise} */ export async function bundleCesiumJs(options) { const buildConfig = defaultESBuildOptions(); @@ -245,9 +245,9 @@ const workspaceSourceFiles = { /** * Generates export declaration from a file from a workspace. * - * @param {String} workspace The workspace the file belongs to. - * @param {String} file The file. - * @returns {String} The export declaration. + * @param {string} workspace The workspace the file belongs to. + * @param {string} file The file. + * @returns {string} The export declaration. */ function generateDeclaration(workspace, file) { let assignmentName = path.basename(file, path.extname(file)); @@ -319,11 +319,11 @@ function rollupWarning(message) { } /** - * @param {Object} options + * @param {object} options * @param {boolean} [options.minify=false] true if the worker output should be minified * @param {boolean} [options.removePragmas=false] true if debug pragma should be removed * @param {boolean} [options.sourcemap=false] true if an external sourcemap should be generated - * @param {String} options.path output directory + * @param {string} options.path output directory */ export async function bundleCombinedWorkers(options) { // Bundle non ES6 workers. @@ -386,15 +386,15 @@ export async function bundleCombinedWorkers(options) { /** * Bundles the workers and outputs the result to the specified directory - * @param {Object} options + * @param {object} options * @param {boolean} [options.minify=false] true if the worker output should be minified * @param {boolean} [options.removePragmas=false] true if debug pragma should be removed * @param {boolean} [options.sourcemap=false] true if an external sourcemap should be generated - * @param {Array.} options.input The worker globs. - * @param {Array.} options.inputES6 The ES6 worker globs. - * @param {String} options.path output directory - * @param {String} options.copyrightHeader The copyright header to add to worker bundles - * @returns {Promise.<*>} + * @param {string[]} options.input The worker globs. + * @param {string[]} options.inputES6 The ES6 worker globs. + * @param {string} options.path output directory + * @param {string} options.copyrightHeader The copyright header to add to worker bundles + * @returns {Promise} */ export async function bundleWorkers(options) { // Copy existing workers @@ -621,8 +621,8 @@ const externalResolvePlugin = { /** * Creates a template html file in the Sandcastle app listing the gallery of demos - * @param {Boolean} [noDevelopmentGallery=false] true if the development gallery should not be included in the list - * @returns {Promise.<*>} + * @param {boolean} [noDevelopmentGallery=false] true if the development gallery should not be included in the list + * @returns {Promise} */ export async function createGalleryList(noDevelopmentGallery) { const demoObjects = []; @@ -721,10 +721,10 @@ const has_new_gallery_demos = ${newDemos.length > 0 ? "true;" : "false;"}\n`; /** * Helper function to copy files. * - * @param {Array.} globs The file globs to be copied. - * @param {String} destination The path to copy the files to. - * @param {String} base The base path to omit from the globs when files are copied. Defaults to "". - * @returns {Promise.} A promise containing the stream output as a buffer. + * @param {string[]} globs The file globs to be copied. + * @param {string} destination The path to copy the files to. + * @param {string} base The base path to omit from the globs when files are copied. Defaults to "". + * @returns {Promise} A promise containing the stream output as a buffer. */ export async function copyFiles(globs, destination, base) { const stream = gulp @@ -737,8 +737,8 @@ export async function copyFiles(globs, destination, base) { /** * Copy assets from engine. * - * @param {String} destination The path to copy files to. - * @returns {Promise.<>} A promise that completes when all assets are copied to the destination. + * @param {string} destination The path to copy files to. + * @returns {Promise} A promise that completes when all assets are copied to the destination. */ export async function copyEngineAssets(destination) { const engineStaticAssets = [ @@ -765,8 +765,8 @@ export async function copyEngineAssets(destination) { /** * Copy assets from widgets. * - * @param {String} destination The path to copy files to. - * @returns {Promise.<>} A promise that completes when all assets are copied to the destination. + * @param {string} destination The path to copy files to. + * @returns {Promise} A promise that completes when all assets are copied to the destination. */ export async function copyWidgetsAssets(destination) { const widgetsStaticAssets = [ @@ -805,10 +805,10 @@ export async function createJsHintOptions() { /** * Bundles spec files for testing in the browser and on the command line with karma. - * @param {Object} options - * @param {Boolean} [options.incremental=false] true if the build should be cached for repeated rebuilds - * @param {Boolean} [options.write=false] true if build output should be written to disk. If false, the files that would have been written as in-memory buffers - * @returns {Promise.<*>} + * @param {object} options + * @param {boolean} [options.incremental=false] true if the build should be cached for repeated rebuilds + * @param {boolean} [options.write=false] true if build output should be written to disk. If false, the files that would have been written as in-memory buffers + * @returns {Promise} */ export function bundleCombinedSpecs(options) { options = options || {}; @@ -834,7 +834,7 @@ export function bundleCombinedSpecs(options) { /** * Creates the index.js for a package. * - * @param {String} workspace The workspace to create the index.js for. + * @param {string} workspace The workspace to create the index.js for. * @returns */ async function createIndexJs(workspace) { @@ -873,9 +873,9 @@ async function createIndexJs(workspace) { /** * Creates a single entry point file by importing all individual spec files. - * @param {Array.} files The individual spec files. - * @param {String} workspace The workspace. - * @param {String} outputPath The path the file is written to. + * @param {string[]} files The individual spec files. + * @param {string} workspace The workspace. + * @param {string} outputPath The path the file is written to. */ async function createSpecListForWorkspace(files, workspace, outputPath) { let contents = ""; @@ -896,12 +896,12 @@ async function createSpecListForWorkspace(files, workspace, outputPath) { /** * Bundles CSS files. * - * @param {Object} options - * @param {Array.} options.filePaths The file paths to bundle. - * @param {Boolean} options.sourcemap - * @param {Boolean} options.minify - * @param {String} options.outdir The output directory. - * @param {String} options.outbase The + * @param {object} options + * @param {string[]} options.filePaths The file paths to bundle. + * @param {boolean} options.sourcemap + * @param {boolean} options.minify + * @param {string} options.outdir The output directory. + * @param {string} options.outbase The */ async function bundleCSS(options) { // Configure options for esbuild. @@ -927,13 +927,13 @@ const workspaceCssFiles = { /** * Bundles spec files for testing in the browser. * - * @param {Object} options - * @param {Boolean} [options.incremental=false] True if builds should be generated incrementally. - * @param {String} options.outbase The base path the output files are relative to. - * @param {String} options.outdir The directory to place the output in. - * @param {String} options.specListFile The path to the SpecList.js file - * @param {Boolean} [options.write=true] True if bundles generated are written to files instead of in-memory buffers. - * @returns {Object} The bundle generated from Specs. + * @param {object} options + * @param {boolean} [options.incremental=false] True if builds should be generated incrementally. + * @param {string} options.outbase The base path the output files are relative to. + * @param {string} options.outdir The directory to place the output in. + * @param {string} options.specListFile The path to the SpecList.js file + * @param {boolean} [options.write=true] True if bundles generated are written to files instead of in-memory buffers. + * @returns {object} The bundle generated from Specs. */ async function bundleSpecs(options) { const incremental = options.incremental ?? true; @@ -967,10 +967,10 @@ async function bundleSpecs(options) { /** * Builds the engine workspace. * - * @param {Object} options - * @param {Boolean} [options.incremental=false] True if builds should be generated incrementally. - * @param {Boolean} [options.minify=false] True if bundles should be minified. - * @param {Boolean} [options.write=true] True if bundles generated are written to files instead of in-memory buffers. + * @param {object} options + * @param {boolean} [options.incremental=false] True if builds should be generated incrementally. + * @param {boolean} [options.minify=false] True if bundles should be minified. + * @param {boolean} [options.write=true] True if bundles generated are written to files instead of in-memory buffers. */ export const buildEngine = async (options) => { options = options || {}; @@ -1018,9 +1018,9 @@ export const buildEngine = async (options) => { /** * Builds the widgets workspace. * - * @param {Object} options - * @param {Boolean} [options.incremental=false] True if builds should be generated incrementally. - * @param {Boolean} [options.write=true] True if bundles generated are written to files instead of in-memory buffers. + * @param {object} options + * @param {boolean} [options.incremental=false] True if builds should be generated incrementally. + * @param {boolean} [options.write=true] True if bundles generated are written to files instead of in-memory buffers. */ export const buildWidgets = async (options) => { options = options || {}; @@ -1052,16 +1052,16 @@ export const buildWidgets = async (options) => { /** * Build CesiumJS. * - * @param {Object} options - * @param {Boolean} [options.development=true] True if build is targeted for development. - * @param {Boolean} [options.iife=true] True if IIFE bundle should be generated. - * @param {Boolean} [options.incremental=true] True if builds should be generated incrementally. - * @param {Boolean} [options.minify=false] True if bundles should be minified. - * @param {Boolean} [options.node=true] True if CommonJS bundle should be generated. - * @param {Boolean} options.outputDirectory The directory where the output should go. - * @param {Boolean} [options.removePragmas=false] True if debug pragmas should be removed. - * @param {Boolean} [options.sourcemap=true] True if sourcemap should be included in the generated bundles. - * @param {Boolean} [options.write=true] True if bundles generated are written to files instead of in-memory buffers. + * @param {object} options + * @param {boolean} [options.development=true] True if build is targeted for development. + * @param {boolean} [options.iife=true] True if IIFE bundle should be generated. + * @param {boolean} [options.incremental=true] True if builds should be generated incrementally. + * @param {boolean} [options.minify=false] True if bundles should be minified. + * @param {boolean} [options.node=true] True if CommonJS bundle should be generated. + * @param {boolean} options.outputDirectory The directory where the output should go. + * @param {boolean} [options.removePragmas=false] True if debug pragmas should be removed. + * @param {boolean} [options.sourcemap=true] True if sourcemap should be included in the generated bundles. + * @param {boolean} [options.write=true] True if bundles generated are written to files instead of in-memory buffers. */ export async function buildCesium(options) { const development = options.development ?? true; diff --git a/gulpfile.js b/gulpfile.js index a31f29bfc609..f877b500801e 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -499,7 +499,7 @@ export const release = gulp.series( * Removes scripts from package.json files to ensure that * they still work when run from within the ZIP file. * - * @param {String} packageJsonPath The path to the package.json. + * @param {string} packageJsonPath The path to the package.json. * @returns {WritableStream} A stream that writes to the updated package.json file. */ async function pruneScriptsForZip(packageJsonPath) { @@ -1250,15 +1250,15 @@ async function setStatus(state, targetUrl, description, context) { /** * Generates coverage report. * - * @param {Object} options An object with the following properties: - * @param {String} options.outputDirectory The output directory for the generated build artifacts. - * @param {String} options.coverageDirectory The path where the coverage reports should be saved to. - * @param {String} options.specList The path to the spec list for the package. + * @param {object} options An object with the following properties: + * @param {string} options.outputDirectory The output directory for the generated build artifacts. + * @param {string} options.coverageDirectory The path where the coverage reports should be saved to. + * @param {string} options.specList The path to the spec list for the package. * @param {RegExp} options.filter The filter for finding which files should be instrumented. - * @param {Boolean} [options.webglStub=false] True if WebGL stub should be used when running tests. - * @param {Boolean} [options.suppressPassed=false] True if output should be suppressed for tests that pass. - * @param {Boolean} [options.failTaskOnError=false] True if the gulp task should fail on errors in the tests. - * @param {String} options.workspace The name of the workspace, if any. + * @param {boolean} [options.webglStub=false] True if WebGL stub should be used when running tests. + * @param {boolean} [options.suppressPassed=false] True if output should be suppressed for tests that pass. + * @param {boolean} [options.failTaskOnError=false] True if the gulp task should fail on errors in the tests. + * @param {string} options.workspace The name of the workspace, if any. */ export async function runCoverage(options) { const webglStub = options.webglStub ?? false; @@ -1635,7 +1635,7 @@ export async function test() { * Generates TypeScript definition file (.d.ts) for a package. * * @param {*} workspaceName - * @param {String} definitionsPath The path of the .d.ts file to generate. + * @param {string} definitionsPath The path of the .d.ts file to generate. * @param {*} configurationPath * @param {*} processSourceFunc * @param {*} processModulesFunc @@ -1920,9 +1920,9 @@ ${source} /** * Reads `ThirdParty.extra.json` file - * @param path {string} Path to `ThirdParty.extra.json` - * @param discoveredDependencies {Array} List of previously discovered modules - * @returns {Promise>} A promise to an array of objects with 'name`, `license`, and `url` strings + * @param {string} path Path to `ThirdParty.extra.json` + * @param {string[]} discoveredDependencies List of previously discovered modules + * @returns {Promise} A promise to an array of objects with 'name`, `license`, and `url` strings */ async function getLicenseDataFromThirdPartyExtra(path, discoveredDependencies) { if (!existsSync(path)) { @@ -1973,10 +1973,10 @@ async function getLicenseDataFromThirdPartyExtra(path, discoveredDependencies) { /** * Extracts name, license, and url from `package.json` file. * - * @param packageName {string} Name of package - * @param discoveredDependencies {Array} List of previously discovered modules - * @param licenseOverride {Array} If specified, override info fetched from package.json. Useful in the case where there are multiple licenses and we might chose a single one. - * @returns {Promise} A promise to an object with 'name`, `license`, and `url` strings + * @param {string} packageName Name of package + * @param {string[]} discoveredDependencies List of previously discovered modules + * @param {string[]} licenseOverride If specified, override info fetched from package.json. Useful in the case where there are multiple licenses and we might chose a single one. + * @returns {Promise} A promise to an object with 'name`, `license`, and `url` strings */ async function getLicenseDataFromPackage( packageJson, diff --git a/packages/engine/Source/Core/ApproximateTerrainHeights.js b/packages/engine/Source/Core/ApproximateTerrainHeights.js index 007fe0501e7d..6b1891ddc827 100644 --- a/packages/engine/Source/Core/ApproximateTerrainHeights.js +++ b/packages/engine/Source/Core/ApproximateTerrainHeights.js @@ -36,7 +36,7 @@ const ApproximateTerrainHeights = {}; /** * Initializes the minimum and maximum terrain heights - * @return {Promise.} + * @return {Promise} */ ApproximateTerrainHeights.initialize = function () { let initPromise = ApproximateTerrainHeights._initPromise; @@ -57,7 +57,7 @@ ApproximateTerrainHeights.initialize = function () { * Computes the minimum and maximum terrain heights for a given rectangle * @param {Rectangle} rectangle The bounding rectangle * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid - * @return {{minimumTerrainHeight: Number, maximumTerrainHeight: Number}} + * @return {{minimumTerrainHeight: number, maximumTerrainHeight: number}} */ ApproximateTerrainHeights.getMinimumMaximumHeights = function ( rectangle, @@ -243,7 +243,7 @@ Object.defineProperties(ApproximateTerrainHeights, { /** * Determines if the terrain heights are initialized and ready to use. To initialize the terrain heights, * call {@link ApproximateTerrainHeights#initialize} and wait for the returned promise to resolve. - * @type {Boolean} + * @type {boolean} * @readonly * @memberof ApproximateTerrainHeights */ diff --git a/packages/engine/Source/Core/ArcGISTiledElevationTerrainProvider.js b/packages/engine/Source/Core/ArcGISTiledElevationTerrainProvider.js index 5d20a5b5eb26..df8ea1dfbe11 100644 --- a/packages/engine/Source/Core/ArcGISTiledElevationTerrainProvider.js +++ b/packages/engine/Source/Core/ArcGISTiledElevationTerrainProvider.js @@ -28,9 +28,9 @@ const ALL_CHILDREN = 15; * @alias ArcGISTiledElevationTerrainProvider * @constructor * - * @param {Object} options Object with the following properties: - * @param {Resource|String|Promise|Promise} options.url The URL of the ArcGIS ImageServer service. - * @param {String} [options.token] The authorization token to use to connect to the service. + * @param {object} options Object with the following properties: + * @param {Resource|string|Promise|Promise} options.url The URL of the ArcGIS ImageServer service. + * @param {string} [options.token] The authorization token to use to connect to the service. * @param {Ellipsoid} [options.ellipsoid] The ellipsoid. If the tilingScheme is specified, * this parameter is ignored and the tiling scheme's ellipsoid is used instead. * If neither parameter is specified, the WGS84 ellipsoid is used. @@ -271,7 +271,7 @@ Object.defineProperties(ArcGISTiledElevationTerrainProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof ArcGISTiledElevationTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -283,7 +283,7 @@ Object.defineProperties(ArcGISTiledElevationTerrainProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof ArcGISTiledElevationTerrainProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -298,7 +298,7 @@ Object.defineProperties(ArcGISTiledElevationTerrainProvider.prototype, { * as a reflective surface with animated waves. This function should not be * called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true. * @memberof ArcGISTiledElevationTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasWaterMask: { @@ -311,7 +311,7 @@ Object.defineProperties(ArcGISTiledElevationTerrainProvider.prototype, { * Gets a value indicating whether or not the requested tiles include vertex normals. * This function should not be called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true. * @memberof ArcGISTiledElevationTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasVertexNormals: { @@ -347,11 +347,11 @@ Object.defineProperties(ArcGISTiledElevationTerrainProvider.prototype, { * {@link ArcGISTiledElevationTerrainProvider#ready} returns true. The result includes terrain * data and indicates that all child tiles are available. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @param {Request} [request] The request object. Intended for internal use only. - * @returns {Promise.|undefined} A promise for the requested geometry. If this method + * @returns {Promise|undefined} A promise for the requested geometry. If this method * returns undefined instead of a promise, it is an indication that too many requests are already * pending and the request will be retried later. */ @@ -459,8 +459,8 @@ function isTileAvailable(that, level, x, y) { /** * Gets the maximum geometric error allowed in a tile at a given level. * - * @param {Number} level The tile level for which to get the maximum geometric error. - * @returns {Number} The maximum geometric error. + * @param {number} level The tile level for which to get the maximum geometric error. + * @returns {number} The maximum geometric error. */ ArcGISTiledElevationTerrainProvider.prototype.getLevelMaximumGeometricError = function ( level @@ -479,10 +479,10 @@ ArcGISTiledElevationTerrainProvider.prototype.getLevelMaximumGeometricError = fu /** * Determines whether data for a tile is available to be loaded. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. - * @returns {Boolean|undefined} Undefined if not supported, otherwise true or false. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. + * @returns {boolean|undefined} Undefined if not supported, otherwise true or false. */ ArcGISTiledElevationTerrainProvider.prototype.getTileDataAvailable = function ( x, @@ -506,9 +506,9 @@ ArcGISTiledElevationTerrainProvider.prototype.getTileDataAvailable = function ( /** * Makes sure we load availability data for a tile * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @returns {undefined} This provider does not support loading availability. */ ArcGISTiledElevationTerrainProvider.prototype.loadTileDataAvailability = function ( diff --git a/packages/engine/Source/Core/ArcType.js b/packages/engine/Source/Core/ArcType.js index dd2e9007ccc9..a1b9f80a8038 100644 --- a/packages/engine/Source/Core/ArcType.js +++ b/packages/engine/Source/Core/ArcType.js @@ -1,13 +1,13 @@ /** * ArcType defines the path that should be taken connecting vertices. * - * @enum {Number} + * @enum {number} */ const ArcType = { /** * Straight line that does not conform to the surface of the ellipsoid. * - * @type {Number} + * @type {number} * @constant */ NONE: 0, @@ -15,7 +15,7 @@ const ArcType = { /** * Follow geodesic path. * - * @type {Number} + * @type {number} * @constant */ GEODESIC: 1, @@ -23,7 +23,7 @@ const ArcType = { /** * Follow rhumb or loxodrome path. * - * @type {Number} + * @type {number} * @constant */ RHUMB: 2, diff --git a/packages/engine/Source/Core/ArticulationStageType.js b/packages/engine/Source/Core/ArticulationStageType.js index 890b6419bb64..7c4c64c303e9 100644 --- a/packages/engine/Source/Core/ArticulationStageType.js +++ b/packages/engine/Source/Core/ArticulationStageType.js @@ -3,7 +3,7 @@ * in the AGI_articulations extension. * * @alias {ArticulationStageType} - * @enum {String} + * @enum {string} * * @private */ diff --git a/packages/engine/Source/Core/AssociativeArray.js b/packages/engine/Source/Core/AssociativeArray.js index 05ae77414746..1012807e8c09 100644 --- a/packages/engine/Source/Core/AssociativeArray.js +++ b/packages/engine/Source/Core/AssociativeArray.js @@ -17,7 +17,7 @@ Object.defineProperties(AssociativeArray.prototype, { * Gets the number of items in the collection. * @memberof AssociativeArray.prototype * - * @type {Number} + * @type {number} */ length: { get: function () { @@ -42,8 +42,8 @@ Object.defineProperties(AssociativeArray.prototype, { /** * Determines if the provided key is in the array. * - * @param {String|Number} key The key to check. - * @returns {Boolean} true if the key is in the array, false otherwise. + * @param {string|number} key The key to check. + * @returns {boolean} true if the key is in the array, false otherwise. */ AssociativeArray.prototype.contains = function (key) { //>>includeStart('debug', pragmas.debug); @@ -58,7 +58,7 @@ AssociativeArray.prototype.contains = function (key) { * Associates the provided key with the provided value. If the key already * exists, it is overwritten with the new value. * - * @param {String|Number} key A unique identifier. + * @param {string|number} key A unique identifier. * @param {*} value The value to associate with the provided key. */ AssociativeArray.prototype.set = function (key, value) { @@ -79,7 +79,7 @@ AssociativeArray.prototype.set = function (key, value) { /** * Retrieves the value associated with the provided key. * - * @param {String|Number} key The key whose value is to be retrieved. + * @param {string|number} key The key whose value is to be retrieved. * @returns {*} The associated value, or undefined if the key does not exist in the collection. */ AssociativeArray.prototype.get = function (key) { @@ -94,8 +94,8 @@ AssociativeArray.prototype.get = function (key) { /** * Removes a key-value pair from the collection. * - * @param {String|Number} key The key to be removed. - * @returns {Boolean} True if it was removed, false if the key was not in the collection. + * @param {string|number} key The key to be removed. + * @returns {boolean} True if it was removed, false if the key was not in the collection. */ AssociativeArray.prototype.remove = function (key) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/AttributeCompression.js b/packages/engine/Source/Core/AttributeCompression.js index b53fc598b38b..b6b521cc0097 100644 --- a/packages/engine/Source/Core/AttributeCompression.js +++ b/packages/engine/Source/Core/AttributeCompression.js @@ -28,7 +28,7 @@ const AttributeCompression = {}; * * @param {Cartesian3} vector The normalized vector to be compressed into 2 component 'oct' encoding. * @param {Cartesian2} result The 2 component oct-encoded unit length vector. - * @param {Number} rangeMax The maximum value of the SNORM range. The encoded vector is stored in log2(rangeMax+1) bits. + * @param {number} rangeMax The maximum value of the SNORM range. The encoded vector is stored in log2(rangeMax+1) bits. * @returns {Cartesian2} The 2 component oct-encoded unit length vector. * * @exception {DeveloperError} vector must be normalized. @@ -106,9 +106,9 @@ AttributeCompression.octEncodeToCartesian4 = function (vector, result) { /** * Decodes a unit-length vector in 'oct' encoding to a normalized 3-component vector. * - * @param {Number} x The x component of the oct-encoded unit length vector. - * @param {Number} y The y component of the oct-encoded unit length vector. - * @param {Number} rangeMax The maximum value of the SNORM range. The encoded vector is stored in log2(rangeMax+1) bits. + * @param {number} x The x component of the oct-encoded unit length vector. + * @param {number} y The y component of the oct-encoded unit length vector. + * @param {number} rangeMax The maximum value of the SNORM range. The encoded vector is stored in log2(rangeMax+1) bits. * @param {Cartesian3} result The decoded and normalized vector * @returns {Cartesian3} The decoded and normalized vector. * @@ -142,8 +142,8 @@ AttributeCompression.octDecodeInRange = function (x, y, rangeMax, result) { /** * Decodes a unit-length vector in 2 byte 'oct' encoding to a normalized 3-component vector. * - * @param {Number} x The x component of the oct-encoded unit length vector. - * @param {Number} y The y component of the oct-encoded unit length vector. + * @param {number} x The x component of the oct-encoded unit length vector. + * @param {number} y The y component of the oct-encoded unit length vector. * @param {Cartesian3} result The decoded and normalized vector. * @returns {Cartesian3} The decoded and normalized vector. * @@ -202,7 +202,7 @@ AttributeCompression.octDecodeFromCartesian4 = function (encoded, result) { * Packs an oct encoded vector into a single floating-point number. * * @param {Cartesian2} encoded The oct encoded vector. - * @returns {Number} The oct encoded vector packed into a single float. + * @returns {number} The oct encoded vector packed into a single float. * */ AttributeCompression.octPackFloat = function (encoded) { @@ -219,7 +219,7 @@ const scratchEncodeCart2 = new Cartesian2(); * stores those values in a single float-point number. * * @param {Cartesian3} vector The normalized vector to be compressed into 2 byte 'oct' encoding. - * @returns {Number} The 2 byte oct-encoded unit length vector. + * @returns {number} The 2 byte oct-encoded unit length vector. * * @exception {DeveloperError} vector must be normalized. */ @@ -231,7 +231,7 @@ AttributeCompression.octEncodeFloat = function (vector) { /** * Decodes a unit-length vector in 'oct' encoding packed in a floating-point number to a normalized 3-component vector. * - * @param {Number} value The oct-encoded unit length vector stored as a single floating-point number. + * @param {number} value The oct-encoded unit length vector stored as a single floating-point number. * @param {Cartesian3} result The decoded and normalized vector * @returns {Cartesian3} The decoded and normalized vector. * @@ -309,7 +309,7 @@ AttributeCompression.octUnpack = function (packed, v1, v2, v3) { * Pack texture coordinates into a single float. The texture coordinates will only preserve 12 bits of precision. * * @param {Cartesian2} textureCoordinates The texture coordinates to compress. Both coordinates must be in the range 0.0-1.0. - * @returns {Number} The packed texture coordinates. + * @returns {number} The packed texture coordinates. * */ AttributeCompression.compressTextureCoordinates = function ( @@ -328,7 +328,7 @@ AttributeCompression.compressTextureCoordinates = function ( /** * Decompresses texture coordinates that were packed into a single float. * - * @param {Number} compressed The compressed texture coordinates. + * @param {number} compressed The compressed texture coordinates. * @param {Cartesian2} result The decompressed texture coordinates. * @returns {Cartesian2} The modified result parameter. * @@ -414,7 +414,7 @@ AttributeCompression.zigZagDeltaDecode = function ( * @param {Int8Array|Uint8Array|Int16Array|Uint16Array|Int32Array|Uint32Array} typedArray The typed array for the quantized data. * @param {ComponentDatatype} componentDatatype The component datatype of the quantized data. * @param {AttributeType} type The attribute type of the quantized data. - * @param {Number} count The number of attributes referenced in the dequantized array. + * @param {number} count The number of attributes referenced in the dequantized array. * * @returns {Float32Array} The dequantized array. */ diff --git a/packages/engine/Source/Core/AxisAlignedBoundingBox.js b/packages/engine/Source/Core/AxisAlignedBoundingBox.js index cb8441938b5b..41af002cd3c8 100644 --- a/packages/engine/Source/Core/AxisAlignedBoundingBox.js +++ b/packages/engine/Source/Core/AxisAlignedBoundingBox.js @@ -164,7 +164,7 @@ AxisAlignedBoundingBox.clone = function (box, result) { * * @param {AxisAlignedBoundingBox} [left] The first AxisAlignedBoundingBox. * @param {AxisAlignedBoundingBox} [right] The second AxisAlignedBoundingBox. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ AxisAlignedBoundingBox.equals = function (left, right) { return ( @@ -251,7 +251,7 @@ AxisAlignedBoundingBox.prototype.intersectPlane = function (plane) { * true if they are equal, false otherwise. * * @param {AxisAlignedBoundingBox} [right] The right hand side AxisAlignedBoundingBox. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ AxisAlignedBoundingBox.prototype.equals = function (right) { return AxisAlignedBoundingBox.equals(this, right); diff --git a/packages/engine/Source/Core/BingMapsGeocoderService.js b/packages/engine/Source/Core/BingMapsGeocoderService.js index a1026f61d701..9be3c9771801 100644 --- a/packages/engine/Source/Core/BingMapsGeocoderService.js +++ b/packages/engine/Source/Core/BingMapsGeocoderService.js @@ -12,9 +12,9 @@ const url = "https://dev.virtualearth.net/REST/v1/Locations"; * @alias BingMapsGeocoderService * @constructor * - * @param {Object} options Object with the following properties: - * @param {String} options.key A key to use with the Bing Maps geocoding service - * @param {String} [options.culture] A Bing Maps {@link https://docs.microsoft.com/en-us/bingmaps/rest-services/common-parameters-and-types/supported-culture-codes|Culture Code} to return results in a specific culture and language. + * @param {object} options Object with the following properties: + * @param {string} options.key A key to use with the Bing Maps geocoding service + * @param {string} [options.culture] A Bing Maps {@link https://docs.microsoft.com/en-us/bingmaps/rest-services/common-parameters-and-types/supported-culture-codes|Culture Code} to return results in a specific culture and language. */ function BingMapsGeocoderService(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -44,7 +44,7 @@ function BingMapsGeocoderService(options) { Object.defineProperties(BingMapsGeocoderService.prototype, { /** * The URL endpoint for the Bing geocoder service - * @type {String} + * @type {string} * @memberof BingMapsGeocoderService.prototype * @readonly */ @@ -56,7 +56,7 @@ Object.defineProperties(BingMapsGeocoderService.prototype, { /** * The key for the Bing geocoder service - * @type {String} + * @type {string} * @memberof BingMapsGeocoderService.prototype * @readonly */ @@ -70,7 +70,7 @@ Object.defineProperties(BingMapsGeocoderService.prototype, { /** * @function * - * @param {String} query The query to be sent to the geocoder service + * @param {string} query The query to be sent to the geocoder service * @returns {Promise} */ BingMapsGeocoderService.prototype.geocode = function (query) { diff --git a/packages/engine/Source/Core/BoundingRectangle.js b/packages/engine/Source/Core/BoundingRectangle.js index 4c858c1f418a..f0a1881613ef 100644 --- a/packages/engine/Source/Core/BoundingRectangle.js +++ b/packages/engine/Source/Core/BoundingRectangle.js @@ -12,10 +12,10 @@ import Rectangle from "./Rectangle.js"; * @alias BoundingRectangle * @constructor * - * @param {Number} [x=0.0] The x coordinate of the rectangle. - * @param {Number} [y=0.0] The y coordinate of the rectangle. - * @param {Number} [width=0.0] The width of the rectangle. - * @param {Number} [height=0.0] The height of the rectangle. + * @param {number} [x=0.0] The x coordinate of the rectangle. + * @param {number} [y=0.0] The y coordinate of the rectangle. + * @param {number} [width=0.0] The width of the rectangle. + * @param {number} [height=0.0] The height of the rectangle. * * @see BoundingSphere * @see Packable @@ -23,28 +23,28 @@ import Rectangle from "./Rectangle.js"; function BoundingRectangle(x, y, width, height) { /** * The x coordinate of the rectangle. - * @type {Number} + * @type {number} * @default 0.0 */ this.x = defaultValue(x, 0.0); /** * The y coordinate of the rectangle. - * @type {Number} + * @type {number} * @default 0.0 */ this.y = defaultValue(y, 0.0); /** * The width of the rectangle. - * @type {Number} + * @type {number} * @default 0.0 */ this.width = defaultValue(width, 0.0); /** * The height of the rectangle. - * @type {Number} + * @type {number} * @default 0.0 */ this.height = defaultValue(height, 0.0); @@ -52,7 +52,7 @@ function BoundingRectangle(x, y, width, height) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ BoundingRectangle.packedLength = 4; @@ -60,10 +60,10 @@ BoundingRectangle.packedLength = 4; * Stores the provided instance into the provided array. * * @param {BoundingRectangle} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ BoundingRectangle.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -84,8 +84,8 @@ BoundingRectangle.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {BoundingRectangle} [result] The object into which to store the result. * @returns {BoundingRectangle} The modified result parameter or a new BoundingRectangle instance if one was not provided. */ @@ -160,7 +160,7 @@ const fromRectangleUpperRight = new Cartographic(); * Computes a bounding rectangle from a rectangle. * * @param {Rectangle} rectangle The valid rectangle used to create a bounding rectangle. - * @param {Object} [projection=GeographicProjection] The projection used to project the rectangle into 2D. + * @param {object} [projection=GeographicProjection] The projection used to project the rectangle into 2D. * @param {BoundingRectangle} [result] The object onto which to store the result. * @returns {BoundingRectangle} The modified result parameter or a new BoundingRectangle instance if one was not provided. */ @@ -326,7 +326,7 @@ BoundingRectangle.intersect = function (left, right) { * * @param {BoundingRectangle} [left] The first BoundingRectangle. * @param {BoundingRectangle} [right] The second BoundingRectangle. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ BoundingRectangle.equals = function (left, right) { return ( @@ -365,7 +365,7 @@ BoundingRectangle.prototype.intersect = function (right) { * true if they are equal, false otherwise. * * @param {BoundingRectangle} [right] The right hand side BoundingRectangle. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ BoundingRectangle.prototype.equals = function (right) { return BoundingRectangle.equals(this, right); diff --git a/packages/engine/Source/Core/BoundingSphere.js b/packages/engine/Source/Core/BoundingSphere.js index 58c9f54e85d8..3da2d739f67f 100644 --- a/packages/engine/Source/Core/BoundingSphere.js +++ b/packages/engine/Source/Core/BoundingSphere.js @@ -18,7 +18,7 @@ import Rectangle from "./Rectangle.js"; * @constructor * * @param {Cartesian3} [center=Cartesian3.ZERO] The center of the bounding sphere. - * @param {Number} [radius=0.0] The radius of the bounding sphere. + * @param {number} [radius=0.0] The radius of the bounding sphere. * * @see AxisAlignedBoundingBox * @see BoundingRectangle @@ -34,7 +34,7 @@ function BoundingSphere(center, radius) { /** * The radius of the sphere. - * @type {Number} + * @type {number} * @default 0.0 */ this.radius = defaultValue(radius, 0.0); @@ -233,7 +233,7 @@ const fromRectangle2DNortheast = new Cartographic(); * Computes a bounding sphere from a rectangle projected in 2D. * * @param {Rectangle} [rectangle] The rectangle around which to create a bounding sphere. - * @param {Object} [projection=GeographicProjection] The projection used to project the rectangle into 2D. + * @param {object} [projection=GeographicProjection] The projection used to project the rectangle into 2D. * @param {BoundingSphere} [result] The object onto which to store the result. * @returns {BoundingSphere} The modified result parameter or a new BoundingSphere instance if none was provided. */ @@ -252,9 +252,9 @@ BoundingSphere.fromRectangle2D = function (rectangle, projection, result) { * object's minimum and maximum heights over the rectangle. * * @param {Rectangle} [rectangle] The rectangle around which to create a bounding sphere. - * @param {Object} [projection=GeographicProjection] The projection used to project the rectangle into 2D. - * @param {Number} [minimumHeight=0.0] The minimum height over the rectangle. - * @param {Number} [maximumHeight=0.0] The maximum height over the rectangle. + * @param {object} [projection=GeographicProjection] The projection used to project the rectangle into 2D. + * @param {number} [minimumHeight=0.0] The minimum height over the rectangle. + * @param {number} [maximumHeight=0.0] The maximum height over the rectangle. * @param {BoundingSphere} [result] The object onto which to store the result. * @returns {BoundingSphere} The modified result parameter or a new BoundingSphere instance if none was provided. */ @@ -312,7 +312,7 @@ const fromRectangle3DScratch = []; * * @param {Rectangle} [rectangle] The valid rectangle used to create a bounding sphere. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid used to determine positions of the rectangle. - * @param {Number} [surfaceHeight=0.0] The height above the surface of the ellipsoid. + * @param {number} [surfaceHeight=0.0] The height above the surface of the ellipsoid. * @param {BoundingSphere} [result] The object onto which to store the result. * @returns {BoundingSphere} The modified result parameter or a new BoundingSphere instance if none was provided. */ @@ -350,12 +350,12 @@ BoundingSphere.fromRectangle3D = function ( * algorithms, a naive algorithm and Ritter's algorithm. The smaller of the two spheres is used to * ensure a tight fit. * - * @param {Number[]} [positions] An array of points that the bounding sphere will enclose. Each point + * @param {number[]} [positions] An array of points that the bounding sphere will enclose. Each point * is formed from three elements in the array in the order X, Y, Z. * @param {Cartesian3} [center=Cartesian3.ZERO] The position to which the positions are relative, which need not be the * origin of the coordinate system. This is useful when the positions are to be used for * relative-to-center (RTC) rendering. - * @param {Number} [stride=3] The number of array elements per vertex. It must be at least 3, but it may + * @param {number} [stride=3] The number of array elements per vertex. It must be at least 3, but it may * be higher. Regardless of the value of this parameter, the X coordinate of the first position * is at array index 0, the Y coordinate is at array index 1, and the Z coordinate is at array index * 2. When stride is 3, the X coordinate of the next position then begins at array index 3. If @@ -555,9 +555,9 @@ BoundingSphere.fromVertices = function (positions, center, stride, result) { * algorithms, a naive algorithm and Ritter's algorithm. The smaller of the two spheres is used to * ensure a tight fit. * - * @param {Number[]} [positionsHigh] An array of high bits of the encoded cartesians that the bounding sphere will enclose. Each point + * @param {number[]} [positionsHigh] An array of high bits of the encoded cartesians that the bounding sphere will enclose. Each point * is formed from three elements in the array in the order X, Y, Z. - * @param {Number[]} [positionsLow] An array of low bits of the encoded cartesians that the bounding sphere will enclose. Each point + * @param {number[]} [positionsLow] An array of low bits of the encoded cartesians that the bounding sphere will enclose. Each point * is formed from three elements in the array in the order X, Y, Z. * @param {BoundingSphere} [result] The object onto which to store the result. * @returns {BoundingSphere} The modified result parameter or a new BoundingSphere instance if one was not provided. @@ -936,7 +936,7 @@ BoundingSphere.clone = function (sphere, result) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ BoundingSphere.packedLength = 4; @@ -944,10 +944,10 @@ BoundingSphere.packedLength = 4; * Stores the provided instance into the provided array. * * @param {BoundingSphere} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ BoundingSphere.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -969,8 +969,8 @@ BoundingSphere.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {BoundingSphere} [result] The object into which to store the result. * @returns {BoundingSphere} The modified result parameter or a new BoundingSphere instance if one was not provided. */ @@ -1147,7 +1147,7 @@ const distanceSquaredToScratch = new Cartesian3(); * * @param {BoundingSphere} sphere The sphere. * @param {Cartesian3} cartesian The point - * @returns {Number} The distance squared from the bounding sphere to the point. Returns 0 if the point is inside the sphere. + * @returns {number} The distance squared from the bounding sphere to the point. Returns 0 if the point is inside the sphere. * * @example * // Sort bounding spheres from back to front @@ -1268,7 +1268,7 @@ const projectTo2DProjection = new GeographicProjection(); * Creates a bounding sphere in 2D from a bounding sphere in 3D world coordinates. * * @param {BoundingSphere} sphere The bounding sphere to transform to 2D. - * @param {Object} [projection=GeographicProjection] The projection to 2D. + * @param {object} [projection=GeographicProjection] The projection to 2D. * @param {BoundingSphere} [result] The object onto which to store the result. * @returns {BoundingSphere} The modified result parameter or a new BoundingSphere instance if none was provided. */ @@ -1381,7 +1381,7 @@ BoundingSphere.projectTo2D = function (sphere, projection, result) { * * @param {BoundingSphere} sphere The bounding sphere surrounding the occludee object. * @param {Occluder} occluder The occluder. - * @returns {Boolean} true if the sphere is not visible; otherwise false. + * @returns {boolean} true if the sphere is not visible; otherwise false. */ BoundingSphere.isOccluded = function (sphere, occluder) { //>>includeStart('debug', pragmas.debug); @@ -1397,7 +1397,7 @@ BoundingSphere.isOccluded = function (sphere, occluder) { * * @param {BoundingSphere} [left] The first BoundingSphere. * @param {BoundingSphere} [right] The second BoundingSphere. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ BoundingSphere.equals = function (left, right) { return ( @@ -1426,7 +1426,7 @@ BoundingSphere.prototype.intersectPlane = function (plane) { * Computes the estimated distance squared from the closest point on a bounding sphere to a point. * * @param {Cartesian3} cartesian The point - * @returns {Number} The estimated distance squared from the bounding sphere to the point. + * @returns {number} The estimated distance squared from the bounding sphere to the point. * * @example * // Sort bounding spheres from back to front @@ -1467,7 +1467,7 @@ BoundingSphere.prototype.computePlaneDistances = function ( * Determines whether or not a sphere is hidden from view by the occluder. * * @param {Occluder} occluder The occluder. - * @returns {Boolean} true if the sphere is not visible; otherwise false. + * @returns {boolean} true if the sphere is not visible; otherwise false. */ BoundingSphere.prototype.isOccluded = function (occluder) { return BoundingSphere.isOccluded(this, occluder); @@ -1478,7 +1478,7 @@ BoundingSphere.prototype.isOccluded = function (occluder) { * true if they are equal, false otherwise. * * @param {BoundingSphere} [right] The right hand side BoundingSphere. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ BoundingSphere.prototype.equals = function (right) { return BoundingSphere.equals(this, right); @@ -1496,7 +1496,7 @@ BoundingSphere.prototype.clone = function (result) { /** * Computes the radius of the BoundingSphere. - * @returns {Number} The radius of the BoundingSphere. + * @returns {number} The radius of the BoundingSphere. */ BoundingSphere.prototype.volume = function () { const radius = this.radius; diff --git a/packages/engine/Source/Core/BoxGeometry.js b/packages/engine/Source/Core/BoxGeometry.js index 32f9aba45602..405107e0afd5 100644 --- a/packages/engine/Source/Core/BoxGeometry.js +++ b/packages/engine/Source/Core/BoxGeometry.js @@ -20,7 +20,7 @@ const diffScratch = new Cartesian3(); * @alias BoxGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.minimum The minimum x, y, and z coordinates of the box. * @param {Cartesian3} options.maximum The maximum x, y, and z coordinates of the box. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. @@ -70,7 +70,7 @@ function BoxGeometry(options) { /** * Creates a cube centered at the origin given its dimensions. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.dimensions The width, depth, and height of the box stored in the x, y, and z coordinates of the Cartesian3, respectively. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * @returns {BoxGeometry} @@ -141,7 +141,7 @@ BoxGeometry.fromAxisAlignedBoundingBox = function (boundingBox) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ BoxGeometry.packedLength = 2 * Cartesian3.packedLength + VertexFormat.packedLength + 1; @@ -150,10 +150,10 @@ BoxGeometry.packedLength = * Stores the provided instance into the provided array. * * @param {BoxGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ BoxGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -194,8 +194,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {BoxGeometry} [result] The object into which to store the result. * @returns {BoxGeometry} The modified result parameter or a new BoxGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/BoxOutlineGeometry.js b/packages/engine/Source/Core/BoxOutlineGeometry.js index a76b4b6be5b3..5e18ee05e9b1 100644 --- a/packages/engine/Source/Core/BoxOutlineGeometry.js +++ b/packages/engine/Source/Core/BoxOutlineGeometry.js @@ -19,7 +19,7 @@ const diffScratch = new Cartesian3(); * @alias BoxOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.minimum The minimum x, y, and z coordinates of the box. * @param {Cartesian3} options.maximum The maximum x, y, and z coordinates of the box. * @@ -62,7 +62,7 @@ function BoxOutlineGeometry(options) { /** * Creates an outline of a cube centered at the origin given its dimensions. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.dimensions The width, depth, and height of the box stored in the x, y, and z coordinates of the Cartesian3, respectively. * @returns {BoxOutlineGeometry} * @@ -130,7 +130,7 @@ BoxOutlineGeometry.fromAxisAlignedBoundingBox = function (boundingBox) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ BoxOutlineGeometry.packedLength = 2 * Cartesian3.packedLength + 1; @@ -138,10 +138,10 @@ BoxOutlineGeometry.packedLength = 2 * Cartesian3.packedLength + 1; * Stores the provided instance into the provided array. * * @param {BoxOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ BoxOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -172,8 +172,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {BoxOutlineGeometry} [result] The object into which to store the result. * @returns {BoxOutlineGeometry} The modified result parameter or a new BoxOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/Cartesian2.js b/packages/engine/Source/Core/Cartesian2.js index b06e8f55a80d..9d7d8137359c 100644 --- a/packages/engine/Source/Core/Cartesian2.js +++ b/packages/engine/Source/Core/Cartesian2.js @@ -9,8 +9,8 @@ import CesiumMath from "./Math.js"; * @alias Cartesian2 * @constructor * - * @param {Number} [x=0.0] The X component. - * @param {Number} [y=0.0] The Y component. + * @param {number} [x=0.0] The X component. + * @param {number} [y=0.0] The Y component. * * @see Cartesian3 * @see Cartesian4 @@ -19,14 +19,14 @@ import CesiumMath from "./Math.js"; function Cartesian2(x, y) { /** * The X component. - * @type {Number} + * @type {number} * @default 0.0 */ this.x = defaultValue(x, 0.0); /** * The Y component. - * @type {Number} + * @type {number} * @default 0.0 */ this.y = defaultValue(y, 0.0); @@ -35,8 +35,8 @@ function Cartesian2(x, y) { /** * Creates a Cartesian2 instance from x and y coordinates. * - * @param {Number} x The x coordinate. - * @param {Number} y The y coordinate. + * @param {number} x The x coordinate. + * @param {number} y The y coordinate. * @param {Cartesian2} [result] The object onto which to store the result. * @returns {Cartesian2} The modified result parameter or a new Cartesian2 instance if one was not provided. */ @@ -94,7 +94,7 @@ Cartesian2.fromCartesian4 = Cartesian2.clone; /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Cartesian2.packedLength = 2; @@ -102,10 +102,10 @@ Cartesian2.packedLength = 2; * Stores the provided instance into the provided array. * * @param {Cartesian2} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Cartesian2.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -124,8 +124,8 @@ Cartesian2.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Cartesian2} [result] The object into which to store the result. * @returns {Cartesian2} The modified result parameter or a new Cartesian2 instance if one was not provided. */ @@ -148,8 +148,8 @@ Cartesian2.unpack = function (array, startingIndex, result) { * Flattens an array of Cartesian2s into an array of components. * * @param {Cartesian2[]} array The array of cartesians to pack. - * @param {Number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 2 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 2) elements. - * @returns {Number[]} The packed array. + * @param {number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 2 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 2) elements. + * @returns {number[]} The packed array. */ Cartesian2.packArray = function (array, result) { //>>includeStart('debug', pragmas.debug); @@ -179,7 +179,7 @@ Cartesian2.packArray = function (array, result) { /** * Unpacks an array of cartesian components into an array of Cartesian2s. * - * @param {Number[]} array The array of components to unpack. + * @param {number[]} array The array of components to unpack. * @param {Cartesian2[]} [result] The array onto which to store the result. * @returns {Cartesian2[]} The unpacked array. */ @@ -210,8 +210,8 @@ Cartesian2.unpackArray = function (array, result) { * Creates a Cartesian2 from two consecutive elements in an array. * @function * - * @param {Number[]} array The array whose two consecutive elements correspond to the x and y components, respectively. - * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. + * @param {number[]} array The array whose two consecutive elements correspond to the x and y components, respectively. + * @param {number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. * @param {Cartesian2} [result] The object onto which to store the result. * @returns {Cartesian2} The modified result parameter or a new Cartesian2 instance if one was not provided. * @@ -230,7 +230,7 @@ Cartesian2.fromArray = Cartesian2.unpack; * Computes the value of the maximum component for the supplied Cartesian. * * @param {Cartesian2} cartesian The cartesian to use. - * @returns {Number} The value of the maximum component. + * @returns {number} The value of the maximum component. */ Cartesian2.maximumComponent = function (cartesian) { //>>includeStart('debug', pragmas.debug); @@ -244,7 +244,7 @@ Cartesian2.maximumComponent = function (cartesian) { * Computes the value of the minimum component for the supplied Cartesian. * * @param {Cartesian2} cartesian The cartesian to use. - * @returns {Number} The value of the minimum component. + * @returns {number} The value of the minimum component. */ Cartesian2.minimumComponent = function (cartesian) { //>>includeStart('debug', pragmas.debug); @@ -325,7 +325,7 @@ Cartesian2.clamp = function (value, min, max, result) { * Computes the provided Cartesian's squared magnitude. * * @param {Cartesian2} cartesian The Cartesian instance whose squared magnitude is to be computed. - * @returns {Number} The squared magnitude. + * @returns {number} The squared magnitude. */ Cartesian2.magnitudeSquared = function (cartesian) { //>>includeStart('debug', pragmas.debug); @@ -339,7 +339,7 @@ Cartesian2.magnitudeSquared = function (cartesian) { * Computes the Cartesian's magnitude (length). * * @param {Cartesian2} cartesian The Cartesian instance whose magnitude is to be computed. - * @returns {Number} The magnitude. + * @returns {number} The magnitude. */ Cartesian2.magnitude = function (cartesian) { return Math.sqrt(Cartesian2.magnitudeSquared(cartesian)); @@ -352,7 +352,7 @@ const distanceScratch = new Cartesian2(); * * @param {Cartesian2} left The first point to compute the distance from. * @param {Cartesian2} right The second point to compute the distance to. - * @returns {Number} The distance between two points. + * @returns {number} The distance between two points. * * @example * // Returns 1.0 @@ -374,7 +374,7 @@ Cartesian2.distance = function (left, right) { * * @param {Cartesian2} left The first point to compute the distance from. * @param {Cartesian2} right The second point to compute the distance to. - * @returns {Number} The distance between two points. + * @returns {number} The distance between two points. * * @example * // Returns 4.0, not 2.0 @@ -422,7 +422,7 @@ Cartesian2.normalize = function (cartesian, result) { * * @param {Cartesian2} left The first Cartesian. * @param {Cartesian2} right The second Cartesian. - * @returns {Number} The dot product. + * @returns {number} The dot product. */ Cartesian2.dot = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -438,7 +438,7 @@ Cartesian2.dot = function (left, right) { * * @param {Cartesian2} left The first Cartesian. * @param {Cartesian2} right The second Cartesian. - * @returns {Number} The cross product. + * @returns {number} The cross product. */ Cartesian2.cross = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -533,7 +533,7 @@ Cartesian2.subtract = function (left, right, result) { * Multiplies the provided Cartesian componentwise by the provided scalar. * * @param {Cartesian2} cartesian The Cartesian to be scaled. - * @param {Number} scalar The scalar to multiply with. + * @param {number} scalar The scalar to multiply with. * @param {Cartesian2} result The object onto which to store the result. * @returns {Cartesian2} The modified result parameter. */ @@ -553,7 +553,7 @@ Cartesian2.multiplyByScalar = function (cartesian, scalar, result) { * Divides the provided Cartesian componentwise by the provided scalar. * * @param {Cartesian2} cartesian The Cartesian to be divided. - * @param {Number} scalar The scalar to divide by. + * @param {number} scalar The scalar to divide by. * @param {Cartesian2} result The object onto which to store the result. * @returns {Cartesian2} The modified result parameter. */ @@ -611,7 +611,7 @@ const lerpScratch = new Cartesian2(); * * @param {Cartesian2} start The value corresponding to t at 0.0. * @param {Cartesian2} end The value corresponding to t at 1.0. - * @param {Number} t The point along t at which to interpolate. + * @param {number} t The point along t at which to interpolate. * @param {Cartesian2} result The object onto which to store the result. * @returns {Cartesian2} The modified result parameter. */ @@ -635,7 +635,7 @@ const angleBetweenScratch2 = new Cartesian2(); * * @param {Cartesian2} left The first Cartesian. * @param {Cartesian2} right The second Cartesian. - * @returns {Number} The angle between the Cartesians. + * @returns {number} The angle between the Cartesians. */ Cartesian2.angleBetween = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -682,7 +682,7 @@ Cartesian2.mostOrthogonalAxis = function (cartesian, result) { * * @param {Cartesian2} [left] The first Cartesian. * @param {Cartesian2} [right] The second Cartesian. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Cartesian2.equals = function (left, right) { return ( @@ -708,9 +708,9 @@ Cartesian2.equalsArray = function (cartesian, array, offset) { * * @param {Cartesian2} [left] The first Cartesian. * @param {Cartesian2} [right] The second Cartesian. - * @param {Number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Cartesian2.equalsEpsilon = function ( left, @@ -784,7 +784,7 @@ Cartesian2.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {Cartesian2} [right] The right hand side Cartesian. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ Cartesian2.prototype.equals = function (right) { return Cartesian2.equals(this, right); @@ -796,9 +796,9 @@ Cartesian2.prototype.equals = function (right) { * false otherwise. * * @param {Cartesian2} [right] The right hand side Cartesian. - * @param {Number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if they are within the provided epsilon, false otherwise. + * @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if they are within the provided epsilon, false otherwise. */ Cartesian2.prototype.equalsEpsilon = function ( right, @@ -816,7 +816,7 @@ Cartesian2.prototype.equalsEpsilon = function ( /** * Creates a string representing this Cartesian in the format '(x, y)'. * - * @returns {String} A string representing the provided Cartesian in the format '(x, y)'. + * @returns {string} A string representing the provided Cartesian in the format '(x, y)'. */ Cartesian2.prototype.toString = function () { return `(${this.x}, ${this.y})`; diff --git a/packages/engine/Source/Core/Cartesian3.js b/packages/engine/Source/Core/Cartesian3.js index 35c5cd20ff3e..934917052da6 100644 --- a/packages/engine/Source/Core/Cartesian3.js +++ b/packages/engine/Source/Core/Cartesian3.js @@ -9,9 +9,9 @@ import CesiumMath from "./Math.js"; * @alias Cartesian3 * @constructor * - * @param {Number} [x=0.0] The X component. - * @param {Number} [y=0.0] The Y component. - * @param {Number} [z=0.0] The Z component. + * @param {number} [x=0.0] The X component. + * @param {number} [y=0.0] The Y component. + * @param {number} [z=0.0] The Z component. * * @see Cartesian2 * @see Cartesian4 @@ -20,21 +20,21 @@ import CesiumMath from "./Math.js"; function Cartesian3(x, y, z) { /** * The X component. - * @type {Number} + * @type {number} * @default 0.0 */ this.x = defaultValue(x, 0.0); /** * The Y component. - * @type {Number} + * @type {number} * @default 0.0 */ this.y = defaultValue(y, 0.0); /** * The Z component. - * @type {Number} + * @type {number} * @default 0.0 */ this.z = defaultValue(z, 0.0); @@ -69,9 +69,9 @@ Cartesian3.fromSpherical = function (spherical, result) { /** * Creates a Cartesian3 instance from x, y and z coordinates. * - * @param {Number} x The x coordinate. - * @param {Number} y The y coordinate. - * @param {Number} z The z coordinate. + * @param {number} x The x coordinate. + * @param {number} y The y coordinate. + * @param {number} z The z coordinate. * @param {Cartesian3} [result] The object onto which to store the result. * @returns {Cartesian3} The modified result parameter or a new Cartesian3 instance if one was not provided. */ @@ -120,7 +120,7 @@ Cartesian3.fromCartesian4 = Cartesian3.clone; /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Cartesian3.packedLength = 3; @@ -128,10 +128,10 @@ Cartesian3.packedLength = 3; * Stores the provided instance into the provided array. * * @param {Cartesian3} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Cartesian3.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -151,8 +151,8 @@ Cartesian3.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Cartesian3} [result] The object into which to store the result. * @returns {Cartesian3} The modified result parameter or a new Cartesian3 instance if one was not provided. */ @@ -176,8 +176,8 @@ Cartesian3.unpack = function (array, startingIndex, result) { * Flattens an array of Cartesian3s into an array of components. * * @param {Cartesian3[]} array The array of cartesians to pack. - * @param {Number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 3 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 3) elements. - * @returns {Number[]} The packed array. + * @param {number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 3 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 3) elements. + * @returns {number[]} The packed array. */ Cartesian3.packArray = function (array, result) { //>>includeStart('debug', pragmas.debug); @@ -207,7 +207,7 @@ Cartesian3.packArray = function (array, result) { /** * Unpacks an array of cartesian components into an array of Cartesian3s. * - * @param {Number[]} array The array of components to unpack. + * @param {number[]} array The array of components to unpack. * @param {Cartesian3[]} [result] The array onto which to store the result. * @returns {Cartesian3[]} The unpacked array. */ @@ -238,8 +238,8 @@ Cartesian3.unpackArray = function (array, result) { * Creates a Cartesian3 from three consecutive elements in an array. * @function * - * @param {Number[]} array The array whose three consecutive elements correspond to the x, y, and z components, respectively. - * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. + * @param {number[]} array The array whose three consecutive elements correspond to the x, y, and z components, respectively. + * @param {number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. * @param {Cartesian3} [result] The object onto which to store the result. * @returns {Cartesian3} The modified result parameter or a new Cartesian3 instance if one was not provided. * @@ -258,7 +258,7 @@ Cartesian3.fromArray = Cartesian3.unpack; * Computes the value of the maximum component for the supplied Cartesian. * * @param {Cartesian3} cartesian The cartesian to use. - * @returns {Number} The value of the maximum component. + * @returns {number} The value of the maximum component. */ Cartesian3.maximumComponent = function (cartesian) { //>>includeStart('debug', pragmas.debug); @@ -272,7 +272,7 @@ Cartesian3.maximumComponent = function (cartesian) { * Computes the value of the minimum component for the supplied Cartesian. * * @param {Cartesian3} cartesian The cartesian to use. - * @returns {Number} The value of the minimum component. + * @returns {number} The value of the minimum component. */ Cartesian3.minimumComponent = function (cartesian) { //>>includeStart('debug', pragmas.debug); @@ -357,7 +357,7 @@ Cartesian3.clamp = function (value, min, max, result) { * Computes the provided Cartesian's squared magnitude. * * @param {Cartesian3} cartesian The Cartesian instance whose squared magnitude is to be computed. - * @returns {Number} The squared magnitude. + * @returns {number} The squared magnitude. */ Cartesian3.magnitudeSquared = function (cartesian) { //>>includeStart('debug', pragmas.debug); @@ -375,7 +375,7 @@ Cartesian3.magnitudeSquared = function (cartesian) { * Computes the Cartesian's magnitude (length). * * @param {Cartesian3} cartesian The Cartesian instance whose magnitude is to be computed. - * @returns {Number} The magnitude. + * @returns {number} The magnitude. */ Cartesian3.magnitude = function (cartesian) { return Math.sqrt(Cartesian3.magnitudeSquared(cartesian)); @@ -388,7 +388,7 @@ const distanceScratch = new Cartesian3(); * * @param {Cartesian3} left The first point to compute the distance from. * @param {Cartesian3} right The second point to compute the distance to. - * @returns {Number} The distance between two points. + * @returns {number} The distance between two points. * * @example * // Returns 1.0 @@ -410,7 +410,7 @@ Cartesian3.distance = function (left, right) { * * @param {Cartesian3} left The first point to compute the distance from. * @param {Cartesian3} right The second point to compute the distance to. - * @returns {Number} The distance between two points. + * @returns {number} The distance between two points. * * @example * // Returns 4.0, not 2.0 @@ -459,7 +459,7 @@ Cartesian3.normalize = function (cartesian, result) { * * @param {Cartesian3} left The first Cartesian. * @param {Cartesian3} right The second Cartesian. - * @returns {Number} The dot product. + * @returns {number} The dot product. */ Cartesian3.dot = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -558,7 +558,7 @@ Cartesian3.subtract = function (left, right, result) { * Multiplies the provided Cartesian componentwise by the provided scalar. * * @param {Cartesian3} cartesian The Cartesian to be scaled. - * @param {Number} scalar The scalar to multiply with. + * @param {number} scalar The scalar to multiply with. * @param {Cartesian3} result The object onto which to store the result. * @returns {Cartesian3} The modified result parameter. */ @@ -579,7 +579,7 @@ Cartesian3.multiplyByScalar = function (cartesian, scalar, result) { * Divides the provided Cartesian componentwise by the provided scalar. * * @param {Cartesian3} cartesian The Cartesian to be divided. - * @param {Number} scalar The scalar to divide by. + * @param {number} scalar The scalar to divide by. * @param {Cartesian3} result The object onto which to store the result. * @returns {Cartesian3} The modified result parameter. */ @@ -640,7 +640,7 @@ const lerpScratch = new Cartesian3(); * * @param {Cartesian3} start The value corresponding to t at 0.0. * @param {Cartesian3} end The value corresponding to t at 1.0. - * @param {Number} t The point along t at which to interpolate. + * @param {number} t The point along t at which to interpolate. * @param {Cartesian3} result The object onto which to store the result. * @returns {Cartesian3} The modified result parameter. */ @@ -664,7 +664,7 @@ const angleBetweenScratch2 = new Cartesian3(); * * @param {Cartesian3} left The first Cartesian. * @param {Cartesian3} right The second Cartesian. - * @returns {Number} The angle between the Cartesians. + * @returns {number} The angle between the Cartesians. */ Cartesian3.angleBetween = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -741,7 +741,7 @@ Cartesian3.projectVector = function (a, b, result) { * * @param {Cartesian3} [left] The first Cartesian. * @param {Cartesian3} [right] The second Cartesian. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Cartesian3.equals = function (left, right) { return ( @@ -772,9 +772,9 @@ Cartesian3.equalsArray = function (cartesian, array, offset) { * * @param {Cartesian3} [left] The first Cartesian. * @param {Cartesian3} [right] The second Cartesian. - * @param {Number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Cartesian3.equalsEpsilon = function ( left, @@ -863,9 +863,9 @@ Cartesian3.midpoint = function (left, right, result) { /** * Returns a Cartesian3 position from longitude and latitude values given in degrees. * - * @param {Number} longitude The longitude, in degrees - * @param {Number} latitude The latitude, in degrees - * @param {Number} [height=0.0] The height, in meters, above the ellipsoid. + * @param {number} longitude The longitude, in degrees + * @param {number} latitude The latitude, in degrees + * @param {number} [height=0.0] The height, in meters, above the ellipsoid. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies. * @param {Cartesian3} [result] The object onto which to store the result. * @returns {Cartesian3} The position @@ -901,9 +901,9 @@ const wgs84RadiiSquared = new Cartesian3( /** * Returns a Cartesian3 position from longitude and latitude values given in radians. * - * @param {Number} longitude The longitude, in radians - * @param {Number} latitude The latitude, in radians - * @param {Number} [height=0.0] The height, in meters, above the ellipsoid. + * @param {number} longitude The longitude, in radians + * @param {number} latitude The latitude, in radians + * @param {number} [height=0.0] The height, in meters, above the ellipsoid. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies. * @param {Cartesian3} [result] The object onto which to store the result. * @returns {Cartesian3} The position @@ -948,7 +948,7 @@ Cartesian3.fromRadians = function ( /** * Returns an array of Cartesian3 positions given an array of longitude and latitude values given in degrees. * - * @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...]. + * @param {number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...]. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the coordinates lie. * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * @returns {Cartesian3[]} The array of positions. @@ -992,7 +992,7 @@ Cartesian3.fromDegreesArray = function (coordinates, ellipsoid, result) { /** * Returns an array of Cartesian3 positions given an array of longitude and latitude values given in radians. * - * @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...]. + * @param {number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...]. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the coordinates lie. * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * @returns {Cartesian3[]} The array of positions. @@ -1036,7 +1036,7 @@ Cartesian3.fromRadiansArray = function (coordinates, ellipsoid, result) { /** * Returns an array of Cartesian3 positions given an array of longitude, latitude and height values where longitude and latitude are given in degrees. * - * @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height, longitude, latitude, height...]. + * @param {number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height, longitude, latitude, height...]. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies. * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * @returns {Cartesian3[]} The array of positions. @@ -1081,7 +1081,7 @@ Cartesian3.fromDegreesArrayHeights = function (coordinates, ellipsoid, result) { /** * Returns an array of Cartesian3 positions given an array of longitude, latitude and height values where longitude and latitude are given in radians. * - * @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height, longitude, latitude, height...]. + * @param {number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height, longitude, latitude, height...]. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the position lies. * @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result. * @returns {Cartesian3[]} The array of positions. @@ -1178,7 +1178,7 @@ Cartesian3.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {Cartesian3} [right] The right hand side Cartesian. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ Cartesian3.prototype.equals = function (right) { return Cartesian3.equals(this, right); @@ -1190,9 +1190,9 @@ Cartesian3.prototype.equals = function (right) { * false otherwise. * * @param {Cartesian3} [right] The right hand side Cartesian. - * @param {Number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if they are within the provided epsilon, false otherwise. + * @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if they are within the provided epsilon, false otherwise. */ Cartesian3.prototype.equalsEpsilon = function ( right, @@ -1210,7 +1210,7 @@ Cartesian3.prototype.equalsEpsilon = function ( /** * Creates a string representing this Cartesian in the format '(x, y, z)'. * - * @returns {String} A string representing this Cartesian in the format '(x, y, z)'. + * @returns {string} A string representing this Cartesian in the format '(x, y, z)'. */ Cartesian3.prototype.toString = function () { return `(${this.x}, ${this.y}, ${this.z})`; diff --git a/packages/engine/Source/Core/Cartesian4.js b/packages/engine/Source/Core/Cartesian4.js index 923dae49a95c..fa841cc9b2aa 100644 --- a/packages/engine/Source/Core/Cartesian4.js +++ b/packages/engine/Source/Core/Cartesian4.js @@ -9,10 +9,10 @@ import CesiumMath from "./Math.js"; * @alias Cartesian4 * @constructor * - * @param {Number} [x=0.0] The X component. - * @param {Number} [y=0.0] The Y component. - * @param {Number} [z=0.0] The Z component. - * @param {Number} [w=0.0] The W component. + * @param {number} [x=0.0] The X component. + * @param {number} [y=0.0] The Y component. + * @param {number} [z=0.0] The Z component. + * @param {number} [w=0.0] The W component. * * @see Cartesian2 * @see Cartesian3 @@ -21,28 +21,28 @@ import CesiumMath from "./Math.js"; function Cartesian4(x, y, z, w) { /** * The X component. - * @type {Number} + * @type {number} * @default 0.0 */ this.x = defaultValue(x, 0.0); /** * The Y component. - * @type {Number} + * @type {number} * @default 0.0 */ this.y = defaultValue(y, 0.0); /** * The Z component. - * @type {Number} + * @type {number} * @default 0.0 */ this.z = defaultValue(z, 0.0); /** * The W component. - * @type {Number} + * @type {number} * @default 0.0 */ this.w = defaultValue(w, 0.0); @@ -51,10 +51,10 @@ function Cartesian4(x, y, z, w) { /** * Creates a Cartesian4 instance from x, y, z and w coordinates. * - * @param {Number} x The x coordinate. - * @param {Number} y The y coordinate. - * @param {Number} z The z coordinate. - * @param {Number} w The w coordinate. + * @param {number} x The x coordinate. + * @param {number} y The y coordinate. + * @param {number} z The z coordinate. + * @param {number} w The w coordinate. * @param {Cartesian4} [result] The object onto which to store the result. * @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided. */ @@ -118,7 +118,7 @@ Cartesian4.clone = function (cartesian, result) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Cartesian4.packedLength = 4; @@ -126,10 +126,10 @@ Cartesian4.packedLength = 4; * Stores the provided instance into the provided array. * * @param {Cartesian4} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Cartesian4.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -150,8 +150,8 @@ Cartesian4.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Cartesian4} [result] The object into which to store the result. * @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided. */ @@ -176,8 +176,8 @@ Cartesian4.unpack = function (array, startingIndex, result) { * Flattens an array of Cartesian4s into an array of components. * * @param {Cartesian4[]} array The array of cartesians to pack. - * @param {Number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 4 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 4) elements. - * @returns {Number[]} The packed array. + * @param {number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 4 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 4) elements. + * @returns {number[]} The packed array. */ Cartesian4.packArray = function (array, result) { //>>includeStart('debug', pragmas.debug); @@ -207,7 +207,7 @@ Cartesian4.packArray = function (array, result) { /** * Unpacks an array of cartesian components into an array of Cartesian4s. * - * @param {Number[]} array The array of components to unpack. + * @param {number[]} array The array of components to unpack. * @param {Cartesian4[]} [result] The array onto which to store the result. * @returns {Cartesian4[]} The unpacked array. */ @@ -238,8 +238,8 @@ Cartesian4.unpackArray = function (array, result) { * Creates a Cartesian4 from four consecutive elements in an array. * @function * - * @param {Number[]} array The array whose four consecutive elements correspond to the x, y, z, and w components, respectively. - * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. + * @param {number[]} array The array whose four consecutive elements correspond to the x, y, z, and w components, respectively. + * @param {number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component. * @param {Cartesian4} [result] The object onto which to store the result. * @returns {Cartesian4} The modified result parameter or a new Cartesian4 instance if one was not provided. * @@ -258,7 +258,7 @@ Cartesian4.fromArray = Cartesian4.unpack; * Computes the value of the maximum component for the supplied Cartesian. * * @param {Cartesian4} cartesian The cartesian to use. - * @returns {Number} The value of the maximum component. + * @returns {number} The value of the maximum component. */ Cartesian4.maximumComponent = function (cartesian) { //>>includeStart('debug', pragmas.debug); @@ -272,7 +272,7 @@ Cartesian4.maximumComponent = function (cartesian) { * Computes the value of the minimum component for the supplied Cartesian. * * @param {Cartesian4} cartesian The cartesian to use. - * @returns {Number} The value of the minimum component. + * @returns {number} The value of the minimum component. */ Cartesian4.minimumComponent = function (cartesian) { //>>includeStart('debug', pragmas.debug); @@ -362,7 +362,7 @@ Cartesian4.clamp = function (value, min, max, result) { * Computes the provided Cartesian's squared magnitude. * * @param {Cartesian4} cartesian The Cartesian instance whose squared magnitude is to be computed. - * @returns {Number} The squared magnitude. + * @returns {number} The squared magnitude. */ Cartesian4.magnitudeSquared = function (cartesian) { //>>includeStart('debug', pragmas.debug); @@ -381,7 +381,7 @@ Cartesian4.magnitudeSquared = function (cartesian) { * Computes the Cartesian's magnitude (length). * * @param {Cartesian4} cartesian The Cartesian instance whose magnitude is to be computed. - * @returns {Number} The magnitude. + * @returns {number} The magnitude. */ Cartesian4.magnitude = function (cartesian) { return Math.sqrt(Cartesian4.magnitudeSquared(cartesian)); @@ -394,7 +394,7 @@ const distanceScratch = new Cartesian4(); * * @param {Cartesian4} left The first point to compute the distance from. * @param {Cartesian4} right The second point to compute the distance to. - * @returns {Number} The distance between two points. + * @returns {number} The distance between two points. * * @example * // Returns 1.0 @@ -418,7 +418,7 @@ Cartesian4.distance = function (left, right) { * * @param {Cartesian4} left The first point to compute the distance from. * @param {Cartesian4} right The second point to compute the distance to. - * @returns {Number} The distance between two points. + * @returns {number} The distance between two points. * * @example * // Returns 4.0, not 2.0 @@ -475,7 +475,7 @@ Cartesian4.normalize = function (cartesian, result) { * * @param {Cartesian4} left The first Cartesian. * @param {Cartesian4} right The second Cartesian. - * @returns {Number} The dot product. + * @returns {number} The dot product. */ Cartesian4.dot = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -580,7 +580,7 @@ Cartesian4.subtract = function (left, right, result) { * Multiplies the provided Cartesian componentwise by the provided scalar. * * @param {Cartesian4} cartesian The Cartesian to be scaled. - * @param {Number} scalar The scalar to multiply with. + * @param {number} scalar The scalar to multiply with. * @param {Cartesian4} result The object onto which to store the result. * @returns {Cartesian4} The modified result parameter. */ @@ -602,7 +602,7 @@ Cartesian4.multiplyByScalar = function (cartesian, scalar, result) { * Divides the provided Cartesian componentwise by the provided scalar. * * @param {Cartesian4} cartesian The Cartesian to be divided. - * @param {Number} scalar The scalar to divide by. + * @param {number} scalar The scalar to divide by. * @param {Cartesian4} result The object onto which to store the result. * @returns {Cartesian4} The modified result parameter. */ @@ -666,7 +666,7 @@ const lerpScratch = new Cartesian4(); * * @param {Cartesian4} start The value corresponding to t at 0.0. * @param {Cartesian4}end The value corresponding to t at 1.0. - * @param {Number} t The point along t at which to interpolate. + * @param {number} t The point along t at which to interpolate. * @param {Cartesian4} result The object onto which to store the result. * @returns {Cartesian4} The modified result parameter. */ @@ -733,7 +733,7 @@ Cartesian4.mostOrthogonalAxis = function (cartesian, result) { * * @param {Cartesian4} [left] The first Cartesian. * @param {Cartesian4} [right] The second Cartesian. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Cartesian4.equals = function (left, right) { return ( @@ -766,9 +766,9 @@ Cartesian4.equalsArray = function (cartesian, array, offset) { * * @param {Cartesian4} [left] The first Cartesian. * @param {Cartesian4} [right] The second Cartesian. - * @param {Number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Cartesian4.equalsEpsilon = function ( left, @@ -870,7 +870,7 @@ Cartesian4.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {Cartesian4} [right] The right hand side Cartesian. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ Cartesian4.prototype.equals = function (right) { return Cartesian4.equals(this, right); @@ -882,9 +882,9 @@ Cartesian4.prototype.equals = function (right) { * false otherwise. * * @param {Cartesian4} [right] The right hand side Cartesian. - * @param {Number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if they are within the provided epsilon, false otherwise. + * @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if they are within the provided epsilon, false otherwise. */ Cartesian4.prototype.equalsEpsilon = function ( right, @@ -902,7 +902,7 @@ Cartesian4.prototype.equalsEpsilon = function ( /** * Creates a string representing this Cartesian in the format '(x, y, z, w)'. * - * @returns {String} A string representing the provided Cartesian in the format '(x, y, z, w)'. + * @returns {string} A string representing the provided Cartesian in the format '(x, y, z, w)'. */ Cartesian4.prototype.toString = function () { return `(${this.x}, ${this.y}, ${this.z}, ${this.w})`; @@ -919,7 +919,7 @@ const littleEndian = testU8[0] === 0x44; /** * Packs an arbitrary floating point value to 4 values representable using uint8. * - * @param {Number} value A floating point number. + * @param {number} value A floating point number. * @param {Cartesian4} [result] The Cartesian4 that will contain the packed float. * @returns {Cartesian4} A Cartesian4 representing the float packed to values in x, y, z, and w. */ @@ -954,7 +954,7 @@ Cartesian4.packFloat = function (value, result) { * Unpacks a float packed using Cartesian4.packFloat. * * @param {Cartesian4} packedFloat A Cartesian4 containing a float packed to 4 values representable using uint8. - * @returns {Number} The unpacked float. + * @returns {number} The unpacked float. * @private */ Cartesian4.unpackFloat = function (packedFloat) { diff --git a/packages/engine/Source/Core/Cartographic.js b/packages/engine/Source/Core/Cartographic.js index e08b82e817f0..87957c75bdce 100644 --- a/packages/engine/Source/Core/Cartographic.js +++ b/packages/engine/Source/Core/Cartographic.js @@ -10,30 +10,30 @@ import scaleToGeodeticSurface from "./scaleToGeodeticSurface.js"; * @alias Cartographic * @constructor * - * @param {Number} [longitude=0.0] The longitude, in radians. - * @param {Number} [latitude=0.0] The latitude, in radians. - * @param {Number} [height=0.0] The height, in meters, above the ellipsoid. + * @param {number} [longitude=0.0] The longitude, in radians. + * @param {number} [latitude=0.0] The latitude, in radians. + * @param {number} [height=0.0] The height, in meters, above the ellipsoid. * * @see Ellipsoid */ function Cartographic(longitude, latitude, height) { /** * The longitude, in radians. - * @type {Number} + * @type {number} * @default 0.0 */ this.longitude = defaultValue(longitude, 0.0); /** * The latitude, in radians. - * @type {Number} + * @type {number} * @default 0.0 */ this.latitude = defaultValue(latitude, 0.0); /** * The height, in meters, above the ellipsoid. - * @type {Number} + * @type {number} * @default 0.0 */ this.height = defaultValue(height, 0.0); @@ -43,9 +43,9 @@ function Cartographic(longitude, latitude, height) { * Creates a new Cartographic instance from longitude and latitude * specified in radians. * - * @param {Number} longitude The longitude, in radians. - * @param {Number} latitude The latitude, in radians. - * @param {Number} [height=0.0] The height, in meters, above the ellipsoid. + * @param {number} longitude The longitude, in radians. + * @param {number} latitude The latitude, in radians. + * @param {number} [height=0.0] The height, in meters, above the ellipsoid. * @param {Cartographic} [result] The object onto which to store the result. * @returns {Cartographic} The modified result parameter or a new Cartographic instance if one was not provided. */ @@ -72,9 +72,9 @@ Cartographic.fromRadians = function (longitude, latitude, height, result) { * specified in degrees. The values in the resulting object will * be in radians. * - * @param {Number} longitude The longitude, in degrees. - * @param {Number} latitude The latitude, in degrees. - * @param {Number} [height=0.0] The height, in meters, above the ellipsoid. + * @param {number} longitude The longitude, in degrees. + * @param {number} latitude The latitude, in degrees. + * @param {number} [height=0.0] The height, in meters, above the ellipsoid. * @param {Cartographic} [result] The object onto which to store the result. * @returns {Cartographic} The modified result parameter or a new Cartographic instance if one was not provided. */ @@ -213,7 +213,7 @@ Cartographic.clone = function (cartographic, result) { * * @param {Cartographic} [left] The first cartographic. * @param {Cartographic} [right] The second cartographic. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Cartographic.equals = function (left, right) { return ( @@ -233,8 +233,8 @@ Cartographic.equals = function (left, right) { * * @param {Cartographic} [left] The first cartographic. * @param {Cartographic} [right] The second cartographic. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Cartographic.equalsEpsilon = function (left, right, epsilon) { epsilon = defaultValue(epsilon, 0); @@ -272,7 +272,7 @@ Cartographic.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {Cartographic} [right] The second cartographic. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Cartographic.prototype.equals = function (right) { return Cartographic.equals(this, right); @@ -284,8 +284,8 @@ Cartographic.prototype.equals = function (right) { * false otherwise. * * @param {Cartographic} [right] The second cartographic. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Cartographic.prototype.equalsEpsilon = function (right, epsilon) { return Cartographic.equalsEpsilon(this, right, epsilon); @@ -294,7 +294,7 @@ Cartographic.prototype.equalsEpsilon = function (right, epsilon) { /** * Creates a string representing this cartographic in the format '(longitude, latitude, height)'. * - * @returns {String} A string representing the provided cartographic in the format '(longitude, latitude, height)'. + * @returns {string} A string representing the provided cartographic in the format '(longitude, latitude, height)'. */ Cartographic.prototype.toString = function () { return `(${this.longitude}, ${this.latitude}, ${this.height})`; diff --git a/packages/engine/Source/Core/CartographicGeocoderService.js b/packages/engine/Source/Core/CartographicGeocoderService.js index 89f698c36fc3..35a6ebd0b10d 100644 --- a/packages/engine/Source/Core/CartographicGeocoderService.js +++ b/packages/engine/Source/Core/CartographicGeocoderService.js @@ -13,7 +13,7 @@ function CartographicGeocoderService() {} /** * @function * - * @param {String} query The query to be sent to the geocoder service + * @param {string} query The query to be sent to the geocoder service * @returns {Promise} */ CartographicGeocoderService.prototype.geocode = function (query) { diff --git a/packages/engine/Source/Core/CatmullRomSpline.js b/packages/engine/Source/Core/CatmullRomSpline.js index 9ecbdba88d4a..8f7c4ea6d9f2 100644 --- a/packages/engine/Source/Core/CatmullRomSpline.js +++ b/packages/engine/Source/Core/CatmullRomSpline.js @@ -111,8 +111,8 @@ const lastTangentScratch = new Cartesian3(); * @alias CatmullRomSpline * @constructor * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. + * @param {object} options Object with the following properties: + * @param {number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. * @param {Cartesian3[]} options.points The array of {@link Cartesian3} control points. * @param {Cartesian3} [options.firstTangent] The tangent of the curve at the first control point. @@ -201,7 +201,7 @@ Object.defineProperties(CatmullRomSpline.prototype, { * * @memberof CatmullRomSpline.prototype * - * @type {Number[]} + * @type {number[]} * @readonly */ times: { @@ -280,8 +280,8 @@ CatmullRomSpline.catmullRomCoefficientMatrix = new Matrix4( * time is in the interval [times[i], times[i + 1]]. * @function * - * @param {Number} time The time. - * @returns {Number} The index for the element at the start of the interval. + * @param {number} time The time. + * @returns {number} The index for the element at the start of the interval. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element @@ -293,8 +293,8 @@ CatmullRomSpline.prototype.findTimeInterval = Spline.prototype.findTimeInterval; * Wraps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, wrapped around to the updated animation. + * @param {number} time The time. + * @return {number} The time, wrapped around to the updated animation. */ CatmullRomSpline.prototype.wrapTime = Spline.prototype.wrapTime; @@ -302,15 +302,15 @@ CatmullRomSpline.prototype.wrapTime = Spline.prototype.wrapTime; * Clamps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, clamped to the animation period. + * @param {number} time The time. + * @return {number} The time, clamped to the animation period. */ CatmullRomSpline.prototype.clampTime = Spline.prototype.clampTime; /** * Evaluates the curve at a given time. * - * @param {Number} time The time at which to evaluate the curve. + * @param {number} time The time at which to evaluate the curve. * @param {Cartesian3} [result] The object onto which to store the result. * @returns {Cartesian3} The modified result parameter or a new instance of the point on the curve at the given time. * diff --git a/packages/engine/Source/Core/CesiumTerrainProvider.js b/packages/engine/Source/Core/CesiumTerrainProvider.js index 34077f60da3d..e97d448994d0 100644 --- a/packages/engine/Source/Core/CesiumTerrainProvider.js +++ b/packages/engine/Source/Core/CesiumTerrainProvider.js @@ -47,13 +47,13 @@ function LayerInformation(layer) { * @alias CesiumTerrainProvider * @constructor * - * @param {Object} options Object with the following properties: - * @param {Resource|String|Promise|Promise} options.url The URL of the Cesium terrain server. - * @param {Boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server, in the form of per vertex normals if available. - * @param {Boolean} [options.requestWaterMask=false] Flag that indicates if the client should request per tile water masks from the server, if available. - * @param {Boolean} [options.requestMetadata=true] Flag that indicates if the client should request per tile metadata from the server, if available. + * @param {object} options Object with the following properties: + * @param {Resource|string|Promise|Promise} options.url The URL of the Cesium terrain server. + * @param {boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server, in the form of per vertex normals if available. + * @param {boolean} [options.requestWaterMask=false] Flag that indicates if the client should request per tile water masks from the server, if available. + * @param {boolean} [options.requestMetadata=true] Flag that indicates if the client should request per tile metadata from the server, if available. * @param {Ellipsoid} [options.ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used. - * @param {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas. + * @param {Credit|string} [options.credit] A credit for the data source, which is displayed on the canvas. * * * @example @@ -83,7 +83,7 @@ function CesiumTerrainProvider(options) { /** * Boolean flag that indicates if the client should request vertex normals from the server. - * @type {Boolean} + * @type {boolean} * @default false * @private */ @@ -94,7 +94,7 @@ function CesiumTerrainProvider(options) { /** * Boolean flag that indicates if the client should request tile watermasks from the server. - * @type {Boolean} + * @type {boolean} * @default false * @private */ @@ -102,7 +102,7 @@ function CesiumTerrainProvider(options) { /** * Boolean flag that indicates if the client should request tile metadata from the server. - * @type {Boolean} + * @type {boolean} * @default true * @private */ @@ -483,7 +483,7 @@ const QuantizedMeshExtensionIds = { /** * Oct-Encoded Per-Vertex Normals are included as an extension to the tile mesh * - * @type {Number} + * @type {number} * @constant * @default 1 */ @@ -491,7 +491,7 @@ const QuantizedMeshExtensionIds = { /** * A watermask is included as an extension to the tile mesh * - * @type {Number} + * @type {number} * @constant * @default 2 */ @@ -499,7 +499,7 @@ const QuantizedMeshExtensionIds = { /** * A json object contain metadata about the tile * - * @type {Number} + * @type {number} * @constant * @default 4 */ @@ -787,12 +787,12 @@ function createQuantizedMeshTerrainData(provider, buffer, level, x, y, layer) { * {@link CesiumTerrainProvider#ready} returns true. The result must include terrain data and * may optionally include a water mask and an indication of which child tiles are available. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @param {Request} [request] The request object. Intended for internal use only. * - * @returns {Promise.|undefined} A promise for the requested geometry. If this method + * @returns {Promise|undefined} A promise for the requested geometry. If this method * returns undefined instead of a promise, it is an indication that too many requests are already * pending and the request will be retried later. * @@ -986,7 +986,7 @@ Object.defineProperties(CesiumTerrainProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof CesiumTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -998,7 +998,7 @@ Object.defineProperties(CesiumTerrainProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof CesiumTerrainProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -1013,7 +1013,7 @@ Object.defineProperties(CesiumTerrainProvider.prototype, { * as a reflective surface with animated waves. This function should not be * called before {@link CesiumTerrainProvider#ready} returns true. * @memberof CesiumTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @exception {DeveloperError} This property must not be called before {@link CesiumTerrainProvider#ready} */ @@ -1035,7 +1035,7 @@ Object.defineProperties(CesiumTerrainProvider.prototype, { * Gets a value indicating whether or not the requested tiles include vertex normals. * This function should not be called before {@link CesiumTerrainProvider#ready} returns true. * @memberof CesiumTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @exception {DeveloperError} This property must not be called before {@link CesiumTerrainProvider#ready} */ @@ -1058,7 +1058,7 @@ Object.defineProperties(CesiumTerrainProvider.prototype, { * Gets a value indicating whether or not the requested tiles include metadata. * This function should not be called before {@link CesiumTerrainProvider#ready} returns true. * @memberof CesiumTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @exception {DeveloperError} This property must not be called before {@link CesiumTerrainProvider#ready} */ @@ -1082,7 +1082,7 @@ Object.defineProperties(CesiumTerrainProvider.prototype, { * Vertex normals data is appended to the standard tile mesh data only if the client requests the vertex normals and * if the server provides vertex normals. * @memberof CesiumTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ requestVertexNormals: { @@ -1096,7 +1096,7 @@ Object.defineProperties(CesiumTerrainProvider.prototype, { * Watermask data is appended to the standard tile mesh data only if the client requests the watermask and * if the server provides a watermask. * @memberof CesiumTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ requestWaterMask: { @@ -1110,7 +1110,7 @@ Object.defineProperties(CesiumTerrainProvider.prototype, { * Metadata is appended to the standard tile mesh data only if the client requests the metadata and * if the server provides a metadata. * @memberof CesiumTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ requestMetadata: { @@ -1148,8 +1148,8 @@ Object.defineProperties(CesiumTerrainProvider.prototype, { /** * Gets the maximum geometric error allowed in a tile at a given level. * - * @param {Number} level The tile level for which to get the maximum geometric error. - * @returns {Number} The maximum geometric error. + * @param {number} level The tile level for which to get the maximum geometric error. + * @returns {number} The maximum geometric error. */ CesiumTerrainProvider.prototype.getLevelMaximumGeometricError = function ( level @@ -1160,10 +1160,10 @@ CesiumTerrainProvider.prototype.getLevelMaximumGeometricError = function ( /** * Determines whether data for a tile is available to be loaded. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. - * @returns {Boolean|undefined} Undefined if not supported or availability is unknown, otherwise true or false. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. + * @returns {boolean|undefined} Undefined if not supported or availability is unknown, otherwise true or false. */ CesiumTerrainProvider.prototype.getTileDataAvailable = function (x, y, level) { if (!defined(this._availability)) { @@ -1198,9 +1198,9 @@ CesiumTerrainProvider.prototype.getTileDataAvailable = function (x, y, level) { /** * Makes sure we load availability data for a tile * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @returns {undefined|Promise} Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded */ CesiumTerrainProvider.prototype.loadTileDataAvailability = function ( diff --git a/packages/engine/Source/Core/Check.js b/packages/engine/Source/Core/Check.js index 1cb5ddf6ee79..543eda9ca0e6 100644 --- a/packages/engine/Source/Core/Check.js +++ b/packages/engine/Source/Core/Check.js @@ -24,7 +24,7 @@ function getFailedTypeErrorMessage(actual, expected, name) { /** * Throws if test is not defined * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value that is to be checked * @exception {DeveloperError} test must be defined */ @@ -37,7 +37,7 @@ Check.defined = function (name, test) { /** * Throws if test is not typeof 'function' * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test * @exception {DeveloperError} test must be typeof 'function' */ @@ -52,7 +52,7 @@ Check.typeOf.func = function (name, test) { /** * Throws if test is not typeof 'string' * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test * @exception {DeveloperError} test must be typeof 'string' */ @@ -67,7 +67,7 @@ Check.typeOf.string = function (name, test) { /** * Throws if test is not typeof 'number' * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test * @exception {DeveloperError} test must be typeof 'number' */ @@ -82,9 +82,9 @@ Check.typeOf.number = function (name, test) { /** * Throws if test is not typeof 'number' and less than limit * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test - * @param {Number} limit The limit value to compare against + * @param {number} limit The limit value to compare against * @exception {DeveloperError} test must be typeof 'number' and less than limit */ Check.typeOf.number.lessThan = function (name, test, limit) { @@ -99,9 +99,9 @@ Check.typeOf.number.lessThan = function (name, test, limit) { /** * Throws if test is not typeof 'number' and less than or equal to limit * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test - * @param {Number} limit The limit value to compare against + * @param {number} limit The limit value to compare against * @exception {DeveloperError} test must be typeof 'number' and less than or equal to limit */ Check.typeOf.number.lessThanOrEquals = function (name, test, limit) { @@ -116,9 +116,9 @@ Check.typeOf.number.lessThanOrEquals = function (name, test, limit) { /** * Throws if test is not typeof 'number' and greater than limit * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test - * @param {Number} limit The limit value to compare against + * @param {number} limit The limit value to compare against * @exception {DeveloperError} test must be typeof 'number' and greater than limit */ Check.typeOf.number.greaterThan = function (name, test, limit) { @@ -133,9 +133,9 @@ Check.typeOf.number.greaterThan = function (name, test, limit) { /** * Throws if test is not typeof 'number' and greater than or equal to limit * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test - * @param {Number} limit The limit value to compare against + * @param {number} limit The limit value to compare against * @exception {DeveloperError} test must be typeof 'number' and greater than or equal to limit */ Check.typeOf.number.greaterThanOrEquals = function (name, test, limit) { @@ -150,7 +150,7 @@ Check.typeOf.number.greaterThanOrEquals = function (name, test, limit) { /** * Throws if test is not typeof 'object' * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test * @exception {DeveloperError} test must be typeof 'object' */ @@ -165,7 +165,7 @@ Check.typeOf.object = function (name, test) { /** * Throws if test is not typeof 'boolean' * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test * @exception {DeveloperError} test must be typeof 'boolean' */ @@ -180,7 +180,7 @@ Check.typeOf.bool = function (name, test) { /** * Throws if test is not typeof 'bigint' * - * @param {String} name The name of the variable being tested + * @param {string} name The name of the variable being tested * @param {*} test The value to test * @exception {DeveloperError} test must be typeof 'bigint' */ @@ -195,8 +195,8 @@ Check.typeOf.bigint = function (name, test) { /** * Throws if test1 and test2 is not typeof 'number' and not equal in value * - * @param {String} name1 The name of the first variable being tested - * @param {String} name2 The name of the second variable being tested against + * @param {string} name1 The name of the first variable being tested + * @param {string} name2 The name of the second variable being tested against * @param {*} test1 The value to test * @param {*} test2 The value to test against * @exception {DeveloperError} test1 and test2 should be type of 'number' and be equal in value diff --git a/packages/engine/Source/Core/CircleGeometry.js b/packages/engine/Source/Core/CircleGeometry.js index 684db45f74c7..78e6387c15a0 100644 --- a/packages/engine/Source/Core/CircleGeometry.js +++ b/packages/engine/Source/Core/CircleGeometry.js @@ -12,15 +12,15 @@ import VertexFormat from "./VertexFormat.js"; * @alias CircleGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.center The circle's center point in the fixed frame. - * @param {Number} options.radius The radius in meters. + * @param {number} options.radius The radius in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid the circle will be on. - * @param {Number} [options.height=0.0] The distance in meters between the circle and the ellipsoid surface. - * @param {Number} [options.granularity=0.02] The angular distance between points on the circle in radians. + * @param {number} [options.height=0.0] The distance in meters between the circle and the ellipsoid surface. + * @param {number} [options.granularity=0.02] The angular distance between points on the circle in radians. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. - * @param {Number} [options.extrudedHeight=0.0] The distance in meters between the circle's extruded face and the ellipsoid surface. - * @param {Number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. + * @param {number} [options.extrudedHeight=0.0] The distance in meters between the circle's extruded face and the ellipsoid surface. + * @param {number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. * * @exception {DeveloperError} radius must be greater than zero. * @exception {DeveloperError} granularity must be greater than zero. @@ -62,7 +62,7 @@ function CircleGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ CircleGeometry.packedLength = EllipseGeometry.packedLength; @@ -70,10 +70,10 @@ CircleGeometry.packedLength = EllipseGeometry.packedLength; * Stores the provided instance into the provided array. * * @param {CircleGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ CircleGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -104,8 +104,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {CircleGeometry} [result] The object into which to store the result. * @returns {CircleGeometry} The modified result parameter or a new CircleGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/CircleOutlineGeometry.js b/packages/engine/Source/Core/CircleOutlineGeometry.js index e0ce1d197d84..80e40987de19 100644 --- a/packages/engine/Source/Core/CircleOutlineGeometry.js +++ b/packages/engine/Source/Core/CircleOutlineGeometry.js @@ -11,14 +11,14 @@ import Ellipsoid from "./Ellipsoid.js"; * @alias CircleOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.center The circle's center point in the fixed frame. - * @param {Number} options.radius The radius in meters. + * @param {number} options.radius The radius in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid the circle will be on. - * @param {Number} [options.height=0.0] The distance in meters between the circle and the ellipsoid surface. - * @param {Number} [options.granularity=0.02] The angular distance between points on the circle in radians. - * @param {Number} [options.extrudedHeight=0.0] The distance in meters between the circle's extruded face and the ellipsoid surface. - * @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom of an extruded circle. + * @param {number} [options.height=0.0] The distance in meters between the circle and the ellipsoid surface. + * @param {number} [options.granularity=0.02] The angular distance between points on the circle in radians. + * @param {number} [options.extrudedHeight=0.0] The distance in meters between the circle's extruded face and the ellipsoid surface. + * @param {number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom of an extruded circle. * * @exception {DeveloperError} radius must be greater than zero. * @exception {DeveloperError} granularity must be greater than zero. @@ -58,7 +58,7 @@ function CircleOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ CircleOutlineGeometry.packedLength = EllipseOutlineGeometry.packedLength; @@ -66,10 +66,10 @@ CircleOutlineGeometry.packedLength = EllipseOutlineGeometry.packedLength; * Stores the provided instance into the provided array. * * @param {CircleOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ CircleOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -102,8 +102,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {CircleOutlineGeometry} [result] The object into which to store the result. * @returns {CircleOutlineGeometry} The modified result parameter or a new CircleOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/Clock.js b/packages/engine/Source/Core/Clock.js index a39346baa9da..8bdea4fbf34c 100644 --- a/packages/engine/Source/Core/Clock.js +++ b/packages/engine/Source/Core/Clock.js @@ -13,15 +13,15 @@ import JulianDate from "./JulianDate.js"; * @alias Clock * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {JulianDate} [options.startTime] The start time of the clock. * @param {JulianDate} [options.stopTime] The stop time of the clock. * @param {JulianDate} [options.currentTime] The current time. - * @param {Number} [options.multiplier=1.0] Determines how much time advances when {@link Clock#tick} is called, negative values allow for advancing backwards. + * @param {number} [options.multiplier=1.0] Determines how much time advances when {@link Clock#tick} is called, negative values allow for advancing backwards. * @param {ClockStep} [options.clockStep=ClockStep.SYSTEM_CLOCK_MULTIPLIER] Determines if calls to {@link Clock#tick} are frame dependent or system clock dependent. * @param {ClockRange} [options.clockRange=ClockRange.UNBOUNDED] Determines how the clock should behave when {@link Clock#startTime} or {@link Clock#stopTime} is reached. - * @param {Boolean} [options.canAnimate=true] Indicates whether {@link Clock#tick} can advance time. This could be false if data is being buffered, for example. The clock will only tick when both {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true. - * @param {Boolean} [options.shouldAnimate=false] Indicates whether {@link Clock#tick} should attempt to advance time. The clock will only tick when both {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true. + * @param {boolean} [options.canAnimate=true] Indicates whether {@link Clock#tick} can advance time. This could be false if data is being buffered, for example. The clock will only tick when both {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true. + * @param {boolean} [options.shouldAnimate=false] Indicates whether {@link Clock#tick} should attempt to advance time. The clock will only tick when both {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true. * * @exception {DeveloperError} startTime must come before stopTime. * @@ -109,7 +109,7 @@ function Clock(options) { * Indicates whether {@link Clock#tick} can advance time. This could be false if data is being buffered, * for example. The clock will only advance time when both * {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true. - * @type {Boolean} + * @type {boolean} * @default true */ this.canAnimate = defaultValue(options.canAnimate, true); @@ -178,7 +178,7 @@ Object.defineProperties(Clock.prototype, { * {@link Clock#clockStep} from {@link ClockStep.SYSTEM_CLOCK} to * {@link ClockStep.SYSTEM_CLOCK_MULTIPLIER}. * @memberof Clock.prototype - * @type {Number} + * @type {number} * @default 1.0 */ multiplier: { @@ -230,7 +230,7 @@ Object.defineProperties(Clock.prototype, { * {@link Clock#clockStep} from {@link ClockStep.SYSTEM_CLOCK} to * {@link ClockStep.SYSTEM_CLOCK_MULTIPLIER}. * @memberof Clock.prototype - * @type {Boolean} + * @type {boolean} * @default false */ shouldAnimate: { diff --git a/packages/engine/Source/Core/ClockRange.js b/packages/engine/Source/Core/ClockRange.js index 694179fcf189..8a8e83f76572 100644 --- a/packages/engine/Source/Core/ClockRange.js +++ b/packages/engine/Source/Core/ClockRange.js @@ -2,7 +2,7 @@ * Constants used by {@link Clock#tick} to determine behavior * when {@link Clock#startTime} or {@link Clock#stopTime} is reached. * - * @enum {Number} + * @enum {number} * * @see Clock * @see ClockStep @@ -11,7 +11,7 @@ const ClockRange = { /** * {@link Clock#tick} will always advances the clock in its current direction. * - * @type {Number} + * @type {number} * @constant */ UNBOUNDED: 0, @@ -20,7 +20,7 @@ const ClockRange = { * When {@link Clock#startTime} or {@link Clock#stopTime} is reached, * {@link Clock#tick} will not advance {@link Clock#currentTime} any further. * - * @type {Number} + * @type {number} * @constant */ CLAMPED: 1, @@ -31,7 +31,7 @@ const ClockRange = { * time is moving backwards, {@link Clock#tick} will not advance past * {@link Clock#startTime} * - * @type {Number} + * @type {number} * @constant */ LOOP_STOP: 2, diff --git a/packages/engine/Source/Core/ClockStep.js b/packages/engine/Source/Core/ClockStep.js index 60ae312d1311..0494677f9d09 100644 --- a/packages/engine/Source/Core/ClockStep.js +++ b/packages/engine/Source/Core/ClockStep.js @@ -2,7 +2,7 @@ * Constants to determine how much time advances with each call * to {@link Clock#tick}. * - * @enum {Number} + * @enum {number} * * @see Clock * @see ClockRange @@ -12,7 +12,7 @@ const ClockStep = { * {@link Clock#tick} advances the current time by a fixed step, * which is the number of seconds specified by {@link Clock#multiplier}. * - * @type {Number} + * @type {number} * @constant */ TICK_DEPENDENT: 0, @@ -21,7 +21,7 @@ const ClockStep = { * {@link Clock#tick} advances the current time by the amount of system * time elapsed since the previous call multiplied by {@link Clock#multiplier}. * - * @type {Number} + * @type {number} * @constant */ SYSTEM_CLOCK_MULTIPLIER: 1, @@ -30,7 +30,7 @@ const ClockStep = { * {@link Clock#tick} sets the clock to the current system time; * ignoring all other settings. * - * @type {Number} + * @type {number} * @constant */ SYSTEM_CLOCK: 2, diff --git a/packages/engine/Source/Core/Color.js b/packages/engine/Source/Core/Color.js index f8b2c180156a..9dfa7b959fd2 100644 --- a/packages/engine/Source/Core/Color.js +++ b/packages/engine/Source/Core/Color.js @@ -26,10 +26,10 @@ function hue2rgb(m1, m2, h) { /** * A color, specified using red, green, blue, and alpha values, * which range from 0 (no intensity) to 1.0 (full intensity). - * @param {Number} [red=1.0] The red component. - * @param {Number} [green=1.0] The green component. - * @param {Number} [blue=1.0] The blue component. - * @param {Number} [alpha=1.0] The alpha component. + * @param {number} [red=1.0] The red component. + * @param {number} [green=1.0] The green component. + * @param {number} [blue=1.0] The blue component. + * @param {number} [alpha=1.0] The alpha component. * * @constructor * @alias Color @@ -39,25 +39,25 @@ function hue2rgb(m1, m2, h) { function Color(red, green, blue, alpha) { /** * The red component. - * @type {Number} + * @type {number} * @default 1.0 */ this.red = defaultValue(red, 1.0); /** * The green component. - * @type {Number} + * @type {number} * @default 1.0 */ this.green = defaultValue(green, 1.0); /** * The blue component. - * @type {Number} + * @type {number} * @default 1.0 */ this.blue = defaultValue(blue, 1.0); /** * The alpha component. - * @type {Number} + * @type {number} * @default 1.0 */ this.alpha = defaultValue(alpha, 1.0); @@ -91,10 +91,10 @@ Color.fromCartesian4 = function (cartesian, result) { * Creates a new Color specified using red, green, blue, and alpha values * that are in the range of 0 to 255, converting them internally to a range of 0.0 to 1.0. * - * @param {Number} [red=255] The red component. - * @param {Number} [green=255] The green component. - * @param {Number} [blue=255] The blue component. - * @param {Number} [alpha=255] The alpha component. + * @param {number} [red=255] The red component. + * @param {number} [green=255] The green component. + * @param {number} [blue=255] The blue component. + * @param {number} [alpha=255] The alpha component. * @param {Color} [result] The object onto which to store the result. * @returns {Color} The modified result parameter or a new Color instance if one was not provided. */ @@ -120,7 +120,7 @@ Color.fromBytes = function (red, green, blue, alpha, result) { * of the specified color, but with the specified alpha value. * * @param {Color} color The base color - * @param {Number} alpha The new alpha component. + * @param {number} alpha The new alpha component. * @param {Color} [result] The object onto which to store the result. * @returns {Color} The modified result parameter or a new Color instance if one was not provided. * @@ -156,7 +156,7 @@ if (FeatureDetection.supportsTypedArrays()) { * Creates a new Color from a single numeric unsigned 32-bit RGBA value, using the endianness * of the system. * - * @param {Number} rgba A single numeric unsigned 32-bit RGBA value. + * @param {number} rgba A single numeric unsigned 32-bit RGBA value. * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The color object. * @@ -180,10 +180,10 @@ Color.fromRgba = function (rgba, result) { /** * Creates a Color instance from hue, saturation, and lightness. * - * @param {Number} [hue=0] The hue angle 0...1 - * @param {Number} [saturation=0] The saturation value 0...1 - * @param {Number} [lightness=0] The lightness value 0...1 - * @param {Number} [alpha=1.0] The alpha component 0...1 + * @param {number} [hue=0] The hue angle 0...1 + * @param {number} [saturation=0] The saturation value 0...1 + * @param {number} [lightness=0] The lightness value 0...1 + * @param {number} [alpha=1.0] The alpha component 0...1 * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The color object. * @@ -228,19 +228,19 @@ Color.fromHsl = function (hue, saturation, lightness, alpha, result) { * Creates a random color using the provided options. For reproducible random colors, you should * call {@link CesiumMath#setRandomNumberSeed} once at the beginning of your application. * - * @param {Object} [options] Object with the following properties: - * @param {Number} [options.red] If specified, the red component to use instead of a randomized value. - * @param {Number} [options.minimumRed=0.0] The maximum red value to generate if none was specified. - * @param {Number} [options.maximumRed=1.0] The minimum red value to generate if none was specified. - * @param {Number} [options.green] If specified, the green component to use instead of a randomized value. - * @param {Number} [options.minimumGreen=0.0] The maximum green value to generate if none was specified. - * @param {Number} [options.maximumGreen=1.0] The minimum green value to generate if none was specified. - * @param {Number} [options.blue] If specified, the blue component to use instead of a randomized value. - * @param {Number} [options.minimumBlue=0.0] The maximum blue value to generate if none was specified. - * @param {Number} [options.maximumBlue=1.0] The minimum blue value to generate if none was specified. - * @param {Number} [options.alpha] If specified, the alpha component to use instead of a randomized value. - * @param {Number} [options.minimumAlpha=0.0] The maximum alpha value to generate if none was specified. - * @param {Number} [options.maximumAlpha=1.0] The minimum alpha value to generate if none was specified. + * @param {object} [options] Object with the following properties: + * @param {number} [options.red] If specified, the red component to use instead of a randomized value. + * @param {number} [options.minimumRed=0.0] The maximum red value to generate if none was specified. + * @param {number} [options.maximumRed=1.0] The minimum red value to generate if none was specified. + * @param {number} [options.green] If specified, the green component to use instead of a randomized value. + * @param {number} [options.minimumGreen=0.0] The maximum green value to generate if none was specified. + * @param {number} [options.maximumGreen=1.0] The minimum green value to generate if none was specified. + * @param {number} [options.blue] If specified, the blue component to use instead of a randomized value. + * @param {number} [options.minimumBlue=0.0] The maximum blue value to generate if none was specified. + * @param {number} [options.maximumBlue=1.0] The minimum blue value to generate if none was specified. + * @param {number} [options.alpha] If specified, the alpha component to use instead of a randomized value. + * @param {number} [options.minimumAlpha=0.0] The maximum alpha value to generate if none was specified. + * @param {number} [options.maximumAlpha=1.0] The minimum alpha value to generate if none was specified. * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The modified result parameter or a new instance if result was undefined. * @@ -359,7 +359,7 @@ const hslParenthesesMatcher = /^hsla?\(\s*([0-9.]+)\s*,\s*([0-9.]+%)\s*,\s*([0-9 /** * Creates a Color instance from a CSS color value. * - * @param {String} color The CSS color value in #rgb, #rgba, #rrggbb, #rrggbbaa, rgb(), rgba(), hsl(), or hsla() format. + * @param {string} color The CSS color value in #rgb, #rgba, #rrggbb, #rrggbbaa, rgb(), rgba(), hsl(), or hsla() format. * @param {Color} [result] The object to store the result in, if undefined a new instance will be created. * @returns {Color} The color object, or undefined if the string was not a valid CSS color. * @@ -435,7 +435,7 @@ Color.fromCssColorString = function (color, result) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Color.packedLength = 4; @@ -443,10 +443,10 @@ Color.packedLength = 4; * Stores the provided instance into the provided array. * * @param {Color} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Color.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -466,8 +466,8 @@ Color.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Color} [result] The object into which to store the result. * @returns {Color} The modified result parameter or a new Color instance if one was not provided. */ @@ -491,8 +491,8 @@ Color.unpack = function (array, startingIndex, result) { * Converts a 'byte' color component in the range of 0 to 255 into * a 'float' color component in the range of 0 to 1.0. * - * @param {Number} number The number to be converted. - * @returns {Number} The converted number. + * @param {number} number The number to be converted. + * @returns {number} The converted number. */ Color.byteToFloat = function (number) { return number / 255.0; @@ -502,8 +502,8 @@ Color.byteToFloat = function (number) { * Converts a 'float' color component in the range of 0 to 1.0 into * a 'byte' color component in the range of 0 to 255. * - * @param {Number} number The number to be converted. - * @returns {Number} The converted number. + * @param {number} number The number to be converted. + * @returns {number} The converted number. */ Color.floatToByte = function (number) { return number === 1.0 ? 255.0 : (number * 256.0) | 0; @@ -535,7 +535,7 @@ Color.clone = function (color, result) { * * @param {Color} left The first Color to compare for equality. * @param {Color} right The second Color to compare for equality. - * @returns {Boolean} true if the Colors are equal; otherwise, false. + * @returns {boolean} true if the Colors are equal; otherwise, false. */ Color.equals = function (left, right) { return ( @@ -575,7 +575,7 @@ Color.prototype.clone = function (result) { * Returns true if this Color equals other. * * @param {Color} other The Color to compare for equality. - * @returns {Boolean} true if the Colors are equal; otherwise, false. + * @returns {boolean} true if the Colors are equal; otherwise, false. */ Color.prototype.equals = function (other) { return Color.equals(this, other); @@ -585,8 +585,8 @@ Color.prototype.equals = function (other) { * Returns true if this Color equals other componentwise within the specified epsilon. * * @param {Color} other The Color to compare for equality. - * @param {Number} [epsilon=0.0] The epsilon to use for equality testing. - * @returns {Boolean} true if the Colors are equal within the specified epsilon; otherwise, false. + * @param {number} [epsilon=0.0] The epsilon to use for equality testing. + * @returns {boolean} true if the Colors are equal within the specified epsilon; otherwise, false. */ Color.prototype.equalsEpsilon = function (other, epsilon) { return ( @@ -602,7 +602,7 @@ Color.prototype.equalsEpsilon = function (other, epsilon) { /** * Creates a string representing this Color in the format '(red, green, blue, alpha)'. * - * @returns {String} A string representing this Color in the format '(red, green, blue, alpha)'. + * @returns {string} A string representing this Color in the format '(red, green, blue, alpha)'. */ Color.prototype.toString = function () { return `(${this.red}, ${this.green}, ${this.blue}, ${this.alpha})`; @@ -611,7 +611,7 @@ Color.prototype.toString = function () { /** * Creates a string containing the CSS color value for this color. * - * @returns {String} The CSS equivalent of this color. + * @returns {string} The CSS equivalent of this color. * * @see {@link http://www.w3.org/TR/css3-color/#rgba-color|CSS RGB or RGBA color values} */ @@ -628,7 +628,7 @@ Color.prototype.toCssColorString = function () { /** * Creates a string containing CSS hex string color value for this color. * - * @returns {String} The CSS hex string equivalent of this color. + * @returns {string} The CSS hex string equivalent of this color. */ Color.prototype.toCssHexString = function () { let r = Color.floatToByte(this.red).toString(16); @@ -657,8 +657,8 @@ Color.prototype.toCssHexString = function () { * Converts this color to an array of red, green, blue, and alpha values * that are in the range of 0 to 255. * - * @param {Number[]} [result] The array to store the result in, if undefined a new instance will be created. - * @returns {Number[]} The modified result parameter or a new instance if result was undefined. + * @param {number[]} [result] The array to store the result in, if undefined a new instance will be created. + * @returns {number[]} The modified result parameter or a new instance if result was undefined. */ Color.prototype.toBytes = function (result) { const red = Color.floatToByte(this.red); @@ -680,7 +680,7 @@ Color.prototype.toBytes = function (result) { * Converts this color to a single numeric unsigned 32-bit RGBA value, using the endianness * of the system. * - * @returns {Number} A single numeric unsigned 32-bit RGBA value. + * @returns {number} A single numeric unsigned 32-bit RGBA value. * * * @example @@ -700,7 +700,7 @@ Color.prototype.toRgba = function () { /** * Brightens this color by the provided magnitude. * - * @param {Number} magnitude A positive number indicating the amount to brighten. + * @param {number} magnitude A positive number indicating the amount to brighten. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. * @@ -725,7 +725,7 @@ Color.prototype.brighten = function (magnitude, result) { /** * Darkens this color by the provided magnitude. * - * @param {Number} magnitude A positive number indicating the amount to darken. + * @param {number} magnitude A positive number indicating the amount to darken. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. * @@ -751,7 +751,7 @@ Color.prototype.darken = function (magnitude, result) { * Creates a new Color that has the same red, green, and blue components * as this Color, but with the specified alpha value. * - * @param {Number} alpha The new alpha component. + * @param {number} alpha The new alpha component. * @param {Color} [result] The object onto which to store the result. * @returns {Color} The modified result parameter or a new Color instance if one was not provided. * @@ -876,7 +876,7 @@ Color.mod = function (left, right, result) { * * @param {Color} start The color corresponding to t at 0.0. * @param {Color} end The color corresponding to t at 1.0. - * @param {Number} t The point along t at which to interpolate. + * @param {number} t The point along t at which to interpolate. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ @@ -899,7 +899,7 @@ Color.lerp = function (start, end, t, result) { * Multiplies the provided Color componentwise by the provided scalar. * * @param {Color} color The Color to be scaled. - * @param {Number} scalar The scalar to multiply with. + * @param {number} scalar The scalar to multiply with. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ @@ -921,7 +921,7 @@ Color.multiplyByScalar = function (color, scalar, result) { * Divides the provided Color componentwise by the provided scalar. * * @param {Color} color The Color to be divided. - * @param {Number} scalar The scalar to divide with. + * @param {number} scalar The scalar to divide with. * @param {Color} result The object onto which to store the result. * @returns {Color} The modified result parameter. */ diff --git a/packages/engine/Source/Core/ColorGeometryInstanceAttribute.js b/packages/engine/Source/Core/ColorGeometryInstanceAttribute.js index 298bdf5da8fc..1b409b4255b3 100644 --- a/packages/engine/Source/Core/ColorGeometryInstanceAttribute.js +++ b/packages/engine/Source/Core/ColorGeometryInstanceAttribute.js @@ -10,10 +10,10 @@ import DeveloperError from "./DeveloperError.js"; * @alias ColorGeometryInstanceAttribute * @constructor * - * @param {Number} [red=1.0] The red component. - * @param {Number} [green=1.0] The green component. - * @param {Number} [blue=1.0] The blue component. - * @param {Number} [alpha=1.0] The alpha component. + * @param {number} [red=1.0] The red component. + * @param {number} [green=1.0] The green component. + * @param {number} [blue=1.0] The blue component. + * @param {number} [alpha=1.0] The alpha component. * * * @example @@ -76,7 +76,7 @@ Object.defineProperties(ColorGeometryInstanceAttribute.prototype, { * * @memberof ColorGeometryInstanceAttribute.prototype * - * @type {Number} + * @type {number} * @readonly * * @default 4 @@ -94,7 +94,7 @@ Object.defineProperties(ColorGeometryInstanceAttribute.prototype, { * * @memberof ColorGeometryInstanceAttribute.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -166,7 +166,7 @@ ColorGeometryInstanceAttribute.toValue = function (color, result) { * * @param {ColorGeometryInstanceAttribute} [left] The first ColorGeometryInstanceAttribute. * @param {ColorGeometryInstanceAttribute} [right] The second ColorGeometryInstanceAttribute. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ ColorGeometryInstanceAttribute.equals = function (left, right) { return ( diff --git a/packages/engine/Source/Core/ComponentDatatype.js b/packages/engine/Source/Core/ComponentDatatype.js index b7c8d3439fc5..9e92afe2696b 100644 --- a/packages/engine/Source/Core/ComponentDatatype.js +++ b/packages/engine/Source/Core/ComponentDatatype.js @@ -7,14 +7,14 @@ import WebGLConstants from "./WebGLConstants.js"; * WebGL component datatypes. Components are intrinsics, * which form attributes, which form vertices. * - * @enum {Number} + * @enum {number} */ const ComponentDatatype = { /** * 8-bit signed byte corresponding to gl.BYTE and the type * of an element in Int8Array. * - * @type {Number} + * @type {number} * @constant */ BYTE: WebGLConstants.BYTE, @@ -23,7 +23,7 @@ const ComponentDatatype = { * 8-bit unsigned byte corresponding to UNSIGNED_BYTE and the type * of an element in Uint8Array. * - * @type {Number} + * @type {number} * @constant */ UNSIGNED_BYTE: WebGLConstants.UNSIGNED_BYTE, @@ -32,7 +32,7 @@ const ComponentDatatype = { * 16-bit signed short corresponding to SHORT and the type * of an element in Int16Array. * - * @type {Number} + * @type {number} * @constant */ SHORT: WebGLConstants.SHORT, @@ -41,7 +41,7 @@ const ComponentDatatype = { * 16-bit unsigned short corresponding to UNSIGNED_SHORT and the type * of an element in Uint16Array. * - * @type {Number} + * @type {number} * @constant */ UNSIGNED_SHORT: WebGLConstants.UNSIGNED_SHORT, @@ -52,7 +52,7 @@ const ComponentDatatype = { * * @memberOf ComponentDatatype * - * @type {Number} + * @type {number} * @constant */ INT: WebGLConstants.INT, @@ -63,7 +63,7 @@ const ComponentDatatype = { * * @memberOf ComponentDatatype * - * @type {Number} + * @type {number} * @constant */ UNSIGNED_INT: WebGLConstants.UNSIGNED_INT, @@ -72,7 +72,7 @@ const ComponentDatatype = { * 32-bit floating-point corresponding to FLOAT and the type * of an element in Float32Array. * - * @type {Number} + * @type {number} * @constant */ FLOAT: WebGLConstants.FLOAT, @@ -84,7 +84,7 @@ const ComponentDatatype = { * * @memberOf ComponentDatatype * - * @type {Number} + * @type {number} * @constant * @default 0x140A */ @@ -95,7 +95,7 @@ const ComponentDatatype = { * Returns the size, in bytes, of the corresponding datatype. * * @param {ComponentDatatype} componentDatatype The component datatype to get the size of. - * @returns {Number} The size in bytes. + * @returns {number} The size in bytes. * * @exception {DeveloperError} componentDatatype is not a valid value. * @@ -177,7 +177,7 @@ ComponentDatatype.fromTypedArray = function (array) { * Validates that the provided component datatype is a valid {@link ComponentDatatype} * * @param {ComponentDatatype} componentDatatype The component datatype to validate. - * @returns {Boolean} true if the provided component datatype is a valid value; otherwise, false. + * @returns {boolean} true if the provided component datatype is a valid value; otherwise, false. * * @example * if (!Cesium.ComponentDatatype.validate(componentDatatype)) { @@ -202,7 +202,7 @@ ComponentDatatype.validate = function (componentDatatype) { * Creates a typed array corresponding to component data type. * * @param {ComponentDatatype} componentDatatype The component data type. - * @param {Number|Array} valuesOrLength The length of the array to create or an array. + * @param {number|Array} valuesOrLength The length of the array to create or an array. * @returns {Int8Array|Uint8Array|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array} A typed array. * * @exception {DeveloperError} componentDatatype is not a valid value. @@ -253,8 +253,8 @@ ComponentDatatype.createTypedArray = function ( * * @param {ComponentDatatype} componentDatatype The type of the view to create. * @param {ArrayBuffer} buffer The buffer storage to use for the view. - * @param {Number} [byteOffset] The offset, in bytes, to the first element in the view. - * @param {Number} [length] The number of elements in the view. + * @param {number} [byteOffset] The offset, in bytes, to the first element in the view. + * @param {number} [length] The number of elements in the view. * @returns {Int8Array|Uint8Array|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array} A typed array view of the buffer. * * @exception {DeveloperError} componentDatatype is not a valid value. @@ -308,7 +308,7 @@ ComponentDatatype.createArrayBufferView = function ( /** * Get the ComponentDatatype from its name. * - * @param {String} name The name of the ComponentDatatype. + * @param {string} name The name of the ComponentDatatype. * @returns {ComponentDatatype} The ComponentDatatype. * * @exception {DeveloperError} name is not a valid value. diff --git a/packages/engine/Source/Core/CompressedTextureBuffer.js b/packages/engine/Source/Core/CompressedTextureBuffer.js index be19eb346779..632c4b9a757f 100644 --- a/packages/engine/Source/Core/CompressedTextureBuffer.js +++ b/packages/engine/Source/Core/CompressedTextureBuffer.js @@ -7,8 +7,8 @@ import defined from "./defined.js"; * * @param {PixelFormat} internalFormat The pixel format of the compressed texture. * @param {PixelDatatype} pixelDatatype The pixel datatype of the compressed texture. - * @param {Number} width The width of the texture. - * @param {Number} height The height of the texture. + * @param {number} width The width of the texture. + * @param {number} height The height of the texture. * @param {Uint8Array} buffer The compressed texture buffer. */ function CompressedTextureBuffer( @@ -28,7 +28,7 @@ function CompressedTextureBuffer( Object.defineProperties(CompressedTextureBuffer.prototype, { /** * The format of the compressed texture. - * @type PixelFormat + * @type {PixelFormat} * @readonly * @memberof CompressedTextureBuffer.prototype */ @@ -39,7 +39,7 @@ Object.defineProperties(CompressedTextureBuffer.prototype, { }, /** * The datatype of the compressed texture. - * @type PixelDatatype + * @type {PixelDatatype} * @readonly * @memberof CompressedTextureBuffer.prototype */ @@ -50,7 +50,7 @@ Object.defineProperties(CompressedTextureBuffer.prototype, { }, /** * The width of the texture. - * @type Number + * @type {number} * @readonly * @memberof CompressedTextureBuffer.prototype */ @@ -61,7 +61,7 @@ Object.defineProperties(CompressedTextureBuffer.prototype, { }, /** * The height of the texture. - * @type Number + * @type {number} * @readonly * @memberof CompressedTextureBuffer.prototype */ @@ -72,7 +72,7 @@ Object.defineProperties(CompressedTextureBuffer.prototype, { }, /** * The compressed texture buffer. - * @type Uint8Array + * @type {Uint8Array} * @readonly * @memberof CompressedTextureBuffer.prototype */ diff --git a/packages/engine/Source/Core/ConstantSpline.js b/packages/engine/Source/Core/ConstantSpline.js index d6c476131a3c..032003de3a3f 100644 --- a/packages/engine/Source/Core/ConstantSpline.js +++ b/packages/engine/Source/Core/ConstantSpline.js @@ -9,7 +9,7 @@ import Spline from "./Spline.js"; * @alias ConstantSpline * @constructor * - * @param {Number|Cartesian3|Quaternion} value The constant value that the spline evaluates to. + * @param {number|Cartesian3|Quaternion} value The constant value that the spline evaluates to. * * @example * const position = new Cesium.Cartesian3(1.0, 2.0, 3.0); @@ -34,7 +34,7 @@ Object.defineProperties(ConstantSpline.prototype, { * * @memberof ConstantSpline.prototype * - * @type {Number|Cartesian3|Quaternion} + * @type {number|Cartesian3|Quaternion} * @readonly */ value: { @@ -51,7 +51,7 @@ Object.defineProperties(ConstantSpline.prototype, { * Since a constant spline has no internal times array, this will throw an error. * @function * - * @param {Number} time The time. + * @param {number} time The time. * * @exception {DeveloperError} findTimeInterval cannot be called on a ConstantSpline. */ @@ -67,8 +67,8 @@ ConstantSpline.prototype.findTimeInterval = function (time) { * Wraps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, wrapped around to the updated animation. + * @param {number} time The time. + * @return {number} The time, wrapped around to the updated animation. */ ConstantSpline.prototype.wrapTime = function (time) { //>>includeStart('debug', pragmas.debug); @@ -82,8 +82,8 @@ ConstantSpline.prototype.wrapTime = function (time) { * Clamps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, clamped to the animation period. + * @param {number} time The time. + * @return {number} The time, clamped to the animation period. */ ConstantSpline.prototype.clampTime = function (time) { //>>includeStart('debug', pragmas.debug); @@ -97,9 +97,9 @@ ConstantSpline.prototype.clampTime = function (time) { * Evaluates the curve at a given time. * @function * - * @param {Number} time The time at which to evaluate the curve. + * @param {number} time The time at which to evaluate the curve. * @param {Cartesian3|Quaternion} [result] The object onto which to store the result. - * @returns {Number|Cartesian3|Quaternion} The modified result parameter or the value that the constant spline represents. + * @returns {number|Cartesian3|Quaternion} The modified result parameter or the value that the constant spline represents. */ ConstantSpline.prototype.evaluate = function (time, result) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/CoplanarPolygonGeometry.js b/packages/engine/Source/Core/CoplanarPolygonGeometry.js index 90b17ceb0a1c..208a1059e051 100644 --- a/packages/engine/Source/Core/CoplanarPolygonGeometry.js +++ b/packages/engine/Source/Core/CoplanarPolygonGeometry.js @@ -227,9 +227,9 @@ function createGeometryFromPolygon( * @alias CoplanarPolygonGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {PolygonHierarchy} options.polygonHierarchy A polygon hierarchy that can include holes. - * @param {Number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. + * @param {number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. * @param {PolygonHierarchy} [options.textureCoordinates] Texture coordinates as a {@link PolygonHierarchy} of {@link Cartesian2} points. @@ -266,7 +266,7 @@ function CoplanarPolygonGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = PolygonGeometryLibrary.computeHierarchyPackedLength( @@ -287,10 +287,10 @@ function CoplanarPolygonGeometry(options) { /** * A description of a coplanar polygon from an array of positions. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of positions that defined the corner points of the polygon. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. - * @param {Number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. + * @param {number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. * @param {PolygonHierarchy} [options.textureCoordinates] Texture coordinates as a {@link PolygonHierarchy} of {@link Cartesian2} points. * @returns {CoplanarPolygonGeometry} @@ -333,10 +333,10 @@ CoplanarPolygonGeometry.fromPositions = function (options) { * Stores the provided instance into the provided array. * * @param {CoplanarPolygonGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ CoplanarPolygonGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -383,8 +383,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {CoplanarPolygonGeometry} [result] The object into which to store the result. * @returns {CoplanarPolygonGeometry} The modified result parameter or a new CoplanarPolygonGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/CoplanarPolygonOutlineGeometry.js b/packages/engine/Source/Core/CoplanarPolygonOutlineGeometry.js index a027cf03a5aa..0f9009676708 100644 --- a/packages/engine/Source/Core/CoplanarPolygonOutlineGeometry.js +++ b/packages/engine/Source/Core/CoplanarPolygonOutlineGeometry.js @@ -54,7 +54,7 @@ function createGeometryFromPositions(positions) { * @alias CoplanarPolygonOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {PolygonHierarchy} options.polygonHierarchy A polygon hierarchy that can include holes. * * @see CoplanarPolygonOutlineGeometry.createGeometry @@ -82,7 +82,7 @@ function CoplanarPolygonOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = PolygonGeometryLibrary.computeHierarchyPackedLength( @@ -94,7 +94,7 @@ function CoplanarPolygonOutlineGeometry(options) { /** * A description of a coplanar polygon outline from an array of positions. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of positions that defined the corner points of the polygon. * @returns {CoplanarPolygonOutlineGeometry} */ @@ -117,10 +117,10 @@ CoplanarPolygonOutlineGeometry.fromPositions = function (options) { * Stores the provided instance into the provided array. * * @param {CoplanarPolygonOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ CoplanarPolygonOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -148,8 +148,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {CoplanarPolygonOutlineGeometry} [result] The object into which to store the result. * @returns {CoplanarPolygonOutlineGeometry} The modified result parameter or a new CoplanarPolygonOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/CornerType.js b/packages/engine/Source/Core/CornerType.js index 9f0f72600cf4..c2c4ed23e41f 100644 --- a/packages/engine/Source/Core/CornerType.js +++ b/packages/engine/Source/Core/CornerType.js @@ -4,14 +4,14 @@ * @demo The {@link https://sandcastle.cesium.com/index.html?src=Corridor.html&label=Geometries|Corridor Demo} * demonstrates the three corner types, as used by {@link CorridorGraphics}. * - * @enum {Number} + * @enum {number} */ const CornerType = { /** * * * Corner has a smooth edge. - * @type {Number} + * @type {number} * @constant */ ROUNDED: 0, @@ -20,7 +20,7 @@ const CornerType = { * * * Corner point is the intersection of adjacent edges. - * @type {Number} + * @type {number} * @constant */ MITERED: 1, @@ -29,7 +29,7 @@ const CornerType = { * * * Corner is clipped. - * @type {Number} + * @type {number} * @constant */ BEVELED: 2, diff --git a/packages/engine/Source/Core/CorridorGeometry.js b/packages/engine/Source/Core/CorridorGeometry.js index a2df6ce51112..e5dd6af5ab53 100644 --- a/packages/engine/Source/Core/CorridorGeometry.js +++ b/packages/engine/Source/Core/CorridorGeometry.js @@ -1047,13 +1047,13 @@ function computeRectangle(positions, ellipsoid, width, cornerType, result) { * @alias CorridorGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of positions that define the center of the corridor. - * @param {Number} options.width The distance between the edges of the corridor in meters. + * @param {number} options.width The distance between the edges of the corridor in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Number} [options.height=0] The distance in meters between the ellipsoid surface and the positions. - * @param {Number} [options.extrudedHeight] The distance in meters between the ellipsoid surface and the extruded face. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number} [options.height=0] The distance in meters between the ellipsoid surface and the positions. + * @param {number} [options.extrudedHeight] The distance in meters between the ellipsoid surface and the extruded face. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * @param {CornerType} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners. * @@ -1104,7 +1104,7 @@ function CorridorGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = 1 + @@ -1118,10 +1118,10 @@ function CorridorGeometry(options) { * Stores the provided instance into the provided array. * * @param {CorridorGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ CorridorGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -1174,8 +1174,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {CorridorGeometry} [result] The object into which to store the result. * @returns {CorridorGeometry} The modified result parameter or a new CorridorGeometry instance if one was not provided. */ @@ -1243,9 +1243,9 @@ CorridorGeometry.unpack = function (array, startingIndex, result) { /** * Computes the bounding rectangle given the provided options * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of positions that define the center of the corridor. - * @param {Number} options.width The distance between the edges of the corridor in meters. + * @param {number} options.width The distance between the edges of the corridor in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. * @param {CornerType} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners. * @param {Rectangle} [result] An object in which to store the result. diff --git a/packages/engine/Source/Core/CorridorOutlineGeometry.js b/packages/engine/Source/Core/CorridorOutlineGeometry.js index c8e9c6130fc0..66a39d04bd3b 100644 --- a/packages/engine/Source/Core/CorridorOutlineGeometry.js +++ b/packages/engine/Source/Core/CorridorOutlineGeometry.js @@ -358,13 +358,13 @@ function computePositionsExtruded(params) { * @alias CorridorOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of positions that define the center of the corridor outline. - * @param {Number} options.width The distance between the edges of the corridor outline. + * @param {number} options.width The distance between the edges of the corridor outline. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Number} [options.height=0] The distance in meters between the positions and the ellipsoid surface. - * @param {Number} [options.extrudedHeight] The distance in meters between the extruded face and the ellipsoid surface. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number} [options.height=0] The distance in meters between the positions and the ellipsoid surface. + * @param {number} [options.extrudedHeight] The distance in meters between the extruded face and the ellipsoid surface. * @param {CornerType} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners. * * @see CorridorOutlineGeometry.createGeometry @@ -405,7 +405,7 @@ function CorridorOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = 1 + positions.length * Cartesian3.packedLength + Ellipsoid.packedLength + 6; @@ -415,10 +415,10 @@ function CorridorOutlineGeometry(options) { * Stores the provided instance into the provided array. * * @param {CorridorOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ CorridorOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -464,8 +464,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {CorridorOutlineGeometry} [result] The object into which to store the result. * @returns {CorridorOutlineGeometry} The modified result parameter or a new CorridorOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/Credit.js b/packages/engine/Source/Core/Credit.js index 456d34768dd5..807a79ff1c0a 100644 --- a/packages/engine/Source/Core/Credit.js +++ b/packages/engine/Source/Core/Credit.js @@ -8,8 +8,8 @@ const creditToId = {}; /** * A credit contains data pertaining to how to display attributions/credits for certain content on the screen. - * @param {String} html An string representing an html code snippet - * @param {Boolean} [showOnScreen=false] If true, the credit will be visible in the main credit container. Otherwise, it will appear in a popover + * @param {string} html An string representing an html code snippet + * @param {boolean} [showOnScreen=false] If true, the credit will be visible in the main credit container. Otherwise, it will appear in a popover * * @alias Credit * @constructor @@ -47,7 +47,7 @@ Object.defineProperties(Credit.prototype, { /** * The credit content * @memberof Credit.prototype - * @type {String} + * @type {string} * @readonly */ html: { @@ -58,7 +58,7 @@ Object.defineProperties(Credit.prototype, { /** * @memberof Credit.prototype - * @type {Number} + * @type {number} * @readonly * * @private @@ -72,7 +72,7 @@ Object.defineProperties(Credit.prototype, { /** * Whether the credit should be displayed on screen or in a lightbox * @memberof Credit.prototype - * @type {Boolean} + * @type {boolean} */ showOnScreen: { get: function () { @@ -116,7 +116,7 @@ Object.defineProperties(Credit.prototype, { * * @param {Credit} left The first credit * @param {Credit} right The second credit - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Credit.equals = function (left, right) { return ( @@ -132,7 +132,7 @@ Credit.equals = function (left, right) { * Returns true if the credits are equal * * @param {Credit} credit The credit to compare to. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Credit.prototype.equals = function (credit) { return Credit.equals(this, credit); diff --git a/packages/engine/Source/Core/CubicRealPolynomial.js b/packages/engine/Source/Core/CubicRealPolynomial.js index 767cadb2802f..b199a322dcb4 100644 --- a/packages/engine/Source/Core/CubicRealPolynomial.js +++ b/packages/engine/Source/Core/CubicRealPolynomial.js @@ -11,11 +11,11 @@ const CubicRealPolynomial = {}; /** * Provides the discriminant of the cubic equation from the supplied coefficients. * - * @param {Number} a The coefficient of the 3rd order monomial. - * @param {Number} b The coefficient of the 2nd order monomial. - * @param {Number} c The coefficient of the 1st order monomial. - * @param {Number} d The coefficient of the 0th order monomial. - * @returns {Number} The value of the discriminant. + * @param {number} a The coefficient of the 3rd order monomial. + * @param {number} b The coefficient of the 2nd order monomial. + * @param {number} c The coefficient of the 1st order monomial. + * @param {number} d The coefficient of the 0th order monomial. + * @returns {number} The value of the discriminant. */ CubicRealPolynomial.computeDiscriminant = function (a, b, c, d) { //>>includeStart('debug', pragmas.debug); @@ -155,11 +155,11 @@ function computeRealRoots(a, b, c, d) { /** * Provides the real valued roots of the cubic polynomial with the provided coefficients. * - * @param {Number} a The coefficient of the 3rd order monomial. - * @param {Number} b The coefficient of the 2nd order monomial. - * @param {Number} c The coefficient of the 1st order monomial. - * @param {Number} d The coefficient of the 0th order monomial. - * @returns {Number[]} The real valued roots. + * @param {number} a The coefficient of the 3rd order monomial. + * @param {number} b The coefficient of the 2nd order monomial. + * @param {number} c The coefficient of the 1st order monomial. + * @param {number} d The coefficient of the 0th order monomial. + * @returns {number[]} The real valued roots. */ CubicRealPolynomial.computeRealRoots = function (a, b, c, d) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/CullingVolume.js b/packages/engine/Source/Core/CullingVolume.js index fca05af24f0e..080d4a0a7688 100644 --- a/packages/engine/Source/Core/CullingVolume.js +++ b/packages/engine/Source/Core/CullingVolume.js @@ -103,7 +103,7 @@ CullingVolume.fromBoundingSphere = function (boundingSphere, result) { /** * Determines whether a bounding volume intersects the culling volume. * - * @param {Object} boundingVolume The bounding volume whose intersection with the culling volume is to be tested. + * @param {object} boundingVolume The bounding volume whose intersection with the culling volume is to be tested. * @returns {Intersect} Intersect.OUTSIDE, Intersect.INTERSECTING, or Intersect.INSIDE. */ CullingVolume.prototype.computeVisibility = function (boundingVolume) { @@ -132,12 +132,12 @@ CullingVolume.prototype.computeVisibility = function (boundingVolume) { /** * Determines whether a bounding volume intersects the culling volume. * - * @param {Object} boundingVolume The bounding volume whose intersection with the culling volume is to be tested. - * @param {Number} parentPlaneMask A bit mask from the boundingVolume's parent's check against the same culling + * @param {object} boundingVolume The bounding volume whose intersection with the culling volume is to be tested. + * @param {number} parentPlaneMask A bit mask from the boundingVolume's parent's check against the same culling * volume, such that if (planeMask & (1 << planeIndex) === 0), for k < 31, then * the parent (and therefore this) volume is completely inside plane[planeIndex] * and that plane check can be skipped. - * @returns {Number} A plane mask as described above (which can be applied to this boundingVolume's children). + * @returns {number} A plane mask as described above (which can be applied to this boundingVolume's children). * * @private */ @@ -192,7 +192,7 @@ CullingVolume.prototype.computeVisibilityWithPlaneMask = function ( * For plane masks (as used in {@link CullingVolume#computeVisibilityWithPlaneMask}), this special value * represents the case where the object bounding volume is entirely outside the culling volume. * - * @type {Number} + * @type {number} * @private */ CullingVolume.MASK_OUTSIDE = 0xffffffff; @@ -201,7 +201,7 @@ CullingVolume.MASK_OUTSIDE = 0xffffffff; * For plane masks (as used in {@link CullingVolume.prototype.computeVisibilityWithPlaneMask}), this value * represents the case where the object bounding volume is entirely inside the culling volume. * - * @type {Number} + * @type {number} * @private */ CullingVolume.MASK_INSIDE = 0x00000000; @@ -210,7 +210,7 @@ CullingVolume.MASK_INSIDE = 0x00000000; * For plane masks (as used in {@link CullingVolume.prototype.computeVisibilityWithPlaneMask}), this value * represents the case where the object bounding volume (may) intersect all planes of the culling volume. * - * @type {Number} + * @type {number} * @private */ CullingVolume.MASK_INDETERMINATE = 0x7fffffff; diff --git a/packages/engine/Source/Core/CustomHeightmapTerrainProvider.js b/packages/engine/Source/Core/CustomHeightmapTerrainProvider.js index adfeaa4f0ebd..d4328b008822 100644 --- a/packages/engine/Source/Core/CustomHeightmapTerrainProvider.js +++ b/packages/engine/Source/Core/CustomHeightmapTerrainProvider.js @@ -10,10 +10,10 @@ import TerrainProvider from "./TerrainProvider.js"; /** * @callback CustomHeightmapTerrainProvider.GeometryCallback - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. - * @returns {Int8Array|Uint8Array|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array|Number[]|Promise.|undefined} An array or a promise to an array of heights in row-major order. If undefined, the globe will render the parent tile. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. + * @returns {Int8Array|Uint8Array|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array|number[]|Promise|undefined} An array or a promise to an array of heights in row-major order. If undefined, the globe will render the parent tile. */ /** @@ -28,17 +28,17 @@ import TerrainProvider from "./TerrainProvider.js"; * @alias CustomHeightmapTerrainProvider * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {CustomHeightmapTerrainProvider.GeometryCallback} options.callback The callback function for requesting tile geometry. - * @param {Number} options.width The number of columns per heightmap tile. - * @param {Number} options.height The number of rows per heightmap tile. + * @param {number} options.width The number of columns per heightmap tile. + * @param {number} options.height The number of rows per heightmap tile. * @param {TilingScheme} [options.tilingScheme] The tiling scheme specifying how the ellipsoidal * surface is broken into tiles. If this parameter is not provided, a {@link GeographicTilingScheme} * is used. * @param {Ellipsoid} [options.ellipsoid] The ellipsoid. If the tilingScheme is specified, * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither * parameter is specified, the WGS84 ellipsoid is used. - * @param {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas. + * @param {Credit|string} [options.credit] A credit for the data source, which is displayed on the canvas. * * @example * const viewer = new Cesium.Viewer("cesiumContainer", { @@ -135,7 +135,7 @@ Object.defineProperties(CustomHeightmapTerrainProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof CustomHeightmapTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -147,7 +147,7 @@ Object.defineProperties(CustomHeightmapTerrainProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof CustomHeightmapTerrainProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -163,7 +163,7 @@ Object.defineProperties(CustomHeightmapTerrainProvider.prototype, { * Water mask is not supported by {@link CustomHeightmapTerrainProvider}, so the return * value will always be false. * @memberof CustomHeightmapTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasWaterMask: { @@ -177,7 +177,7 @@ Object.defineProperties(CustomHeightmapTerrainProvider.prototype, { * Vertex normals are not supported by {@link CustomHeightmapTerrainProvider}, so the return * value will always be false. * @memberof CustomHeightmapTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasVertexNormals: { @@ -189,7 +189,7 @@ Object.defineProperties(CustomHeightmapTerrainProvider.prototype, { /** * Gets the number of columns per heightmap tile. * @memberof CustomHeightmapTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ width: { @@ -201,7 +201,7 @@ Object.defineProperties(CustomHeightmapTerrainProvider.prototype, { /** * Gets the number of rows per heightmap tile. * @memberof CustomHeightmapTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ height: { @@ -215,12 +215,12 @@ Object.defineProperties(CustomHeightmapTerrainProvider.prototype, { * Requests the geometry for a given tile. The result includes terrain * data and indicates that all child tiles are available. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @param {Request} [request] The request object. Intended for internal use only. * - * @returns {Promise.|undefined} A promise for the requested geometry. If this method + * @returns {Promise|undefined} A promise for the requested geometry. If this method * returns undefined instead of a promise, it is an indication that too many requests are already * pending and the request will be retried later. */ @@ -241,7 +241,7 @@ CustomHeightmapTerrainProvider.prototype.requestTileGeometry = function ( return Promise.resolve(promise).then(function (heightmapData) { let buffer = heightmapData; if (Array.isArray(buffer)) { - // HeightmapTerrainData expects a TypedArray, so convert from Number[] to Float64Array + // HeightmapTerrainData expects a TypedArray, so convert from number[] to Float64Array buffer = new Float64Array(buffer); } @@ -256,8 +256,8 @@ CustomHeightmapTerrainProvider.prototype.requestTileGeometry = function ( /** * Gets the maximum geometric error allowed in a tile at a given level. * - * @param {Number} level The tile level for which to get the maximum geometric error. - * @returns {Number} The maximum geometric error. + * @param {number} level The tile level for which to get the maximum geometric error. + * @returns {number} The maximum geometric error. */ CustomHeightmapTerrainProvider.prototype.getLevelMaximumGeometricError = function ( level @@ -268,10 +268,10 @@ CustomHeightmapTerrainProvider.prototype.getLevelMaximumGeometricError = functio /** * Determines whether data for a tile is available to be loaded. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. - * @returns {Boolean|undefined} Undefined if not supported, otherwise true or false. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. + * @returns {boolean|undefined} Undefined if not supported, otherwise true or false. */ CustomHeightmapTerrainProvider.prototype.getTileDataAvailable = function ( x, @@ -284,9 +284,9 @@ CustomHeightmapTerrainProvider.prototype.getTileDataAvailable = function ( /** * Makes sure we load availability data for a tile * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @returns {undefined|Promise} Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded */ CustomHeightmapTerrainProvider.prototype.loadTileDataAvailability = function ( diff --git a/packages/engine/Source/Core/CylinderGeometry.js b/packages/engine/Source/Core/CylinderGeometry.js index bfaf8e06a856..a2b620c57a72 100644 --- a/packages/engine/Source/Core/CylinderGeometry.js +++ b/packages/engine/Source/Core/CylinderGeometry.js @@ -27,11 +27,11 @@ const positionScratch = new Cartesian3(); * @alias CylinderGeometry * @constructor * - * @param {Object} options Object with the following properties: - * @param {Number} options.length The length of the cylinder. - * @param {Number} options.topRadius The radius of the top of the cylinder. - * @param {Number} options.bottomRadius The radius of the bottom of the cylinder. - * @param {Number} [options.slices=128] The number of edges around the perimeter of the cylinder. + * @param {object} options Object with the following properties: + * @param {number} options.length The length of the cylinder. + * @param {number} options.topRadius The radius of the top of the cylinder. + * @param {number} options.bottomRadius The radius of the bottom of the cylinder. + * @param {number} [options.slices=128] The number of edges around the perimeter of the cylinder. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * * @exception {DeveloperError} options.slices must be greater than or equal to 3. @@ -92,7 +92,7 @@ function CylinderGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ CylinderGeometry.packedLength = VertexFormat.packedLength + 5; @@ -100,10 +100,10 @@ CylinderGeometry.packedLength = VertexFormat.packedLength + 5; * Stores the provided instance into the provided array. * * @param {CylinderGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ CylinderGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -142,8 +142,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {CylinderGeometry} [result] The object into which to store the result. * @returns {CylinderGeometry} The modified result parameter or a new CylinderGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/CylinderOutlineGeometry.js b/packages/engine/Source/Core/CylinderOutlineGeometry.js index b639e07cbcf6..bd587dcb4084 100644 --- a/packages/engine/Source/Core/CylinderOutlineGeometry.js +++ b/packages/engine/Source/Core/CylinderOutlineGeometry.js @@ -22,12 +22,12 @@ const radiusScratch = new Cartesian2(); * @alias CylinderOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: - * @param {Number} options.length The length of the cylinder. - * @param {Number} options.topRadius The radius of the top of the cylinder. - * @param {Number} options.bottomRadius The radius of the bottom of the cylinder. - * @param {Number} [options.slices=128] The number of edges around the perimeter of the cylinder. - * @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom surfaces of the cylinder. + * @param {object} options Object with the following properties: + * @param {number} options.length The length of the cylinder. + * @param {number} options.topRadius The radius of the top of the cylinder. + * @param {number} options.bottomRadius The radius of the bottom of the cylinder. + * @param {number} [options.slices=128] The number of edges around the perimeter of the cylinder. + * @param {number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom surfaces of the cylinder. * * @exception {DeveloperError} options.length must be greater than 0. * @exception {DeveloperError} options.topRadius must be greater than 0. @@ -84,7 +84,7 @@ function CylinderOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ CylinderOutlineGeometry.packedLength = 6; @@ -92,10 +92,10 @@ CylinderOutlineGeometry.packedLength = 6; * Stores the provided instance into the provided array. * * @param {CylinderOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ CylinderOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -127,8 +127,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {CylinderOutlineGeometry} [result] The object into which to store the result. * @returns {CylinderOutlineGeometry} The modified result parameter or a new CylinderOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/DefaultProxy.js b/packages/engine/Source/Core/DefaultProxy.js index 17b3badb71b0..8000b305da2a 100644 --- a/packages/engine/Source/Core/DefaultProxy.js +++ b/packages/engine/Source/Core/DefaultProxy.js @@ -6,7 +6,7 @@ * @constructor * @extends {Proxy} * - * @param {String} proxy The proxy URL that will be used to requests all resources. + * @param {string} proxy The proxy URL that will be used to requests all resources. */ function DefaultProxy(proxy) { this.proxy = proxy; @@ -15,8 +15,8 @@ function DefaultProxy(proxy) { /** * Get the final URL to use to request a given resource. * - * @param {String} resource The resource to request. - * @returns {String} proxied resource + * @param {string} resource The resource to request. + * @returns {string} proxied resource */ DefaultProxy.prototype.getURL = function (resource) { const prefix = this.proxy.indexOf("?") === -1 ? "?" : ""; diff --git a/packages/engine/Source/Core/DeveloperError.js b/packages/engine/Source/Core/DeveloperError.js index 142af569e4dc..a330471eef23 100644 --- a/packages/engine/Source/Core/DeveloperError.js +++ b/packages/engine/Source/Core/DeveloperError.js @@ -14,21 +14,21 @@ import defined from "./defined.js"; * @constructor * @extends Error * - * @param {String} [message] The error message for this exception. + * @param {string} [message] The error message for this exception. * * @see RuntimeError */ function DeveloperError(message) { /** * 'DeveloperError' indicating that this exception was thrown due to a developer error. - * @type {String} + * @type {string} * @readonly */ this.name = "DeveloperError"; /** * The explanation for why this exception was thrown. - * @type {String} + * @type {string} * @readonly */ this.message = message; @@ -43,7 +43,7 @@ function DeveloperError(message) { /** * The stack trace of this exception, if available. - * @type {String} + * @type {string} * @readonly */ this.stack = stack; diff --git a/packages/engine/Source/Core/DistanceDisplayCondition.js b/packages/engine/Source/Core/DistanceDisplayCondition.js index 31c3a26a04e0..e00e08aec341 100644 --- a/packages/engine/Source/Core/DistanceDisplayCondition.js +++ b/packages/engine/Source/Core/DistanceDisplayCondition.js @@ -8,8 +8,8 @@ import DeveloperError from "./DeveloperError.js"; * @alias DistanceDisplayCondition * @constructor * - * @param {Number} [near=0.0] The smallest distance in the interval where the object is visible. - * @param {Number} [far=Number.MAX_VALUE] The largest distance in the interval where the object is visible. + * @param {number} [near=0.0] The smallest distance in the interval where the object is visible. + * @param {number} [far=Number.MAX_VALUE] The largest distance in the interval where the object is visible. * * @example * // Make a billboard that is only visible when the distance to the camera is between 10 and 20 meters. @@ -27,7 +27,7 @@ Object.defineProperties(DistanceDisplayCondition.prototype, { /** * The smallest distance in the interval where the object is visible. * @memberof DistanceDisplayCondition.prototype - * @type {Number} + * @type {number} * @default 0.0 */ near: { @@ -41,7 +41,7 @@ Object.defineProperties(DistanceDisplayCondition.prototype, { /** * The largest distance in the interval where the object is visible. * @memberof DistanceDisplayCondition.prototype - * @type {Number} + * @type {number} * @default Number.MAX_VALUE */ far: { @@ -56,7 +56,7 @@ Object.defineProperties(DistanceDisplayCondition.prototype, { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ DistanceDisplayCondition.packedLength = 2; @@ -64,10 +64,10 @@ DistanceDisplayCondition.packedLength = 2; * Stores the provided instance into the provided array. * * @param {DistanceDisplayCondition} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ DistanceDisplayCondition.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -90,8 +90,8 @@ DistanceDisplayCondition.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {DistanceDisplayCondition} [result] The object into which to store the result. * @returns {DistanceDisplayCondition} The modified result parameter or a new DistanceDisplayCondition instance if one was not provided. */ @@ -117,7 +117,7 @@ DistanceDisplayCondition.unpack = function (array, startingIndex, result) { * * @param {DistanceDisplayCondition} left A distance display condition. * @param {DistanceDisplayCondition} right Another distance display condition. - * @return {Boolean} Whether the two distance display conditions are equal. + * @return {boolean} Whether the two distance display conditions are equal. */ DistanceDisplayCondition.equals = function (left, right) { return ( @@ -164,7 +164,7 @@ DistanceDisplayCondition.prototype.clone = function (result) { * Determines if this distance display condition is equal to another. * * @param {DistanceDisplayCondition} other Another distance display condition. - * @return {Boolean} Whether this distance display condition is equal to the other. + * @return {boolean} Whether this distance display condition is equal to the other. */ DistanceDisplayCondition.prototype.equals = function (other) { return DistanceDisplayCondition.equals(this, other); diff --git a/packages/engine/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js b/packages/engine/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js index b6a35ca8c9dd..6bf81bd70db0 100644 --- a/packages/engine/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js +++ b/packages/engine/Source/Core/DistanceDisplayConditionGeometryInstanceAttribute.js @@ -9,8 +9,8 @@ import DeveloperError from "./DeveloperError.js"; * @alias DistanceDisplayConditionGeometryInstanceAttribute * @constructor * - * @param {Number} [near=0.0] The near distance. - * @param {Number} [far=Number.MAX_VALUE] The far distance. + * @param {number} [near=0.0] The near distance. + * @param {number} [far=Number.MAX_VALUE] The far distance. * * @exception {DeveloperError} far must be greater than near. * @@ -47,7 +47,7 @@ function DistanceDisplayConditionGeometryInstanceAttribute(near, far) { /** * The values for the attributes stored in a typed array. * - * @type Float32Array + * @type {Float32Array} * * @default [0.0, 0.0, Number.MAX_VALUE] */ @@ -79,7 +79,7 @@ Object.defineProperties( * * @memberof DistanceDisplayConditionGeometryInstanceAttribute.prototype * - * @type {Number} + * @type {number} * @readonly * * @default 3 @@ -97,7 +97,7 @@ Object.defineProperties( * * @memberof DistanceDisplayConditionGeometryInstanceAttribute.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false diff --git a/packages/engine/Source/Core/DoubleEndedPriorityQueue.js b/packages/engine/Source/Core/DoubleEndedPriorityQueue.js index 85725846311a..e0abcf5f6e0f 100644 --- a/packages/engine/Source/Core/DoubleEndedPriorityQueue.js +++ b/packages/engine/Source/Core/DoubleEndedPriorityQueue.js @@ -10,9 +10,9 @@ import defined from "./defined.js"; * @constructor * @private * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {DoubleEndedPriorityQueue.ComparatorCallback} options.comparator The comparator to use for the queue. If comparator(a, b) is less than 0, a is lower priority than b. - * @param {Number} [options.maximumLength] The maximum length of the queue. If an element is inserted when the queue is at full capacity, the minimum element is removed. By default, the size of the queue is unlimited. + * @param {number} [options.maximumLength] The maximum length of the queue. If an element is inserted when the queue is at full capacity, the minimum element is removed. By default, the size of the queue is unlimited. */ function DoubleEndedPriorityQueue(options) { //>>includeStart('debug', pragmas.debug); @@ -41,7 +41,7 @@ Object.defineProperties(DoubleEndedPriorityQueue.prototype, { * * @memberof DoubleEndedPriorityQueue.prototype * - * @type {Number} + * @type {number} * @readonly */ length: { @@ -58,7 +58,7 @@ Object.defineProperties(DoubleEndedPriorityQueue.prototype, { * * @memberof DoubleEndedPriorityQueue.prototype * - * @type {Number} + * @type {number} * @readonly */ maximumLength: { @@ -400,6 +400,6 @@ function pushDown(that, index) { * @callback DoubleEndedPriorityQueue.ComparatorCallback * @param {*} a An element in the queue. * @param {*} b An element in the queue. - * @returns {Number} If the result of the comparison is less than 0, a is lower priority than b. + * @returns {number} If the result of the comparison is less than 0, a is lower priority than b. */ export default DoubleEndedPriorityQueue; diff --git a/packages/engine/Source/Core/EarthOrientationParameters.js b/packages/engine/Source/Core/EarthOrientationParameters.js index 7dcec0842547..514d9284a584 100644 --- a/packages/engine/Source/Core/EarthOrientationParameters.js +++ b/packages/engine/Source/Core/EarthOrientationParameters.js @@ -20,11 +20,11 @@ import TimeStandard from "./TimeStandard.js"; * @alias EarthOrientationParameters * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Object} [options.data] The actual EOP data. If neither this + * @param {object} [options] Object with the following properties: + * @param {object} [options.data] The actual EOP data. If neither this * parameter nor options.data is specified, all EOP values are assumed * to be 0.0. - * @param {Boolean} [options.addNewLeapSeconds=true] True if leap seconds that + * @param {boolean} [options.addNewLeapSeconds=true] True if leap seconds that * are specified in the EOP data but not in {@link JulianDate.leapSeconds} * should be added to {@link JulianDate.leapSeconds}. False if * new leap seconds should be handled correctly in the context @@ -75,12 +75,12 @@ function EarthOrientationParameters(options) { /** * - * @param {Resource|String} [url] The URL from which to obtain EOP data. If neither this + * @param {Resource|string} [url] The URL from which to obtain EOP data. If neither this * parameter nor options.data is specified, all EOP values are assumed * to be 0.0. If options.data is specified, this parameter is * ignored. - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.addNewLeapSeconds=true] True if leap seconds that + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.addNewLeapSeconds=true] True if leap seconds that * are specified in the EOP data but not in {@link JulianDate.leapSeconds} * should be added to {@link JulianDate.leapSeconds}. False if * new leap seconds should be handled correctly in the context diff --git a/packages/engine/Source/Core/EarthOrientationParametersSample.js b/packages/engine/Source/Core/EarthOrientationParametersSample.js index 2dbc856954d4..336e564da4b8 100644 --- a/packages/engine/Source/Core/EarthOrientationParametersSample.js +++ b/packages/engine/Source/Core/EarthOrientationParametersSample.js @@ -4,11 +4,11 @@ * @alias EarthOrientationParametersSample * @constructor * - * @param {Number} xPoleWander The pole wander about the X axis, in radians. - * @param {Number} yPoleWander The pole wander about the Y axis, in radians. - * @param {Number} xPoleOffset The offset to the Celestial Intermediate Pole (CIP) about the X axis, in radians. - * @param {Number} yPoleOffset The offset to the Celestial Intermediate Pole (CIP) about the Y axis, in radians. - * @param {Number} ut1MinusUtc The difference in time standards, UT1 - UTC, in seconds. + * @param {number} xPoleWander The pole wander about the X axis, in radians. + * @param {number} yPoleWander The pole wander about the Y axis, in radians. + * @param {number} xPoleOffset The offset to the Celestial Intermediate Pole (CIP) about the X axis, in radians. + * @param {number} yPoleOffset The offset to the Celestial Intermediate Pole (CIP) about the Y axis, in radians. + * @param {number} ut1MinusUtc The difference in time standards, UT1 - UTC, in seconds. * * @private */ @@ -21,31 +21,31 @@ function EarthOrientationParametersSample( ) { /** * The pole wander about the X axis, in radians. - * @type {Number} + * @type {number} */ this.xPoleWander = xPoleWander; /** * The pole wander about the Y axis, in radians. - * @type {Number} + * @type {number} */ this.yPoleWander = yPoleWander; /** * The offset to the Celestial Intermediate Pole (CIP) about the X axis, in radians. - * @type {Number} + * @type {number} */ this.xPoleOffset = xPoleOffset; /** * The offset to the Celestial Intermediate Pole (CIP) about the Y axis, in radians. - * @type {Number} + * @type {number} */ this.yPoleOffset = yPoleOffset; /** * The difference in time standards, UT1 - UTC, in seconds. - * @type {Number} + * @type {number} */ this.ut1MinusUtc = ut1MinusUtc; } diff --git a/packages/engine/Source/Core/EasingFunction.js b/packages/engine/Source/Core/EasingFunction.js index 8baaf38d28e4..0b8cc00c2e86 100644 --- a/packages/engine/Source/Core/EasingFunction.js +++ b/packages/engine/Source/Core/EasingFunction.js @@ -240,8 +240,8 @@ const EasingFunction = { /** * Function interface for implementing a custom easing function. * @callback EasingFunction.Callback - * @param {Number} time The time in the range [0, 1]. - * @returns {Number} The value of the function at the given time. + * @param {number} time The time in the range [0, 1]. + * @returns {number} The value of the function at the given time. * * @example * function quadraticIn(time) { diff --git a/packages/engine/Source/Core/EllipseGeometry.js b/packages/engine/Source/Core/EllipseGeometry.js index b7ecda453b16..483ec135780b 100644 --- a/packages/engine/Source/Core/EllipseGeometry.js +++ b/packages/engine/Source/Core/EllipseGeometry.js @@ -888,16 +888,16 @@ function computeRectangle( * @alias EllipseGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.center The ellipse's center point in the fixed frame. - * @param {Number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters. - * @param {Number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters. + * @param {number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters. + * @param {number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid the ellipse will be on. - * @param {Number} [options.height=0.0] The distance in meters between the ellipse and the ellipsoid surface. - * @param {Number} [options.extrudedHeight] The distance in meters between the ellipse's extruded face and the ellipsoid surface. - * @param {Number} [options.rotation=0.0] The angle of rotation counter-clockwise from north. - * @param {Number} [options.stRotation=0.0] The rotation of the texture coordinates counter-clockwise from north. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The angular distance between points on the ellipse in radians. + * @param {number} [options.height=0.0] The distance in meters between the ellipse and the ellipsoid surface. + * @param {number} [options.extrudedHeight] The distance in meters between the ellipse's extruded face and the ellipsoid surface. + * @param {number} [options.rotation=0.0] The angle of rotation counter-clockwise from north. + * @param {number} [options.stRotation=0.0] The rotation of the texture coordinates counter-clockwise from north. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The angular distance between points on the ellipse in radians. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * * @exception {DeveloperError} semiMajorAxis and semiMinorAxis must be greater than zero. @@ -967,7 +967,7 @@ function EllipseGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ EllipseGeometry.packedLength = Cartesian3.packedLength + @@ -979,10 +979,10 @@ EllipseGeometry.packedLength = * Stores the provided instance into the provided array. * * @param {EllipseGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ EllipseGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -1035,8 +1035,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {EllipseGeometry} [result] The object into which to store the result. * @returns {EllipseGeometry} The modified result parameter or a new EllipseGeometry instance if one was not provided. */ @@ -1105,13 +1105,13 @@ EllipseGeometry.unpack = function (array, startingIndex, result) { /** * Computes the bounding rectangle based on the provided options * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.center The ellipse's center point in the fixed frame. - * @param {Number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters. - * @param {Number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters. + * @param {number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters. + * @param {number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid the ellipse will be on. - * @param {Number} [options.rotation=0.0] The angle of rotation counter-clockwise from north. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The angular distance between points on the ellipse in radians. + * @param {number} [options.rotation=0.0] The angle of rotation counter-clockwise from north. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The angular distance between points on the ellipse in radians. * @param {Rectangle} [result] An object in which to store the result * * @returns {Rectangle} The result rectangle diff --git a/packages/engine/Source/Core/EllipseOutlineGeometry.js b/packages/engine/Source/Core/EllipseOutlineGeometry.js index 5a18e4f7e31a..3593c2db0b9c 100644 --- a/packages/engine/Source/Core/EllipseOutlineGeometry.js +++ b/packages/engine/Source/Core/EllipseOutlineGeometry.js @@ -184,16 +184,16 @@ function computeExtrudedEllipse(options) { * @alias EllipseOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.center The ellipse's center point in the fixed frame. - * @param {Number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters. - * @param {Number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters. + * @param {number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters. + * @param {number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid the ellipse will be on. - * @param {Number} [options.height=0.0] The distance in meters between the ellipse and the ellipsoid surface. - * @param {Number} [options.extrudedHeight] The distance in meters between the ellipse's extruded face and the ellipsoid surface. - * @param {Number} [options.rotation=0.0] The angle from north (counter-clockwise) in radians. - * @param {Number} [options.granularity=0.02] The angular distance between points on the ellipse in radians. - * @param {Number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom surface of an extruded ellipse. + * @param {number} [options.height=0.0] The distance in meters between the ellipse and the ellipsoid surface. + * @param {number} [options.extrudedHeight] The distance in meters between the ellipse's extruded face and the ellipsoid surface. + * @param {number} [options.rotation=0.0] The angle from north (counter-clockwise) in radians. + * @param {number} [options.granularity=0.02] The angular distance between points on the ellipse in radians. + * @param {number} [options.numberOfVerticalLines=16] Number of lines to draw between the top and bottom surface of an extruded ellipse. * * @exception {DeveloperError} semiMajorAxis and semiMinorAxis must be greater than zero. * @exception {DeveloperError} semiMajorAxis must be greater than or equal to the semiMinorAxis. @@ -263,7 +263,7 @@ function EllipseOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ EllipseOutlineGeometry.packedLength = Cartesian3.packedLength + Ellipsoid.packedLength + 8; @@ -272,10 +272,10 @@ EllipseOutlineGeometry.packedLength = * Stores the provided instance into the provided array. * * @param {EllipseOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ EllipseOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -325,8 +325,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {EllipseOutlineGeometry} [result] The object into which to store the result. * @returns {EllipseOutlineGeometry} The modified result parameter or a new EllipseOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/Ellipsoid.js b/packages/engine/Source/Core/Ellipsoid.js index 184dec48833f..88e7937e622d 100644 --- a/packages/engine/Source/Core/Ellipsoid.js +++ b/packages/engine/Source/Core/Ellipsoid.js @@ -62,9 +62,9 @@ function initialize(ellipsoid, x, y, z) { * @alias Ellipsoid * @constructor * - * @param {Number} [x=0] The radius in the x direction. - * @param {Number} [y=0] The radius in the y direction. - * @param {Number} [z=0] The radius in the z direction. + * @param {number} [x=0] The radius in the x direction. + * @param {number} [y=0] The radius in the y direction. + * @param {number} [z=0] The radius in the z direction. * * @exception {DeveloperError} All radii components must be greater than or equal to zero. * @@ -145,7 +145,7 @@ Object.defineProperties(Ellipsoid.prototype, { /** * Gets the minimum radius of the ellipsoid. * @memberof Ellipsoid.prototype - * @type {Number} + * @type {number} * @readonly */ minimumRadius: { @@ -156,7 +156,7 @@ Object.defineProperties(Ellipsoid.prototype, { /** * Gets the maximum radius of the ellipsoid. * @memberof Ellipsoid.prototype - * @type {Number} + * @type {number} * @readonly */ maximumRadius: { @@ -267,7 +267,7 @@ Ellipsoid.prototype.clone = function (result) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Ellipsoid.packedLength = Cartesian3.packedLength; @@ -275,10 +275,10 @@ Ellipsoid.packedLength = Cartesian3.packedLength; * Stores the provided instance into the provided array. * * @param {Ellipsoid} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Ellipsoid.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -296,8 +296,8 @@ Ellipsoid.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Ellipsoid} [result] The object into which to store the result. * @returns {Ellipsoid} The modified result parameter or a new Ellipsoid instance if one was not provided. */ @@ -618,7 +618,7 @@ Ellipsoid.prototype.transformPositionFromScaledSpace = function ( * true if they are equal, false otherwise. * * @param {Ellipsoid} [right] The other Ellipsoid. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ Ellipsoid.prototype.equals = function (right) { return ( @@ -630,7 +630,7 @@ Ellipsoid.prototype.equals = function (right) { /** * Creates a string representing this Ellipsoid in the format '(radii.x, radii.y, radii.z)'. * - * @returns {String} A string representing this ellipsoid in the format '(radii.x, radii.y, radii.z)'. + * @returns {string} A string representing this ellipsoid in the format '(radii.x, radii.y, radii.z)'. */ Ellipsoid.prototype.toString = function () { return this._radii.toString(); @@ -640,7 +640,7 @@ Ellipsoid.prototype.toString = function () { * Computes a point which is the intersection of the surface normal with the z-axis. * * @param {Cartesian3} position the position. must be on the surface of the ellipsoid. - * @param {Number} [buffer = 0.0] A buffer to subtract from the ellipsoid size when checking if the point is inside the ellipsoid. + * @param {number} [buffer = 0.0] A buffer to subtract from the ellipsoid size when checking if the point is inside the ellipsoid. * In earth case, with common earth datums, there is no need for this buffer since the intersection point is always (relatively) very close to the center. * In WGS84 datum, intersection point is at max z = +-42841.31151331382 (0.673% of z-axis). * Intersection point could be outside the ellipsoid if the ratio of MajorAxis / AxisOfRotation is bigger than the square root of 2 @@ -714,10 +714,10 @@ const weights = [ /** * Compute the 10th order Gauss-Legendre Quadrature of the given definite integral. * - * @param {Number} a The lower bound for the integration. - * @param {Number} b The upper bound for the integration. + * @param {number} a The lower bound for the integration. + * @param {number} b The upper bound for the integration. * @param {Ellipsoid~RealValuedScalarFunction} func The function to integrate. - * @returns {Number} The value of the integral of the given function over the given domain. + * @returns {number} The value of the integral of the given function over the given domain. * * @private */ @@ -748,8 +748,8 @@ function gaussLegendreQuadrature(a, b, func) { * A real valued scalar function. * @callback Ellipsoid~RealValuedScalarFunction * - * @param {Number} x The value used to evaluate the function. - * @returns {Number} The value of the function at x. + * @param {number} x The value used to evaluate the function. + * @returns {number} The value of the function at x. * * @private */ @@ -759,7 +759,7 @@ function gaussLegendreQuadrature(a, b, func) { * Gauss-Legendre 10th order quadrature. * * @param {Rectangle} rectangle The rectangle used for computing the surface area. - * @returns {Number} The approximate area of the rectangle on the surface of this ellipsoid. + * @returns {number} The approximate area of the rectangle on the surface of this ellipsoid. */ Ellipsoid.prototype.surfaceArea = function (rectangle) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/EllipsoidGeodesic.js b/packages/engine/Source/Core/EllipsoidGeodesic.js index 99256cfeaebf..6416b8241149 100644 --- a/packages/engine/Source/Core/EllipsoidGeodesic.js +++ b/packages/engine/Source/Core/EllipsoidGeodesic.js @@ -315,7 +315,7 @@ Object.defineProperties(EllipsoidGeodesic.prototype, { /** * Gets the surface distance between the start and end point * @memberof EllipsoidGeodesic.prototype - * @type {Number} + * @type {number} * @readonly */ surfaceDistance: { @@ -355,7 +355,7 @@ Object.defineProperties(EllipsoidGeodesic.prototype, { /** * Gets the heading at the initial point. * @memberof EllipsoidGeodesic.prototype - * @type {Number} + * @type {number} * @readonly */ startHeading: { @@ -371,7 +371,7 @@ Object.defineProperties(EllipsoidGeodesic.prototype, { /** * Gets the heading at the final point. * @memberof EllipsoidGeodesic.prototype - * @type {Number} + * @type {number} * @readonly */ endHeading: { @@ -403,7 +403,7 @@ EllipsoidGeodesic.prototype.setEndPoints = function (start, end) { /** * Provides the location of a point at the indicated portion along the geodesic. * - * @param {Number} fraction The portion of the distance between the initial and final points. + * @param {number} fraction The portion of the distance between the initial and final points. * @param {Cartographic} [result] The object in which to store the result. * @returns {Cartographic} The location of the point along the geodesic. */ @@ -420,7 +420,7 @@ EllipsoidGeodesic.prototype.interpolateUsingFraction = function ( /** * Provides the location of a point at the indicated distance along the geodesic. * - * @param {Number} distance The distance from the inital point to the point of interest along the geodesic + * @param {number} distance The distance from the inital point to the point of interest along the geodesic * @param {Cartographic} [result] The object in which to store the result. * @returns {Cartographic} The location of the point along the geodesic. * diff --git a/packages/engine/Source/Core/EllipsoidGeometry.js b/packages/engine/Source/Core/EllipsoidGeometry.js index e7ea3db90201..e6a8409dc78b 100644 --- a/packages/engine/Source/Core/EllipsoidGeometry.js +++ b/packages/engine/Source/Core/EllipsoidGeometry.js @@ -31,15 +31,15 @@ const sin = Math.sin; * @alias EllipsoidGeometry * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Cartesian3} [options.radii=Cartesian3(1.0, 1.0, 1.0)] The radii of the ellipsoid in the x, y, and z directions. * @param {Cartesian3} [options.innerRadii=options.radii] The inner radii of the ellipsoid in the x, y, and z directions. - * @param {Number} [options.minimumClock=0.0] The minimum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. - * @param {Number} [options.maximumClock=2*PI] The maximum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. - * @param {Number} [options.minimumCone=0.0] The minimum angle measured from the positive z-axis and toward the negative z-axis. - * @param {Number} [options.maximumCone=PI] The maximum angle measured from the positive z-axis and toward the negative z-axis. - * @param {Number} [options.stackPartitions=64] The number of times to partition the ellipsoid into stacks. - * @param {Number} [options.slicePartitions=64] The number of times to partition the ellipsoid into radial slices. + * @param {number} [options.minimumClock=0.0] The minimum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. + * @param {number} [options.maximumClock=2*PI] The maximum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. + * @param {number} [options.minimumCone=0.0] The minimum angle measured from the positive z-axis and toward the negative z-axis. + * @param {number} [options.maximumCone=PI] The maximum angle measured from the positive z-axis and toward the negative z-axis. + * @param {number} [options.stackPartitions=64] The number of times to partition the ellipsoid into stacks. + * @param {number} [options.slicePartitions=64] The number of times to partition the ellipsoid into radial slices. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * * @exception {DeveloperError} options.slicePartitions cannot be less than three. @@ -95,7 +95,7 @@ function EllipsoidGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ EllipsoidGeometry.packedLength = 2 * Cartesian3.packedLength + VertexFormat.packedLength + 7; @@ -104,10 +104,10 @@ EllipsoidGeometry.packedLength = * Stores the provided instance into the provided array. * * @param {EllipsoidGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ EllipsoidGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -160,8 +160,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {EllipsoidGeometry} [result] The object into which to store the result. * @returns {EllipsoidGeometry} The modified result parameter or a new EllipsoidGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/EllipsoidOutlineGeometry.js b/packages/engine/Source/Core/EllipsoidOutlineGeometry.js index 7b24cb420f42..53b1fd403a97 100644 --- a/packages/engine/Source/Core/EllipsoidOutlineGeometry.js +++ b/packages/engine/Source/Core/EllipsoidOutlineGeometry.js @@ -23,16 +23,16 @@ const sin = Math.sin; * @alias EllipsoidOutlineGeometry * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Cartesian3} [options.radii=Cartesian3(1.0, 1.0, 1.0)] The radii of the ellipsoid in the x, y, and z directions. * @param {Cartesian3} [options.innerRadii=options.radii] The inner radii of the ellipsoid in the x, y, and z directions. - * @param {Number} [options.minimumClock=0.0] The minimum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. - * @param {Number} [options.maximumClock=2*PI] The maximum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. - * @param {Number} [options.minimumCone=0.0] The minimum angle measured from the positive z-axis and toward the negative z-axis. - * @param {Number} [options.maximumCone=PI] The maximum angle measured from the positive z-axis and toward the negative z-axis. - * @param {Number} [options.stackPartitions=10] The count of stacks for the ellipsoid (1 greater than the number of parallel lines). - * @param {Number} [options.slicePartitions=8] The count of slices for the ellipsoid (Equal to the number of radial lines). - * @param {Number} [options.subdivisions=128] The number of points per line, determining the granularity of the curvature. + * @param {number} [options.minimumClock=0.0] The minimum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. + * @param {number} [options.maximumClock=2*PI] The maximum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. + * @param {number} [options.minimumCone=0.0] The minimum angle measured from the positive z-axis and toward the negative z-axis. + * @param {number} [options.maximumCone=PI] The maximum angle measured from the positive z-axis and toward the negative z-axis. + * @param {number} [options.stackPartitions=10] The count of stacks for the ellipsoid (1 greater than the number of parallel lines). + * @param {number} [options.slicePartitions=8] The count of slices for the ellipsoid (Equal to the number of radial lines). + * @param {number} [options.subdivisions=128] The number of points per line, determining the granularity of the curvature. * * @exception {DeveloperError} options.stackPartitions must be greater than or equal to one. * @exception {DeveloperError} options.slicePartitions must be greater than or equal to zero. @@ -96,7 +96,7 @@ function EllipsoidOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ EllipsoidOutlineGeometry.packedLength = 2 * Cartesian3.packedLength + 8; @@ -104,10 +104,10 @@ EllipsoidOutlineGeometry.packedLength = 2 * Cartesian3.packedLength + 8; * Stores the provided instance into the provided array. * * @param {EllipsoidOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ EllipsoidOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -157,8 +157,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {EllipsoidOutlineGeometry} [result] The object into which to store the result. * @returns {EllipsoidOutlineGeometry} The modified result parameter or a new EllipsoidOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/EllipsoidRhumbLine.js b/packages/engine/Source/Core/EllipsoidRhumbLine.js index adfa9089f296..047d48e87961 100644 --- a/packages/engine/Source/Core/EllipsoidRhumbLine.js +++ b/packages/engine/Source/Core/EllipsoidRhumbLine.js @@ -415,7 +415,7 @@ Object.defineProperties(EllipsoidRhumbLine.prototype, { /** * Gets the surface distance between the start and end point * @memberof EllipsoidRhumbLine.prototype - * @type {Number} + * @type {number} * @readonly */ surfaceDistance: { @@ -455,7 +455,7 @@ Object.defineProperties(EllipsoidRhumbLine.prototype, { /** * Gets the heading from the start point to the end point. * @memberof EllipsoidRhumbLine.prototype - * @type {Number} + * @type {number} * @readonly */ heading: { @@ -473,8 +473,8 @@ Object.defineProperties(EllipsoidRhumbLine.prototype, { * Create a rhumb line using an initial position with a heading and distance. * * @param {Cartographic} start The initial planetodetic point on the path. - * @param {Number} heading The heading in radians. - * @param {Number} distance The rhumb line distance between the start and end point. + * @param {number} heading The heading in radians. + * @param {number} distance The rhumb line distance between the start and end point. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rhumb line lies. * @param {EllipsoidRhumbLine} [result] The object in which to store the result. * @returns {EllipsoidRhumbLine} The EllipsoidRhumbLine object. @@ -538,7 +538,7 @@ EllipsoidRhumbLine.prototype.setEndPoints = function (start, end) { /** * Provides the location of a point at the indicated portion along the rhumb line. * - * @param {Number} fraction The portion of the distance between the initial and final points. + * @param {number} fraction The portion of the distance between the initial and final points. * @param {Cartographic} [result] The object in which to store the result. * @returns {Cartographic} The location of the point along the rhumb line. */ @@ -555,7 +555,7 @@ EllipsoidRhumbLine.prototype.interpolateUsingFraction = function ( /** * Provides the location of a point at the indicated distance along the rhumb line. * - * @param {Number} distance The distance from the inital point to the point of interest along the rhumbLine. + * @param {number} distance The distance from the inital point to the point of interest along the rhumbLine. * @param {Cartographic} [result] The object in which to store the result. * @returns {Cartographic} The location of the point along the rhumb line. * @@ -588,7 +588,7 @@ EllipsoidRhumbLine.prototype.interpolateUsingSurfaceDistance = function ( * Provides the location of a point at the indicated longitude along the rhumb line. * If the longitude is outside the range of start and end points, the first intersection with the longitude from the start point in the direction of the heading is returned. This follows the spiral property of a rhumb line. * - * @param {Number} intersectionLongitude The longitude, in radians, at which to find the intersection point from the starting point using the heading. + * @param {number} intersectionLongitude The longitude, in radians, at which to find the intersection point from the starting point using the heading. * @param {Cartographic} [result] The object in which to store the result. * @returns {Cartographic} The location of the intersection point along the rhumb line, undefined if there is no intersection or infinite intersections. * @@ -692,7 +692,7 @@ EllipsoidRhumbLine.prototype.findIntersectionWithLongitude = function ( * Provides the location of a point at the indicated latitude along the rhumb line. * If the latitude is outside the range of start and end points, the first intersection with the latitude from that start point in the direction of the heading is returned. This follows the spiral property of a rhumb line. * - * @param {Number} intersectionLatitude The latitude, in radians, at which to find the intersection point from the starting point using the heading. + * @param {number} intersectionLatitude The latitude, in radians, at which to find the intersection point from the starting point using the heading. * @param {Cartographic} [result] The object in which to store the result. * @returns {Cartographic} The location of the intersection point along the rhumb line, undefined if there is no intersection or infinite intersections. * diff --git a/packages/engine/Source/Core/EllipsoidTerrainProvider.js b/packages/engine/Source/Core/EllipsoidTerrainProvider.js index 29857362fbf9..7ef3f155401f 100644 --- a/packages/engine/Source/Core/EllipsoidTerrainProvider.js +++ b/packages/engine/Source/Core/EllipsoidTerrainProvider.js @@ -13,7 +13,7 @@ import TerrainProvider from "./TerrainProvider.js"; * @alias EllipsoidTerrainProvider * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {TilingScheme} [options.tilingScheme] The tiling scheme specifying how the ellipsoidal * surface is broken into tiles. If this parameter is not provided, a {@link GeographicTilingScheme} * is used. @@ -89,7 +89,7 @@ Object.defineProperties(EllipsoidTerrainProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof EllipsoidTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -101,7 +101,7 @@ Object.defineProperties(EllipsoidTerrainProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof EllipsoidTerrainProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -116,7 +116,7 @@ Object.defineProperties(EllipsoidTerrainProvider.prototype, { * as a reflective surface with animated waves. This function should not be * called before {@link EllipsoidTerrainProvider#ready} returns true. * @memberof EllipsoidTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasWaterMask: { @@ -129,7 +129,7 @@ Object.defineProperties(EllipsoidTerrainProvider.prototype, { * Gets a value indicating whether or not the requested tiles include vertex normals. * This function should not be called before {@link EllipsoidTerrainProvider#ready} returns true. * @memberof EllipsoidTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasVertexNormals: { @@ -158,12 +158,12 @@ Object.defineProperties(EllipsoidTerrainProvider.prototype, { * {@link TerrainProvider#ready} returns true. The result includes terrain * data and indicates that all child tiles are available. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @param {Request} [request] The request object. Intended for internal use only. * - * @returns {Promise.|undefined} A promise for the requested geometry. If this method + * @returns {Promise|undefined} A promise for the requested geometry. If this method * returns undefined instead of a promise, it is an indication that too many requests are already * pending and the request will be retried later. */ @@ -187,8 +187,8 @@ EllipsoidTerrainProvider.prototype.requestTileGeometry = function ( /** * Gets the maximum geometric error allowed in a tile at a given level. * - * @param {Number} level The tile level for which to get the maximum geometric error. - * @returns {Number} The maximum geometric error. + * @param {number} level The tile level for which to get the maximum geometric error. + * @returns {number} The maximum geometric error. */ EllipsoidTerrainProvider.prototype.getLevelMaximumGeometricError = function ( level @@ -199,10 +199,10 @@ EllipsoidTerrainProvider.prototype.getLevelMaximumGeometricError = function ( /** * Determines whether data for a tile is available to be loaded. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. - * @returns {Boolean|undefined} Undefined if not supported, otherwise true or false. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. + * @returns {boolean|undefined} Undefined if not supported, otherwise true or false. */ EllipsoidTerrainProvider.prototype.getTileDataAvailable = function ( x, @@ -215,9 +215,9 @@ EllipsoidTerrainProvider.prototype.getTileDataAvailable = function ( /** * Makes sure we load availability data for a tile * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @returns {undefined} This provider does not support loading availability. */ EllipsoidTerrainProvider.prototype.loadTileDataAvailability = function ( diff --git a/packages/engine/Source/Core/EllipsoidalOccluder.js b/packages/engine/Source/Core/EllipsoidalOccluder.js index 02ae7e6f7305..e94d8bbcbf3d 100644 --- a/packages/engine/Source/Core/EllipsoidalOccluder.js +++ b/packages/engine/Source/Core/EllipsoidalOccluder.js @@ -87,7 +87,7 @@ const scratchCartesian = new Cartesian3(); * Determines whether or not a point, the occludee, is hidden from view by the occluder. * * @param {Cartesian3} occludee The point to test for visibility. - * @returns {Boolean} true if the occludee is visible; otherwise false. + * @returns {boolean} true if the occludee is visible; otherwise false. * * @example * const cameraPosition = new Cesium.Cartesian3(0, 0, 2.5); @@ -115,7 +115,7 @@ EllipsoidalOccluder.prototype.isPointVisible = function (occludee) { * into the scaled space, call {@link Ellipsoid#transformPositionToScaledSpace}. * * @param {Cartesian3} occludeeScaledSpacePosition The point to test for visibility, represented in the scaled space. - * @returns {Boolean} true if the occludee is visible; otherwise false. + * @returns {boolean} true if the occludee is visible; otherwise false. * * @example * const cameraPosition = new Cesium.Cartesian3(0, 0, 2.5); @@ -145,7 +145,7 @@ const scratchCameraPositionInScaledSpaceShrunk = new Cartesian3(); * {@link EllipsoidalOccluder#computeHorizonCullingPointFromVerticesPossiblyUnderEllipsoid}. * * @param {Cartesian3} occludeeScaledSpacePosition The point to test for visibility, represented in the scaled space of the possibly-shrunk ellipsoid. - * @returns {Boolean} true if the occludee is visible; otherwise false. + * @returns {boolean} true if the occludee is visible; otherwise false. */ EllipsoidalOccluder.prototype.isScaledSpacePointVisiblePossiblyUnderEllipsoid = function ( occludeeScaledSpacePosition, @@ -222,7 +222,7 @@ const scratchEllipsoidShrunk = Ellipsoid.clone(Ellipsoid.UNIT_SPHERE); * @param {Cartesian3[]} positions The positions from which to compute the horizon culling point. The positions * must be expressed in a reference frame centered at the ellipsoid and aligned with the * ellipsoid's axes. - * @param {Number} [minimumHeight] The minimum height of all positions. If this value is undefined, all positions are assumed to be above the ellipsoid. + * @param {number} [minimumHeight] The minimum height of all positions. If this value is undefined, all positions are assumed to be above the ellipsoid. * @param {Cartesian3} [result] The instance on which to store the result instead of allocating a new instance. * @returns {Cartesian3} The computed horizon culling point, expressed in the possibly-shrunk ellipsoid-scaled space. */ @@ -254,10 +254,10 @@ EllipsoidalOccluder.prototype.computeHorizonCullingPointPossiblyUnderEllipsoid = * A reasonable direction to use is the direction from the center of the ellipsoid to * the center of the bounding sphere computed from the positions. The direction need not * be normalized. - * @param {Number[]} vertices The vertices from which to compute the horizon culling point. The positions + * @param {number[]} vertices The vertices from which to compute the horizon culling point. The positions * must be expressed in a reference frame centered at the ellipsoid and aligned with the * ellipsoid's axes. - * @param {Number} [stride=3] + * @param {number} [stride=3] * @param {Cartesian3} [center=Cartesian3.ZERO] * @param {Cartesian3} [result] The instance on which to store the result instead of allocating a new instance. * @returns {Cartesian3} The computed horizon culling point, expressed in the ellipsoid-scaled space. @@ -289,12 +289,12 @@ EllipsoidalOccluder.prototype.computeHorizonCullingPointFromVertices = function * A reasonable direction to use is the direction from the center of the ellipsoid to * the center of the bounding sphere computed from the positions. The direction need not * be normalized. - * @param {Number[]} vertices The vertices from which to compute the horizon culling point. The positions + * @param {number[]} vertices The vertices from which to compute the horizon culling point. The positions * must be expressed in a reference frame centered at the ellipsoid and aligned with the * ellipsoid's axes. - * @param {Number} [stride=3] + * @param {number} [stride=3] * @param {Cartesian3} [center=Cartesian3.ZERO] - * @param {Number} [minimumHeight] The minimum height of all vertices. If this value is undefined, all vertices are assumed to be above the ellipsoid. + * @param {number} [minimumHeight] The minimum height of all vertices. If this value is undefined, all vertices are assumed to be above the ellipsoid. * @param {Cartesian3} [result] The instance on which to store the result instead of allocating a new instance. * @returns {Cartesian3} The computed horizon culling point, expressed in the possibly-shrunk ellipsoid-scaled space. */ diff --git a/packages/engine/Source/Core/EncodedCartesian3.js b/packages/engine/Source/Core/EncodedCartesian3.js index 45bac72ee95d..b6df42a5ffd4 100644 --- a/packages/engine/Source/Core/EncodedCartesian3.js +++ b/packages/engine/Source/Core/EncodedCartesian3.js @@ -41,9 +41,9 @@ function EncodedCartesian3() { * The fixed-point encoding follows {@link http://help.agi.com/AGIComponents/html/BlogPrecisionsPrecisions.htm|Precisions, Precisions}. *

* - * @param {Number} value The floating-point value to encode. - * @param {Object} [result] The object onto which to store the result. - * @returns {Object} The modified result parameter or a new instance if one was not provided. + * @param {number} value The floating-point value to encode. + * @param {object} [result] The object onto which to store the result. + * @returns {object} The modified result parameter or a new instance if one was not provided. * * @example * const value = 1234567.1234567; @@ -132,8 +132,8 @@ const encodedP = new EncodedCartesian3(); *

* * @param {Cartesian3} cartesian The cartesian to encode. - * @param {Number[]} cartesianArray The array to write to. - * @param {Number} index The index into the array to start writing. Six elements will be written. + * @param {number[]} cartesianArray The array to write to. + * @param {number} index The index into the array to start writing. Six elements will be written. * * @exception {DeveloperError} index must be a number greater than or equal to 0. * diff --git a/packages/engine/Source/Core/Event.js b/packages/engine/Source/Core/Event.js index a6c0000da71d..cf53ef966052 100644 --- a/packages/engine/Source/Core/Event.js +++ b/packages/engine/Source/Core/Event.js @@ -32,7 +32,7 @@ Object.defineProperties(Event.prototype, { /** * The number of listeners currently subscribed to the event. * @memberof Event.prototype - * @type {Number} + * @type {number} * @readonly */ numberOfListeners: { @@ -48,7 +48,7 @@ Object.defineProperties(Event.prototype, { * in which the function will execute. * * @param {Listener} listener The function to be executed when the event is raised. - * @param {Object} [scope] An optional object scope to serve as the this + * @param {object} [scope] An optional object scope to serve as the this * pointer in which the listener function will execute. * @returns {Event.RemoveCallback} A function that will remove this event listener when invoked. * @@ -73,8 +73,8 @@ Event.prototype.addEventListener = function (listener, scope) { * Unregisters a previously registered callback. * * @param {Listener} listener The function to be unregistered. - * @param {Object} [scope] The scope that was originally passed to addEventListener. - * @returns {Boolean} true if the listener was removed; false if the listener and scope are not registered with the event. + * @param {object} [scope] The scope that was originally passed to addEventListener. + * @returns {boolean} true if the listener was removed; false if the listener and scope are not registered with the event. * * @see Event#addEventListener * @see Event#raiseEvent diff --git a/packages/engine/Source/Core/EventHelper.js b/packages/engine/Source/Core/EventHelper.js index 4ae3a4a0904a..e9a024c64597 100644 --- a/packages/engine/Source/Core/EventHelper.js +++ b/packages/engine/Source/Core/EventHelper.js @@ -30,7 +30,7 @@ function EventHelper() { * * @param {Event} event The event to attach to. * @param {Function} listener The function to be executed when the event is raised. - * @param {Object} [scope] An optional object scope to serve as the this + * @param {object} [scope] An optional object scope to serve as the this * pointer in which the listener function will execute. * @returns {EventHelper.RemoveCallback} A function that will remove this event listener when invoked. * diff --git a/packages/engine/Source/Core/ExtrapolationType.js b/packages/engine/Source/Core/ExtrapolationType.js index 0480f15596b4..a62b453818a4 100644 --- a/packages/engine/Source/Core/ExtrapolationType.js +++ b/packages/engine/Source/Core/ExtrapolationType.js @@ -2,7 +2,7 @@ * Constants to determine how an interpolated value is extrapolated * when querying outside the bounds of available data. * - * @enum {Number} + * @enum {number} * * @see SampledProperty */ @@ -10,7 +10,7 @@ const ExtrapolationType = { /** * No extrapolation occurs. * - * @type {Number} + * @type {number} * @constant */ NONE: 0, @@ -18,7 +18,7 @@ const ExtrapolationType = { /** * The first or last value is used when outside the range of sample data. * - * @type {Number} + * @type {number} * @constant */ HOLD: 1, @@ -26,7 +26,7 @@ const ExtrapolationType = { /** * The value is extrapolated. * - * @type {Number} + * @type {number} * @constant */ EXTRAPOLATE: 2, diff --git a/packages/engine/Source/Core/FeatureDetection.js b/packages/engine/Source/Core/FeatureDetection.js index 410311b89705..e7f41884fe42 100644 --- a/packages/engine/Source/Core/FeatureDetection.js +++ b/packages/engine/Source/Core/FeatureDetection.js @@ -326,7 +326,7 @@ const FeatureDetection = { * Detects whether the current browser supports Basis Universal textures and the web assembly modules needed to transcode them. * * @param {Scene} scene - * @returns {Boolean} true if the browser supports web assembly modules and the scene supports Basis Universal textures, false if not. + * @returns {boolean} true if the browser supports web assembly modules and the scene supports Basis Universal textures, false if not. */ FeatureDetection.supportsBasis = function (scene) { return FeatureDetection.supportsWebAssembly() && scene.context.supportsBasis; @@ -335,7 +335,7 @@ FeatureDetection.supportsBasis = function (scene) { /** * Detects whether the current browser supports the full screen standard. * - * @returns {Boolean} true if the browser supports the full screen standard, false if not. + * @returns {boolean} true if the browser supports the full screen standard, false if not. * * @see Fullscreen * @see {@link http://dvcs.w3.org/hg/fullscreen/raw-file/tip/Overview.html|W3C Fullscreen Living Specification} @@ -347,7 +347,7 @@ FeatureDetection.supportsFullscreen = function () { /** * Detects whether the current browser supports typed arrays. * - * @returns {Boolean} true if the browser supports typed arrays, false if not. + * @returns {boolean} true if the browser supports typed arrays, false if not. * * @see {@link https://tc39.es/ecma262/#sec-typedarray-objects|Typed Array Specification} */ @@ -358,7 +358,7 @@ FeatureDetection.supportsTypedArrays = function () { /** * Detects whether the current browser supports BigInt64Array typed arrays. * - * @returns {Boolean} true if the browser supports BigInt64Array typed arrays, false if not. + * @returns {boolean} true if the browser supports BigInt64Array typed arrays, false if not. * * @see {@link https://tc39.es/ecma262/#sec-typedarray-objects|Typed Array Specification} */ @@ -369,7 +369,7 @@ FeatureDetection.supportsBigInt64Array = function () { /** * Detects whether the current browser supports BigUint64Array typed arrays. * - * @returns {Boolean} true if the browser supports BigUint64Array typed arrays, false if not. + * @returns {boolean} true if the browser supports BigUint64Array typed arrays, false if not. * * @see {@link https://tc39.es/ecma262/#sec-typedarray-objects|Typed Array Specification} */ @@ -380,7 +380,7 @@ FeatureDetection.supportsBigUint64Array = function () { /** * Detects whether the current browser supports BigInt. * - * @returns {Boolean} true if the browser supports BigInt, false if not. + * @returns {boolean} true if the browser supports BigInt, false if not. * * @see {@link https://tc39.es/ecma262/#sec-bigint-objects|BigInt Specification} */ @@ -391,7 +391,7 @@ FeatureDetection.supportsBigInt = function () { /** * Detects whether the current browser supports Web Workers. * - * @returns {Boolean} true if the browsers supports Web Workers, false if not. + * @returns {boolean} true if the browsers supports Web Workers, false if not. * * @see {@link http://www.w3.org/TR/workers/} */ @@ -402,7 +402,7 @@ FeatureDetection.supportsWebWorkers = function () { /** * Detects whether the current browser supports Web Assembly. * - * @returns {Boolean} true if the browsers supports Web Assembly, false if not. + * @returns {boolean} true if the browsers supports Web Assembly, false if not. * * @see {@link https://developer.mozilla.org/en-US/docs/WebAssembly} */ @@ -414,7 +414,7 @@ FeatureDetection.supportsWebAssembly = function () { * Detects whether the current browser supports a WebGL2 rendering context for the specified scene. * * @param {Scene} scene the Cesium scene specifying the rendering context - * @returns {Boolean} true if the browser supports a WebGL2 rendering context, false if not. + * @returns {boolean} true if the browser supports a WebGL2 rendering context, false if not. * * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext|WebGL2RenderingContext} */ diff --git a/packages/engine/Source/Core/FrustumGeometry.js b/packages/engine/Source/Core/FrustumGeometry.js index f19fb633e25b..bece354b733c 100644 --- a/packages/engine/Source/Core/FrustumGeometry.js +++ b/packages/engine/Source/Core/FrustumGeometry.js @@ -25,7 +25,7 @@ const ORTHOGRAPHIC = 1; * @alias FrustumGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {PerspectiveFrustum|OrthographicFrustum} options.frustum The frustum. * @param {Cartesian3} options.origin The origin of the frustum. * @param {Quaternion} options.orientation The orientation of the frustum. @@ -69,7 +69,7 @@ function FrustumGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = 2 + @@ -83,10 +83,10 @@ function FrustumGeometry(options) { * Stores the provided instance into the provided array. * * @param {FrustumGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ FrustumGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -129,8 +129,8 @@ const scratchVertexFormat = new VertexFormat(); /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {FrustumGeometry} [result] The object into which to store the result. */ FrustumGeometry.unpack = function (array, startingIndex, result) { diff --git a/packages/engine/Source/Core/FrustumOutlineGeometry.js b/packages/engine/Source/Core/FrustumOutlineGeometry.js index 73aeb81817a4..e49aea1bd141 100644 --- a/packages/engine/Source/Core/FrustumOutlineGeometry.js +++ b/packages/engine/Source/Core/FrustumOutlineGeometry.js @@ -22,7 +22,7 @@ const ORTHOGRAPHIC = 1; * @alias FrustumOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {PerspectiveFrustum|OrthographicFrustum} options.frustum The frustum. * @param {Cartesian3} options.origin The origin of the frustum. * @param {Quaternion} options.orientation The orientation of the frustum. @@ -63,7 +63,7 @@ function FrustumOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = 2 + frustumPackedLength + Cartesian3.packedLength + Quaternion.packedLength; @@ -73,10 +73,10 @@ function FrustumOutlineGeometry(options) { * Stores the provided instance into the provided array. * * @param {FrustumOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ FrustumOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -116,8 +116,8 @@ const scratchPackorigin = new Cartesian3(); /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {FrustumOutlineGeometry} [result] The object into which to store the result. */ FrustumOutlineGeometry.unpack = function (array, startingIndex, result) { diff --git a/packages/engine/Source/Core/Fullscreen.js b/packages/engine/Source/Core/Fullscreen.js index b63a51fe5fed..3b18de25a213 100644 --- a/packages/engine/Source/Core/Fullscreen.js +++ b/packages/engine/Source/Core/Fullscreen.js @@ -24,7 +24,7 @@ Object.defineProperties(Fullscreen, { * The element that is currently fullscreen, if any. To simply check if the * browser is in fullscreen mode or not, use {@link Fullscreen#fullscreen}. * @memberof Fullscreen - * @type {Object} + * @type {object} * @readonly */ element: { @@ -43,7 +43,7 @@ Object.defineProperties(Fullscreen, { * In your event handler, to determine if the browser is in fullscreen mode or not, * use {@link Fullscreen#fullscreen}. * @memberof Fullscreen - * @type {String} + * @type {string} * @readonly */ changeEventName: { @@ -60,7 +60,7 @@ Object.defineProperties(Fullscreen, { * The name of the event that is fired when a fullscreen error * occurs. This event name is intended for use with addEventListener. * @memberof Fullscreen - * @type {String} + * @type {string} * @readonly */ errorEventName: { @@ -78,7 +78,7 @@ Object.defineProperties(Fullscreen, { * For example, by default, iframes cannot go fullscreen unless the containing page * adds an "allowfullscreen" attribute (or prefixed equivalent). * @memberof Fullscreen - * @type {Boolean} + * @type {boolean} * @readonly */ enabled: { @@ -94,7 +94,7 @@ Object.defineProperties(Fullscreen, { /** * Determines if the browser is currently in fullscreen mode. * @memberof Fullscreen - * @type {Boolean} + * @type {boolean} * @readonly */ fullscreen: { @@ -111,7 +111,7 @@ Object.defineProperties(Fullscreen, { /** * Detects whether the browser supports the standard fullscreen API. * - * @returns {Boolean} true if the browser supports the standard fullscreen API, + * @returns {boolean} true if the browser supports the standard fullscreen API, * false otherwise. */ Fullscreen.supportsFullscreen = function () { @@ -214,8 +214,8 @@ Fullscreen.supportsFullscreen = function () { * Asynchronously requests the browser to enter fullscreen mode on the given element. * If fullscreen mode is not supported by the browser, does nothing. * - * @param {Object} element The HTML element which will be placed into fullscreen mode. - * @param {Object} [vrDevice] The HMDVRDevice device. + * @param {object} element The HTML element which will be placed into fullscreen mode. + * @param {object} [vrDevice] The HMDVRDevice device. * * @example * // Put the entire page into fullscreen. diff --git a/packages/engine/Source/Core/GeocodeType.js b/packages/engine/Source/Core/GeocodeType.js index f224ab9e4063..3348b6d5ffbf 100644 --- a/packages/engine/Source/Core/GeocodeType.js +++ b/packages/engine/Source/Core/GeocodeType.js @@ -1,13 +1,13 @@ /** * The type of geocoding to be performed by a {@link GeocoderService}. - * @enum {Number} + * @enum {number} * @see Geocoder */ const GeocodeType = { /** * Perform a search where the input is considered complete. * - * @type {Number} + * @type {number} * @constant */ SEARCH: 0, @@ -16,7 +16,7 @@ const GeocodeType = { * Perform an auto-complete using partial input, typically * reserved for providing possible results as a user is typing. * - * @type {Number} + * @type {number} * @constant */ AUTOCOMPLETE: 1, diff --git a/packages/engine/Source/Core/GeocoderService.js b/packages/engine/Source/Core/GeocoderService.js index 5162da37835a..9d5f026c37ca 100644 --- a/packages/engine/Source/Core/GeocoderService.js +++ b/packages/engine/Source/Core/GeocoderService.js @@ -1,8 +1,8 @@ import DeveloperError from "./DeveloperError.js"; /** - * @typedef {Object} GeocoderService.Result - * @property {String} displayName The display name for a location + * @typedef {object} GeocoderService.Result + * @property {string} displayName The display name for a location * @property {Rectangle|Cartesian3} destination The bounding box for a location */ @@ -21,7 +21,7 @@ function GeocoderService() {} /** * @function * - * @param {String} query The query to be sent to the geocoder service + * @param {string} query The query to be sent to the geocoder service * @param {GeocodeType} [type=GeocodeType.SEARCH] The type of geocode to perform. * @returns {Promise} */ diff --git a/packages/engine/Source/Core/GeographicTilingScheme.js b/packages/engine/Source/Core/GeographicTilingScheme.js index e03fbfcad8a4..0b2ce78a3576 100644 --- a/packages/engine/Source/Core/GeographicTilingScheme.js +++ b/packages/engine/Source/Core/GeographicTilingScheme.js @@ -15,13 +15,13 @@ import Rectangle from "./Rectangle.js"; * @alias GeographicTilingScheme * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid whose surface is being tiled. Defaults to * the WGS84 ellipsoid. * @param {Rectangle} [options.rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the tiling scheme. - * @param {Number} [options.numberOfLevelZeroTilesX=2] The number of tiles in the X direction at level zero of + * @param {number} [options.numberOfLevelZeroTilesX=2] The number of tiles in the X direction at level zero of * the tile tree. - * @param {Number} [options.numberOfLevelZeroTilesY=1] The number of tiles in the Y direction at level zero of + * @param {number} [options.numberOfLevelZeroTilesY=1] The number of tiles in the Y direction at level zero of * the tile tree. */ function GeographicTilingScheme(options) { @@ -78,8 +78,8 @@ Object.defineProperties(GeographicTilingScheme.prototype, { /** * Gets the total number of tiles in the X direction at a specified level-of-detail. * - * @param {Number} level The level-of-detail. - * @returns {Number} The number of tiles in the X direction at the given level. + * @param {number} level The level-of-detail. + * @returns {number} The number of tiles in the X direction at the given level. */ GeographicTilingScheme.prototype.getNumberOfXTilesAtLevel = function (level) { return this._numberOfLevelZeroTilesX << level; @@ -88,8 +88,8 @@ GeographicTilingScheme.prototype.getNumberOfXTilesAtLevel = function (level) { /** * Gets the total number of tiles in the Y direction at a specified level-of-detail. * - * @param {Number} level The level-of-detail. - * @returns {Number} The number of tiles in the Y direction at the given level. + * @param {number} level The level-of-detail. + * @returns {number} The number of tiles in the Y direction at the given level. */ GeographicTilingScheme.prototype.getNumberOfYTilesAtLevel = function (level) { return this._numberOfLevelZeroTilesY << level; @@ -133,10 +133,10 @@ GeographicTilingScheme.prototype.rectangleToNativeRectangle = function ( * Converts tile x, y coordinates and level to a rectangle expressed in the native coordinates * of the tiling scheme. * - * @param {Number} x The integer x coordinate of the tile. - * @param {Number} y The integer y coordinate of the tile. - * @param {Number} level The tile level-of-detail. Zero is the least detailed. - * @param {Object} [result] The instance to which to copy the result, or undefined if a new instance + * @param {number} x The integer x coordinate of the tile. + * @param {number} y The integer y coordinate of the tile. + * @param {number} level The tile level-of-detail. Zero is the least detailed. + * @param {object} [result] The instance to which to copy the result, or undefined if a new instance * should be created. * @returns {Rectangle} The specified 'result', or a new object containing the rectangle * if 'result' is undefined. @@ -158,10 +158,10 @@ GeographicTilingScheme.prototype.tileXYToNativeRectangle = function ( /** * Converts tile x, y coordinates and level to a cartographic rectangle in radians. * - * @param {Number} x The integer x coordinate of the tile. - * @param {Number} y The integer y coordinate of the tile. - * @param {Number} level The tile level-of-detail. Zero is the least detailed. - * @param {Object} [result] The instance to which to copy the result, or undefined if a new instance + * @param {number} x The integer x coordinate of the tile. + * @param {number} y The integer y coordinate of the tile. + * @param {number} level The tile level-of-detail. Zero is the least detailed. + * @param {object} [result] The instance to which to copy the result, or undefined if a new instance * should be created. * @returns {Rectangle} The specified 'result', or a new object containing the rectangle * if 'result' is undefined. @@ -201,7 +201,7 @@ GeographicTilingScheme.prototype.tileXYToRectangle = function ( * a given cartographic position. * * @param {Cartographic} position The position. - * @param {Number} level The tile level-of-detail. Zero is the least detailed. + * @param {number} level The tile level-of-detail. Zero is the least detailed. * @param {Cartesian2} [result] The instance to which to copy the result, or undefined if a new instance * should be created. * @returns {Cartesian2} The specified 'result', or a new object containing the tile x, y coordinates diff --git a/packages/engine/Source/Core/Geometry.js b/packages/engine/Source/Core/Geometry.js index 9be59cba9942..5d891e0a783c 100644 --- a/packages/engine/Source/Core/Geometry.js +++ b/packages/engine/Source/Core/Geometry.js @@ -26,7 +26,7 @@ import Transforms from "./Transforms.js"; * @alias Geometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {GeometryAttributes} options.attributes Attributes, which make up the geometry's vertices. * @param {PrimitiveType} [options.primitiveType=PrimitiveType.TRIANGLES] The type of primitives in the geometry. * @param {Uint16Array|Uint32Array} [options.indices] Optional index data that determines the primitives in the geometry. @@ -123,7 +123,7 @@ function Geometry(options) { * Optional index data that - along with {@link Geometry#primitiveType} - * determines the primitives in the geometry. * - * @type Array + * @type {Array} * * @default undefined */ @@ -174,7 +174,7 @@ function Geometry(options) { * respect to the number of attributes in a vertex, not the number of vertices. * * @param {Geometry} geometry The geometry. - * @returns {Number} The number of vertices in the geometry. + * @returns {number} The number of vertices in the geometry. * * @example * const numVertices = Cesium.Geometry.computeNumberOfVertices(geometry); @@ -244,10 +244,10 @@ const rotation2DScratch = new Matrix2(); * as an intermediary instead of local ENU, which is more accurate for large-area rectangles. * * @param {Cartesian3[]} positions Array of positions outlining the geometry - * @param {Number} stRotation Texture coordinate rotation. + * @param {number} stRotation Texture coordinate rotation. * @param {Ellipsoid} ellipsoid Ellipsoid for projecting and generating local vectors. * @param {Rectangle} boundingRectangle Bounding rectangle around the positions. - * @returns {Number[]} An array of 6 numbers specifying [minimum point, u extent, v extent] as points in the "cartographic" system. + * @returns {number[]} An array of 6 numbers specifying [minimum point, u extent, v extent] as points in the "cartographic" system. * @private */ Geometry._textureCoordinateRotationPoints = function ( diff --git a/packages/engine/Source/Core/GeometryAttribute.js b/packages/engine/Source/Core/GeometryAttribute.js index 9b1e35b6dbcd..18c27af5d07e 100644 --- a/packages/engine/Source/Core/GeometryAttribute.js +++ b/packages/engine/Source/Core/GeometryAttribute.js @@ -10,10 +10,10 @@ import DeveloperError from "./DeveloperError.js"; * @alias GeometryAttribute * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {ComponentDatatype} [options.componentDatatype] The datatype of each component in the attribute, e.g., individual elements in values. - * @param {Number} [options.componentsPerAttribute] A number between 1 and 4 that defines the number of components in an attributes. - * @param {Boolean} [options.normalize=false] When true and componentDatatype is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering. + * @param {number} [options.componentsPerAttribute] A number between 1 and 4 that defines the number of components in an attributes. + * @param {boolean} [options.normalize=false] When true and componentDatatype is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering. * @param {number[]|Int8Array|Uint8Array|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array} [options.values] The values for the attributes stored in a typed array. * * @exception {DeveloperError} options.componentsPerAttribute must be between 1 and 4. @@ -64,7 +64,7 @@ function GeometryAttribute(options) { * The datatype of each component in the attribute, e.g., individual elements in * {@link GeometryAttribute#values}. * - * @type ComponentDatatype + * @type {ComponentDatatype} * * @default undefined */ @@ -75,7 +75,7 @@ function GeometryAttribute(options) { * For example, a position attribute with x, y, and z components would have 3 as * shown in the code example. * - * @type Number + * @type {number} * * @default undefined * @@ -98,7 +98,7 @@ function GeometryAttribute(options) { * This is commonly used when storing colors using {@link ComponentDatatype.UNSIGNED_BYTE}. *

* - * @type Boolean + * @type {boolean} * * @default false * diff --git a/packages/engine/Source/Core/GeometryInstance.js b/packages/engine/Source/Core/GeometryInstance.js index 1eedb7341f3c..572d9b81ef68 100644 --- a/packages/engine/Source/Core/GeometryInstance.js +++ b/packages/engine/Source/Core/GeometryInstance.js @@ -12,11 +12,11 @@ import Matrix4 from "./Matrix4.js"; * @alias GeometryInstance * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Geometry|GeometryFactory} options.geometry The geometry to instance. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The model matrix that transforms to transform the geometry from model to world coordinates. - * @param {Object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} or get/set per-instance attributes with {@link Primitive#getGeometryInstanceAttributes}. - * @param {Object} [options.attributes] Per-instance attributes like a show or color attribute shown in the example below. + * @param {object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} or get/set per-instance attributes with {@link Primitive#getGeometryInstanceAttributes}. + * @param {object} [options.attributes] Per-instance attributes like a show or color attribute shown in the example below. * * * @example @@ -83,7 +83,7 @@ function GeometryInstance(options) { /** * User-defined object returned when the instance is picked or used to get/set per-instance attributes. * - * @type Object + * @type {object} * * @default undefined * @@ -103,7 +103,7 @@ function GeometryInstance(options) { * Per-instance attributes like {@link ColorGeometryInstanceAttribute} or {@link ShowGeometryInstanceAttribute}. * {@link Geometry} attributes varying per vertex; these attributes are constant for the entire instance. * - * @type Object + * @type {object} * * @default undefined */ diff --git a/packages/engine/Source/Core/GeometryInstanceAttribute.js b/packages/engine/Source/Core/GeometryInstanceAttribute.js index aabb2df41889..f857326cf747 100644 --- a/packages/engine/Source/Core/GeometryInstanceAttribute.js +++ b/packages/engine/Source/Core/GeometryInstanceAttribute.js @@ -8,11 +8,11 @@ import DeveloperError from "./DeveloperError.js"; * @alias GeometryInstanceAttribute * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {ComponentDatatype} options.componentDatatype The datatype of each component in the attribute, e.g., individual elements in values. - * @param {Number} options.componentsPerAttribute A number between 1 and 4 that defines the number of components in an attributes. - * @param {Boolean} [options.normalize=false] When true and componentDatatype is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering. - * @param {Number[]} options.value The value for the attribute. + * @param {number} options.componentsPerAttribute A number between 1 and 4 that defines the number of components in an attributes. + * @param {boolean} [options.normalize=false] When true and componentDatatype is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering. + * @param {number[]} options.value The value for the attribute. * * @exception {DeveloperError} options.componentsPerAttribute must be between 1 and 4. * @@ -77,7 +77,7 @@ function GeometryInstanceAttribute(options) { * For example, a position attribute with x, y, and z components would have 3 as * shown in the code example. * - * @type Number + * @type {number} * * @default undefined * @@ -99,7 +99,7 @@ function GeometryInstanceAttribute(options) { * This is commonly used when storing colors using {@link ComponentDatatype.UNSIGNED_BYTE}. *

* - * @type Boolean + * @type {boolean} * * @default false * @@ -121,7 +121,7 @@ function GeometryInstanceAttribute(options) { * every three elements in values defines one attributes since * componentsPerAttribute is 3. * - * @type {Number[]} + * @type {number[]} * * @default undefined * diff --git a/packages/engine/Source/Core/GeometryPipeline.js b/packages/engine/Source/Core/GeometryPipeline.js index c62466052fc4..37e56ec2a16b 100644 --- a/packages/engine/Source/Core/GeometryPipeline.js +++ b/packages/engine/Source/Core/GeometryPipeline.js @@ -155,8 +155,8 @@ GeometryPipeline.toWireframe = function (geometry) { * visualize vector attributes like normals, tangents, and bitangents. * * @param {Geometry} geometry The Geometry instance with the attribute. - * @param {String} [attributeName='normal'] The name of the attribute. - * @param {Number} [length=10000.0] The length of each line segment in meters. This can be negative to point the vector in the opposite direction. + * @param {string} [attributeName='normal'] The name of the attribute. + * @param {number} [length=10000.0] The length of each line segment in meters. This can be negative to point the vector in the opposite direction. * @returns {Geometry} A new Geometry instance with line segments for the vector. * * @exception {DeveloperError} geometry.attributes must have an attribute with the same name as the attributeName parameter. @@ -228,7 +228,7 @@ GeometryPipeline.createLineSegmentsForVectors = function ( * for matching vertex attributes and shader programs. * * @param {Geometry} geometry The geometry, which is not modified, to create the object for. - * @returns {Object} An object with attribute name / index pairs. + * @returns {object} An object with attribute name / index pairs. * * @example * const attributeLocations = Cesium.GeometryPipeline.createAttributeLocations(geometry); @@ -394,7 +394,7 @@ GeometryPipeline.reorderForPreVertexCache = function (geometry) { * is not TRIANGLES or the geometry does not have an indices, this function has no effect. * * @param {Geometry} geometry The geometry to modify. - * @param {Number} [cacheCapacity=24] The number of vertices that can be held in the GPU's vertex cache. + * @param {number} [cacheCapacity=24] The number of vertices that can be held in the GPU's vertex cache. * @returns {Geometry} The modified geometry argument, with its indices reordered for the post-vertex-shader cache. * * @exception {DeveloperError} cacheCapacity must be greater than two. @@ -601,10 +601,10 @@ const scratchProjectTo2DCartographic = new Cartographic(); *

* * @param {Geometry} geometry The geometry to modify. - * @param {String} attributeName The name of the attribute. - * @param {String} attributeName3D The name of the attribute in 3D. - * @param {String} attributeName2D The name of the attribute in 2D. - * @param {Object} [projection=new GeographicProjection()] The projection to use. + * @param {string} attributeName The name of the attribute. + * @param {string} attributeName3D The name of the attribute in 3D. + * @param {string} attributeName2D The name of the attribute in 2D. + * @param {object} [projection=new GeographicProjection()] The projection to use. * @returns {Geometry} The modified geometry argument with position3D and position2D attributes. * * @exception {DeveloperError} geometry must have attribute matching the attributeName argument. @@ -714,9 +714,9 @@ const encodedResult = { *

* * @param {Geometry} geometry The geometry to modify. - * @param {String} attributeName The name of the attribute. - * @param {String} attributeHighName The name of the attribute for the encoded high bits. - * @param {String} attributeLowName The name of the attribute for the encoded low bits. + * @param {string} attributeName The name of the attribute. + * @param {string} attributeHighName The name of the attribute for the encoded high bits. + * @param {string} attributeLowName The name of the attribute for the encoded low bits. * @returns {Geometry} The modified geometry argument, with its encoded attribute. * * @exception {DeveloperError} geometry must have attribute matching the attributeName argument. diff --git a/packages/engine/Source/Core/GoogleEarthEnterpriseMetadata.js b/packages/engine/Source/Core/GoogleEarthEnterpriseMetadata.js index 39f10b66f5f0..54825fed1d4b 100644 --- a/packages/engine/Source/Core/GoogleEarthEnterpriseMetadata.js +++ b/packages/engine/Source/Core/GoogleEarthEnterpriseMetadata.js @@ -36,7 +36,7 @@ const defaultKey = stringToBuffer( * @alias GoogleEarthEnterpriseMetadata * @constructor * - * @param {Resource|String} resourceOrUrl The url of the Google Earth Enterprise server hosting the imagery + * @param {Resource|string} resourceOrUrl The url of the Google Earth Enterprise server hosting the imagery * * @see GoogleEarthEnterpriseImageryProvider * @see GoogleEarthEnterpriseTerrainProvider @@ -63,42 +63,42 @@ function GoogleEarthEnterpriseMetadata(resourceOrUrl) { /** * True if imagery is available. - * @type {Boolean} + * @type {boolean} * @default true */ this.imageryPresent = true; /** * True if imagery is sent as a protocol buffer, false if sent as plain images. If undefined we will try both. - * @type {Boolean} + * @type {boolean} * @default undefined */ this.protoImagery = undefined; /** * True if terrain is available. - * @type {Boolean} + * @type {boolean} * @default true */ this.terrainPresent = true; /** * Exponent used to compute constant to calculate negative height values. - * @type {Number} + * @type {number} * @default 32 */ this.negativeAltitudeExponentBias = 32; /** * Threshold where any numbers smaller are actually negative values. They are multiplied by -2^negativeAltitudeExponentBias. - * @type {Number} + * @type {number} * @default EPSILON12 */ this.negativeAltitudeThreshold = CesiumMath.EPSILON12; /** * Dictionary of provider id to copyright strings. - * @type {Object} + * @type {object} * @default {} */ this.providers = {}; @@ -134,7 +134,7 @@ Object.defineProperties(GoogleEarthEnterpriseMetadata.prototype, { /** * Gets the name of the Google Earth Enterprise server. * @memberof GoogleEarthEnterpriseMetadata.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -170,7 +170,7 @@ Object.defineProperties(GoogleEarthEnterpriseMetadata.prototype, { /** * Gets a promise that resolves to true when the metadata is ready for use. * @memberof GoogleEarthEnterpriseMetadata.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -184,9 +184,9 @@ Object.defineProperties(GoogleEarthEnterpriseMetadata.prototype, { * Converts a tiles (x, y, level) position into a quadkey used to request an image * from a Google Earth Enterprise server. * - * @param {Number} x The tile's x coordinate. - * @param {Number} y The tile's y coordinate. - * @param {Number} level The tile's zoom level. + * @param {number} x The tile's x coordinate. + * @param {number} y The tile's y coordinate. + * @param {number} level The tile's zoom level. * * @see GoogleEarthEnterpriseMetadata#quadKeyToTileXY */ @@ -226,7 +226,7 @@ GoogleEarthEnterpriseMetadata.tileXYToQuadKey = function (x, y, level) { * Converts a tile's quadkey used to request an image from a Google Earth Enterprise server into the * (x, y, level) position. * - * @param {String} quadkey The tile's quad key + * @param {string} quadkey The tile's quad key * * @see GoogleEarthEnterpriseMetadata#tileXYToQuadKey */ @@ -294,8 +294,8 @@ const taskProcessor = new TaskProcessor("decodeGoogleEarthEnterprisePacket"); /** * Retrieves a Google Earth Enterprise quadtree packet. * - * @param {String} [quadKey=''] The quadkey to retrieve the packet for. - * @param {Number} [version=1] The cnode version to be used in the request. + * @param {string} [quadKey=''] The quadkey to retrieve the packet for. + * @param {number} [version=1] The cnode version to be used in the request. * @param {Request} [request] The request object. Intended for internal use only. * * @private @@ -373,9 +373,9 @@ GoogleEarthEnterpriseMetadata.prototype.getQuadTreePacket = function ( /** * Populates the metadata subtree down to the specified tile. * - * @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} A promise that resolves to the tile info for the requested quad key @@ -460,9 +460,9 @@ function populateSubtree(that, quadKey, request) { /** * Gets information about a tile * - * @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 {GoogleEarthEnterpriseTileInformation|undefined} Information about the tile or undefined if it isn't loaded. * * @private @@ -479,7 +479,7 @@ GoogleEarthEnterpriseMetadata.prototype.getTileInformation = function ( /** * Gets information about a tile from a quadKey * - * @param {String} quadkey The quadkey for the tile + * @param {string} quadkey The quadkey for the tile * @returns {GoogleEarthEnterpriseTileInformation|undefined} Information about the tile or undefined if it isn't loaded. * * @private diff --git a/packages/engine/Source/Core/GoogleEarthEnterpriseTerrainData.js b/packages/engine/Source/Core/GoogleEarthEnterpriseTerrainData.js index cead7ff94de2..f343aff99575 100644 --- a/packages/engine/Source/Core/GoogleEarthEnterpriseTerrainData.js +++ b/packages/engine/Source/Core/GoogleEarthEnterpriseTerrainData.js @@ -22,11 +22,11 @@ import TerrainMesh from "./TerrainMesh.js"; * @alias GoogleEarthEnterpriseTerrainData * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {ArrayBuffer} options.buffer The buffer containing terrain data. - * @param {Number} options.negativeAltitudeExponentBias Multiplier for negative terrain heights that are encoded as very small positive values. - * @param {Number} options.negativeElevationThreshold Threshold for negative values - * @param {Number} [options.childTileMask=15] A bit mask indicating which of this tile's four children exist. + * @param {number} options.negativeAltitudeExponentBias Multiplier for negative terrain heights that are encoded as very small positive values. + * @param {number} options.negativeElevationThreshold Threshold for negative values + * @param {number} [options.childTileMask=15] A bit mask indicating which of this tile's four children exist. * If a child's bit is set, geometry will be requested for that tile as well when it * is needed. If the bit is cleared, the child tile is not requested and geometry is * instead upsampled from the parent. The bit values are as follows: @@ -37,7 +37,7 @@ import TerrainMesh from "./TerrainMesh.js"; * 24Northeast * 38Northwest * - * @param {Boolean} [options.createdByUpsampling=false] True if this instance was created by upsampling another instance; + * @param {boolean} [options.createdByUpsampling=false] True if this instance was created by upsampling another instance; * otherwise, false. * @param {Credit[]} [options.credits] Array of credits for this tile. * @@ -132,15 +132,15 @@ const rectangleScratch = new Rectangle(); * * @private * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {TilingScheme} options.tilingScheme The tiling scheme to which this tile belongs. - * @param {Number} options.x The X coordinate of the tile for which to create the terrain data. - * @param {Number} options.y The Y coordinate of the tile for which to create the terrain data. - * @param {Number} options.level The level of the tile for which to create the terrain data. - * @param {Number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. - * @param {Number} [options.exaggerationRelativeHeight=0.0] The height from which terrain is exaggerated. - * @param {Boolean} [options.throttle=true] If true, indicates that this operation will need to be retried if too many asynchronous mesh creations are already in progress. - * @returns {Promise.|undefined} A promise for the terrain mesh, or undefined if too many + * @param {number} options.x The X coordinate of the tile for which to create the terrain data. + * @param {number} options.y The Y coordinate of the tile for which to create the terrain data. + * @param {number} options.level The level of the tile for which to create the terrain data. + * @param {number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. + * @param {number} [options.exaggerationRelativeHeight=0.0] The height from which terrain is exaggerated. + * @param {boolean} [options.throttle=true] If true, indicates that this operation will need to be retried if too many asynchronous mesh creations are already in progress. + * @returns {Promise|undefined} A promise for the terrain mesh, or undefined if too many * asynchronous mesh creations are already in progress and the operation should * be retried later. */ @@ -237,9 +237,9 @@ GoogleEarthEnterpriseTerrainData.prototype.createMesh = function (options) { * Computes the terrain height at a specified longitude and latitude. * * @param {Rectangle} rectangle The rectangle covered by this terrain data. - * @param {Number} longitude The longitude in radians. - * @param {Number} latitude The latitude in radians. - * @returns {Number} The terrain height at the specified position. If the position + * @param {number} longitude The longitude in radians. + * @param {number} latitude The latitude in radians. + * @returns {number} The terrain height at the specified position. If the position * is outside the rectangle, this method will extrapolate the height, which is likely to be wildly * incorrect for positions far outside the rectangle. */ @@ -276,13 +276,13 @@ const upsampleTaskProcessor = new TaskProcessor( * height samples in this instance, interpolated if necessary. * * @param {TilingScheme} tilingScheme The tiling scheme of this terrain data. - * @param {Number} thisX The X coordinate of this tile in the tiling scheme. - * @param {Number} thisY The Y coordinate of this tile in the tiling scheme. - * @param {Number} thisLevel The level of this tile in the tiling scheme. - * @param {Number} descendantX The X coordinate within the tiling scheme of the descendant tile for which we are upsampling. - * @param {Number} descendantY The Y coordinate within the tiling scheme of the descendant tile for which we are upsampling. - * @param {Number} descendantLevel The level within the tiling scheme of the descendant tile for which we are upsampling. - * @returns {Promise.|undefined} A promise for upsampled heightmap terrain data for the descendant tile, + * @param {number} thisX The X coordinate of this tile in the tiling scheme. + * @param {number} thisY The Y coordinate of this tile in the tiling scheme. + * @param {number} thisLevel The level of this tile in the tiling scheme. + * @param {number} descendantX The X coordinate within the tiling scheme of the descendant tile for which we are upsampling. + * @param {number} descendantY The Y coordinate within the tiling scheme of the descendant tile for which we are upsampling. + * @param {number} descendantLevel The level within the tiling scheme of the descendant tile for which we are upsampling. + * @returns {Promise|undefined} A promise for upsampled heightmap terrain data for the descendant tile, * or undefined if too many asynchronous upsample operations are in progress and the request has been * deferred. */ @@ -387,11 +387,11 @@ GoogleEarthEnterpriseTerrainData.prototype.upsample = function ( * to be one of the four children of this tile. If non-child tile coordinates are * given, the availability of the southeast child tile is returned. * - * @param {Number} thisX The tile X coordinate of this (the parent) tile. - * @param {Number} thisY The tile Y coordinate of this (the parent) tile. - * @param {Number} childX The tile X coordinate of the child tile to check for availability. - * @param {Number} childY The tile Y coordinate of the child tile to check for availability. - * @returns {Boolean} True if the child tile is available; otherwise, false. + * @param {number} thisX The tile X coordinate of this (the parent) tile. + * @param {number} thisY The tile Y coordinate of this (the parent) tile. + * @param {number} childX The tile X coordinate of the child tile to check for availability. + * @param {number} childY The tile Y coordinate of the child tile to check for availability. + * @returns {boolean} True if the child tile is available; otherwise, false. */ GoogleEarthEnterpriseTerrainData.prototype.isChildAvailable = function ( thisX, @@ -423,7 +423,7 @@ GoogleEarthEnterpriseTerrainData.prototype.isChildAvailable = function ( * as by downloading it from a remote server. This method should return true for instances * returned from a call to {@link HeightmapTerrainData#upsample}. * - * @returns {Boolean} True if this instance was created by upsampling; otherwise, false. + * @returns {boolean} True if this instance was created by upsampling; otherwise, false. */ GoogleEarthEnterpriseTerrainData.prototype.wasCreatedByUpsampling = function () { return this._createdByUpsampling; diff --git a/packages/engine/Source/Core/GoogleEarthEnterpriseTerrainProvider.js b/packages/engine/Source/Core/GoogleEarthEnterpriseTerrainProvider.js index 74c89b8d5321..5b8c1d1207e0 100644 --- a/packages/engine/Source/Core/GoogleEarthEnterpriseTerrainProvider.js +++ b/packages/engine/Source/Core/GoogleEarthEnterpriseTerrainProvider.js @@ -72,11 +72,11 @@ TerrainCache.prototype.tidy = function () { * @alias GoogleEarthEnterpriseTerrainProvider * @constructor * - * @param {Object} options Object with the following properties: - * @param {Resource|String} options.url The url of the Google Earth Enterprise server hosting the imagery. + * @param {object} options Object with the following properties: + * @param {Resource|string} options.url The url of the Google Earth Enterprise server hosting the imagery. * @param {GoogleEarthEnterpriseMetadata} options.metadata A metadata object that can be used to share metadata requests with a GoogleEarthEnterpriseImageryProvider. * @param {Ellipsoid} [options.ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used. - * @param {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas. + * @param {Credit|string} [options.credit] A credit for the data source, which is displayed on the canvas. * * @see GoogleEarthEnterpriseImageryProvider * @see CesiumTerrainProvider @@ -179,7 +179,7 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, { /** * Gets the name of the Google Earth Enterprise server url hosting the imagery. * @memberof GoogleEarthEnterpriseTerrainProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -238,7 +238,7 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof GoogleEarthEnterpriseTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -250,7 +250,7 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof GoogleEarthEnterpriseTerrainProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -278,7 +278,7 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, { * as a reflective surface with animated waves. This function should not be * called before {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true. * @memberof GoogleEarthEnterpriseTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasWaterMask: { @@ -291,7 +291,7 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, { * Gets a value indicating whether or not the requested tiles include vertex normals. * This function should not be called before {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true. * @memberof GoogleEarthEnterpriseTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasVertexNormals: { @@ -342,11 +342,11 @@ function computeChildMask(quadKey, info, metadata) { * {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true. The result must include terrain data and * may optionally include a water mask and an indication of which child tiles are available. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @param {Request} [request] The request object. Intended for internal use only. - * @returns {Promise.|undefined} A promise for the requested geometry. If this method + * @returns {Promise|undefined} A promise for the requested geometry. If this method * returns undefined instead of a promise, it is an indication that too many requests are already * pending and the request will be retried later. * @@ -546,8 +546,8 @@ GoogleEarthEnterpriseTerrainProvider.prototype.requestTileGeometry = function ( /** * Gets the maximum geometric error allowed in a tile at a given level. * - * @param {Number} level The tile level for which to get the maximum geometric error. - * @returns {Number} The maximum geometric error. + * @param {number} level The tile level for which to get the maximum geometric error. + * @returns {number} The maximum geometric error. */ GoogleEarthEnterpriseTerrainProvider.prototype.getLevelMaximumGeometricError = function ( level @@ -558,10 +558,10 @@ GoogleEarthEnterpriseTerrainProvider.prototype.getLevelMaximumGeometricError = f /** * Determines whether data for a tile is available to be loaded. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. - * @returns {Boolean|undefined} Undefined if not supported, otherwise true or false. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. + * @returns {boolean|undefined} Undefined if not supported, otherwise true or false. */ GoogleEarthEnterpriseTerrainProvider.prototype.getTileDataAvailable = function ( x, @@ -615,9 +615,9 @@ GoogleEarthEnterpriseTerrainProvider.prototype.getTileDataAvailable = function ( /** * Makes sure we load availability data for a tile * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @returns {undefined} */ GoogleEarthEnterpriseTerrainProvider.prototype.loadTileDataAvailability = function ( diff --git a/packages/engine/Source/Core/GoogleEarthEnterpriseTileInformation.js b/packages/engine/Source/Core/GoogleEarthEnterpriseTileInformation.js index 88f6bee95dca..e1caecb56ae5 100644 --- a/packages/engine/Source/Core/GoogleEarthEnterpriseTileInformation.js +++ b/packages/engine/Source/Core/GoogleEarthEnterpriseTileInformation.js @@ -11,12 +11,12 @@ const terrainBitmask = 0x80; /** * Contains information about each tile from a Google Earth Enterprise server * - * @param {Number} bits Bitmask that contains the type of data and available children for each tile. - * @param {Number} cnodeVersion Version of the request for subtree metadata. - * @param {Number} imageryVersion Version of the request for imagery tile. - * @param {Number} terrainVersion Version of the request for terrain tile. - * @param {Number} imageryProvider Id of imagery provider. - * @param {Number} terrainProvider Id of terrain provider. + * @param {number} bits Bitmask that contains the type of data and available children for each tile. + * @param {number} cnodeVersion Version of the request for subtree metadata. + * @param {number} imageryVersion Version of the request for imagery tile. + * @param {number} terrainVersion Version of the request for terrain tile. + * @param {number} imageryProvider Id of imagery provider. + * @param {number} terrainProvider Id of terrain provider. * * @private */ @@ -41,7 +41,7 @@ function GoogleEarthEnterpriseTileInformation( /** * Creates GoogleEarthEnterpriseTileInformation from an object * - * @param {Object} info Object to be cloned + * @param {object} info Object to be cloned * @param {GoogleEarthEnterpriseTileInformation} [result] The object onto which to store the result. * @returns {GoogleEarthEnterpriseTileInformation} The modified result parameter or a new GoogleEarthEnterpriseTileInformation instance if none was provided. */ @@ -81,7 +81,7 @@ GoogleEarthEnterpriseTileInformation.prototype.setParent = function (parent) { /** * Gets whether a subtree is available * - * @returns {Boolean} true if subtree is available, false otherwise. + * @returns {boolean} true if subtree is available, false otherwise. */ GoogleEarthEnterpriseTileInformation.prototype.hasSubtree = function () { return isBitSet(this._bits, cacheFlagBitmask); @@ -90,7 +90,7 @@ GoogleEarthEnterpriseTileInformation.prototype.hasSubtree = function () { /** * Gets whether imagery is available * - * @returns {Boolean} true if imagery is available, false otherwise. + * @returns {boolean} true if imagery is available, false otherwise. */ GoogleEarthEnterpriseTileInformation.prototype.hasImagery = function () { return isBitSet(this._bits, imageBitmask); @@ -99,7 +99,7 @@ GoogleEarthEnterpriseTileInformation.prototype.hasImagery = function () { /** * Gets whether terrain is available * - * @returns {Boolean} true if terrain is available, false otherwise. + * @returns {boolean} true if terrain is available, false otherwise. */ GoogleEarthEnterpriseTileInformation.prototype.hasTerrain = function () { return isBitSet(this._bits, terrainBitmask); @@ -108,7 +108,7 @@ GoogleEarthEnterpriseTileInformation.prototype.hasTerrain = function () { /** * Gets whether any children are present * - * @returns {Boolean} true if any children are available, false otherwise. + * @returns {boolean} true if any children are available, false otherwise. */ GoogleEarthEnterpriseTileInformation.prototype.hasChildren = function () { return isBitSet(this._bits, anyChildBitmask); @@ -117,9 +117,9 @@ GoogleEarthEnterpriseTileInformation.prototype.hasChildren = function () { /** * Gets whether a specified child is available * - * @param {Number} index Index of child tile + * @param {number} index Index of child tile * - * @returns {Boolean} true if child is available, false otherwise + * @returns {boolean} true if child is available, false otherwise */ GoogleEarthEnterpriseTileInformation.prototype.hasChild = function (index) { return isBitSet(this._bits, childrenBitmasks[index]); @@ -128,7 +128,7 @@ GoogleEarthEnterpriseTileInformation.prototype.hasChild = function (index) { /** * Gets bitmask containing children * - * @returns {Number} Children bitmask + * @returns {number} Children bitmask */ GoogleEarthEnterpriseTileInformation.prototype.getChildBitmask = function () { return this._bits & anyChildBitmask; diff --git a/packages/engine/Source/Core/GregorianDate.js b/packages/engine/Source/Core/GregorianDate.js index cd4c53c1d1a3..14973a978eca 100644 --- a/packages/engine/Source/Core/GregorianDate.js +++ b/packages/engine/Source/Core/GregorianDate.js @@ -4,14 +4,14 @@ * @alias GregorianDate * @constructor * - * @param {Number} [year] The year as a whole number. - * @param {Number} [month] The month as a whole number with range [1, 12]. - * @param {Number} [day] The day of the month as a whole number starting at 1. - * @param {Number} [hour] The hour as a whole number with range [0, 23]. - * @param {Number} [minute] The minute of the hour as a whole number with range [0, 59]. - * @param {Number} [second] The second of the minute as a whole number with range [0, 60], with 60 representing a leap second. - * @param {Number} [millisecond] The millisecond of the second as a floating point number with range [0.0, 1000.0). - * @param {Boolean} [isLeapSecond] Whether this time is during a leap second. + * @param {number} [year] The year as a whole number. + * @param {number} [month] The month as a whole number with range [1, 12]. + * @param {number} [day] The day of the month as a whole number starting at 1. + * @param {number} [hour] The hour as a whole number with range [0, 23]. + * @param {number} [minute] The minute of the hour as a whole number with range [0, 59]. + * @param {number} [second] The second of the minute as a whole number with range [0, 60], with 60 representing a leap second. + * @param {number} [millisecond] The millisecond of the second as a floating point number with range [0.0, 1000.0). + * @param {boolean} [isLeapSecond] Whether this time is during a leap second. * * @see JulianDate#toGregorianDate */ @@ -27,42 +27,42 @@ function GregorianDate( ) { /** * Gets or sets the year as a whole number. - * @type {Number} + * @type {number} */ this.year = year; /** * Gets or sets the month as a whole number with range [1, 12]. - * @type {Number} + * @type {number} */ this.month = month; /** * Gets or sets the day of the month as a whole number starting at 1. - * @type {Number} + * @type {number} */ this.day = day; /** * Gets or sets the hour as a whole number with range [0, 23]. - * @type {Number} + * @type {number} */ this.hour = hour; /** * Gets or sets the minute of the hour as a whole number with range [0, 59]. - * @type {Number} + * @type {number} */ this.minute = minute; /** * Gets or sets the second of the minute as a whole number with range [0, 60], with 60 representing a leap second. - * @type {Number} + * @type {number} */ this.second = second; /** * Gets or sets the millisecond of the second as a floating point number with range [0.0, 1000.0). - * @type {Number} + * @type {number} */ this.millisecond = millisecond; /** * Gets or sets whether this time is during a leap second. - * @type {Boolean} + * @type {boolean} */ this.isLeapSecond = isLeapSecond; } diff --git a/packages/engine/Source/Core/GroundPolylineGeometry.js b/packages/engine/Source/Core/GroundPolylineGeometry.js index 8422a587d0ff..877874c2f5a0 100644 --- a/packages/engine/Source/Core/GroundPolylineGeometry.js +++ b/packages/engine/Source/Core/GroundPolylineGeometry.js @@ -49,11 +49,11 @@ const WALL_INITIAL_MAX_HEIGHT = 1000.0; * @alias GroundPolylineGeometry * @constructor * - * @param {Object} options Options with the following properties: + * @param {object} options Options with the following properties: * @param {Cartesian3[]} options.positions An array of {@link Cartesian3} defining the polyline's points. Heights above the ellipsoid will be ignored. - * @param {Number} [options.width=1.0] The screen space width in pixels. - * @param {Number} [options.granularity=9999.0] The distance interval in meters used for interpolating options.points. Defaults to 9999.0 meters. Zero indicates no interpolation. - * @param {Boolean} [options.loop=false] Whether during geometry creation a line segment will be added between the last and first line positions to make this Polyline a loop. + * @param {number} [options.width=1.0] The screen space width in pixels. + * @param {number} [options.granularity=9999.0] The distance interval in meters used for interpolating options.points. Defaults to 9999.0 meters. Zero indicates no interpolation. + * @param {boolean} [options.loop=false] Whether during geometry creation a line segment will be added between the last and first line positions to make this Polyline a loop. * @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of line the polyline segments must follow. Valid options are {@link ArcType.GEODESIC} and {@link ArcType.RHUMB}. * * @exception {DeveloperError} At least two positions are required. @@ -92,7 +92,7 @@ function GroundPolylineGeometry(options) { /** * The screen space width in pixels. - * @type {Number} + * @type {number} */ this.width = defaultValue(options.width, 1.0); // Doesn't get packed, not necessary for computing geometry. @@ -101,7 +101,7 @@ function GroundPolylineGeometry(options) { /** * The distance interval used for interpolating options.points. Zero indicates no interpolation. * Default of 9999.0 allows centimeter accuracy with 32 bit floating point. - * @type {Boolean} + * @type {boolean} * @default 9999.0 */ this.granularity = defaultValue(options.granularity, 9999.0); @@ -109,7 +109,7 @@ function GroundPolylineGeometry(options) { /** * Whether during geometry creation a line segment will be added between the last and first line positions to make this Polyline a loop. * If the geometry has two positions this parameter will be ignored. - * @type {Boolean} + * @type {boolean} * @default false */ this.loop = defaultValue(options.loop, false); @@ -135,7 +135,7 @@ Object.defineProperties(GroundPolylineGeometry.prototype, { /** * The number of elements used to pack the object into an array. * @memberof GroundPolylineGeometry.prototype - * @type {Number} + * @type {number} * @readonly * @private */ @@ -285,10 +285,10 @@ function getPosition(ellipsoid, cartographic, height, result) { * Stores the provided instance into the provided array. * * @param {PolygonGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ GroundPolylineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -325,8 +325,8 @@ GroundPolylineGeometry.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {PolygonGeometry} [result] The object into which to store the result. */ GroundPolylineGeometry.unpack = function (array, startingIndex, result) { diff --git a/packages/engine/Source/Core/HeadingPitchRange.js b/packages/engine/Source/Core/HeadingPitchRange.js index 15741102e771..355f03c816f9 100644 --- a/packages/engine/Source/Core/HeadingPitchRange.js +++ b/packages/engine/Source/Core/HeadingPitchRange.js @@ -9,14 +9,14 @@ import defined from "./defined.js"; * @alias HeadingPitchRange * @constructor * - * @param {Number} [heading=0.0] The heading angle in radians. - * @param {Number} [pitch=0.0] The pitch angle in radians. - * @param {Number} [range=0.0] The distance from the center in meters. + * @param {number} [heading=0.0] The heading angle in radians. + * @param {number} [pitch=0.0] The pitch angle in radians. + * @param {number} [range=0.0] The distance from the center in meters. */ function HeadingPitchRange(heading, pitch, range) { /** * Heading is the rotation from the local north direction where a positive angle is increasing eastward. - * @type {Number} + * @type {number} * @default 0.0 */ this.heading = defaultValue(heading, 0.0); @@ -24,14 +24,14 @@ function HeadingPitchRange(heading, pitch, range) { /** * Pitch is the rotation from the local xy-plane. Positive pitch angles * are above the plane. Negative pitch angles are below the plane. - * @type {Number} + * @type {number} * @default 0.0 */ this.pitch = defaultValue(pitch, 0.0); /** * Range is the distance from the center of the local frame. - * @type {Number} + * @type {number} * @default 0.0 */ this.range = defaultValue(range, 0.0); diff --git a/packages/engine/Source/Core/HeadingPitchRoll.js b/packages/engine/Source/Core/HeadingPitchRoll.js index dfa22c92fc34..92a3dadfefc2 100644 --- a/packages/engine/Source/Core/HeadingPitchRoll.js +++ b/packages/engine/Source/Core/HeadingPitchRoll.js @@ -10,26 +10,26 @@ import CesiumMath from "./Math.js"; * @alias HeadingPitchRoll * @constructor * - * @param {Number} [heading=0.0] The heading component in radians. - * @param {Number} [pitch=0.0] The pitch component in radians. - * @param {Number} [roll=0.0] The roll component in radians. + * @param {number} [heading=0.0] The heading component in radians. + * @param {number} [pitch=0.0] The pitch component in radians. + * @param {number} [roll=0.0] The roll component in radians. */ function HeadingPitchRoll(heading, pitch, roll) { /** * Gets or sets the heading. - * @type {Number} + * @type {number} * @default 0.0 */ this.heading = defaultValue(heading, 0.0); /** * Gets or sets the pitch. - * @type {Number} + * @type {number} * @default 0.0 */ this.pitch = defaultValue(pitch, 0.0); /** * Gets or sets the roll. - * @type {Number} + * @type {number} * @default 0.0 */ this.roll = defaultValue(roll, 0.0); @@ -69,9 +69,9 @@ HeadingPitchRoll.fromQuaternion = function (quaternion, result) { /** * Returns a new HeadingPitchRoll instance from angles given in degrees. * - * @param {Number} heading the heading in degrees - * @param {Number} pitch the pitch in degrees - * @param {Number} roll the heading in degrees + * @param {number} heading the heading in degrees + * @param {number} pitch the pitch in degrees + * @param {number} roll the heading in degrees * @param {HeadingPitchRoll} [result] The object in which to store the result. If not provided, a new instance is created and returned. * @returns {HeadingPitchRoll} A new HeadingPitchRoll instance */ @@ -126,7 +126,7 @@ HeadingPitchRoll.clone = function (headingPitchRoll, result) { * * @param {HeadingPitchRoll} [left] The first HeadingPitchRoll. * @param {HeadingPitchRoll} [right] The second HeadingPitchRoll. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ HeadingPitchRoll.equals = function (left, right) { return ( @@ -146,9 +146,9 @@ HeadingPitchRoll.equals = function (left, right) { * * @param {HeadingPitchRoll} [left] The first HeadingPitchRoll. * @param {HeadingPitchRoll} [right] The second HeadingPitchRoll. - * @param {Number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ HeadingPitchRoll.equalsEpsilon = function ( left, @@ -196,7 +196,7 @@ HeadingPitchRoll.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {HeadingPitchRoll} [right] The right hand side HeadingPitchRoll. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ HeadingPitchRoll.prototype.equals = function (right) { return HeadingPitchRoll.equals(this, right); @@ -208,9 +208,9 @@ HeadingPitchRoll.prototype.equals = function (right) { * false otherwise. * * @param {HeadingPitchRoll} [right] The right hand side HeadingPitchRoll. - * @param {Number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if they are within the provided epsilon, false otherwise. + * @param {number} [relativeEpsilon=0] The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if they are within the provided epsilon, false otherwise. */ HeadingPitchRoll.prototype.equalsEpsilon = function ( right, @@ -228,7 +228,7 @@ HeadingPitchRoll.prototype.equalsEpsilon = function ( /** * Creates a string representing this HeadingPitchRoll in the format '(heading, pitch, roll)' in radians. * - * @returns {String} A string representing the provided HeadingPitchRoll in the format '(heading, pitch, roll)'. + * @returns {string} A string representing the provided HeadingPitchRoll in the format '(heading, pitch, roll)'. */ HeadingPitchRoll.prototype.toString = function () { return `(${this.heading}, ${this.pitch}, ${this.roll})`; diff --git a/packages/engine/Source/Core/Heap.js b/packages/engine/Source/Core/Heap.js index 47816444f829..700475cedc55 100644 --- a/packages/engine/Source/Core/Heap.js +++ b/packages/engine/Source/Core/Heap.js @@ -9,7 +9,7 @@ import defined from "./defined.js"; * @constructor * @private * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Heap.ComparatorCallback} options.comparator The comparator to use for the heap. If comparator(a, b) is less than 0, sort a to a lower index than b, otherwise sort to a higher index. */ function Heap(options) { @@ -30,7 +30,7 @@ Object.defineProperties(Heap.prototype, { * * @memberof Heap.prototype * - * @type {Number} + * @type {number} * @readonly */ length: { @@ -58,7 +58,7 @@ Object.defineProperties(Heap.prototype, { * * @memberof Heap.prototype * - * @type {Number} + * @type {number} */ maximumLength: { get: function () { @@ -105,7 +105,7 @@ function swap(array, a, b) { /** * Resizes the internal array of the heap. * - * @param {Number} [length] The length to resize internal array to. Defaults to the current length of the heap. + * @param {number} [length] The length to resize internal array to. Defaults to the current length of the heap. */ Heap.prototype.reserve = function (length) { length = defaultValue(length, this._length); @@ -115,7 +115,7 @@ Heap.prototype.reserve = function (length) { /** * Update the heap so that index and all descendants satisfy the heap property. * - * @param {Number} [index=0] The starting index to heapify from. + * @param {number} [index=0] The starting index to heapify from. */ Heap.prototype.heapify = function (index) { index = defaultValue(index, 0); @@ -204,7 +204,7 @@ Heap.prototype.insert = function (element) { /** * Remove the element specified by index from the heap and return it. * - * @param {Number} [index=0] The index to remove. + * @param {number} [index=0] The index to remove. * @returns {*} The specified element of the heap. */ Heap.prototype.pop = function (index) { @@ -229,6 +229,6 @@ Heap.prototype.pop = function (index) { * @callback Heap.ComparatorCallback * @param {*} a An element in the heap. * @param {*} b An element in the heap. - * @returns {Number} If the result of the comparison is less than 0, sort a to a lower index than b, otherwise sort to a higher index. + * @returns {number} If the result of the comparison is less than 0, sort a to a lower index than b, otherwise sort to a higher index. */ export default Heap; diff --git a/packages/engine/Source/Core/HeightmapEncoding.js b/packages/engine/Source/Core/HeightmapEncoding.js index a7f02a09d60a..ba66c785b839 100644 --- a/packages/engine/Source/Core/HeightmapEncoding.js +++ b/packages/engine/Source/Core/HeightmapEncoding.js @@ -1,13 +1,13 @@ /** * The encoding that is used for a heightmap * - * @enum {Number} + * @enum {number} */ const HeightmapEncoding = { /** * No encoding * - * @type {Number} + * @type {number} * @constant */ NONE: 0, @@ -15,7 +15,7 @@ const HeightmapEncoding = { /** * LERC encoding * - * @type {Number} + * @type {number} * @constant * * @see {@link https://github.com/Esri/lerc|The LERC specification} diff --git a/packages/engine/Source/Core/HeightmapTerrainData.js b/packages/engine/Source/Core/HeightmapTerrainData.js index 4d797eddbbb4..fab32e682b89 100644 --- a/packages/engine/Source/Core/HeightmapTerrainData.js +++ b/packages/engine/Source/Core/HeightmapTerrainData.js @@ -23,11 +23,11 @@ import TerrainProvider from "./TerrainProvider.js"; * @alias HeightmapTerrainData * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Int8Array|Uint8Array|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array} options.buffer The buffer containing height data. - * @param {Number} options.width The width (longitude direction) of the heightmap, in samples. - * @param {Number} options.height The height (latitude direction) of the heightmap, in samples. - * @param {Number} [options.childTileMask=15] A bit mask indicating which of this tile's four children exist. + * @param {number} options.width The width (longitude direction) of the heightmap, in samples. + * @param {number} options.height The height (latitude direction) of the heightmap, in samples. + * @param {number} [options.childTileMask=15] A bit mask indicating which of this tile's four children exist. * If a child's bit is set, geometry will be requested for that tile as well when it * is needed. If the bit is cleared, the child tile is not requested and geometry is * instead upsampled from the parent. The bit values are as follows: @@ -41,38 +41,38 @@ import TerrainProvider from "./TerrainProvider.js"; * @param {Uint8Array} [options.waterMask] The water mask included in this terrain data, if any. A water mask is a square * Uint8Array or image where a value of 255 indicates water and a value of 0 indicates land. * Values in between 0 and 255 are allowed as well to smoothly blend between land and water. - * @param {Object} [options.structure] An object describing the structure of the height data. - * @param {Number} [options.structure.heightScale=1.0] The factor by which to multiply height samples in order to obtain + * @param {object} [options.structure] An object describing the structure of the height data. + * @param {number} [options.structure.heightScale=1.0] The factor by which to multiply height samples in order to obtain * the height above the heightOffset, in meters. The heightOffset is added to the resulting * height after multiplying by the scale. - * @param {Number} [options.structure.heightOffset=0.0] The offset to add to the scaled height to obtain the final + * @param {number} [options.structure.heightOffset=0.0] The offset to add to the scaled height to obtain the final * height in meters. The offset is added after the height sample is multiplied by the * heightScale. - * @param {Number} [options.structure.elementsPerHeight=1] The number of elements in the buffer that make up a single height + * @param {number} [options.structure.elementsPerHeight=1] The number of elements in the buffer that make up a single height * sample. This is usually 1, indicating that each element is a separate height sample. If * it is greater than 1, that number of elements together form the height sample, which is * computed according to the structure.elementMultiplier and structure.isBigEndian properties. - * @param {Number} [options.structure.stride=1] The number of elements to skip to get from the first element of + * @param {number} [options.structure.stride=1] The number of elements to skip to get from the first element of * one height to the first element of the next height. - * @param {Number} [options.structure.elementMultiplier=256.0] The multiplier used to compute the height value when the + * @param {number} [options.structure.elementMultiplier=256.0] The multiplier used to compute the height value when the * stride property is greater than 1. For example, if the stride is 4 and the strideMultiplier * is 256, the height is computed as follows: * `height = buffer[index] + buffer[index + 1] * 256 + buffer[index + 2] * 256 * 256 + buffer[index + 3] * 256 * 256 * 256` * This is assuming that the isBigEndian property is false. If it is true, the order of the * elements is reversed. - * @param {Boolean} [options.structure.isBigEndian=false] Indicates endianness of the elements in the buffer when the + * @param {boolean} [options.structure.isBigEndian=false] Indicates endianness of the elements in the buffer when the * stride property is greater than 1. If this property is false, the first element is the * low-order element. If it is true, the first element is the high-order element. - * @param {Number} [options.structure.lowestEncodedHeight] The lowest value that can be stored in the height buffer. Any heights that are lower + * @param {number} [options.structure.lowestEncodedHeight] The lowest value that can be stored in the height buffer. Any heights that are lower * than this value after encoding with the `heightScale` and `heightOffset` are clamped to this value. For example, if the height * buffer is a `Uint16Array`, this value should be 0 because a `Uint16Array` cannot store negative numbers. If this parameter is * not specified, no minimum value is enforced. - * @param {Number} [options.structure.highestEncodedHeight] The highest value that can be stored in the height buffer. Any heights that are higher + * @param {number} [options.structure.highestEncodedHeight] The highest value that can be stored in the height buffer. Any heights that are higher * than this value after encoding with the `heightScale` and `heightOffset` are clamped to this value. For example, if the height * buffer is a `Uint16Array`, this value should be `256 * 256 - 1` or 65535 because a `Uint16Array` cannot store numbers larger * than 65535. If this parameter is not specified, no maximum value is enforced. * @param {HeightmapEncoding} [options.encoding=HeightmapEncoding.NONE] The encoding that is used on the buffer. - * @param {Boolean} [options.createdByUpsampling=false] True if this instance was created by upsampling another instance; + * @param {boolean} [options.createdByUpsampling=false] True if this instance was created by upsampling another instance; * otherwise, false. * * @@ -195,15 +195,15 @@ const createMeshTaskProcessorThrottle = new TaskProcessor( * * @private * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {TilingScheme} options.tilingScheme The tiling scheme to which this tile belongs. - * @param {Number} options.x The X coordinate of the tile for which to create the terrain data. - * @param {Number} options.y The Y coordinate of the tile for which to create the terrain data. - * @param {Number} options.level The level of the tile for which to create the terrain data. - * @param {Number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. - * @param {Number} [options.exaggerationRelativeHeight=0.0] The height relative to which terrain is exaggerated. - * @param {Boolean} [options.throttle=true] If true, indicates that this operation will need to be retried if too many asynchronous mesh creations are already in progress. - * @returns {Promise.|undefined} A promise for the terrain mesh, or undefined if too many + * @param {number} options.x The X coordinate of the tile for which to create the terrain data. + * @param {number} options.y The Y coordinate of the tile for which to create the terrain data. + * @param {number} options.level The level of the tile for which to create the terrain data. + * @param {number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. + * @param {number} [options.exaggerationRelativeHeight=0.0] The height relative to which terrain is exaggerated. + * @param {boolean} [options.throttle=true] If true, indicates that this operation will need to be retried if too many asynchronous mesh creations are already in progress. + * @returns {Promise|undefined} A promise for the terrain mesh, or undefined if too many * asynchronous mesh creations are already in progress and the operation should * be retried later. */ @@ -316,13 +316,13 @@ HeightmapTerrainData.prototype.createMesh = function (options) { }; /** - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {TilingScheme} options.tilingScheme The tiling scheme to which this tile belongs. - * @param {Number} options.x The X coordinate of the tile for which to create the terrain data. - * @param {Number} options.y The Y coordinate of the tile for which to create the terrain data. - * @param {Number} options.level The level of the tile for which to create the terrain data. - * @param {Number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. - * @param {Number} [options.exaggerationRelativeHeight=0.0] The height relative to which terrain is exaggerated. + * @param {number} options.x The X coordinate of the tile for which to create the terrain data. + * @param {number} options.y The Y coordinate of the tile for which to create the terrain data. + * @param {number} options.level The level of the tile for which to create the terrain data. + * @param {number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. + * @param {number} [options.exaggerationRelativeHeight=0.0] The height relative to which terrain is exaggerated. * * @private */ @@ -423,9 +423,9 @@ HeightmapTerrainData.prototype._createMeshSync = function (options) { * Computes the terrain height at a specified longitude and latitude. * * @param {Rectangle} rectangle The rectangle covered by this terrain data. - * @param {Number} longitude The longitude in radians. - * @param {Number} latitude The latitude in radians. - * @returns {Number} The terrain height at the specified position. If the position + * @param {number} longitude The longitude in radians. + * @param {number} latitude The latitude in radians. + * @returns {number} The terrain height at the specified position. If the position * is outside the rectangle, this method will extrapolate the height, which is likely to be wildly * incorrect for positions far outside the rectangle. */ @@ -494,13 +494,13 @@ HeightmapTerrainData.prototype.interpolateHeight = function ( * height samples in this instance, interpolated if necessary. * * @param {TilingScheme} tilingScheme The tiling scheme of this terrain data. - * @param {Number} thisX The X coordinate of this tile in the tiling scheme. - * @param {Number} thisY The Y coordinate of this tile in the tiling scheme. - * @param {Number} thisLevel The level of this tile in the tiling scheme. - * @param {Number} descendantX The X coordinate within the tiling scheme of the descendant tile for which we are upsampling. - * @param {Number} descendantY The Y coordinate within the tiling scheme of the descendant tile for which we are upsampling. - * @param {Number} descendantLevel The level within the tiling scheme of the descendant tile for which we are upsampling. - * @returns {Promise.|undefined} A promise for upsampled heightmap terrain data for the descendant tile, + * @param {number} thisX The X coordinate of this tile in the tiling scheme. + * @param {number} thisY The Y coordinate of this tile in the tiling scheme. + * @param {number} thisLevel The level of this tile in the tiling scheme. + * @param {number} descendantX The X coordinate within the tiling scheme of the descendant tile for which we are upsampling. + * @param {number} descendantY The Y coordinate within the tiling scheme of the descendant tile for which we are upsampling. + * @param {number} descendantLevel The level within the tiling scheme of the descendant tile for which we are upsampling. + * @returns {Promise|undefined} A promise for upsampled heightmap terrain data for the descendant tile, * or undefined if the mesh is unavailable. */ HeightmapTerrainData.prototype.upsample = function ( @@ -644,11 +644,11 @@ HeightmapTerrainData.prototype.upsample = function ( * to be one of the four children of this tile. If non-child tile coordinates are * given, the availability of the southeast child tile is returned. * - * @param {Number} thisX The tile X coordinate of this (the parent) tile. - * @param {Number} thisY The tile Y coordinate of this (the parent) tile. - * @param {Number} childX The tile X coordinate of the child tile to check for availability. - * @param {Number} childY The tile Y coordinate of the child tile to check for availability. - * @returns {Boolean} True if the child tile is available; otherwise, false. + * @param {number} thisX The tile X coordinate of this (the parent) tile. + * @param {number} thisY The tile Y coordinate of this (the parent) tile. + * @param {number} childX The tile X coordinate of the child tile to check for availability. + * @param {number} childY The tile Y coordinate of the child tile to check for availability. + * @returns {boolean} True if the child tile is available; otherwise, false. */ HeightmapTerrainData.prototype.isChildAvailable = function ( thisX, @@ -688,7 +688,7 @@ HeightmapTerrainData.prototype.isChildAvailable = function ( * as by downloading it from a remote server. This method should return true for instances * returned from a call to {@link HeightmapTerrainData#upsample}. * - * @returns {Boolean} True if this instance was created by upsampling; otherwise, false. + * @returns {boolean} True if this instance was created by upsampling; otherwise, false. */ HeightmapTerrainData.prototype.wasCreatedByUpsampling = function () { return this._createdByUpsampling; diff --git a/packages/engine/Source/Core/HeightmapTessellator.js b/packages/engine/Source/Core/HeightmapTessellator.js index a1b2c48072e3..be566f845e34 100644 --- a/packages/engine/Source/Core/HeightmapTessellator.js +++ b/packages/engine/Source/Core/HeightmapTessellator.js @@ -46,51 +46,51 @@ const maximumScratch = new Cartesian3(); /** * Fills an array of vertices from a heightmap image. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Int8Array|Uint8Array|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array} options.heightmap The heightmap to tessellate. - * @param {Number} options.width The width of the heightmap, in height samples. - * @param {Number} options.height The height of the heightmap, in height samples. - * @param {Number} options.skirtHeight The height of skirts to drape at the edges of the heightmap. + * @param {number} options.width The width of the heightmap, in height samples. + * @param {number} options.height The height of the heightmap, in height samples. + * @param {number} options.skirtHeight The height of skirts to drape at the edges of the heightmap. * @param {Rectangle} options.nativeRectangle A rectangle in the native coordinates of the heightmap's projection. For * a heightmap with a geographic projection, this is degrees. For the web mercator * projection, this is meters. - * @param {Number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. - * @param {Number} [options.exaggerationRelativeHeight=0.0] The height from which terrain is exaggerated. + * @param {number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. + * @param {number} [options.exaggerationRelativeHeight=0.0] The height from which terrain is exaggerated. * @param {Rectangle} [options.rectangle] The rectangle covered by the heightmap, in geodetic coordinates with north, south, east and * west properties in radians. Either rectangle or nativeRectangle must be provided. If both * are provided, they're assumed to be consistent. - * @param {Boolean} [options.isGeographic=true] True if the heightmap uses a {@link GeographicProjection}, or false if it uses + * @param {boolean} [options.isGeographic=true] True if the heightmap uses a {@link GeographicProjection}, or false if it uses * a {@link WebMercatorProjection}. * @param {Cartesian3} [options.relativeToCenter=Cartesian3.ZERO] The positions will be computed as Cartesian3.subtract(worldPosition, relativeToCenter). * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to which the heightmap applies. - * @param {Object} [options.structure] An object describing the structure of the height data. - * @param {Number} [options.structure.heightScale=1.0] The factor by which to multiply height samples in order to obtain + * @param {object} [options.structure] An object describing the structure of the height data. + * @param {number} [options.structure.heightScale=1.0] The factor by which to multiply height samples in order to obtain * the height above the heightOffset, in meters. The heightOffset is added to the resulting * height after multiplying by the scale. - * @param {Number} [options.structure.heightOffset=0.0] The offset to add to the scaled height to obtain the final + * @param {number} [options.structure.heightOffset=0.0] The offset to add to the scaled height to obtain the final * height in meters. The offset is added after the height sample is multiplied by the * heightScale. - * @param {Number} [options.structure.elementsPerHeight=1] The number of elements in the buffer that make up a single height + * @param {number} [options.structure.elementsPerHeight=1] The number of elements in the buffer that make up a single height * sample. This is usually 1, indicating that each element is a separate height sample. If * it is greater than 1, that number of elements together form the height sample, which is * computed according to the structure.elementMultiplier and structure.isBigEndian properties. - * @param {Number} [options.structure.stride=1] The number of elements to skip to get from the first element of + * @param {number} [options.structure.stride=1] The number of elements to skip to get from the first element of * one height to the first element of the next height. - * @param {Number} [options.structure.elementMultiplier=256.0] The multiplier used to compute the height value when the + * @param {number} [options.structure.elementMultiplier=256.0] The multiplier used to compute the height value when the * stride property is greater than 1. For example, if the stride is 4 and the strideMultiplier * is 256, the height is computed as follows: * `height = buffer[index] + buffer[index + 1] * 256 + buffer[index + 2] * 256 * 256 + buffer[index + 3] * 256 * 256 * 256` * This is assuming that the isBigEndian property is false. If it is true, the order of the * elements is reversed. - * @param {Number} [options.structure.lowestEncodedHeight] The lowest value that can be stored in the height buffer. Any heights that are lower + * @param {number} [options.structure.lowestEncodedHeight] The lowest value that can be stored in the height buffer. Any heights that are lower * than this value after encoding with the `heightScale` and `heightOffset` are clamped to this value. For example, if the height * buffer is a `Uint16Array`, this value should be 0 because a `Uint16Array` cannot store negative numbers. If this parameter is * not specified, no minimum value is enforced. - * @param {Number} [options.structure.highestEncodedHeight] The highest value that can be stored in the height buffer. Any heights that are higher + * @param {number} [options.structure.highestEncodedHeight] The highest value that can be stored in the height buffer. Any heights that are higher * than this value after encoding with the `heightScale` and `heightOffset` are clamped to this value. For example, if the height * buffer is a `Uint16Array`, this value should be `256 * 256 - 1` or 65535 because a `Uint16Array` cannot store numbers larger * than 65535. If this parameter is not specified, no maximum value is enforced. - * @param {Boolean} [options.structure.isBigEndian=false] Indicates endianness of the elements in the buffer when the + * @param {boolean} [options.structure.isBigEndian=false] Indicates endianness of the elements in the buffer when the * stride property is greater than 1. If this property is false, the first element is the * low-order element. If it is true, the first element is the high-order element. * diff --git a/packages/engine/Source/Core/HermitePolynomialApproximation.js b/packages/engine/Source/Core/HermitePolynomialApproximation.js index 4e7cae0549c9..c2737cd26d28 100644 --- a/packages/engine/Source/Core/HermitePolynomialApproximation.js +++ b/packages/engine/Source/Core/HermitePolynomialApproximation.js @@ -73,9 +73,9 @@ const HermitePolynomialApproximation = { /** * Given the desired degree, returns the number of data points required for interpolation. * - * @param {Number} degree The desired degree of interpolation. - * @param {Number} [inputOrder=0] The order of the inputs (0 means just the data, 1 means the data and its derivative, etc). - * @returns {Number} The number of required data points needed for the desired degree of interpolation. + * @param {number} degree The desired degree of interpolation. + * @param {number} [inputOrder=0] The order of the inputs (0 means just the data, 1 means the data and its derivative, etc). + * @returns {number} The number of required data points needed for the desired degree of interpolation. * @exception {DeveloperError} degree must be 0 or greater. * @exception {DeveloperError} inputOrder must be 0 or greater. */ @@ -103,15 +103,15 @@ HermitePolynomialApproximation.getRequiredDataPoints = function ( /** * Interpolates values using Hermite Polynomial Approximation. * - * @param {Number} x The independent variable for which the dependent variables will be interpolated. - * @param {Number[]} xTable The array of independent variables to use to interpolate. The values + * @param {number} x The independent variable for which the dependent variables will be interpolated. + * @param {number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. - * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. - * @param {Number} yStride The number of dependent variable values in yTable corresponding to + * @param {number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. - * @param {Number[]} [result] An existing array into which to store the result. - * @returns {Number[]} The array of interpolated values, or the result parameter if one was provided. + * @param {number[]} [result] An existing array into which to store the result. + * @returns {number[]} The array of interpolated values, or the result parameter if one was provided. */ HermitePolynomialApproximation.interpolateOrderZero = function ( x, @@ -199,18 +199,18 @@ const arrayScratch = []; /** * Interpolates values using Hermite Polynomial Approximation. * - * @param {Number} x The independent variable for which the dependent variables will be interpolated. - * @param {Number[]} xTable The array of independent variables to use to interpolate. The values + * @param {number} x The independent variable for which the dependent variables will be interpolated. + * @param {number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. - * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. - * @param {Number} yStride The number of dependent variable values in yTable corresponding to + * @param {number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. - * @param {Number} inputOrder The number of derivatives supplied for input. - * @param {Number} outputOrder The number of derivatives desired for output. - * @param {Number[]} [result] An existing array into which to store the result. + * @param {number} inputOrder The number of derivatives supplied for input. + * @param {number} outputOrder The number of derivatives desired for output. + * @param {number[]} [result] An existing array into which to store the result. * - * @returns {Number[]} The array of interpolated values, or the result parameter if one was provided. + * @returns {number[]} The array of interpolated values, or the result parameter if one was provided. */ HermitePolynomialApproximation.interpolate = function ( x, diff --git a/packages/engine/Source/Core/HermiteSpline.js b/packages/engine/Source/Core/HermiteSpline.js index a89719c47a9d..629e81e7687a 100644 --- a/packages/engine/Source/Core/HermiteSpline.js +++ b/packages/engine/Source/Core/HermiteSpline.js @@ -119,8 +119,8 @@ function generateNatural(points) { * @alias HermiteSpline * @constructor * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. + * @param {object} options Object with the following properties: + * @param {number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. * @param {Cartesian3[]} options.points The array of control points. * @param {Cartesian3[]} options.inTangents The array of incoming tangents at each control point. @@ -229,7 +229,7 @@ Object.defineProperties(HermiteSpline.prototype, { * * @memberof HermiteSpline.prototype * - * @type {Number[]} + * @type {number[]} * @readonly */ times: { @@ -285,8 +285,8 @@ Object.defineProperties(HermiteSpline.prototype, { * Creates a spline where the tangents at each control point are the same. * The curves are guaranteed to be at least in the class C1. * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.times The array of control point times. + * @param {object} options Object with the following properties: + * @param {number[]} options.times The array of control point times. * @param {Cartesian3[]} options.points The array of control points. * @param {Cartesian3[]} options.tangents The array of tangents at the control points. * @returns {HermiteSpline} A hermite spline. @@ -357,8 +357,8 @@ HermiteSpline.createC1 = function (options) { * Creates a natural cubic spline. The tangents at the control points are generated * to create a curve in the class C2. * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.times The array of control point times. + * @param {object} options Object with the following properties: + * @param {number[]} options.times The array of control point times. * @param {Cartesian3[]} options.points The array of control points. * @returns {HermiteSpline|LinearSpline} A hermite spline, or a linear spline if less than 3 control points were given. * @@ -422,9 +422,9 @@ HermiteSpline.createNaturalCubic = function (options) { * Creates a clamped cubic spline. The tangents at the interior control points are generated * to create a curve in the class C2. * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.times The array of control point times. - * @param {Number[]|Cartesian3[]} options.points The array of control points. + * @param {object} options Object with the following properties: + * @param {number[]} options.times The array of control point times. + * @param {number[]|Cartesian3[]} options.points The array of control points. * @param {Cartesian3} options.firstTangent The outgoing tangent of the first control point. * @param {Cartesian3} options.lastTangent The incoming tangent of the last control point. * @returns {HermiteSpline|LinearSpline} A hermite spline, or a linear spline if less than 3 control points were given. @@ -523,8 +523,8 @@ HermiteSpline.hermiteCoefficientMatrix = new Matrix4( * time is in the interval [times[i], times[i + 1]]. * @function * - * @param {Number} time The time. - * @returns {Number} The index for the element at the start of the interval. + * @param {number} time The time. + * @returns {number} The index for the element at the start of the interval. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element @@ -539,8 +539,8 @@ const scratchTemp = new Cartesian3(); * Wraps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, wrapped around to the updated animation. + * @param {number} time The time. + * @return {number} The time, wrapped around to the updated animation. */ HermiteSpline.prototype.wrapTime = Spline.prototype.wrapTime; @@ -548,15 +548,15 @@ HermiteSpline.prototype.wrapTime = Spline.prototype.wrapTime; * Clamps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, clamped to the animation period. + * @param {number} time The time. + * @return {number} The time, clamped to the animation period. */ HermiteSpline.prototype.clampTime = Spline.prototype.clampTime; /** * Evaluates the curve at a given time. * - * @param {Number} time The time at which to evaluate the curve. + * @param {number} time The time at which to evaluate the curve. * @param {Cartesian3} [result] The object onto which to store the result. * @returns {Cartesian3} The modified result parameter or a new instance of the point on the curve at the given time. * diff --git a/packages/engine/Source/Core/HilbertOrder.js b/packages/engine/Source/Core/HilbertOrder.js index 8bfdde6cb553..540a1ea493b4 100644 --- a/packages/engine/Source/Core/HilbertOrder.js +++ b/packages/engine/Source/Core/HilbertOrder.js @@ -11,10 +11,10 @@ const HilbertOrder = {}; /** * Computes the Hilbert index at the given level from 2D coordinates. * - * @param {Number} level The level of the curve - * @param {Number} x The X coordinate - * @param {Number} y The Y coordinate - * @returns {Number} The Hilbert index. + * @param {number} level The level of the curve + * @param {number} x The X coordinate + * @param {number} y The Y coordinate + * @returns {number} The Hilbert index. * @private */ HilbertOrder.encode2D = function (level, x, y) { @@ -55,9 +55,9 @@ HilbertOrder.encode2D = function (level, x, y) { /** * Computes the 2D coordinates from the Hilbert index at the given level. * - * @param {Number} level The level of the curve - * @param {BigInt} index The Hilbert index - * @returns {Number[]} An array containing the 2D coordinates ([x, y]) corresponding to the Morton index. + * @param {number} level The level of the curve + * @param {bigint} index The Hilbert index + * @returns {number[]} An array containing the 2D coordinates ([x, y]) corresponding to the Morton index. * @private */ HilbertOrder.decode2D = function (level, index) { diff --git a/packages/engine/Source/Core/Iau2006XysData.js b/packages/engine/Source/Core/Iau2006XysData.js index 27c9d3d76835..c09aec64a55c 100644 --- a/packages/engine/Source/Core/Iau2006XysData.js +++ b/packages/engine/Source/Core/Iau2006XysData.js @@ -13,15 +13,15 @@ import TimeStandard from "./TimeStandard.js"; * @alias Iau2006XysData * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Resource|String} [options.xysFileUrlTemplate='Assets/IAU2006_XYS/IAU2006_XYS_{0}.json'] A template URL for obtaining the XYS data. In the template, + * @param {object} [options] Object with the following properties: + * @param {Resource|string} [options.xysFileUrlTemplate='Assets/IAU2006_XYS/IAU2006_XYS_{0}.json'] A template URL for obtaining the XYS data. In the template, * `{0}` will be replaced with the file index. - * @param {Number} [options.interpolationOrder=9] The order of interpolation to perform on the XYS data. - * @param {Number} [options.sampleZeroJulianEphemerisDate=2442396.5] The Julian ephemeris date (JED) of the + * @param {number} [options.interpolationOrder=9] The order of interpolation to perform on the XYS data. + * @param {number} [options.sampleZeroJulianEphemerisDate=2442396.5] The Julian ephemeris date (JED) of the * first XYS sample. - * @param {Number} [options.stepSizeDays=1.0] The step size, in days, between successive XYS samples. - * @param {Number} [options.samplesPerXysFile=1000] The number of samples in each XYS file. - * @param {Number} [options.totalSamples=27426] The total number of samples in all XYS files. + * @param {number} [options.stepSizeDays=1.0] The step size, in days, between successive XYS samples. + * @param {number} [options.samplesPerXysFile=1000] The number of samples in each XYS file. + * @param {number} [options.totalSamples=27426] The total number of samples in all XYS files. * * @private */ @@ -85,13 +85,13 @@ function getDaysSinceEpoch(xys, dayTT, secondTT) { /** * Preloads XYS data for a specified date range. * - * @param {Number} startDayTT The Julian day number of the beginning of the interval to preload, expressed in + * @param {number} startDayTT The Julian day number of the beginning of the interval to preload, expressed in * the Terrestrial Time (TT) time standard. - * @param {Number} startSecondTT The seconds past noon of the beginning of the interval to preload, expressed in + * @param {number} startSecondTT The seconds past noon of the beginning of the interval to preload, expressed in * the Terrestrial Time (TT) time standard. - * @param {Number} stopDayTT The Julian day number of the end of the interval to preload, expressed in + * @param {number} stopDayTT The Julian day number of the end of the interval to preload, expressed in * the Terrestrial Time (TT) time standard. - * @param {Number} stopSecondTT The seconds past noon of the end of the interval to preload, expressed in + * @param {number} stopSecondTT The seconds past noon of the end of the interval to preload, expressed in * the Terrestrial Time (TT) time standard. * @returns {Promise} A promise that, when resolved, indicates that the requested interval has been * preloaded. @@ -138,9 +138,9 @@ Iau2006XysData.prototype.preload = function ( * Computes the XYS values for a given date by interpolating. If the required data is not yet downloaded, * this method will return undefined. * - * @param {Number} dayTT The Julian day number for which to compute the XYS value, expressed in + * @param {number} dayTT The Julian day number for which to compute the XYS value, expressed in * the Terrestrial Time (TT) time standard. - * @param {Number} secondTT The seconds past noon of the date for which to compute the XYS value, expressed in + * @param {number} secondTT The seconds past noon of the date for which to compute the XYS value, expressed in * the Terrestrial Time (TT) time standard. * @param {Iau2006XysSample} [result] The instance to which to copy the interpolated result. If this parameter * is undefined, a new instance is allocated and returned. diff --git a/packages/engine/Source/Core/Iau2006XysSample.js b/packages/engine/Source/Core/Iau2006XysSample.js index 2e712b592262..e0a83e0c3258 100644 --- a/packages/engine/Source/Core/Iau2006XysSample.js +++ b/packages/engine/Source/Core/Iau2006XysSample.js @@ -4,28 +4,28 @@ * @alias Iau2006XysSample * @constructor * - * @param {Number} x The X value. - * @param {Number} y The Y value. - * @param {Number} s The S value. + * @param {number} x The X value. + * @param {number} y The Y value. + * @param {number} s The S value. * * @private */ function Iau2006XysSample(x, y, s) { /** * The X value. - * @type {Number} + * @type {number} */ this.x = x; /** * The Y value. - * @type {Number} + * @type {number} */ this.y = y; /** * The S value. - * @type {Number} + * @type {number} */ this.s = s; } diff --git a/packages/engine/Source/Core/IauOrientationParameters.js b/packages/engine/Source/Core/IauOrientationParameters.js index 361aa7725fd8..ba72c47384e6 100644 --- a/packages/engine/Source/Core/IauOrientationParameters.js +++ b/packages/engine/Source/Core/IauOrientationParameters.js @@ -19,7 +19,7 @@ function IauOrientationParameters( /** * The right ascension of the north pole of the body with respect to * the International Celestial Reference Frame, in radians. - * @type {Number} + * @type {number} * * @private */ @@ -28,7 +28,7 @@ function IauOrientationParameters( /** * The declination of the north pole of the body with respect to * the International Celestial Reference Frame, in radians. - * @type {Number} + * @type {number} * * @private */ @@ -37,7 +37,7 @@ function IauOrientationParameters( /** * The rotation about the north pole used to align a set of axes with * the meridian defined by the IAU report, in radians. - * @type {Number} + * @type {number} * * @private */ @@ -45,7 +45,7 @@ function IauOrientationParameters( /** * The instantaneous rotation rate about the north pole, in radians per second. - * @type {Number} + * @type {number} * * @private */ diff --git a/packages/engine/Source/Core/IndexDatatype.js b/packages/engine/Source/Core/IndexDatatype.js index 70f4457a8978..6a31e2ce9426 100644 --- a/packages/engine/Source/Core/IndexDatatype.js +++ b/packages/engine/Source/Core/IndexDatatype.js @@ -7,14 +7,14 @@ import WebGLConstants from "./WebGLConstants.js"; * Constants for WebGL index datatypes. These corresponds to the * type parameter of {@link http://www.khronos.org/opengles/sdk/docs/man/xhtml/glDrawElements.xml|drawElements}. * - * @enum {Number} + * @enum {number} */ const IndexDatatype = { /** * 8-bit unsigned byte corresponding to UNSIGNED_BYTE and the type * of an element in Uint8Array. * - * @type {Number} + * @type {number} * @constant */ UNSIGNED_BYTE: WebGLConstants.UNSIGNED_BYTE, @@ -23,7 +23,7 @@ const IndexDatatype = { * 16-bit unsigned short corresponding to UNSIGNED_SHORT and the type * of an element in Uint16Array. * - * @type {Number} + * @type {number} * @constant */ UNSIGNED_SHORT: WebGLConstants.UNSIGNED_SHORT, @@ -32,7 +32,7 @@ const IndexDatatype = { * 32-bit unsigned int corresponding to UNSIGNED_INT and the type * of an element in Uint32Array. * - * @type {Number} + * @type {number} * @constant */ UNSIGNED_INT: WebGLConstants.UNSIGNED_INT, @@ -42,7 +42,7 @@ const IndexDatatype = { * Returns the size, in bytes, of the corresponding datatype. * * @param {IndexDatatype} indexDatatype The index datatype to get the size of. - * @returns {Number} The size in bytes. + * @returns {number} The size in bytes. * * @example * // Returns 2 @@ -68,7 +68,7 @@ IndexDatatype.getSizeInBytes = function (indexDatatype) { /** * Gets the datatype with a given size in bytes. * - * @param {Number} sizeInBytes The size of a single index in bytes. + * @param {number} sizeInBytes The size of a single index in bytes. * @returns {IndexDatatype} The index datatype with the given size. */ IndexDatatype.fromSizeInBytes = function (sizeInBytes) { @@ -92,7 +92,7 @@ IndexDatatype.fromSizeInBytes = function (sizeInBytes) { * Validates that the provided index datatype is a valid {@link IndexDatatype}. * * @param {IndexDatatype} indexDatatype The index datatype to validate. - * @returns {Boolean} true if the provided index datatype is a valid value; otherwise, false. + * @returns {boolean} true if the provided index datatype is a valid value; otherwise, false. * * @example * if (!Cesium.IndexDatatype.validate(indexDatatype)) { @@ -112,8 +112,8 @@ IndexDatatype.validate = function (indexDatatype) { * Creates a typed array that will store indices, using either * or Uint32Array depending on the number of vertices. * - * @param {Number} numberOfVertices Number of vertices that the indices will reference. - * @param {Number|Array} indicesLengthOrArray Passed through to the typed array constructor. + * @param {number} numberOfVertices Number of vertices that the indices will reference. + * @param {number|Array} indicesLengthOrArray Passed through to the typed array constructor. * @returns {Uint16Array|Uint32Array} A Uint16Array or Uint32Array constructed with indicesLengthOrArray. * * @example @@ -140,10 +140,10 @@ IndexDatatype.createTypedArray = function ( * Creates a typed array from a source array buffer. The resulting typed array will store indices, using either * or Uint32Array depending on the number of vertices. * - * @param {Number} numberOfVertices Number of vertices that the indices will reference. + * @param {number} numberOfVertices Number of vertices that the indices will reference. * @param {ArrayBuffer} sourceArray Passed through to the typed array constructor. - * @param {Number} byteOffset Passed through to the typed array constructor. - * @param {Number} length Passed through to the typed array constructor. + * @param {number} byteOffset Passed through to the typed array constructor. + * @param {number} length Passed through to the typed array constructor. * @returns {Uint16Array|Uint32Array} A Uint16Array or Uint32Array constructed with sourceArray, byteOffset, and length. * */ diff --git a/packages/engine/Source/Core/InterpolationAlgorithm.js b/packages/engine/Source/Core/InterpolationAlgorithm.js index f11caeba82ec..b050eda4ddb8 100644 --- a/packages/engine/Source/Core/InterpolationAlgorithm.js +++ b/packages/engine/Source/Core/InterpolationAlgorithm.js @@ -13,7 +13,7 @@ const InterpolationAlgorithm = {}; /** * Gets the name of this interpolation algorithm. - * @type {String} + * @type {string} */ InterpolationAlgorithm.type = undefined; @@ -21,8 +21,8 @@ InterpolationAlgorithm.type = undefined; * Given the desired degree, returns the number of data points required for interpolation. * @function * - * @param {Number} degree The desired degree of interpolation. - * @returns {Number} The number of required data points needed for the desired degree of interpolation. + * @param {number} degree The desired degree of interpolation. + * @returns {number} The number of required data points needed for the desired degree of interpolation. */ InterpolationAlgorithm.getRequiredDataPoints = DeveloperError.throwInstantiationError; @@ -31,16 +31,16 @@ InterpolationAlgorithm.getRequiredDataPoints = * Performs zero order interpolation. * @function * - * @param {Number} x The independent variable for which the dependent variables will be interpolated. - * @param {Number[]} xTable The array of independent variables to use to interpolate. The values + * @param {number} x The independent variable for which the dependent variables will be interpolated. + * @param {number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. - * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. - * @param {Number} yStride The number of dependent variable values in yTable corresponding to + * @param {number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. - * @param {Number[]} [result] An existing array into which to store the result. + * @param {number[]} [result] An existing array into which to store the result. * - * @returns {Number[]} The array of interpolated values, or the result parameter if one was provided. + * @returns {number[]} The array of interpolated values, or the result parameter if one was provided. */ InterpolationAlgorithm.interpolateOrderZero = DeveloperError.throwInstantiationError; @@ -49,17 +49,17 @@ InterpolationAlgorithm.interpolateOrderZero = * Performs higher order interpolation. Not all interpolators need to support high-order interpolation, * if this function remains undefined on implementing objects, interpolateOrderZero will be used instead. * @function - * @param {Number} x The independent variable for which the dependent variables will be interpolated. - * @param {Number[]} xTable The array of independent variables to use to interpolate. The values + * @param {number} x The independent variable for which the dependent variables will be interpolated. + * @param {number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. - * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. - * @param {Number} yStride The number of dependent variable values in yTable corresponding to + * @param {number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. - * @param {Number} inputOrder The number of derivatives supplied for input. - * @param {Number} outputOrder The number of derivatives desired for output. - * @param {Number[]} [result] An existing array into which to store the result. - * @returns {Number[]} The array of interpolated values, or the result parameter if one was provided. + * @param {number} inputOrder The number of derivatives supplied for input. + * @param {number} outputOrder The number of derivatives desired for output. + * @param {number[]} [result] An existing array into which to store the result. + * @returns {number[]} The array of interpolated values, or the result parameter if one was provided. */ InterpolationAlgorithm.interpolate = DeveloperError.throwInstantiationError; export default InterpolationAlgorithm; diff --git a/packages/engine/Source/Core/InterpolationType.js b/packages/engine/Source/Core/InterpolationType.js index 2cfa604d2a9f..50b6e4b3fc8f 100644 --- a/packages/engine/Source/Core/InterpolationType.js +++ b/packages/engine/Source/Core/InterpolationType.js @@ -1,7 +1,7 @@ /** * An enum describing the type of interpolation used in a glTF animation. * - * @enum {Number} + * @enum {number} * * @private */ diff --git a/packages/engine/Source/Core/Intersect.js b/packages/engine/Source/Core/Intersect.js index 526bb9e24270..dada0889bd41 100644 --- a/packages/engine/Source/Core/Intersect.js +++ b/packages/engine/Source/Core/Intersect.js @@ -4,13 +4,13 @@ * partially inside the frustum and partially outside (INTERSECTING), or somewhere entirely * outside of the frustum's 6 planes (OUTSIDE). * - * @enum {Number} + * @enum {number} */ const Intersect = { /** * Represents that an object is not contained within the frustum. * - * @type {Number} + * @type {number} * @constant */ OUTSIDE: -1, @@ -18,7 +18,7 @@ const Intersect = { /** * Represents that an object intersects one of the frustum's planes. * - * @type {Number} + * @type {number} * @constant */ INTERSECTING: 0, @@ -26,7 +26,7 @@ const Intersect = { /** * Represents that an object is fully within the frustum. * - * @type {Number} + * @type {number} * @constant */ INSIDE: 1, diff --git a/packages/engine/Source/Core/IntersectionTests.js b/packages/engine/Source/Core/IntersectionTests.js index 92e3f861391f..c8cbcbddebea 100644 --- a/packages/engine/Source/Core/IntersectionTests.js +++ b/packages/engine/Source/Core/IntersectionTests.js @@ -77,9 +77,9 @@ const scratchQVec = new Cartesian3(); * @param {Cartesian3} p0 The first vertex of the triangle. * @param {Cartesian3} p1 The second vertex of the triangle. * @param {Cartesian3} p2 The third vertex of the triangle. - * @param {Boolean} [cullBackFaces=false] If true, will only compute an intersection with the front face of the triangle + * @param {boolean} [cullBackFaces=false] If true, will only compute an intersection with the front face of the triangle * and return undefined for intersections with the back face. - * @returns {Number} The intersection as a parametric distance along the ray, or undefined if there is no intersection. + * @returns {number} The intersection as a parametric distance along the ray, or undefined if there is no intersection. */ IntersectionTests.rayTriangleParametric = function ( ray, @@ -177,7 +177,7 @@ IntersectionTests.rayTriangleParametric = function ( * @param {Cartesian3} p0 The first vertex of the triangle. * @param {Cartesian3} p1 The second vertex of the triangle. * @param {Cartesian3} p2 The third vertex of the triangle. - * @param {Boolean} [cullBackFaces=false] If true, will only compute an intersection with the front face of the triangle + * @param {boolean} [cullBackFaces=false] If true, will only compute an intersection with the front face of the triangle * and return undefined for intersections with the back face. * @param {Cartesian3} [result] The Cartesian3 onto which to store the result. * @returns {Cartesian3} The intersection point or undefined if there is no intersections. @@ -220,7 +220,7 @@ const scratchLineSegmentTriangleRay = new Ray(); * @param {Cartesian3} p0 The first vertex of the triangle. * @param {Cartesian3} p1 The second vertex of the triangle. * @param {Cartesian3} p2 The third vertex of the triangle. - * @param {Boolean} [cullBackFaces=false] If true, will only compute an intersection with the front face of the triangle + * @param {boolean} [cullBackFaces=false] If true, will only compute an intersection with the front face of the triangle * and return undefined for intersections with the back face. * @param {Cartesian3} [result] The Cartesian3 onto which to store the result. * @returns {Cartesian3} The intersection point or undefined if there is no intersections. @@ -868,7 +868,7 @@ IntersectionTests.lineSegmentPlane = function ( * @param {Cartesian3} p1 Second point of the triangle * @param {Cartesian3} p2 Third point of the triangle * @param {Plane} plane Intersection plane - * @returns {Object} An object with properties positions and indices, which are arrays that represent three triangles that do not cross the plane. (Undefined if no intersection exists) + * @returns {object} An object with properties positions and indices, which are arrays that represent three triangles that do not cross the plane. (Undefined if no intersection exists) * * @example * const origin = Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883); diff --git a/packages/engine/Source/Core/Intersections2D.js b/packages/engine/Source/Core/Intersections2D.js index dcf8db9955ce..df98e06093db 100644 --- a/packages/engine/Source/Core/Intersections2D.js +++ b/packages/engine/Source/Core/Intersections2D.js @@ -16,15 +16,15 @@ const Intersections2D = {}; * polygon on a given side of the threshold. The resulting polygon may have 0, 1, 2, * 3, or 4 vertices. * - * @param {Number} threshold The threshold coordinate value at which to clip the triangle. - * @param {Boolean} keepAbove true to keep the portion of the triangle above the threshold, or false + * @param {number} threshold The threshold coordinate value at which to clip the triangle. + * @param {boolean} keepAbove true to keep the portion of the triangle above the threshold, or false * to keep the portion below. - * @param {Number} u0 The coordinate of the first vertex in the triangle, in counter-clockwise order. - * @param {Number} u1 The coordinate of the second vertex in the triangle, in counter-clockwise order. - * @param {Number} u2 The coordinate of the third vertex in the triangle, in counter-clockwise order. - * @param {Number[]} [result] The array into which to copy the result. If this parameter is not supplied, + * @param {number} u0 The coordinate of the first vertex in the triangle, in counter-clockwise order. + * @param {number} u1 The coordinate of the second vertex in the triangle, in counter-clockwise order. + * @param {number} u2 The coordinate of the third vertex in the triangle, in counter-clockwise order. + * @param {number[]} [result] The array into which to copy the result. If this parameter is not supplied, * a new array is constructed and returned. - * @returns {Number[]} The polygon that results after the clip, specified as a list of + * @returns {number[]} The polygon that results after the clip, specified as a list of * vertices. The vertices are specified in counter-clockwise order. * Each vertex is either an index from the existing list (identified as * a 0, 1, or 2) or -1 indicating a new vertex not in the original triangle. @@ -217,14 +217,14 @@ Intersections2D.clipTriangleAtAxisAlignedThreshold = function ( /** * Compute the barycentric coordinates of a 2D position within a 2D triangle. * - * @param {Number} x The x coordinate of the position for which to find the barycentric coordinates. - * @param {Number} y The y coordinate of the position for which to find the barycentric coordinates. - * @param {Number} x1 The x coordinate of the triangle's first vertex. - * @param {Number} y1 The y coordinate of the triangle's first vertex. - * @param {Number} x2 The x coordinate of the triangle's second vertex. - * @param {Number} y2 The y coordinate of the triangle's second vertex. - * @param {Number} x3 The x coordinate of the triangle's third vertex. - * @param {Number} y3 The y coordinate of the triangle's third vertex. + * @param {number} x The x coordinate of the position for which to find the barycentric coordinates. + * @param {number} y The y coordinate of the position for which to find the barycentric coordinates. + * @param {number} x1 The x coordinate of the triangle's first vertex. + * @param {number} y1 The y coordinate of the triangle's first vertex. + * @param {number} x2 The x coordinate of the triangle's second vertex. + * @param {number} y2 The y coordinate of the triangle's second vertex. + * @param {number} x3 The x coordinate of the triangle's third vertex. + * @param {number} y3 The y coordinate of the triangle's third vertex. * @param {Cartesian3} [result] The instance into to which to copy the result. If this parameter * is undefined, a new instance is created and returned. * @returns {Cartesian3} The barycentric coordinates of the position within the triangle. @@ -294,14 +294,14 @@ Intersections2D.computeBarycentricCoordinates = function ( /** * Compute the intersection between 2 line segments * - * @param {Number} x00 The x coordinate of the first line's first vertex. - * @param {Number} y00 The y coordinate of the first line's first vertex. - * @param {Number} x01 The x coordinate of the first line's second vertex. - * @param {Number} y01 The y coordinate of the first line's second vertex. - * @param {Number} x10 The x coordinate of the second line's first vertex. - * @param {Number} y10 The y coordinate of the second line's first vertex. - * @param {Number} x11 The x coordinate of the second line's second vertex. - * @param {Number} y11 The y coordinate of the second line's second vertex. + * @param {number} x00 The x coordinate of the first line's first vertex. + * @param {number} y00 The y coordinate of the first line's first vertex. + * @param {number} x01 The x coordinate of the first line's second vertex. + * @param {number} y01 The y coordinate of the first line's second vertex. + * @param {number} x10 The x coordinate of the second line's first vertex. + * @param {number} y10 The y coordinate of the second line's first vertex. + * @param {number} x11 The x coordinate of the second line's second vertex. + * @param {number} y11 The y coordinate of the second line's second vertex. * @param {Cartesian2} [result] The instance into to which to copy the result. If this parameter * is undefined, a new instance is created and returned. * @returns {Cartesian2} The intersection point, undefined if there is no intersection point or lines are coincident. diff --git a/packages/engine/Source/Core/Interval.js b/packages/engine/Source/Core/Interval.js index b09a5024ffc5..4f8f99c8b962 100644 --- a/packages/engine/Source/Core/Interval.js +++ b/packages/engine/Source/Core/Interval.js @@ -5,19 +5,19 @@ import defaultValue from "./defaultValue.js"; * @alias Interval * @constructor * - * @param {Number} [start=0.0] The beginning of the interval. - * @param {Number} [stop=0.0] The end of the interval. + * @param {number} [start=0.0] The beginning of the interval. + * @param {number} [stop=0.0] The end of the interval. */ function Interval(start, stop) { /** * The beginning of the interval. - * @type {Number} + * @type {number} * @default 0.0 */ this.start = defaultValue(start, 0.0); /** * The end of the interval. - * @type {Number} + * @type {number} * @default 0.0 */ this.stop = defaultValue(stop, 0.0); diff --git a/packages/engine/Source/Core/Ion.js b/packages/engine/Source/Core/Ion.js index a1daf6ecd06a..f566d49ac37c 100644 --- a/packages/engine/Source/Core/Ion.js +++ b/packages/engine/Source/Core/Ion.js @@ -24,14 +24,14 @@ const Ion = {}; /** * Gets or sets the default Cesium ion access token. * - * @type {String} + * @type {string} */ Ion.defaultAccessToken = defaultAccessToken; /** * Gets or sets the default Cesium ion server. * - * @type {String|Resource} + * @type {string|Resource} * @default https://api.cesium.com */ Ion.defaultServer = new Resource({ url: "https://api.cesium.com/" }); diff --git a/packages/engine/Source/Core/IonGeocoderService.js b/packages/engine/Source/Core/IonGeocoderService.js index 534e7c5e9c76..8d73ff089cfb 100644 --- a/packages/engine/Source/Core/IonGeocoderService.js +++ b/packages/engine/Source/Core/IonGeocoderService.js @@ -11,10 +11,10 @@ import Resource from "./Resource.js"; * @alias IonGeocoderService * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Scene} options.scene The scene - * @param {String} [options.accessToken=Ion.defaultAccessToken] The access token to use. - * @param {String|Resource} [options.server=Ion.defaultServer] The resource to the Cesium ion API server. + * @param {string} [options.accessToken=Ion.defaultAccessToken] The access token to use. + * @param {string|Resource} [options.server=Ion.defaultServer] The resource to the Cesium ion API server. * * @see Ion */ @@ -54,7 +54,7 @@ function IonGeocoderService(options) { /** * @function * - * @param {String} query The query to be sent to the geocoder service + * @param {string} query The query to be sent to the geocoder service * @param {GeocodeType} [type=GeocodeType.SEARCH] The type of geocode to perform. * @returns {Promise} */ diff --git a/packages/engine/Source/Core/IonResource.js b/packages/engine/Source/Core/IonResource.js index ca3f0f36041f..137be3899ee1 100644 --- a/packages/engine/Source/Core/IonResource.js +++ b/packages/engine/Source/Core/IonResource.js @@ -15,7 +15,7 @@ import RuntimeError from "./RuntimeError.js"; * @constructor * @augments Resource * - * @param {Object} endpoint The result of the Cesium ion asset endpoint service. + * @param {object} endpoint The result of the Cesium ion asset endpoint service. * @param {Resource} endpointResource The resource used to retreive the endpoint. * * @see Ion @@ -80,11 +80,11 @@ if (defined(Object.create)) { /** * Asynchronously creates an instance. * - * @param {Number} assetId The Cesium ion asset id. - * @param {Object} [options] An object with the following properties: - * @param {String} [options.accessToken=Ion.defaultAccessToken] The access token to use. - * @param {String|Resource} [options.server=Ion.defaultServer] The resource to the Cesium ion API server. - * @returns {Promise.} A Promise to am instance representing the Cesium ion Asset. + * @param {number} assetId The Cesium ion asset id. + * @param {object} [options] An object with the following properties: + * @param {string} [options.accessToken=Ion.defaultAccessToken] The access token to use. + * @param {string|Resource} [options.server=Ion.defaultServer] The resource to the Cesium ion API server. + * @returns {Promise} A Promise to am instance representing the Cesium ion Asset. * * @example * //Load a Cesium3DTileset with asset ID of 124624234 diff --git a/packages/engine/Source/Core/JulianDate.js b/packages/engine/Source/Core/JulianDate.js index 363736b83cca..3e8a6ec24d5e 100644 --- a/packages/engine/Source/Core/JulianDate.js +++ b/packages/engine/Source/Core/JulianDate.js @@ -199,20 +199,20 @@ const iso8601ErrorMessage = "Invalid ISO 8601 date."; * @alias JulianDate * @constructor * - * @param {Number} [julianDayNumber=0.0] The Julian Day Number representing the number of whole days. Fractional days will also be handled correctly. - * @param {Number} [secondsOfDay=0.0] The number of seconds into the current Julian Day Number. Fractional seconds, negative seconds and seconds greater than a day will be handled correctly. + * @param {number} [julianDayNumber=0.0] The Julian Day Number representing the number of whole days. Fractional days will also be handled correctly. + * @param {number} [secondsOfDay=0.0] The number of seconds into the current Julian Day Number. Fractional seconds, negative seconds and seconds greater than a day will be handled correctly. * @param {TimeStandard} [timeStandard=TimeStandard.UTC] The time standard in which the first two parameters are defined. */ function JulianDate(julianDayNumber, secondsOfDay, timeStandard) { /** * Gets or sets the number of whole days. - * @type {Number} + * @type {number} */ this.dayNumber = undefined; /** * Gets or sets the number of seconds into the current day. - * @type {Number} + * @type {number} */ this.secondsOfDay = undefined; @@ -304,7 +304,7 @@ JulianDate.fromDate = function (date, result) { * This method is superior to Date.parse because it will handle all valid formats defined by the ISO 8601 * specification, including leap seconds and sub-millisecond times, which discarded by most JavaScript implementations. * - * @param {String} iso8601String An ISO 8601 date. + * @param {string} iso8601String An ISO 8601 date. * @param {JulianDate} [result] An existing instance to use for the result. * @returns {JulianDate} The modified result parameter or a new instance if none was provided. * @@ -745,8 +745,8 @@ JulianDate.toDate = function (julianDate) { * Creates an ISO8601 representation of the provided date. * * @param {JulianDate} julianDate The date to be converted. - * @param {Number} [precision] The number of fractional digits used to represent the seconds component. By default, the most precise representation is used. - * @returns {String} The ISO8601 representation of the provided date. + * @param {number} [precision] The number of fractional digits used to represent the seconds component. By default, the most precise representation is used. + * @returns {string} The ISO8601 representation of the provided date. */ JulianDate.toIso8601 = function (julianDate, precision) { //>>includeStart('debug', pragmas.debug); @@ -858,7 +858,7 @@ JulianDate.clone = function (julianDate, result) { * * @param {JulianDate} left The first instance. * @param {JulianDate} right The second instance. - * @returns {Number} A negative value if left is less than right, a positive value if left is greater than right, or zero if left and right are equal. + * @returns {number} A negative value if left is less than right, a positive value if left is greater than right, or zero if left and right are equal. */ JulianDate.compare = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -882,7 +882,7 @@ JulianDate.compare = function (left, right) { * * @param {JulianDate} [left] The first instance. * @param {JulianDate} [right] The second instance. - * @returns {Boolean} true if the dates are equal; otherwise, false. + * @returns {boolean} true if the dates are equal; otherwise, false. */ JulianDate.equals = function (left, right) { return ( @@ -902,8 +902,8 @@ JulianDate.equals = function (left, right) { * * @param {JulianDate} [left] The first instance. * @param {JulianDate} [right] The second instance. - * @param {Number} [epsilon=0] The maximum number of seconds that should separate the two instances. - * @returns {Boolean} true if the two dates are within epsilon seconds of each other; otherwise false. + * @param {number} [epsilon=0] The maximum number of seconds that should separate the two instances. + * @returns {boolean} true if the two dates are within epsilon seconds of each other; otherwise false. */ JulianDate.equalsEpsilon = function (left, right, epsilon) { epsilon = defaultValue(epsilon, 0); @@ -920,7 +920,7 @@ JulianDate.equalsEpsilon = function (left, right, epsilon) { * Computes the total number of whole and fractional days represented by the provided instance. * * @param {JulianDate} julianDate The date. - * @returns {Number} The Julian date as single floating point number. + * @returns {number} The Julian date as single floating point number. */ JulianDate.totalDays = function (julianDate) { //>>includeStart('debug', pragmas.debug); @@ -939,7 +939,7 @@ JulianDate.totalDays = function (julianDate) { * * @param {JulianDate} left The first instance. * @param {JulianDate} right The second instance. - * @returns {Number} The difference, in seconds, when subtracting right from left. + * @returns {number} The difference, in seconds, when subtracting right from left. */ JulianDate.secondsDifference = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -961,7 +961,7 @@ JulianDate.secondsDifference = function (left, right) { * * @param {JulianDate} left The first instance. * @param {JulianDate} right The second instance. - * @returns {Number} The difference, in days, when subtracting right from left. + * @returns {number} The difference, in days, when subtracting right from left. */ JulianDate.daysDifference = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -983,7 +983,7 @@ JulianDate.daysDifference = function (left, right) { * Computes the number of seconds the provided instance is ahead of UTC. * * @param {JulianDate} julianDate The date. - * @returns {Number} The number of seconds the provided instance is ahead of UTC + * @returns {number} The number of seconds the provided instance is ahead of UTC */ JulianDate.computeTaiMinusUtc = function (julianDate) { binarySearchScratchLeapSecond.julianDate = julianDate; @@ -1007,7 +1007,7 @@ JulianDate.computeTaiMinusUtc = function (julianDate) { * Adds the provided number of seconds to the provided date instance. * * @param {JulianDate} julianDate The date. - * @param {Number} seconds The number of seconds to add or subtract. + * @param {number} seconds The number of seconds to add or subtract. * @param {JulianDate} result An existing instance to use for the result. * @returns {JulianDate} The modified result parameter. */ @@ -1035,7 +1035,7 @@ JulianDate.addSeconds = function (julianDate, seconds, result) { * Adds the provided number of minutes to the provided date instance. * * @param {JulianDate} julianDate The date. - * @param {Number} minutes The number of minutes to add or subtract. + * @param {number} minutes The number of minutes to add or subtract. * @param {JulianDate} result An existing instance to use for the result. * @returns {JulianDate} The modified result parameter. */ @@ -1061,7 +1061,7 @@ JulianDate.addMinutes = function (julianDate, minutes, result) { * Adds the provided number of hours to the provided date instance. * * @param {JulianDate} julianDate The date. - * @param {Number} hours The number of hours to add or subtract. + * @param {number} hours The number of hours to add or subtract. * @param {JulianDate} result An existing instance to use for the result. * @returns {JulianDate} The modified result parameter. */ @@ -1087,7 +1087,7 @@ JulianDate.addHours = function (julianDate, hours, result) { * Adds the provided number of days to the provided date instance. * * @param {JulianDate} julianDate The date. - * @param {Number} days The number of days to add or subtract. + * @param {number} days The number of days to add or subtract. * @param {JulianDate} result An existing instance to use for the result. * @returns {JulianDate} The modified result parameter. */ @@ -1113,7 +1113,7 @@ JulianDate.addDays = function (julianDate, days, result) { * * @param {JulianDate} left The first instance. * @param {JulianDate} right The second instance. - * @returns {Boolean} true if left is earlier than right, false otherwise. + * @returns {boolean} true if left is earlier than right, false otherwise. */ JulianDate.lessThan = function (left, right) { return JulianDate.compare(left, right) < 0; @@ -1124,7 +1124,7 @@ JulianDate.lessThan = function (left, right) { * * @param {JulianDate} left The first instance. * @param {JulianDate} right The second instance. - * @returns {Boolean} true if left is earlier than or equal to right, false otherwise. + * @returns {boolean} true if left is earlier than or equal to right, false otherwise. */ JulianDate.lessThanOrEquals = function (left, right) { return JulianDate.compare(left, right) <= 0; @@ -1135,7 +1135,7 @@ JulianDate.lessThanOrEquals = function (left, right) { * * @param {JulianDate} left The first instance. * @param {JulianDate} right The second instance. - * @returns {Boolean} true if left is later than right, false otherwise. + * @returns {boolean} true if left is later than right, false otherwise. */ JulianDate.greaterThan = function (left, right) { return JulianDate.compare(left, right) > 0; @@ -1146,7 +1146,7 @@ JulianDate.greaterThan = function (left, right) { * * @param {JulianDate} left The first instance. * @param {JulianDate} right The second instance. - * @returns {Boolean} true if left is later than or equal to right, false otherwise. + * @returns {boolean} true if left is later than or equal to right, false otherwise. */ JulianDate.greaterThanOrEquals = function (left, right) { return JulianDate.compare(left, right) >= 0; @@ -1166,7 +1166,7 @@ JulianDate.prototype.clone = function (result) { * Compares this and the provided instance and returns true if they are equal, false otherwise. * * @param {JulianDate} [right] The second instance. - * @returns {Boolean} true if the dates are equal; otherwise, false. + * @returns {boolean} true if the dates are equal; otherwise, false. */ JulianDate.prototype.equals = function (right) { return JulianDate.equals(this, right); @@ -1179,8 +1179,8 @@ JulianDate.prototype.equals = function (right) { * seconds, must be less than epsilon. * * @param {JulianDate} [right] The second instance. - * @param {Number} [epsilon=0] The maximum number of seconds that should separate the two instances. - * @returns {Boolean} true if the two dates are within epsilon seconds of each other; otherwise false. + * @param {number} [epsilon=0] The maximum number of seconds that should separate the two instances. + * @returns {boolean} true if the two dates are within epsilon seconds of each other; otherwise false. */ JulianDate.prototype.equalsEpsilon = function (right, epsilon) { return JulianDate.equalsEpsilon(this, right, epsilon); @@ -1189,7 +1189,7 @@ JulianDate.prototype.equalsEpsilon = function (right, epsilon) { /** * Creates a string representing this date in ISO8601 format. * - * @returns {String} A string representing this date in ISO8601 format. + * @returns {string} A string representing this date in ISO8601 format. */ JulianDate.prototype.toString = function () { return JulianDate.toIso8601(this); diff --git a/packages/engine/Source/Core/KeyboardEventModifier.js b/packages/engine/Source/Core/KeyboardEventModifier.js index 687783fdf74c..ede05482c421 100644 --- a/packages/engine/Source/Core/KeyboardEventModifier.js +++ b/packages/engine/Source/Core/KeyboardEventModifier.js @@ -2,13 +2,13 @@ * This enumerated type is for representing keyboard modifiers. These are keys * that are held down in addition to other event types. * - * @enum {Number} + * @enum {number} */ const KeyboardEventModifier = { /** * Represents the shift key being held down. * - * @type {Number} + * @type {number} * @constant */ SHIFT: 0, @@ -16,7 +16,7 @@ const KeyboardEventModifier = { /** * Represents the control key being held down. * - * @type {Number} + * @type {number} * @constant */ CTRL: 1, @@ -24,7 +24,7 @@ const KeyboardEventModifier = { /** * Represents the alt key being held down. * - * @type {Number} + * @type {number} * @constant */ ALT: 2, diff --git a/packages/engine/Source/Core/LagrangePolynomialApproximation.js b/packages/engine/Source/Core/LagrangePolynomialApproximation.js index e5f91d7bebb9..67c15aa28fb1 100644 --- a/packages/engine/Source/Core/LagrangePolynomialApproximation.js +++ b/packages/engine/Source/Core/LagrangePolynomialApproximation.js @@ -12,8 +12,8 @@ const LagrangePolynomialApproximation = { /** * Given the desired degree, returns the number of data points required for interpolation. * - * @param {Number} degree The desired degree of interpolation. - * @returns {Number} The number of required data points needed for the desired degree of interpolation. + * @param {number} degree The desired degree of interpolation. + * @returns {number} The number of required data points needed for the desired degree of interpolation. */ LagrangePolynomialApproximation.getRequiredDataPoints = function (degree) { return Math.max(degree + 1.0, 2); @@ -22,15 +22,15 @@ LagrangePolynomialApproximation.getRequiredDataPoints = function (degree) { /** * Interpolates values using Lagrange Polynomial Approximation. * - * @param {Number} x The independent variable for which the dependent variables will be interpolated. - * @param {Number[]} xTable The array of independent variables to use to interpolate. The values + * @param {number} x The independent variable for which the dependent variables will be interpolated. + * @param {number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. - * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. - * @param {Number} yStride The number of dependent variable values in yTable corresponding to + * @param {number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. - * @param {Number[]} [result] An existing array into which to store the result. - * @returns {Number[]} The array of interpolated values, or the result parameter if one was provided. + * @param {number[]} [result] An existing array into which to store the result. + * @returns {number[]} The array of interpolated values, or the result parameter if one was provided. */ LagrangePolynomialApproximation.interpolateOrderZero = function ( x, diff --git a/packages/engine/Source/Core/LeapSecond.js b/packages/engine/Source/Core/LeapSecond.js index 920fa66c33cb..dbcf62cd453f 100644 --- a/packages/engine/Source/Core/LeapSecond.js +++ b/packages/engine/Source/Core/LeapSecond.js @@ -5,7 +5,7 @@ * @constructor * * @param {JulianDate} [date] A Julian date representing the time of the leap second. - * @param {Number} [offset] The cumulative number of seconds that TAI is ahead of UTC at the provided date. + * @param {number} [offset] The cumulative number of seconds that TAI is ahead of UTC at the provided date. */ function LeapSecond(date, offset) { /** @@ -17,7 +17,7 @@ function LeapSecond(date, offset) { /** * Gets or sets the cumulative number of seconds between the UTC and TAI time standards at the time * of this leap second. - * @type {Number} + * @type {number} */ this.offset = offset; } diff --git a/packages/engine/Source/Core/LinearApproximation.js b/packages/engine/Source/Core/LinearApproximation.js index 3137ffc896e8..c605a7f4fb39 100644 --- a/packages/engine/Source/Core/LinearApproximation.js +++ b/packages/engine/Source/Core/LinearApproximation.js @@ -14,8 +14,8 @@ const LinearApproximation = { * Given the desired degree, returns the number of data points required for interpolation. * Since linear interpolation can only generate a first degree polynomial, this function * always returns 2. - * @param {Number} degree The desired degree of interpolation. - * @returns {Number} This function always returns 2. + * @param {number} degree The desired degree of interpolation. + * @returns {number} This function always returns 2. * */ LinearApproximation.getRequiredDataPoints = function (degree) { @@ -25,15 +25,15 @@ LinearApproximation.getRequiredDataPoints = function (degree) { /** * Interpolates values using linear approximation. * - * @param {Number} x The independent variable for which the dependent variables will be interpolated. - * @param {Number[]} xTable The array of independent variables to use to interpolate. The values + * @param {number} x The independent variable for which the dependent variables will be interpolated. + * @param {number[]} xTable The array of independent variables to use to interpolate. The values * in this array must be in increasing order and the same value must not occur twice in the array. - * @param {Number[]} yTable The array of dependent variables to use to interpolate. For a set of three + * @param {number[]} yTable The array of dependent variables to use to interpolate. For a set of three * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}. - * @param {Number} yStride The number of dependent variable values in yTable corresponding to + * @param {number} yStride The number of dependent variable values in yTable corresponding to * each independent variable value in xTable. - * @param {Number[]} [result] An existing array into which to store the result. - * @returns {Number[]} The array of interpolated values, or the result parameter if one was provided. + * @param {number[]} [result] An existing array into which to store the result. + * @returns {number[]} The array of interpolated values, or the result parameter if one was provided. */ LinearApproximation.interpolateOrderZero = function ( x, diff --git a/packages/engine/Source/Core/LinearSpline.js b/packages/engine/Source/Core/LinearSpline.js index 3e327440dbeb..d067d318cc26 100644 --- a/packages/engine/Source/Core/LinearSpline.js +++ b/packages/engine/Source/Core/LinearSpline.js @@ -10,10 +10,10 @@ import Spline from "./Spline.js"; * @alias LinearSpline * @constructor * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. + * @param {object} options Object with the following properties: + * @param {number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. - * @param {Number[]|Cartesian3[]} options.points The array of control points. + * @param {number[]|Cartesian3[]} options.points The array of control points. * * @exception {DeveloperError} points.length must be greater than or equal to 2. * @exception {DeveloperError} times.length must be equal to points.length. @@ -74,7 +74,7 @@ Object.defineProperties(LinearSpline.prototype, { * * @memberof LinearSpline.prototype * - * @type {Number[]} + * @type {number[]} * @readonly */ times: { @@ -88,7 +88,7 @@ Object.defineProperties(LinearSpline.prototype, { * * @memberof LinearSpline.prototype * - * @type {Number[]|Cartesian3[]} + * @type {number[]|Cartesian3[]} * @readonly */ points: { @@ -103,8 +103,8 @@ Object.defineProperties(LinearSpline.prototype, { * time is in the interval [times[i], times[i + 1]]. * @function * - * @param {Number} time The time. - * @returns {Number} The index for the element at the start of the interval. + * @param {number} time The time. + * @returns {number} The index for the element at the start of the interval. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element @@ -116,8 +116,8 @@ LinearSpline.prototype.findTimeInterval = Spline.prototype.findTimeInterval; * Wraps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, wrapped around to the updated animation. + * @param {number} time The time. + * @return {number} The time, wrapped around to the updated animation. */ LinearSpline.prototype.wrapTime = Spline.prototype.wrapTime; @@ -125,17 +125,17 @@ LinearSpline.prototype.wrapTime = Spline.prototype.wrapTime; * Clamps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, clamped to the animation period. + * @param {number} time The time. + * @return {number} The time, clamped to the animation period. */ LinearSpline.prototype.clampTime = Spline.prototype.clampTime; /** * Evaluates the curve at a given time. * - * @param {Number} time The time at which to evaluate the curve. + * @param {number} time The time at which to evaluate the curve. * @param {Cartesian3} [result] The object onto which to store the result. - * @returns {Number|Cartesian3} The modified result parameter or a new instance of the point on the curve at the given time. + * @returns {number|Cartesian3} The modified result parameter or a new instance of the point on the curve at the given time. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element diff --git a/packages/engine/Source/Core/ManagedArray.js b/packages/engine/Source/Core/ManagedArray.js index 180143d222fb..9eeb280e5ffd 100644 --- a/packages/engine/Source/Core/ManagedArray.js +++ b/packages/engine/Source/Core/ManagedArray.js @@ -8,7 +8,7 @@ import defaultValue from "./defaultValue.js"; * @constructor * @private * - * @param {Number} [length=0] The initial length of the array. + * @param {number} [length=0] The initial length of the array. */ function ManagedArray(length) { length = defaultValue(length, 0); @@ -22,7 +22,7 @@ Object.defineProperties(ManagedArray.prototype, { * If the set length is greater than the length of the internal array, the internal array is resized. * * @memberof ManagedArray.prototype - * @type Number + * @type {number} */ length: { get: function () { @@ -50,7 +50,7 @@ Object.defineProperties(ManagedArray.prototype, { * Gets the internal array. * * @memberof ManagedArray.prototype - * @type Array + * @type {Array} * @readonly */ values: { @@ -63,7 +63,7 @@ Object.defineProperties(ManagedArray.prototype, { /** * Gets the element at an index. * - * @param {Number} index The index to get. + * @param {number} index The index to get. */ ManagedArray.prototype.get = function (index) { //>>includeStart('debug', pragmas.debug); @@ -76,7 +76,7 @@ ManagedArray.prototype.get = function (index) { /** * Sets the element at an index. Resizes the array if index is greater than the length of the array. * - * @param {Number} index The index to set. + * @param {number} index The index to set. * @param {*} element The element to set at index. */ ManagedArray.prototype.set = function (index, element) { @@ -126,7 +126,7 @@ ManagedArray.prototype.pop = function () { /** * Resize the internal array if length > _array.length. * - * @param {Number} length The length. + * @param {number} length The length. */ ManagedArray.prototype.reserve = function (length) { //>>includeStart('debug', pragmas.debug); @@ -141,7 +141,7 @@ ManagedArray.prototype.reserve = function (length) { /** * Resize the array. * - * @param {Number} length The length. + * @param {number} length The length. */ ManagedArray.prototype.resize = function (length) { //>>includeStart('debug', pragmas.debug); @@ -154,7 +154,7 @@ ManagedArray.prototype.resize = function (length) { /** * Trim the internal array to the specified length. Defaults to the current length. * - * @param {Number} [length] The length. + * @param {number} [length] The length. */ ManagedArray.prototype.trim = function (length) { length = defaultValue(length, this._length); diff --git a/packages/engine/Source/Core/Math.js b/packages/engine/Source/Core/Math.js index c61d99174414..a8f5e57d681f 100644 --- a/packages/engine/Source/Core/Math.js +++ b/packages/engine/Source/Core/Math.js @@ -14,147 +14,147 @@ const CesiumMath = {}; /** * 0.1 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON1 = 0.1; /** * 0.01 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON2 = 0.01; /** * 0.001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON3 = 0.001; /** * 0.0001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON4 = 0.0001; /** * 0.00001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON5 = 0.00001; /** * 0.000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON6 = 0.000001; /** * 0.0000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON7 = 0.0000001; /** * 0.00000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON8 = 0.00000001; /** * 0.000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON9 = 0.000000001; /** * 0.0000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON10 = 0.0000000001; /** * 0.00000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON11 = 0.00000000001; /** * 0.000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON12 = 0.000000000001; /** * 0.0000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON13 = 0.0000000000001; /** * 0.00000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON14 = 0.00000000000001; /** * 0.000000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON15 = 0.000000000000001; /** * 0.0000000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON16 = 0.0000000000000001; /** * 0.00000000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON17 = 0.00000000000000001; /** * 0.000000000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON18 = 0.000000000000000001; /** * 0.0000000000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON19 = 0.0000000000000000001; /** * 0.00000000000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON20 = 0.00000000000000000001; /** * 0.000000000000000000001 - * @type {Number} + * @type {number} * @constant */ CesiumMath.EPSILON21 = 0.000000000000000000001; @@ -162,14 +162,14 @@ CesiumMath.EPSILON21 = 0.000000000000000000001; /** * The gravitational parameter of the Earth in meters cubed * per second squared as defined by the WGS84 model: 3.986004418e14 - * @type {Number} + * @type {number} * @constant */ CesiumMath.GRAVITATIONALPARAMETER = 3.986004418e14; /** * Radius of the sun in meters: 6.955e8 - * @type {Number} + * @type {number} * @constant */ CesiumMath.SOLAR_RADIUS = 6.955e8; @@ -178,21 +178,21 @@ CesiumMath.SOLAR_RADIUS = 6.955e8; * The mean radius of the moon, according to the "Report of the IAU/IAG Working Group on * Cartographic Coordinates and Rotational Elements of the Planets and satellites: 2000", * Celestial Mechanics 82: 83-110, 2002. - * @type {Number} + * @type {number} * @constant */ CesiumMath.LUNAR_RADIUS = 1737400.0; /** * 64 * 1024 - * @type {Number} + * @type {number} * @constant */ CesiumMath.SIXTY_FOUR_KILOBYTES = 64 * 1024; /** * 4 * 1024 * 1024 * 1024 - * @type {Number} + * @type {number} * @constant */ CesiumMath.FOUR_GIGABYTES = 4 * 1024 * 1024 * 1024; @@ -202,8 +202,8 @@ CesiumMath.FOUR_GIGABYTES = 4 * 1024 * 1024 * 1024; * negative, or 0 if the value is 0. * * @function - * @param {Number} value The value to return the sign of. - * @returns {Number} The sign of value. + * @param {number} value The value to return the sign of. + * @returns {number} The sign of value. */ // eslint-disable-next-line es/no-math-sign CesiumMath.sign = defaultValue(Math.sign, function sign(value) { @@ -219,8 +219,8 @@ CesiumMath.sign = defaultValue(Math.sign, function sign(value) { * Returns 1.0 if the given value is positive or zero, and -1.0 if it is negative. * This is similar to {@link CesiumMath#sign} except that returns 1.0 instead of * 0.0 when the input value is 0.0. - * @param {Number} value The value to return the sign of. - * @returns {Number} The sign of value. + * @param {number} value The value to return the sign of. + * @returns {number} The sign of value. */ CesiumMath.signNotZero = function (value) { return value < 0.0 ? -1.0 : 1.0; @@ -228,9 +228,9 @@ CesiumMath.signNotZero = function (value) { /** * Converts a scalar value in the range [-1.0, 1.0] to a SNORM in the range [0, rangeMaximum] - * @param {Number} value The scalar value in the range [-1.0, 1.0] - * @param {Number} [rangeMaximum=255] The maximum value in the mapped range, 255 by default. - * @returns {Number} A SNORM value, where 0 maps to -1.0 and rangeMaximum maps to 1.0. + * @param {number} value The scalar value in the range [-1.0, 1.0] + * @param {number} [rangeMaximum=255] The maximum value in the mapped range, 255 by default. + * @returns {number} A SNORM value, where 0 maps to -1.0 and rangeMaximum maps to 1.0. * * @see CesiumMath.fromSNorm */ @@ -243,9 +243,9 @@ CesiumMath.toSNorm = function (value, rangeMaximum) { /** * Converts a SNORM value in the range [0, rangeMaximum] to a scalar in the range [-1.0, 1.0]. - * @param {Number} value SNORM value in the range [0, rangeMaximum] - * @param {Number} [rangeMaximum=255] The maximum value in the SNORM range, 255 by default. - * @returns {Number} Scalar in the range [-1.0, 1.0]. + * @param {number} value SNORM value in the range [0, rangeMaximum] + * @param {number} [rangeMaximum=255] The maximum value in the SNORM range, 255 by default. + * @returns {number} Scalar in the range [-1.0, 1.0]. * * @see CesiumMath.toSNorm */ @@ -258,10 +258,10 @@ CesiumMath.fromSNorm = function (value, rangeMaximum) { /** * Converts a scalar value in the range [rangeMinimum, rangeMaximum] to a scalar in the range [0.0, 1.0] - * @param {Number} value The scalar value in the range [rangeMinimum, rangeMaximum] - * @param {Number} rangeMinimum The minimum value in the mapped range. - * @param {Number} rangeMaximum The maximum value in the mapped range. - * @returns {Number} A scalar value, where rangeMinimum maps to 0.0 and rangeMaximum maps to 1.0. + * @param {number} value The scalar value in the range [rangeMinimum, rangeMaximum] + * @param {number} rangeMinimum The minimum value in the mapped range. + * @param {number} rangeMaximum The maximum value in the mapped range. + * @returns {number} A scalar value, where rangeMinimum maps to 0.0 and rangeMaximum maps to 1.0. */ CesiumMath.normalize = function (value, rangeMinimum, rangeMaximum) { rangeMaximum = Math.max(rangeMaximum - rangeMinimum, 0.0); @@ -289,8 +289,8 @@ CesiumMath.normalize = function (value, rangeMinimum, rangeMaximum) { *

* * @function - * @param {Number} value The number whose hyperbolic sine is to be returned. - * @returns {Number} The hyperbolic sine of value. + * @param {number} value The number whose hyperbolic sine is to be returned. + * @returns {number} The hyperbolic sine of value. */ // eslint-disable-next-line es/no-math-sinh CesiumMath.sinh = defaultValue(Math.sinh, function sinh(value) { @@ -314,8 +314,8 @@ CesiumMath.sinh = defaultValue(Math.sinh, function sinh(value) { *

* * @function - * @param {Number} value The number whose hyperbolic cosine is to be returned. - * @returns {Number} The hyperbolic cosine of value. + * @param {number} value The number whose hyperbolic cosine is to be returned. + * @returns {number} The hyperbolic cosine of value. */ // eslint-disable-next-line es/no-math-cosh CesiumMath.cosh = defaultValue(Math.cosh, function cosh(value) { @@ -325,10 +325,10 @@ CesiumMath.cosh = defaultValue(Math.cosh, function cosh(value) { /** * Computes the linear interpolation of two values. * - * @param {Number} p The start value to interpolate. - * @param {Number} q The end value to interpolate. - * @param {Number} time The time of interpolation generally in the range [0.0, 1.0]. - * @returns {Number} The linearly interpolated value. + * @param {number} p The start value to interpolate. + * @param {number} q The end value to interpolate. + * @param {number} time The time of interpolation generally in the range [0.0, 1.0]. + * @returns {number} The linearly interpolated value. * * @example * const n = Cesium.Math.lerp(0.0, 2.0, 0.5); // returns 1.0 @@ -340,7 +340,7 @@ CesiumMath.lerp = function (p, q, time) { /** * pi * - * @type {Number} + * @type {number} * @constant */ CesiumMath.PI = Math.PI; @@ -348,7 +348,7 @@ CesiumMath.PI = Math.PI; /** * 1/pi * - * @type {Number} + * @type {number} * @constant */ CesiumMath.ONE_OVER_PI = 1.0 / Math.PI; @@ -356,7 +356,7 @@ CesiumMath.ONE_OVER_PI = 1.0 / Math.PI; /** * pi/2 * - * @type {Number} + * @type {number} * @constant */ CesiumMath.PI_OVER_TWO = Math.PI / 2.0; @@ -364,7 +364,7 @@ CesiumMath.PI_OVER_TWO = Math.PI / 2.0; /** * pi/3 * - * @type {Number} + * @type {number} * @constant */ CesiumMath.PI_OVER_THREE = Math.PI / 3.0; @@ -372,7 +372,7 @@ CesiumMath.PI_OVER_THREE = Math.PI / 3.0; /** * pi/4 * - * @type {Number} + * @type {number} * @constant */ CesiumMath.PI_OVER_FOUR = Math.PI / 4.0; @@ -380,7 +380,7 @@ CesiumMath.PI_OVER_FOUR = Math.PI / 4.0; /** * pi/6 * - * @type {Number} + * @type {number} * @constant */ CesiumMath.PI_OVER_SIX = Math.PI / 6.0; @@ -388,7 +388,7 @@ CesiumMath.PI_OVER_SIX = Math.PI / 6.0; /** * 3pi/2 * - * @type {Number} + * @type {number} * @constant */ CesiumMath.THREE_PI_OVER_TWO = (3.0 * Math.PI) / 2.0; @@ -396,7 +396,7 @@ CesiumMath.THREE_PI_OVER_TWO = (3.0 * Math.PI) / 2.0; /** * 2pi * - * @type {Number} + * @type {number} * @constant */ CesiumMath.TWO_PI = 2.0 * Math.PI; @@ -404,7 +404,7 @@ CesiumMath.TWO_PI = 2.0 * Math.PI; /** * 1/2pi * - * @type {Number} + * @type {number} * @constant */ CesiumMath.ONE_OVER_TWO_PI = 1.0 / (2.0 * Math.PI); @@ -412,7 +412,7 @@ CesiumMath.ONE_OVER_TWO_PI = 1.0 / (2.0 * Math.PI); /** * The number of radians in a degree. * - * @type {Number} + * @type {number} * @constant */ CesiumMath.RADIANS_PER_DEGREE = Math.PI / 180.0; @@ -420,7 +420,7 @@ CesiumMath.RADIANS_PER_DEGREE = Math.PI / 180.0; /** * The number of degrees in a radian. * - * @type {Number} + * @type {number} * @constant */ CesiumMath.DEGREES_PER_RADIAN = 180.0 / Math.PI; @@ -428,15 +428,15 @@ CesiumMath.DEGREES_PER_RADIAN = 180.0 / Math.PI; /** * The number of radians in an arc second. * - * @type {Number} + * @type {number} * @constant */ CesiumMath.RADIANS_PER_ARCSECOND = CesiumMath.RADIANS_PER_DEGREE / 3600.0; /** * Converts degrees to radians. - * @param {Number} degrees The angle to convert in degrees. - * @returns {Number} The corresponding angle in radians. + * @param {number} degrees The angle to convert in degrees. + * @returns {number} The corresponding angle in radians. */ CesiumMath.toRadians = function (degrees) { //>>includeStart('debug', pragmas.debug); @@ -449,8 +449,8 @@ CesiumMath.toRadians = function (degrees) { /** * Converts radians to degrees. - * @param {Number} radians The angle to convert in radians. - * @returns {Number} The corresponding angle in degrees. + * @param {number} radians The angle to convert in radians. + * @returns {number} The corresponding angle in degrees. */ CesiumMath.toDegrees = function (radians) { //>>includeStart('debug', pragmas.debug); @@ -464,8 +464,8 @@ CesiumMath.toDegrees = function (radians) { /** * Converts a longitude value, in radians, to the range [-Math.PI, Math.PI). * - * @param {Number} angle The longitude value, in radians, to convert to the range [-Math.PI, Math.PI). - * @returns {Number} The equivalent longitude value in the range [-Math.PI, Math.PI). + * @param {number} angle The longitude value, in radians, to convert to the range [-Math.PI, Math.PI). + * @returns {number} The equivalent longitude value in the range [-Math.PI, Math.PI). * * @example * // Convert 270 degrees to -90 degrees longitude @@ -495,8 +495,8 @@ CesiumMath.convertLongitudeRange = function (angle) { * Convenience function that clamps a latitude value, in radians, to the range [-Math.PI/2, Math.PI/2). * Useful for sanitizing data before use in objects requiring correct range. * - * @param {Number} angle The latitude value, in radians, to clamp to the range [-Math.PI/2, Math.PI/2). - * @returns {Number} The latitude value clamped to the range [-Math.PI/2, Math.PI/2). + * @param {number} angle The latitude value, in radians, to clamp to the range [-Math.PI/2, Math.PI/2). + * @returns {number} The latitude value clamped to the range [-Math.PI/2, Math.PI/2). * * @example * // Clamp 108 degrees latitude to 90 degrees latitude @@ -519,8 +519,8 @@ CesiumMath.clampToLatitudeRange = function (angle) { /** * Produces an angle in the range -Pi <= angle <= Pi which is equivalent to the provided angle. * - * @param {Number} angle in radians - * @returns {Number} The angle in the range [-CesiumMath.PI, CesiumMath.PI]. + * @param {number} angle in radians + * @returns {number} The angle in the range [-CesiumMath.PI, CesiumMath.PI]. */ CesiumMath.negativePiToPi = function (angle) { //>>includeStart('debug', pragmas.debug); @@ -539,8 +539,8 @@ CesiumMath.negativePiToPi = function (angle) { /** * Produces an angle in the range 0 <= angle <= 2Pi which is equivalent to the provided angle. * - * @param {Number} angle in radians - * @returns {Number} The angle in the range [0, CesiumMath.TWO_PI]. + * @param {number} angle in radians + * @returns {number} The angle in the range [0, CesiumMath.TWO_PI]. */ CesiumMath.zeroToTwoPi = function (angle) { //>>includeStart('debug', pragmas.debug); @@ -566,9 +566,9 @@ CesiumMath.zeroToTwoPi = function (angle) { /** * The modulo operation that also works for negative dividends. * - * @param {Number} m The dividend. - * @param {Number} n The divisor. - * @returns {Number} The remainder. + * @param {number} m The dividend. + * @param {number} n The divisor. + * @returns {number} The remainder. */ CesiumMath.mod = function (m, n) { //>>includeStart('debug', pragmas.debug); @@ -597,11 +597,11 @@ CesiumMath.mod = function (m, n) { * first compared using an absolute tolerance test. If that fails, a relative tolerance test is performed. * Use this test if you are unsure of the magnitudes of left and right. * - * @param {Number} left The first value to compare. - * @param {Number} right The other value to compare. - * @param {Number} [relativeEpsilon=0] The maximum inclusive delta between left and right for the relative tolerance test. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The maximum inclusive delta between left and right for the absolute tolerance test. - * @returns {Boolean} true if the values are equal within the epsilon; otherwise, false. + * @param {number} left The first value to compare. + * @param {number} right The other value to compare. + * @param {number} [relativeEpsilon=0] The maximum inclusive delta between left and right for the relative tolerance test. + * @param {number} [absoluteEpsilon=relativeEpsilon] The maximum inclusive delta between left and right for the absolute tolerance test. + * @returns {boolean} true if the values are equal within the epsilon; otherwise, false. * * @example * const a = Cesium.Math.equalsEpsilon(0.0, 0.01, Cesium.Math.EPSILON2); // true @@ -637,10 +637,10 @@ CesiumMath.equalsEpsilon = function ( * Determines if the left value is less than the right value. If the two values are within * absoluteEpsilon of each other, they are considered equal and this function returns false. * - * @param {Number} left The first number to compare. - * @param {Number} right The second number to compare. - * @param {Number} absoluteEpsilon The absolute epsilon to use in comparison. - * @returns {Boolean} true if left is less than right by more than + * @param {number} left The first number to compare. + * @param {number} right The second number to compare. + * @param {number} absoluteEpsilon The absolute epsilon to use in comparison. + * @returns {boolean} true if left is less than right by more than * absoluteEpsilon. false if left is greater or if the two * values are nearly equal. */ @@ -663,10 +663,10 @@ CesiumMath.lessThan = function (left, right, absoluteEpsilon) { * Determines if the left value is less than or equal to the right value. If the two values are within * absoluteEpsilon of each other, they are considered equal and this function returns true. * - * @param {Number} left The first number to compare. - * @param {Number} right The second number to compare. - * @param {Number} absoluteEpsilon The absolute epsilon to use in comparison. - * @returns {Boolean} true if left is less than right or if the + * @param {number} left The first number to compare. + * @param {number} right The second number to compare. + * @param {number} absoluteEpsilon The absolute epsilon to use in comparison. + * @returns {boolean} true if left is less than right or if the * the values are nearly equal. */ CesiumMath.lessThanOrEquals = function (left, right, absoluteEpsilon) { @@ -688,10 +688,10 @@ CesiumMath.lessThanOrEquals = function (left, right, absoluteEpsilon) { * Determines if the left value is greater the right value. If the two values are within * absoluteEpsilon of each other, they are considered equal and this function returns false. * - * @param {Number} left The first number to compare. - * @param {Number} right The second number to compare. - * @param {Number} absoluteEpsilon The absolute epsilon to use in comparison. - * @returns {Boolean} true if left is greater than right by more than + * @param {number} left The first number to compare. + * @param {number} right The second number to compare. + * @param {number} absoluteEpsilon The absolute epsilon to use in comparison. + * @returns {boolean} true if left is greater than right by more than * absoluteEpsilon. false if left is less or if the two * values are nearly equal. */ @@ -714,10 +714,10 @@ CesiumMath.greaterThan = function (left, right, absoluteEpsilon) { * Determines if the left value is greater than or equal to the right value. If the two values are within * absoluteEpsilon of each other, they are considered equal and this function returns true. * - * @param {Number} left The first number to compare. - * @param {Number} right The second number to compare. - * @param {Number} absoluteEpsilon The absolute epsilon to use in comparison. - * @returns {Boolean} true if left is greater than right or if the + * @param {number} left The first number to compare. + * @param {number} right The second number to compare. + * @param {number} absoluteEpsilon The absolute epsilon to use in comparison. + * @returns {boolean} true if left is greater than right or if the * the values are nearly equal. */ CesiumMath.greaterThanOrEquals = function (left, right, absoluteEpsilon) { @@ -740,8 +740,8 @@ const factorials = [1]; /** * Computes the factorial of the provided number. * - * @param {Number} n The number whose factorial is to be computed. - * @returns {Number} The factorial of the provided number or undefined if the number is less than 0. + * @param {number} n The number whose factorial is to be computed. + * @returns {number} The factorial of the provided number or undefined if the number is less than 0. * * @exception {DeveloperError} A number greater than or equal to 0 is required. * @@ -776,10 +776,10 @@ CesiumMath.factorial = function (n) { /** * Increments a number with a wrapping to a minimum value if the number exceeds the maximum value. * - * @param {Number} [n] The number to be incremented. - * @param {Number} [maximumValue] The maximum incremented value before rolling over to the minimum value. - * @param {Number} [minimumValue=0.0] The number reset to after the maximum value has been exceeded. - * @returns {Number} The incremented number. + * @param {number} [n] The number to be incremented. + * @param {number} [maximumValue] The maximum incremented value before rolling over to the minimum value. + * @param {number} [minimumValue=0.0] The number reset to after the maximum value has been exceeded. + * @returns {number} The incremented number. * * @exception {DeveloperError} Maximum value must be greater than minimum value. * @@ -810,8 +810,8 @@ CesiumMath.incrementWrap = function (n, maximumValue, minimumValue) { * Determines if a non-negative integer is a power of two. * The maximum allowed input is (2^32)-1 due to 32-bit bitwise operator limitation in Javascript. * - * @param {Number} n The integer to test in the range [0, (2^32)-1]. - * @returns {Boolean} true if the number if a power of two; otherwise, false. + * @param {number} n The integer to test in the range [0, (2^32)-1]. + * @returns {boolean} true if the number if a power of two; otherwise, false. * * @exception {DeveloperError} A number between 0 and (2^32)-1 is required. * @@ -833,8 +833,8 @@ CesiumMath.isPowerOfTwo = function (n) { * Computes the next power-of-two integer greater than or equal to the provided non-negative integer. * The maximum allowed input is 2^31 due to 32-bit bitwise operator limitation in Javascript. * - * @param {Number} n The integer to test in the range [0, 2^31]. - * @returns {Number} The next power-of-two integer. + * @param {number} n The integer to test in the range [0, 2^31]. + * @returns {number} The next power-of-two integer. * * @exception {DeveloperError} A number between 0 and 2^31 is required. * @@ -865,8 +865,8 @@ CesiumMath.nextPowerOfTwo = function (n) { * Computes the previous power-of-two integer less than or equal to the provided non-negative integer. * The maximum allowed input is (2^32)-1 due to 32-bit bitwise operator limitation in Javascript. * - * @param {Number} n The integer to test in the range [0, (2^32)-1]. - * @returns {Number} The previous power-of-two integer. + * @param {number} n The integer to test in the range [0, (2^32)-1]. + * @returns {number} The previous power-of-two integer. * * @exception {DeveloperError} A number between 0 and (2^32)-1 is required. * @@ -897,10 +897,10 @@ CesiumMath.previousPowerOfTwo = function (n) { /** * Constraint a value to lie between two values. * - * @param {Number} value The value to clamp. - * @param {Number} min The minimum value. - * @param {Number} max The maximum value. - * @returns {Number} The clamped value such that min <= result <= max. + * @param {number} value The value to clamp. + * @param {number} min The minimum value. + * @param {number} max The maximum value. + * @returns {number} The clamped value such that min <= result <= max. */ CesiumMath.clamp = function (value, min, max) { //>>includeStart('debug', pragmas.debug); @@ -918,7 +918,7 @@ let randomNumberGenerator = new MersenneTwister(); * Sets the seed used by the random number generator * in {@link CesiumMath#nextRandomNumber}. * - * @param {Number} seed An integer used as the seed. + * @param {number} seed An integer used as the seed. */ CesiumMath.setRandomNumberSeed = function (seed) { //>>includeStart('debug', pragmas.debug); @@ -934,7 +934,7 @@ CesiumMath.setRandomNumberSeed = function (seed) { * Generates a random floating point number in the range of [0.0, 1.0) * using a Mersenne twister. * - * @returns {Number} A random number in the range of [0.0, 1.0). + * @returns {number} A random number in the range of [0.0, 1.0). * * @see CesiumMath.setRandomNumberSeed * @see {@link http://en.wikipedia.org/wiki/Mersenne_twister|Mersenne twister on Wikipedia} @@ -946,9 +946,9 @@ CesiumMath.nextRandomNumber = function () { /** * Generates a random number between two numbers. * - * @param {Number} min The minimum value. - * @param {Number} max The maximum value. - * @returns {Number} A random number between the min and max. + * @param {number} min The minimum value. + * @param {number} max The maximum value. + * @returns {number} A random number between the min and max. */ CesiumMath.randomBetween = function (min, max) { return CesiumMath.nextRandomNumber() * (max - min) + min; @@ -958,8 +958,8 @@ CesiumMath.randomBetween = function (min, max) { * Computes Math.acos(value), but first clamps value to the range [-1.0, 1.0] * so that the function will never return NaN. * - * @param {Number} value The value for which to compute acos. - * @returns {Number} The acos of the value if the value is in the range [-1.0, 1.0], or the acos of -1.0 or 1.0, + * @param {number} value The value for which to compute acos. + * @returns {number} The acos of the value if the value is in the range [-1.0, 1.0], or the acos of -1.0 or 1.0, * whichever is closer, if the value is outside the range. */ CesiumMath.acosClamped = function (value) { @@ -975,8 +975,8 @@ CesiumMath.acosClamped = function (value) { * Computes Math.asin(value), but first clamps value to the range [-1.0, 1.0] * so that the function will never return NaN. * - * @param {Number} value The value for which to compute asin. - * @returns {Number} The asin of the value if the value is in the range [-1.0, 1.0], or the asin of -1.0 or 1.0, + * @param {number} value The value for which to compute asin. + * @returns {number} The asin of the value if the value is in the range [-1.0, 1.0], or the asin of -1.0 or 1.0, * whichever is closer, if the value is outside the range. */ CesiumMath.asinClamped = function (value) { @@ -991,9 +991,9 @@ CesiumMath.asinClamped = function (value) { /** * Finds the chord length between two points given the circle's radius and the angle between the points. * - * @param {Number} angle The angle between the two points. - * @param {Number} radius The radius of the circle. - * @returns {Number} The chord length. + * @param {number} angle The angle between the two points. + * @param {number} radius The radius of the circle. + * @returns {number} The chord length. */ CesiumMath.chordLength = function (angle, radius) { //>>includeStart('debug', pragmas.debug); @@ -1010,9 +1010,9 @@ CesiumMath.chordLength = function (angle, radius) { /** * Finds the logarithm of a number to a base. * - * @param {Number} number The number. - * @param {Number} base The base. - * @returns {Number} The result. + * @param {number} number The number. + * @param {number} base The base. + * @returns {number} The result. */ CesiumMath.logBase = function (number, base) { //>>includeStart('debug', pragmas.debug); @@ -1031,8 +1031,8 @@ CesiumMath.logBase = function (number, base) { * Returns NaN if number is not provided. * * @function - * @param {Number} [number] The number. - * @returns {Number} The result. + * @param {number} [number] The number. + * @returns {number} The result. */ // eslint-disable-next-line es/no-math-cbrt CesiumMath.cbrt = defaultValue(Math.cbrt, function cbrt(number) { @@ -1044,8 +1044,8 @@ CesiumMath.cbrt = defaultValue(Math.cbrt, function cbrt(number) { * Finds the base 2 logarithm of a number. * * @function - * @param {Number} number The number. - * @returns {Number} The result. + * @param {number} number The number. + * @returns {number} The result. */ // eslint-disable-next-line es/no-math-log2 CesiumMath.log2 = defaultValue(Math.log2, function log2(number) { @@ -1068,8 +1068,8 @@ CesiumMath.fog = function (distanceToCamera, density) { * Rajan, S. Sichun Wang Inkol, R. Joyal, A., May 2006. * Adapted from ShaderFastLibs under MIT License. * - * @param {Number} x An input number in the range [-1, 1] - * @returns {Number} An approximation of atan(x) + * @param {number} x An input number in the range [-1, 1] + * @returns {number} An approximation of atan(x) */ CesiumMath.fastApproximateAtan = function (x) { //>>includeStart('debug', pragmas.debug); @@ -1084,9 +1084,9 @@ CesiumMath.fastApproximateAtan = function (x) { * * Range reduction math based on nvidia's cg reference implementation: http://developer.download.nvidia.com/cg/atan2.html * - * @param {Number} x An input number that isn't zero if y is zero. - * @param {Number} y An input number that isn't zero if x is zero. - * @returns {Number} An approximation of atan2(x, y) + * @param {number} x An input number that isn't zero if y is zero. + * @param {number} y An input number that isn't zero if x is zero. + * @returns {number} An approximation of atan2(x, y) */ CesiumMath.fastApproximateAtan2 = function (x, y) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/Matrix2.js b/packages/engine/Source/Core/Matrix2.js index 266cc4c3f297..7f0cba621c0d 100644 --- a/packages/engine/Source/Core/Matrix2.js +++ b/packages/engine/Source/Core/Matrix2.js @@ -11,10 +11,10 @@ import DeveloperError from "./DeveloperError.js"; * @constructor * @implements {ArrayLike} * - * @param {Number} [column0Row0=0.0] The value for column 0, row 0. - * @param {Number} [column1Row0=0.0] The value for column 1, row 0. - * @param {Number} [column0Row1=0.0] The value for column 0, row 1. - * @param {Number} [column1Row1=0.0] The value for column 1, row 1. + * @param {number} [column0Row0=0.0] The value for column 0, row 0. + * @param {number} [column1Row0=0.0] The value for column 1, row 0. + * @param {number} [column0Row1=0.0] The value for column 0, row 1. + * @param {number} [column1Row1=0.0] The value for column 1, row 1. * * @see Matrix2.fromArray * @see Matrix2.fromColumnMajorArray @@ -34,7 +34,7 @@ function Matrix2(column0Row0, column1Row0, column0Row1, column1Row1) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Matrix2.packedLength = 4; @@ -42,10 +42,10 @@ Matrix2.packedLength = 4; * Stores the provided instance into the provided array. * * @param {Matrix2} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Matrix2.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -66,8 +66,8 @@ Matrix2.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Matrix2} [result] The object into which to store the result. * @returns {Matrix2} The modified result parameter or a new Matrix2 instance if one was not provided. */ @@ -94,8 +94,8 @@ Matrix2.unpack = function (array, startingIndex, result) { * are stored in column-major order. * * @param {Matrix2[]} array The array of matrices to pack. - * @param {Number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 4 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 4) elements. - * @returns {Number[]} The packed array. + * @param {number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 4 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 4) elements. + * @returns {number[]} The packed array. */ Matrix2.packArray = function (array, result) { //>>includeStart('debug', pragmas.debug); @@ -125,7 +125,7 @@ Matrix2.packArray = function (array, result) { /** * Unpacks an array of column-major matrix components into an array of Matrix2s. * - * @param {Number[]} array The array of components to unpack. + * @param {number[]} array The array of components to unpack. * @param {Matrix2[]} [result] The array onto which to store the result. * @returns {Matrix2[]} The unpacked array. */ @@ -177,8 +177,8 @@ Matrix2.clone = function (matrix, result) { * Creates a Matrix2 from 4 consecutive elements in an array. * * @function - * @param {Number[]} array The array whose 4 consecutive elements correspond to the positions of the matrix. Assumes column-major order. - * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix. + * @param {number[]} array The array whose 4 consecutive elements correspond to the positions of the matrix. Assumes column-major order. + * @param {number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix. * @param {Matrix2} [result] The object onto which to store the result. * @returns {Matrix2} The modified result parameter or a new Matrix2 instance if one was not provided. * @@ -198,7 +198,7 @@ Matrix2.fromArray = Matrix2.unpack; /** * Creates a Matrix2 instance from a column-major order array. * - * @param {Number[]} values The column-major order array. + * @param {number[]} values The column-major order array. * @param {Matrix2} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix2} The modified result parameter, or a new Matrix2 instance if one was not provided. */ @@ -214,7 +214,7 @@ Matrix2.fromColumnMajorArray = function (values, result) { * Creates a Matrix2 instance from a row-major order array. * The resulting matrix will be in column-major order. * - * @param {Number[]} values The row-major order array. + * @param {number[]} values The row-major order array. * @param {Matrix2} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix2} The modified result parameter, or a new Matrix2 instance if one was not provided. */ @@ -265,7 +265,7 @@ Matrix2.fromScale = function (scale, result) { /** * Computes a Matrix2 instance representing a uniform scale. * - * @param {Number} scale The uniform scale factor. + * @param {number} scale The uniform scale factor. * @param {Matrix2} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix2} The modified result parameter, or a new Matrix2 instance if one was not provided. * @@ -294,7 +294,7 @@ Matrix2.fromUniformScale = function (scale, result) { /** * Creates a rotation matrix. * - * @param {Number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise. + * @param {number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise. * @param {Matrix2} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix2} The modified result parameter, or a new Matrix2 instance if one was not provided. * @@ -327,8 +327,8 @@ Matrix2.fromRotation = function (angle, result) { * The array will be in column-major order. * * @param {Matrix2} matrix The matrix to use.. - * @param {Number[]} [result] The Array onto which to store the result. - * @returns {Number[]} The modified Array parameter or a new Array instance if one was not provided. + * @param {number[]} [result] The Array onto which to store the result. + * @returns {number[]} The modified Array parameter or a new Array instance if one was not provided. */ Matrix2.toArray = function (matrix, result) { //>>includeStart('debug', pragmas.debug); @@ -348,9 +348,9 @@ Matrix2.toArray = function (matrix, result) { /** * Computes the array index of the element at the provided row and column. * - * @param {Number} row The zero-based index of the row. - * @param {Number} column The zero-based index of the column. - * @returns {Number} The index of the element at the provided row and column. + * @param {number} row The zero-based index of the row. + * @param {number} column The zero-based index of the column. + * @returns {number} The index of the element at the provided row and column. * * @exception {DeveloperError} row must be 0 or 1. * @exception {DeveloperError} column must be 0 or 1. @@ -377,7 +377,7 @@ Matrix2.getElementIndex = function (column, row) { * Retrieves a copy of the matrix column at the provided index as a Cartesian2 instance. * * @param {Matrix2} matrix The matrix to use. - * @param {Number} index The zero-based index of the column to retrieve. + * @param {number} index The zero-based index of the column to retrieve. * @param {Cartesian2} result The object onto which to store the result. * @returns {Cartesian2} The modified result parameter. * @@ -406,7 +406,7 @@ Matrix2.getColumn = function (matrix, index, result) { * Computes a new matrix that replaces the specified column in the provided matrix with the provided Cartesian2 instance. * * @param {Matrix2} matrix The matrix to use. - * @param {Number} index The zero-based index of the column to set. + * @param {number} index The zero-based index of the column to set. * @param {Cartesian2} cartesian The Cartesian whose values will be assigned to the specified column. * @param {Cartesian2} result The object onto which to store the result. * @returns {Matrix2} The modified result parameter. @@ -435,7 +435,7 @@ Matrix2.setColumn = function (matrix, index, cartesian, result) { * Retrieves a copy of the matrix row at the provided index as a Cartesian2 instance. * * @param {Matrix2} matrix The matrix to use. - * @param {Number} index The zero-based index of the row to retrieve. + * @param {number} index The zero-based index of the row to retrieve. * @param {Cartesian2} result The object onto which to store the result. * @returns {Cartesian2} The modified result parameter. * @@ -463,7 +463,7 @@ Matrix2.getRow = function (matrix, index, result) { * Computes a new matrix that replaces the specified row in the provided matrix with the provided Cartesian2 instance. * * @param {Matrix2} matrix The matrix to use. - * @param {Number} index The zero-based index of the row to set. + * @param {number} index The zero-based index of the row to set. * @param {Cartesian2} cartesian The Cartesian whose values will be assigned to the specified row. * @param {Matrix2} result The object onto which to store the result. * @returns {Matrix2} The modified result parameter. @@ -531,7 +531,7 @@ const scaleScratch2 = new Cartesian2(); * This assumes the matrix is an affine transformation. * * @param {Matrix2} matrix The matrix to use. - * @param {Number} scale The uniform scale that replaces the scale of the provided matrix. + * @param {number} scale The uniform scale that replaces the scale of the provided matrix. * @param {Matrix2} result The object onto which to store the result. * @returns {Matrix2} The modified result parameter. * @@ -599,7 +599,7 @@ const scaleScratch3 = new Cartesian2(); * The maximum scale is the maximum length of the column vectors. * * @param {Matrix2} matrix The matrix. - * @returns {Number} The maximum scale. + * @returns {number} The maximum scale. */ Matrix2.getMaximumScale = function (matrix) { Matrix2.getScale(matrix, scaleScratch3); @@ -761,7 +761,7 @@ Matrix2.multiplyByVector = function (matrix, cartesian, result) { * Computes the product of a matrix and a scalar. * * @param {Matrix2} matrix The matrix. - * @param {Number} scalar The number to multiply by. + * @param {number} scalar The number to multiply by. * @param {Matrix2} result The object onto which to store the result. * @returns {Matrix2} The modified result parameter. */ @@ -818,7 +818,7 @@ Matrix2.multiplyByScale = function (matrix, scale, result) { * Computes the product of a matrix times a uniform scale, as if the scale were a scale matrix. * * @param {Matrix2} matrix The matrix on the left-hand side. - * @param {Number} scale The uniform scale on the right-hand side. + * @param {number} scale The uniform scale on the right-hand side. * @param {Matrix2} result The object onto which to store the result. * @returns {Matrix2} The modified result parameter. * @@ -920,7 +920,7 @@ Matrix2.abs = function (matrix, result) { * * @param {Matrix2} [left] The first matrix. * @param {Matrix2} [right] The second matrix. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Matrix2.equals = function (left, right) { return ( @@ -953,8 +953,8 @@ Matrix2.equalsArray = function (matrix, array, offset) { * * @param {Matrix2} [left] The first matrix. * @param {Matrix2} [right] The second matrix. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Matrix2.equalsEpsilon = function (left, right, epsilon) { epsilon = defaultValue(epsilon, 0); @@ -988,7 +988,7 @@ Matrix2.ZERO = Object.freeze(new Matrix2(0.0, 0.0, 0.0, 0.0)); /** * The index into Matrix2 for column 0, row 0. * - * @type {Number} + * @type {number} * @constant * * @example @@ -1000,7 +1000,7 @@ Matrix2.COLUMN0ROW0 = 0; /** * The index into Matrix2 for column 0, row 1. * - * @type {Number} + * @type {number} * @constant * * @example @@ -1012,7 +1012,7 @@ Matrix2.COLUMN0ROW1 = 1; /** * The index into Matrix2 for column 1, row 0. * - * @type {Number} + * @type {number} * @constant * * @example @@ -1024,7 +1024,7 @@ Matrix2.COLUMN1ROW0 = 2; /** * The index into Matrix2 for column 1, row 1. * - * @type {Number} + * @type {number} * @constant * * @example @@ -1038,7 +1038,7 @@ Object.defineProperties(Matrix2.prototype, { * Gets the number of items in the collection. * @memberof Matrix2.prototype * - * @type {Number} + * @type {number} */ length: { get: function () { @@ -1062,7 +1062,7 @@ Matrix2.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {Matrix2} [right] The right hand side matrix. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ Matrix2.prototype.equals = function (right) { return Matrix2.equals(this, right); @@ -1074,8 +1074,8 @@ Matrix2.prototype.equals = function (right) { * false otherwise. * * @param {Matrix2} [right] The right hand side matrix. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if they are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if they are within the provided epsilon, false otherwise. */ Matrix2.prototype.equalsEpsilon = function (right, epsilon) { return Matrix2.equalsEpsilon(this, right, epsilon); @@ -1085,7 +1085,7 @@ Matrix2.prototype.equalsEpsilon = function (right, epsilon) { * Creates a string representing this Matrix with each row being * on a separate line and in the format '(column0, column1)'. * - * @returns {String} A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1)'. + * @returns {string} A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1)'. */ Matrix2.prototype.toString = function () { return `(${this[0]}, ${this[2]})\n` + `(${this[1]}, ${this[3]})`; diff --git a/packages/engine/Source/Core/Matrix3.js b/packages/engine/Source/Core/Matrix3.js index 04b1cbeb2324..80b4a5185c24 100644 --- a/packages/engine/Source/Core/Matrix3.js +++ b/packages/engine/Source/Core/Matrix3.js @@ -12,15 +12,15 @@ import CesiumMath from "./Math.js"; * @constructor * @implements {ArrayLike} * - * @param {Number} [column0Row0=0.0] The value for column 0, row 0. - * @param {Number} [column1Row0=0.0] The value for column 1, row 0. - * @param {Number} [column2Row0=0.0] The value for column 2, row 0. - * @param {Number} [column0Row1=0.0] The value for column 0, row 1. - * @param {Number} [column1Row1=0.0] The value for column 1, row 1. - * @param {Number} [column2Row1=0.0] The value for column 2, row 1. - * @param {Number} [column0Row2=0.0] The value for column 0, row 2. - * @param {Number} [column1Row2=0.0] The value for column 1, row 2. - * @param {Number} [column2Row2=0.0] The value for column 2, row 2. + * @param {number} [column0Row0=0.0] The value for column 0, row 0. + * @param {number} [column1Row0=0.0] The value for column 1, row 0. + * @param {number} [column2Row0=0.0] The value for column 2, row 0. + * @param {number} [column0Row1=0.0] The value for column 0, row 1. + * @param {number} [column1Row1=0.0] The value for column 1, row 1. + * @param {number} [column2Row1=0.0] The value for column 2, row 1. + * @param {number} [column0Row2=0.0] The value for column 0, row 2. + * @param {number} [column1Row2=0.0] The value for column 1, row 2. + * @param {number} [column2Row2=0.0] The value for column 2, row 2. * * @see Matrix3.fromArray * @see Matrix3.fromColumnMajorArray @@ -60,7 +60,7 @@ function Matrix3( /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Matrix3.packedLength = 9; @@ -68,10 +68,10 @@ Matrix3.packedLength = 9; * Stores the provided instance into the provided array. * * @param {Matrix3} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Matrix3.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -97,8 +97,8 @@ Matrix3.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Matrix3} [result] The object into which to store the result. * @returns {Matrix3} The modified result parameter or a new Matrix3 instance if one was not provided. */ @@ -130,8 +130,8 @@ Matrix3.unpack = function (array, startingIndex, result) { * are stored in column-major order. * * @param {Matrix3[]} array The array of matrices to pack. - * @param {Number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 9 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 9) elements. - * @returns {Number[]} The packed array. + * @param {number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 9 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 9) elements. + * @returns {number[]} The packed array. */ Matrix3.packArray = function (array, result) { //>>includeStart('debug', pragmas.debug); @@ -161,7 +161,7 @@ Matrix3.packArray = function (array, result) { /** * Unpacks an array of column-major matrix components into an array of Matrix3s. * - * @param {Number[]} array The array of components to unpack. + * @param {number[]} array The array of components to unpack. * @param {Matrix3[]} [result] The array onto which to store the result. * @returns {Matrix3[]} The unpacked array. */ @@ -228,8 +228,8 @@ Matrix3.clone = function (matrix, result) { * Creates a Matrix3 from 9 consecutive elements in an array. * * @function - * @param {Number[]} array The array whose 9 consecutive elements correspond to the positions of the matrix. Assumes column-major order. - * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix. + * @param {number[]} array The array whose 9 consecutive elements correspond to the positions of the matrix. Assumes column-major order. + * @param {number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix. * @param {Matrix3} [result] The object onto which to store the result. * @returns {Matrix3} The modified result parameter or a new Matrix3 instance if one was not provided. * @@ -251,7 +251,7 @@ Matrix3.fromArray = Matrix3.unpack; /** * Creates a Matrix3 instance from a column-major order array. * - * @param {Number[]} values The column-major order array. + * @param {number[]} values The column-major order array. * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided. */ @@ -267,7 +267,7 @@ Matrix3.fromColumnMajorArray = function (values, result) { * Creates a Matrix3 instance from a row-major order array. * The resulting matrix will be in column-major order. * - * @param {Number[]} values The row-major order array. + * @param {number[]} values The row-major order array. * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided. */ @@ -435,7 +435,7 @@ Matrix3.fromScale = function (scale, result) { /** * Computes a Matrix3 instance representing a uniform scale. * - * @param {Number} scale The uniform scale factor. + * @param {number} scale The uniform scale factor. * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided. * @@ -515,7 +515,7 @@ Matrix3.fromCrossProduct = function (vector, result) { /** * Creates a rotation matrix around the x-axis. * - * @param {Number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise. + * @param {number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise. * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided. * @@ -563,7 +563,7 @@ Matrix3.fromRotationX = function (angle, result) { /** * Creates a rotation matrix around the y-axis. * - * @param {Number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise. + * @param {number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise. * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided. * @@ -611,7 +611,7 @@ Matrix3.fromRotationY = function (angle, result) { /** * Creates a rotation matrix around the z-axis. * - * @param {Number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise. + * @param {number} angle The angle, in radians, of the rotation. Positive angles are counterclockwise. * @param {Matrix3} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix3} The modified result parameter, or a new Matrix3 instance if one was not provided. * @@ -661,8 +661,8 @@ Matrix3.fromRotationZ = function (angle, result) { * The array will be in column-major order. * * @param {Matrix3} matrix The matrix to use.. - * @param {Number[]} [result] The Array onto which to store the result. - * @returns {Number[]} The modified Array parameter or a new Array instance if one was not provided. + * @param {number[]} [result] The Array onto which to store the result. + * @returns {number[]} The modified Array parameter or a new Array instance if one was not provided. */ Matrix3.toArray = function (matrix, result) { //>>includeStart('debug', pragmas.debug); @@ -697,9 +697,9 @@ Matrix3.toArray = function (matrix, result) { /** * Computes the array index of the element at the provided row and column. * - * @param {Number} column The zero-based index of the column. - * @param {Number} row The zero-based index of the row. - * @returns {Number} The index of the element at the provided row and column. + * @param {number} column The zero-based index of the column. + * @param {number} row The zero-based index of the row. + * @returns {number} The index of the element at the provided row and column. * * @exception {DeveloperError} row must be 0, 1, or 2. * @exception {DeveloperError} column must be 0, 1, or 2. @@ -725,7 +725,7 @@ Matrix3.getElementIndex = function (column, row) { * Retrieves a copy of the matrix column at the provided index as a Cartesian3 instance. * * @param {Matrix3} matrix The matrix to use. - * @param {Number} index The zero-based index of the column to retrieve. + * @param {number} index The zero-based index of the column to retrieve. * @param {Cartesian3} result The object onto which to store the result. * @returns {Cartesian3} The modified result parameter. * @@ -754,7 +754,7 @@ Matrix3.getColumn = function (matrix, index, result) { * Computes a new matrix that replaces the specified column in the provided matrix with the provided Cartesian3 instance. * * @param {Matrix3} matrix The matrix to use. - * @param {Number} index The zero-based index of the column to set. + * @param {number} index The zero-based index of the column to set. * @param {Cartesian3} cartesian The Cartesian whose values will be assigned to the specified column. * @param {Matrix3} result The object onto which to store the result. * @returns {Matrix3} The modified result parameter. @@ -782,7 +782,7 @@ Matrix3.setColumn = function (matrix, index, cartesian, result) { * Retrieves a copy of the matrix row at the provided index as a Cartesian3 instance. * * @param {Matrix3} matrix The matrix to use. - * @param {Number} index The zero-based index of the row to retrieve. + * @param {number} index The zero-based index of the row to retrieve. * @param {Cartesian3} result The object onto which to store the result. * @returns {Cartesian3} The modified result parameter. * @@ -810,7 +810,7 @@ Matrix3.getRow = function (matrix, index, result) { * Computes a new matrix that replaces the specified row in the provided matrix with the provided Cartesian3 instance. * * @param {Matrix3} matrix The matrix to use. - * @param {Number} index The zero-based index of the row to set. + * @param {number} index The zero-based index of the row to set. * @param {Cartesian3} cartesian The Cartesian whose values will be assigned to the specified row. * @param {Matrix3} result The object onto which to store the result. * @returns {Matrix3} The modified result parameter. @@ -883,7 +883,7 @@ const scaleScratch2 = new Cartesian3(); * This assumes the matrix is an affine transformation. * * @param {Matrix3} matrix The matrix to use. - * @param {Number} scale The uniform scale that replaces the scale of the provided matrix. + * @param {number} scale The uniform scale that replaces the scale of the provided matrix. * @param {Matrix3} result The object onto which to store the result. * @returns {Matrix3} The modified result parameter. * @@ -960,7 +960,7 @@ const scaleScratch3 = new Cartesian3(); * The maximum scale is the maximum length of the column vectors. * * @param {Matrix3} matrix The matrix. - * @returns {Number} The maximum scale. + * @returns {number} The maximum scale. */ Matrix3.getMaximumScale = function (matrix) { Matrix3.getScale(matrix, scaleScratch3); @@ -1167,7 +1167,7 @@ Matrix3.multiplyByVector = function (matrix, cartesian, result) { * Computes the product of a matrix and a scalar. * * @param {Matrix3} matrix The matrix. - * @param {Number} scalar The number to multiply by. + * @param {number} scalar The number to multiply by. * @param {Matrix3} result The object onto which to store the result. * @returns {Matrix3} The modified result parameter. */ @@ -1234,7 +1234,7 @@ Matrix3.multiplyByScale = function (matrix, scale, result) { * Computes the product of a matrix times a uniform scale, as if the scale were a scale matrix. * * @param {Matrix3} matrix The matrix on the left-hand side. - * @param {Number} scale The uniform scale on the right-hand side. + * @param {number} scale The uniform scale on the right-hand side. * @param {Matrix3} result The object onto which to store the result. * @returns {Matrix3} The modified result parameter. * @@ -1429,8 +1429,8 @@ const jMatrixTranspose = new Matrix3(); *

* * @param {Matrix3} matrix The matrix to decompose into diagonal and unitary matrix. Expected to be symmetric. - * @param {Object} [result] An object with unitary and diagonal properties which are matrices onto which to store the result. - * @returns {Object} An object with unitary and diagonal properties which are the unitary and diagonal matrices, respectively. + * @param {object} [result] An object with unitary and diagonal properties which are matrices onto which to store the result. + * @returns {object} An object with unitary and diagonal properties which are the unitary and diagonal matrices, respectively. * * @example * const a = //... symetric matrix @@ -1520,7 +1520,7 @@ Matrix3.abs = function (matrix, result) { * Computes the determinant of the provided matrix. * * @param {Matrix3} matrix The matrix to use. - * @returns {Number} The value of the determinant of the matrix. + * @returns {number} The value of the determinant of the matrix. */ Matrix3.determinant = function (matrix) { //>>includeStart('debug', pragmas.debug); @@ -1618,7 +1618,7 @@ Matrix3.inverseTranspose = function (matrix, result) { * * @param {Matrix3} [left] The first matrix. * @param {Matrix3} [right] The second matrix. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Matrix3.equals = function (left, right) { return ( @@ -1644,8 +1644,8 @@ Matrix3.equals = function (left, right) { * * @param {Matrix3} [left] The first matrix. * @param {Matrix3} [right] The second matrix. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Matrix3.equalsEpsilon = function (left, right, epsilon) { epsilon = defaultValue(epsilon, 0); @@ -1689,7 +1689,7 @@ Matrix3.ZERO = Object.freeze( /** * The index into Matrix3 for column 0, row 0. * - * @type {Number} + * @type {number} * @constant */ Matrix3.COLUMN0ROW0 = 0; @@ -1697,7 +1697,7 @@ Matrix3.COLUMN0ROW0 = 0; /** * The index into Matrix3 for column 0, row 1. * - * @type {Number} + * @type {number} * @constant */ Matrix3.COLUMN0ROW1 = 1; @@ -1705,7 +1705,7 @@ Matrix3.COLUMN0ROW1 = 1; /** * The index into Matrix3 for column 0, row 2. * - * @type {Number} + * @type {number} * @constant */ Matrix3.COLUMN0ROW2 = 2; @@ -1713,7 +1713,7 @@ Matrix3.COLUMN0ROW2 = 2; /** * The index into Matrix3 for column 1, row 0. * - * @type {Number} + * @type {number} * @constant */ Matrix3.COLUMN1ROW0 = 3; @@ -1721,7 +1721,7 @@ Matrix3.COLUMN1ROW0 = 3; /** * The index into Matrix3 for column 1, row 1. * - * @type {Number} + * @type {number} * @constant */ Matrix3.COLUMN1ROW1 = 4; @@ -1729,7 +1729,7 @@ Matrix3.COLUMN1ROW1 = 4; /** * The index into Matrix3 for column 1, row 2. * - * @type {Number} + * @type {number} * @constant */ Matrix3.COLUMN1ROW2 = 5; @@ -1737,7 +1737,7 @@ Matrix3.COLUMN1ROW2 = 5; /** * The index into Matrix3 for column 2, row 0. * - * @type {Number} + * @type {number} * @constant */ Matrix3.COLUMN2ROW0 = 6; @@ -1745,7 +1745,7 @@ Matrix3.COLUMN2ROW0 = 6; /** * The index into Matrix3 for column 2, row 1. * - * @type {Number} + * @type {number} * @constant */ Matrix3.COLUMN2ROW1 = 7; @@ -1753,7 +1753,7 @@ Matrix3.COLUMN2ROW1 = 7; /** * The index into Matrix3 for column 2, row 2. * - * @type {Number} + * @type {number} * @constant */ Matrix3.COLUMN2ROW2 = 8; @@ -1763,7 +1763,7 @@ Object.defineProperties(Matrix3.prototype, { * Gets the number of items in the collection. * @memberof Matrix3.prototype * - * @type {Number} + * @type {number} */ length: { get: function () { @@ -1787,7 +1787,7 @@ Matrix3.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {Matrix3} [right] The right hand side matrix. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ Matrix3.prototype.equals = function (right) { return Matrix3.equals(this, right); @@ -1816,8 +1816,8 @@ Matrix3.equalsArray = function (matrix, array, offset) { * false otherwise. * * @param {Matrix3} [right] The right hand side matrix. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if they are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if they are within the provided epsilon, false otherwise. */ Matrix3.prototype.equalsEpsilon = function (right, epsilon) { return Matrix3.equalsEpsilon(this, right, epsilon); @@ -1827,7 +1827,7 @@ Matrix3.prototype.equalsEpsilon = function (right, epsilon) { * Creates a string representing this Matrix with each row being * on a separate line and in the format '(column0, column1, column2)'. * - * @returns {String} A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1, column2)'. + * @returns {string} A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1, column2)'. */ Matrix3.prototype.toString = function () { return ( diff --git a/packages/engine/Source/Core/Matrix4.js b/packages/engine/Source/Core/Matrix4.js index 6b6aa3047cb9..ecdaa3c0d001 100644 --- a/packages/engine/Source/Core/Matrix4.js +++ b/packages/engine/Source/Core/Matrix4.js @@ -15,22 +15,22 @@ import RuntimeError from "./RuntimeError.js"; * @constructor * @implements {ArrayLike} * - * @param {Number} [column0Row0=0.0] The value for column 0, row 0. - * @param {Number} [column1Row0=0.0] The value for column 1, row 0. - * @param {Number} [column2Row0=0.0] The value for column 2, row 0. - * @param {Number} [column3Row0=0.0] The value for column 3, row 0. - * @param {Number} [column0Row1=0.0] The value for column 0, row 1. - * @param {Number} [column1Row1=0.0] The value for column 1, row 1. - * @param {Number} [column2Row1=0.0] The value for column 2, row 1. - * @param {Number} [column3Row1=0.0] The value for column 3, row 1. - * @param {Number} [column0Row2=0.0] The value for column 0, row 2. - * @param {Number} [column1Row2=0.0] The value for column 1, row 2. - * @param {Number} [column2Row2=0.0] The value for column 2, row 2. - * @param {Number} [column3Row2=0.0] The value for column 3, row 2. - * @param {Number} [column0Row3=0.0] The value for column 0, row 3. - * @param {Number} [column1Row3=0.0] The value for column 1, row 3. - * @param {Number} [column2Row3=0.0] The value for column 2, row 3. - * @param {Number} [column3Row3=0.0] The value for column 3, row 3. + * @param {number} [column0Row0=0.0] The value for column 0, row 0. + * @param {number} [column1Row0=0.0] The value for column 1, row 0. + * @param {number} [column2Row0=0.0] The value for column 2, row 0. + * @param {number} [column3Row0=0.0] The value for column 3, row 0. + * @param {number} [column0Row1=0.0] The value for column 0, row 1. + * @param {number} [column1Row1=0.0] The value for column 1, row 1. + * @param {number} [column2Row1=0.0] The value for column 2, row 1. + * @param {number} [column3Row1=0.0] The value for column 3, row 1. + * @param {number} [column0Row2=0.0] The value for column 0, row 2. + * @param {number} [column1Row2=0.0] The value for column 1, row 2. + * @param {number} [column2Row2=0.0] The value for column 2, row 2. + * @param {number} [column3Row2=0.0] The value for column 3, row 2. + * @param {number} [column0Row3=0.0] The value for column 0, row 3. + * @param {number} [column1Row3=0.0] The value for column 1, row 3. + * @param {number} [column2Row3=0.0] The value for column 2, row 3. + * @param {number} [column3Row3=0.0] The value for column 3, row 3. * * @see Matrix4.fromArray * @see Matrix4.fromColumnMajorArray @@ -91,7 +91,7 @@ function Matrix4( /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Matrix4.packedLength = 16; @@ -99,10 +99,10 @@ Matrix4.packedLength = 16; * Stores the provided instance into the provided array. * * @param {Matrix4} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Matrix4.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -135,8 +135,8 @@ Matrix4.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Matrix4} [result] The object into which to store the result. * @returns {Matrix4} The modified result parameter or a new Matrix4 instance if one was not provided. */ @@ -175,8 +175,8 @@ Matrix4.unpack = function (array, startingIndex, result) { * are stored in column-major order. * * @param {Matrix4[]} array The array of matrices to pack. - * @param {Number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 16 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 16) elements. - * @returns {Number[]} The packed array. + * @param {number[]} [result] The array onto which to store the result. If this is a typed array, it must have array.length * 16 components, else a {@link DeveloperError} will be thrown. If it is a regular array, it will be resized to have (array.length * 16) elements. + * @returns {number[]} The packed array. */ Matrix4.packArray = function (array, result) { //>>includeStart('debug', pragmas.debug); @@ -206,7 +206,7 @@ Matrix4.packArray = function (array, result) { /** * Unpacks an array of column-major matrix components into an array of Matrix4s. * - * @param {Number[]} array The array of components to unpack. + * @param {number[]} array The array of components to unpack. * @param {Matrix4[]} [result] The array onto which to store the result. * @returns {Matrix4[]} The unpacked array. */ @@ -287,8 +287,8 @@ Matrix4.clone = function (matrix, result) { * Creates a Matrix4 from 16 consecutive elements in an array. * @function * - * @param {Number[]} array The array whose 16 consecutive elements correspond to the positions of the matrix. Assumes column-major order. - * @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix. + * @param {number[]} array The array whose 16 consecutive elements correspond to the positions of the matrix. Assumes column-major order. + * @param {number} [startingIndex=0] The offset into the array of the first element, which corresponds to first column first row position in the matrix. * @param {Matrix4} [result] The object onto which to store the result. * @returns {Matrix4} The modified result parameter or a new Matrix4 instance if one was not provided. * @@ -311,7 +311,7 @@ Matrix4.fromArray = Matrix4.unpack; /** * Computes a Matrix4 instance from a column-major order array. * - * @param {Number[]} values The column-major order array. + * @param {number[]} values The column-major order array. * @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided. */ @@ -327,7 +327,7 @@ Matrix4.fromColumnMajorArray = function (values, result) { * Computes a Matrix4 instance from a row-major order array. * The resulting matrix will be in column-major order. * - * @param {Number[]} values The row-major order array. + * @param {number[]} values The row-major order array. * @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided. */ @@ -614,7 +614,7 @@ Matrix4.fromScale = function (scale, result) { /** * Computes a Matrix4 instance representing a uniform scale. * - * @param {Number} scale The uniform scale factor. + * @param {number} scale The uniform scale factor. * @param {Matrix4} [result] The object in which the result will be stored, if undefined a new instance will be created. * @returns {Matrix4} The modified result parameter, or a new Matrix4 instance if one was not provided. * @@ -818,10 +818,10 @@ Matrix4.fromCamera = function (camera, result) { /** * Computes a Matrix4 instance representing a perspective transformation matrix. * - * @param {Number} fovY The field of view along the Y axis in radians. - * @param {Number} aspectRatio The aspect ratio. - * @param {Number} near The distance to the near plane in meters. - * @param {Number} far The distance to the far plane in meters. + * @param {number} fovY The field of view along the Y axis in radians. + * @param {number} aspectRatio The aspect ratio. + * @param {number} near The distance to the near plane in meters. + * @param {number} far The distance to the far plane in meters. * @param {Matrix4} result The object in which the result will be stored. * @returns {Matrix4} The modified result parameter. * @@ -874,12 +874,12 @@ Matrix4.computePerspectiveFieldOfView = function ( /** * Computes a Matrix4 instance representing an orthographic transformation matrix. * - * @param {Number} left The number of meters to the left of the camera that will be in view. - * @param {Number} right The number of meters to the right of the camera that will be in view. - * @param {Number} bottom The number of meters below of the camera that will be in view. - * @param {Number} top The number of meters above of the camera that will be in view. - * @param {Number} near The distance to the near plane in meters. - * @param {Number} far The distance to the far plane in meters. + * @param {number} left The number of meters to the left of the camera that will be in view. + * @param {number} right The number of meters to the right of the camera that will be in view. + * @param {number} bottom The number of meters below of the camera that will be in view. + * @param {number} top The number of meters above of the camera that will be in view. + * @param {number} near The distance to the near plane in meters. + * @param {number} far The distance to the far plane in meters. * @param {Matrix4} result The object in which the result will be stored. * @returns {Matrix4} The modified result parameter. */ @@ -935,12 +935,12 @@ Matrix4.computeOrthographicOffCenter = function ( /** * Computes a Matrix4 instance representing an off center perspective transformation. * - * @param {Number} left The number of meters to the left of the camera that will be in view. - * @param {Number} right The number of meters to the right of the camera that will be in view. - * @param {Number} bottom The number of meters below of the camera that will be in view. - * @param {Number} top The number of meters above of the camera that will be in view. - * @param {Number} near The distance to the near plane in meters. - * @param {Number} far The distance to the far plane in meters. + * @param {number} left The number of meters to the left of the camera that will be in view. + * @param {number} right The number of meters to the right of the camera that will be in view. + * @param {number} bottom The number of meters below of the camera that will be in view. + * @param {number} top The number of meters above of the camera that will be in view. + * @param {number} near The distance to the near plane in meters. + * @param {number} far The distance to the far plane in meters. * @param {Matrix4} result The object in which the result will be stored. * @returns {Matrix4} The modified result parameter. */ @@ -993,11 +993,11 @@ Matrix4.computePerspectiveOffCenter = function ( /** * Computes a Matrix4 instance representing an infinite off center perspective transformation. * - * @param {Number} left The number of meters to the left of the camera that will be in view. - * @param {Number} right The number of meters to the right of the camera that will be in view. - * @param {Number} bottom The number of meters below of the camera that will be in view. - * @param {Number} top The number of meters above of the camera that will be in view. - * @param {Number} near The distance to the near plane in meters. + * @param {number} left The number of meters to the left of the camera that will be in view. + * @param {number} right The number of meters to the right of the camera that will be in view. + * @param {number} bottom The number of meters below of the camera that will be in view. + * @param {number} top The number of meters above of the camera that will be in view. + * @param {number} near The distance to the near plane in meters. * @param {Matrix4} result The object in which the result will be stored. * @returns {Matrix4} The modified result parameter. */ @@ -1048,9 +1048,9 @@ Matrix4.computeInfinitePerspectiveOffCenter = function ( /** * Computes a Matrix4 instance that transforms from normalized device coordinates to window coordinates. * - * @param {Object} [viewport = { x : 0.0, y : 0.0, width : 0.0, height : 0.0 }] The viewport's corners as shown in Example 1. - * @param {Number} [nearDepthRange=0.0] The near plane distance in window coordinates. - * @param {Number} [farDepthRange=1.0] The far plane distance in window coordinates. + * @param {object} [viewport = { x : 0.0, y : 0.0, width : 0.0, height : 0.0 }] The viewport's corners as shown in Example 1. + * @param {number} [nearDepthRange=0.0] The near plane distance in window coordinates. + * @param {number} [farDepthRange=1.0] The far plane distance in window coordinates. * @param {Matrix4} [result] The object in which the result will be stored. * @returns {Matrix4} The modified result parameter. * @@ -1156,8 +1156,8 @@ Matrix4.computeView = function (position, direction, up, right, result) { * The array will be in column-major order. * * @param {Matrix4} matrix The matrix to use.. - * @param {Number[]} [result] The Array onto which to store the result. - * @returns {Number[]} The modified Array parameter or a new Array instance if one was not provided. + * @param {number[]} [result] The Array onto which to store the result. + * @returns {number[]} The modified Array parameter or a new Array instance if one was not provided. * * @example * //create an array from an instance of Matrix4 @@ -1217,9 +1217,9 @@ Matrix4.toArray = function (matrix, result) { /** * Computes the array index of the element at the provided row and column. * - * @param {Number} row The zero-based index of the row. - * @param {Number} column The zero-based index of the column. - * @returns {Number} The index of the element at the provided row and column. + * @param {number} row The zero-based index of the row. + * @param {number} column The zero-based index of the column. + * @returns {number} The index of the element at the provided row and column. * * @exception {DeveloperError} row must be 0, 1, 2, or 3. * @exception {DeveloperError} column must be 0, 1, 2, or 3. @@ -1246,7 +1246,7 @@ Matrix4.getElementIndex = function (column, row) { * Retrieves a copy of the matrix column at the provided index as a Cartesian4 instance. * * @param {Matrix4} matrix The matrix to use. - * @param {Number} index The zero-based index of the column to retrieve. + * @param {number} index The zero-based index of the column to retrieve. * @param {Cartesian4} result The object onto which to store the result. * @returns {Cartesian4} The modified result parameter. * @@ -1296,7 +1296,7 @@ Matrix4.getColumn = function (matrix, index, result) { * Computes a new matrix that replaces the specified column in the provided matrix with the provided Cartesian4 instance. * * @param {Matrix4} matrix The matrix to use. - * @param {Number} index The zero-based index of the column to set. + * @param {number} index The zero-based index of the column to set. * @param {Cartesian4} cartesian The Cartesian whose values will be assigned to the specified column. * @param {Matrix4} result The object onto which to store the result. * @returns {Matrix4} The modified result parameter. @@ -1342,7 +1342,7 @@ Matrix4.setColumn = function (matrix, index, cartesian, result) { * Retrieves a copy of the matrix row at the provided index as a Cartesian4 instance. * * @param {Matrix4} matrix The matrix to use. - * @param {Number} index The zero-based index of the row to retrieve. + * @param {number} index The zero-based index of the row to retrieve. * @param {Cartesian4} result The object onto which to store the result. * @returns {Cartesian4} The modified result parameter. * @@ -1391,7 +1391,7 @@ Matrix4.getRow = function (matrix, index, result) { * Computes a new matrix that replaces the specified row in the provided matrix with the provided Cartesian4 instance. * * @param {Matrix4} matrix The matrix to use. - * @param {Number} index The zero-based index of the row to set. + * @param {number} index The zero-based index of the row to set. * @param {Cartesian4} cartesian The Cartesian whose values will be assigned to the specified row. * @param {Matrix4} result The object onto which to store the result. * @returns {Matrix4} The modified result parameter. @@ -1531,7 +1531,7 @@ const scaleScratch2 = new Cartesian3(); * This assumes the matrix is an affine transformation. * * @param {Matrix4} matrix The matrix to use. - * @param {Number} scale The uniform scale that replaces the scale of the provided matrix. + * @param {number} scale The uniform scale that replaces the scale of the provided matrix. * @param {Matrix4} result The object onto which to store the result. * @returns {Matrix4} The modified result parameter. * @@ -1619,7 +1619,7 @@ const scaleScratch3 = new Cartesian3(); * 3x3 matrix. * * @param {Matrix4} matrix The matrix. - * @returns {Number} The maximum scale. + * @returns {number} The maximum scale. */ Matrix4.getMaximumScale = function (matrix) { Matrix4.getScale(matrix, scaleScratch3); @@ -2154,7 +2154,7 @@ Matrix4.multiplyByScale = function (matrix, scale, result) { * Computes the product of a matrix times a uniform scale, as if the scale were a scale matrix. * * @param {Matrix4} matrix The matrix on the left-hand side. - * @param {Number} scale The uniform scale on the right-hand side. + * @param {number} scale The uniform scale on the right-hand side. * @param {Matrix4} result The object onto which to store the result. * @returns {Matrix4} The modified result parameter. * @@ -2306,7 +2306,7 @@ Matrix4.multiplyByPoint = function (matrix, cartesian, result) { * Computes the product of a matrix and a scalar. * * @param {Matrix4} matrix The matrix. - * @param {Number} scalar The number to multiply by. + * @param {number} scalar The number to multiply by. * @param {Matrix4} result The object onto which to store the result. * @returns {Matrix4} The modified result parameter. * @@ -2491,7 +2491,7 @@ Matrix4.abs = function (matrix, result) { * * @param {Matrix4} [left] The first matrix. * @param {Matrix4} [right] The second matrix. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. * * @example * //compares two Matrix4 instances @@ -2552,8 +2552,8 @@ Matrix4.equals = function (left, right) { * * @param {Matrix4} [left] The first matrix. * @param {Matrix4} [right] The second matrix. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. * * @example * //compares two Matrix4 instances @@ -3019,7 +3019,7 @@ Matrix4.ZERO = Object.freeze( /** * The index into Matrix4 for column 0, row 0. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN0ROW0 = 0; @@ -3027,7 +3027,7 @@ Matrix4.COLUMN0ROW0 = 0; /** * The index into Matrix4 for column 0, row 1. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN0ROW1 = 1; @@ -3035,7 +3035,7 @@ Matrix4.COLUMN0ROW1 = 1; /** * The index into Matrix4 for column 0, row 2. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN0ROW2 = 2; @@ -3043,7 +3043,7 @@ Matrix4.COLUMN0ROW2 = 2; /** * The index into Matrix4 for column 0, row 3. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN0ROW3 = 3; @@ -3051,7 +3051,7 @@ Matrix4.COLUMN0ROW3 = 3; /** * The index into Matrix4 for column 1, row 0. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN1ROW0 = 4; @@ -3059,7 +3059,7 @@ Matrix4.COLUMN1ROW0 = 4; /** * The index into Matrix4 for column 1, row 1. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN1ROW1 = 5; @@ -3067,7 +3067,7 @@ Matrix4.COLUMN1ROW1 = 5; /** * The index into Matrix4 for column 1, row 2. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN1ROW2 = 6; @@ -3075,7 +3075,7 @@ Matrix4.COLUMN1ROW2 = 6; /** * The index into Matrix4 for column 1, row 3. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN1ROW3 = 7; @@ -3083,7 +3083,7 @@ Matrix4.COLUMN1ROW3 = 7; /** * The index into Matrix4 for column 2, row 0. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN2ROW0 = 8; @@ -3091,7 +3091,7 @@ Matrix4.COLUMN2ROW0 = 8; /** * The index into Matrix4 for column 2, row 1. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN2ROW1 = 9; @@ -3099,7 +3099,7 @@ Matrix4.COLUMN2ROW1 = 9; /** * The index into Matrix4 for column 2, row 2. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN2ROW2 = 10; @@ -3107,7 +3107,7 @@ Matrix4.COLUMN2ROW2 = 10; /** * The index into Matrix4 for column 2, row 3. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN2ROW3 = 11; @@ -3115,7 +3115,7 @@ Matrix4.COLUMN2ROW3 = 11; /** * The index into Matrix4 for column 3, row 0. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN3ROW0 = 12; @@ -3123,7 +3123,7 @@ Matrix4.COLUMN3ROW0 = 12; /** * The index into Matrix4 for column 3, row 1. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN3ROW1 = 13; @@ -3131,7 +3131,7 @@ Matrix4.COLUMN3ROW1 = 13; /** * The index into Matrix4 for column 3, row 2. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN3ROW2 = 14; @@ -3139,7 +3139,7 @@ Matrix4.COLUMN3ROW2 = 14; /** * The index into Matrix4 for column 3, row 3. * - * @type {Number} + * @type {number} * @constant */ Matrix4.COLUMN3ROW3 = 15; @@ -3149,7 +3149,7 @@ Object.defineProperties(Matrix4.prototype, { * Gets the number of items in the collection. * @memberof Matrix4.prototype * - * @type {Number} + * @type {number} */ length: { get: function () { @@ -3173,7 +3173,7 @@ Matrix4.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {Matrix4} [right] The right hand side matrix. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ Matrix4.prototype.equals = function (right) { return Matrix4.equals(this, right); @@ -3209,8 +3209,8 @@ Matrix4.equalsArray = function (matrix, array, offset) { * false otherwise. * * @param {Matrix4} [right] The right hand side matrix. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if they are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if they are within the provided epsilon, false otherwise. */ Matrix4.prototype.equalsEpsilon = function (right, epsilon) { return Matrix4.equalsEpsilon(this, right, epsilon); @@ -3220,7 +3220,7 @@ Matrix4.prototype.equalsEpsilon = function (right, epsilon) { * Computes a string representing this Matrix with each row being * on a separate line and in the format '(column0, column1, column2, column3)'. * - * @returns {String} A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1, column2, column3)'. + * @returns {string} A string representing the provided Matrix with each row being on a separate line and in the format '(column0, column1, column2, column3)'. */ Matrix4.prototype.toString = function () { return ( diff --git a/packages/engine/Source/Core/MorphWeightSpline.js b/packages/engine/Source/Core/MorphWeightSpline.js index 76e2d211b383..d566c1e604f7 100644 --- a/packages/engine/Source/Core/MorphWeightSpline.js +++ b/packages/engine/Source/Core/MorphWeightSpline.js @@ -10,10 +10,10 @@ import Spline from "./Spline.js"; * @alias MorphWeightSpline * @constructor * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. + * @param {object} options Object with the following properties: + * @param {number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. - * @param {Number[]} options.weights The array of floating-point control weights given. The weights are ordered such + * @param {number[]} options.weights The array of floating-point control weights given. The weights are ordered such * that all weights for the targets are given in chronological order and order in which they appear in * the glTF from which the morph targets come. This means for 2 targets, weights = [w(0,0), w(0,1), w(1,0), w(1,1) ...] * where i and j in w(i,j) are the time indices and target indices, respectively. @@ -69,7 +69,7 @@ Object.defineProperties(MorphWeightSpline.prototype, { * * @memberof WeightSpline.prototype * - * @type {Number[]} + * @type {number[]} * @readonly */ times: { @@ -83,7 +83,7 @@ Object.defineProperties(MorphWeightSpline.prototype, { * * @memberof WeightSpline.prototype * - * @type {Number[]} + * @type {number[]} * @readonly */ weights: { @@ -98,8 +98,8 @@ Object.defineProperties(MorphWeightSpline.prototype, { * time is in the interval [times[i], times[i + 1]]. * @function * - * @param {Number} time The time. - * @returns {Number} The index for the element at the start of the interval. + * @param {number} time The time. + * @returns {number} The index for the element at the start of the interval. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element @@ -112,8 +112,8 @@ MorphWeightSpline.prototype.findTimeInterval = * Wraps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, wrapped around to the updated animation. + * @param {number} time The time. + * @return {number} The time, wrapped around to the updated animation. */ MorphWeightSpline.prototype.wrapTime = Spline.prototype.wrapTime; @@ -121,17 +121,17 @@ MorphWeightSpline.prototype.wrapTime = Spline.prototype.wrapTime; * Clamps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, clamped to the animation period. + * @param {number} time The time. + * @return {number} The time, clamped to the animation period. */ MorphWeightSpline.prototype.clampTime = Spline.prototype.clampTime; /** * Evaluates the curve at a given time. * - * @param {Number} time The time at which to evaluate the curve. - * @param {Number[]} [result] The object onto which to store the result. - * @returns {Number[]} The modified result parameter or a new instance of the point on the curve at the given time. + * @param {number} time The time at which to evaluate the curve. + * @param {number[]} [result] The object onto which to store the result. + * @returns {number[]} The modified result parameter or a new instance of the point on the curve at the given time. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element diff --git a/packages/engine/Source/Core/MortonOrder.js b/packages/engine/Source/Core/MortonOrder.js index 9f3cb94ef3c4..390abf913957 100644 --- a/packages/engine/Source/Core/MortonOrder.js +++ b/packages/engine/Source/Core/MortonOrder.js @@ -22,8 +22,8 @@ const MortonOrder = {}; * output: 20 * * @private - * @param {Number} v A 16-bit unsigned integer. - * @returns {Number} A 32-bit unsigned integer. + * @param {number} v A 16-bit unsigned integer. + * @returns {number} A 32-bit unsigned integer. * @see {@link https://fgiesen.wordpress.com/2009/12/13/decoding-morton-codes/} * @private */ @@ -46,8 +46,8 @@ function insertOneSpacing(v) { * output: 72 * * @private - * @param {Number} v A 10-bit unsigned integer. - * @returns {Number} A 30-bit unsigned integer. + * @param {number} v A 10-bit unsigned integer. + * @returns {number} A 30-bit unsigned integer. * @see {@link https://fgiesen.wordpress.com/2009/12/13/decoding-morton-codes/} */ function insertTwoSpacing(v) { @@ -69,8 +69,8 @@ function insertTwoSpacing(v) { * output: 6 * * @private - * @param {Number} v A 32-bit unsigned integer. - * @returns {Number} A 16-bit unsigned integer. + * @param {number} v A 32-bit unsigned integer. + * @returns {number} A 16-bit unsigned integer. * @see {@link https://fgiesen.wordpress.com/2009/12/13/decoding-morton-codes/} */ function removeOneSpacing(v) { @@ -93,8 +93,8 @@ function removeOneSpacing(v) { * output: 6 * * @private - * @param {Number} v A 30-bit unsigned integer. - * @returns {Number} A 10-bit unsigned integer. + * @param {number} v A 30-bit unsigned integer. + * @returns {number} A 10-bit unsigned integer. * @see {@link https://fgiesen.wordpress.com/2009/12/13/decoding-morton-codes/} */ function removeTwoSpacing(v) { @@ -110,9 +110,9 @@ function removeTwoSpacing(v) { * Computes the Morton index from 2D coordinates. This is equivalent to interleaving their bits. * The inputs must be 16-bit unsigned integers (resulting in 32-bit Morton index) due to 32-bit bitwise operator limitation in JavaScript. * - * @param {Number} x The X coordinate in the range [0, (2^16)-1]. - * @param {Number} y The Y coordinate in the range [0, (2^16)-1]. - * @returns {Number} The Morton index. + * @param {number} x The X coordinate in the range [0, (2^16)-1]. + * @param {number} y The Y coordinate in the range [0, (2^16)-1]. + * @returns {number} The Morton index. * @private */ MortonOrder.encode2D = function (x, y) { @@ -135,9 +135,9 @@ MortonOrder.encode2D = function (x, y) { * Computes the 2D coordinates from a Morton index. This is equivalent to deinterleaving their bits. * The input must be a 32-bit unsigned integer (resulting in 16 bits per coordinate) due to 32-bit bitwise operator limitation in JavaScript. * - * @param {Number} mortonIndex The Morton index in the range [0, (2^32)-1]. - * @param {Number[]} [result] The array onto which to store the result. - * @returns {Number[]} An array containing the 2D coordinates correspoding to the Morton index. + * @param {number} mortonIndex The Morton index in the range [0, (2^32)-1]. + * @param {number[]} [result] The array onto which to store the result. + * @returns {number[]} An array containing the 2D coordinates correspoding to the Morton index. * @private */ MortonOrder.decode2D = function (mortonIndex, result) { @@ -161,10 +161,10 @@ MortonOrder.decode2D = function (mortonIndex, result) { * Computes the Morton index from 3D coordinates. This is equivalent to interleaving their bits. * The inputs must be 10-bit unsigned integers (resulting in 30-bit Morton index) due to 32-bit bitwise operator limitation in JavaScript. * - * @param {Number} x The X coordinate in the range [0, (2^10)-1]. - * @param {Number} y The Y coordinate in the range [0, (2^10)-1]. - * @param {Number} z The Z coordinate in the range [0, (2^10)-1]. - * @returns {Number} The Morton index. + * @param {number} x The X coordinate in the range [0, (2^10)-1]. + * @param {number} y The Y coordinate in the range [0, (2^10)-1]. + * @param {number} z The Z coordinate in the range [0, (2^10)-1]. + * @returns {number} The Morton index. * @private */ MortonOrder.encode3D = function (x, y, z) { @@ -188,9 +188,9 @@ MortonOrder.encode3D = function (x, y, z) { * Computes the 3D coordinates from a Morton index. This is equivalent to deinterleaving their bits. * The input must be a 30-bit unsigned integer (resulting in 10 bits per coordinate) due to 32-bit bitwise operator limitation in JavaScript. * - * @param {Number} mortonIndex The Morton index in the range [0, (2^30)-1]. - * @param {Number[]} [result] The array onto which to store the result. - * @returns {Number[]} An array containing the 3D coordinates corresponding to the Morton index. + * @param {number} mortonIndex The Morton index in the range [0, (2^30)-1]. + * @param {number[]} [result] The array onto which to store the result. + * @returns {number[]} An array containing the 3D coordinates corresponding to the Morton index. * @private */ MortonOrder.decode3D = function (mortonIndex, result) { diff --git a/packages/engine/Source/Core/NearFarScalar.js b/packages/engine/Source/Core/NearFarScalar.js index 61eb59a0dd03..9b693fcc6387 100644 --- a/packages/engine/Source/Core/NearFarScalar.js +++ b/packages/engine/Source/Core/NearFarScalar.js @@ -7,35 +7,35 @@ import DeveloperError from "./DeveloperError.js"; * @alias NearFarScalar * @constructor * - * @param {Number} [near=0.0] The lower bound of the camera range. - * @param {Number} [nearValue=0.0] The value at the lower bound of the camera range. - * @param {Number} [far=1.0] The upper bound of the camera range. - * @param {Number} [farValue=0.0] The value at the upper bound of the camera range. + * @param {number} [near=0.0] The lower bound of the camera range. + * @param {number} [nearValue=0.0] The value at the lower bound of the camera range. + * @param {number} [far=1.0] The upper bound of the camera range. + * @param {number} [farValue=0.0] The value at the upper bound of the camera range. * * @see Packable */ function NearFarScalar(near, nearValue, far, farValue) { /** * The lower bound of the camera range. - * @type {Number} + * @type {number} * @default 0.0 */ this.near = defaultValue(near, 0.0); /** * The value at the lower bound of the camera range. - * @type {Number} + * @type {number} * @default 0.0 */ this.nearValue = defaultValue(nearValue, 0.0); /** * The upper bound of the camera range. - * @type {Number} + * @type {number} * @default 1.0 */ this.far = defaultValue(far, 1.0); /** * The value at the upper bound of the camera range. - * @type {Number} + * @type {number} * @default 0.0 */ this.farValue = defaultValue(farValue, 0.0); @@ -71,7 +71,7 @@ NearFarScalar.clone = function (nearFarScalar, result) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ NearFarScalar.packedLength = 4; @@ -79,10 +79,10 @@ NearFarScalar.packedLength = 4; * Stores the provided instance into the provided array. * * @param {NearFarScalar} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ NearFarScalar.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -107,8 +107,8 @@ NearFarScalar.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {NearFarScalar} [result] The object into which to store the result. * @returns {NearFarScalar} The modified result parameter or a new NearFarScalar instance if one was not provided. */ @@ -137,7 +137,7 @@ NearFarScalar.unpack = function (array, startingIndex, result) { * * @param {NearFarScalar} [left] The first NearFarScalar. * @param {NearFarScalar} [right] The second NearFarScalar. - * @returns {Boolean} true if left and right are equal; otherwise false. + * @returns {boolean} true if left and right are equal; otherwise false. */ NearFarScalar.equals = function (left, right) { return ( @@ -166,7 +166,7 @@ NearFarScalar.prototype.clone = function (result) { * false otherwise. * * @param {NearFarScalar} [right] The right hand side NearFarScalar. - * @returns {Boolean} true if left and right are equal; otherwise false. + * @returns {boolean} true if left and right are equal; otherwise false. */ NearFarScalar.prototype.equals = function (right) { return NearFarScalar.equals(this, right); diff --git a/packages/engine/Source/Core/Occluder.js b/packages/engine/Source/Core/Occluder.js index 9f7b69899e4a..cf247a0c3600 100644 --- a/packages/engine/Source/Core/Occluder.js +++ b/packages/engine/Source/Core/Occluder.js @@ -65,7 +65,7 @@ Object.defineProperties(Occluder.prototype, { /** * The radius of the occluder. * @memberof Occluder.prototype - * @type {Number} + * @type {number} */ radius: { get: function () { @@ -175,7 +175,7 @@ const tempVecScratch = new Cartesian3(); * Determines whether or not a point, the occludee, is hidden from view by the occluder. * * @param {Cartesian3} occludee The point surrounding the occludee object. - * @returns {Boolean} true if the occludee is visible; otherwise false. + * @returns {boolean} true if the occludee is visible; otherwise false. * * * @example @@ -211,7 +211,7 @@ const occludeePositionScratch = new Cartesian3(); * Determines whether or not a sphere, the occludee, is hidden from view by the occluder. * * @param {BoundingSphere} occludee The bounding sphere surrounding the occludee object. - * @returns {Boolean} true if the occludee is visible; otherwise false. + * @returns {boolean} true if the occludee is visible; otherwise false. * * * @example @@ -389,7 +389,7 @@ const occludeePointScratch = new Cartesian3(); * @param {BoundingSphere} occluderBoundingSphere The bounding sphere surrounding the occluder. * @param {Cartesian3} occludeePosition The point where the occludee (bounding sphere of radius 0) is located. * @param {Cartesian3[]} positions List of altitude points on the horizon near the surface of the occluder. - * @returns {Object} An object containing two attributes: occludeePoint and valid + * @returns {object} An object containing two attributes: occludeePoint and valid * which is a boolean value. * * @exception {DeveloperError} positions must contain at least one element. @@ -500,7 +500,7 @@ const computeOccludeePointFromRectangleScratch = []; * * @param {Rectangle} rectangle The rectangle used to create a bounding sphere. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid used to determine positions of the rectangle. - * @returns {Object} An object containing two attributes: occludeePoint and valid + * @returns {object} An object containing two attributes: occludeePoint and valid * which is a boolean value. */ Occluder.computeOccludeePointFromRectangle = function (rectangle, ellipsoid) { diff --git a/packages/engine/Source/Core/OffsetGeometryInstanceAttribute.js b/packages/engine/Source/Core/OffsetGeometryInstanceAttribute.js index ca643f2e1108..039d0b2136af 100644 --- a/packages/engine/Source/Core/OffsetGeometryInstanceAttribute.js +++ b/packages/engine/Source/Core/OffsetGeometryInstanceAttribute.js @@ -9,9 +9,9 @@ import defined from "./defined.js"; * @alias OffsetGeometryInstanceAttribute * @constructor * - * @param {Number} [x=0] The x translation - * @param {Number} [y=0] The y translation - * @param {Number} [z=0] The z translation + * @param {number} [x=0] The x translation + * @param {number} [y=0] The y translation + * @param {number} [z=0] The z translation * * @private * @@ -54,7 +54,7 @@ Object.defineProperties(OffsetGeometryInstanceAttribute.prototype, { * * @memberof OffsetGeometryInstanceAttribute.prototype * - * @type {Number} + * @type {number} * @readonly * * @default 3 @@ -72,7 +72,7 @@ Object.defineProperties(OffsetGeometryInstanceAttribute.prototype, { * * @memberof OffsetGeometryInstanceAttribute.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false diff --git a/packages/engine/Source/Core/OpenCageGeocoderService.js b/packages/engine/Source/Core/OpenCageGeocoderService.js index ca575c97d546..f49342b73f2a 100644 --- a/packages/engine/Source/Core/OpenCageGeocoderService.js +++ b/packages/engine/Source/Core/OpenCageGeocoderService.js @@ -11,22 +11,22 @@ import Resource from "./Resource.js"; * @alias OpenCageGeocoderService * @constructor * - * @param {Resource|String} url The endpoint to the OpenCage server. - * @param {String} apiKey The OpenCage API Key. - * @param {Object} [params] An object with the following properties (See https://opencagedata.com/api#forward-opt): - * @param {Number} [params.abbrv] When set to 1 we attempt to abbreviate and shorten the formatted string we return. - * @param {Number} [options.add_request] When set to 1 the various request parameters are added to the response for ease of debugging. - * @param {String} [options.bounds] Provides the geocoder with a hint to the region that the query resides in. - * @param {String} [options.countrycode] Restricts the results to the specified country or countries (as defined by the ISO 3166-1 Alpha 2 standard). - * @param {String} [options.jsonp] Wraps the returned JSON with a function name. - * @param {String} [options.language] An IETF format language code. - * @param {Number} [options.limit] The maximum number of results we should return. - * @param {Number} [options.min_confidence] An integer from 1-10. Only results with at least this confidence will be returned. - * @param {Number} [options.no_annotations] When set to 1 results will not contain annotations. - * @param {Number} [options.no_dedupe] When set to 1 results will not be deduplicated. - * @param {Number} [options.no_record] When set to 1 the query contents are not logged. - * @param {Number} [options.pretty] When set to 1 results are 'pretty' printed for easier reading. Useful for debugging. - * @param {String} [options.proximity] Provides the geocoder with a hint to bias results in favour of those closer to the specified location (For example: 41.40139,2.12870). + * @param {Resource|string} url The endpoint to the OpenCage server. + * @param {string} apiKey The OpenCage API Key. + * @param {object} [params] An object with the following properties (See https://opencagedata.com/api#forward-opt): + * @param {number} [params.abbrv] When set to 1 we attempt to abbreviate and shorten the formatted string we return. + * @param {number} [options.add_request] When set to 1 the various request parameters are added to the response for ease of debugging. + * @param {string} [options.bounds] Provides the geocoder with a hint to the region that the query resides in. + * @param {string} [options.countrycode] Restricts the results to the specified country or countries (as defined by the ISO 3166-1 Alpha 2 standard). + * @param {string} [options.jsonp] Wraps the returned JSON with a function name. + * @param {string} [options.language] An IETF format language code. + * @param {number} [options.limit] The maximum number of results we should return. + * @param {number} [options.min_confidence] An integer from 1-10. Only results with at least this confidence will be returned. + * @param {number} [options.no_annotations] When set to 1 results will not contain annotations. + * @param {number} [options.no_dedupe] When set to 1 results will not be deduplicated. + * @param {number} [options.no_record] When set to 1 the query contents are not logged. + * @param {number} [options.pretty] When set to 1 results are 'pretty' printed for easier reading. Useful for debugging. + * @param {string} [options.proximity] Provides the geocoder with a hint to bias results in favour of those closer to the specified location (For example: 41.40139,2.12870). * * @example * // Configure a Viewer to use the OpenCage Geocoder @@ -64,7 +64,7 @@ Object.defineProperties(OpenCageGeocoderService.prototype, { }, /** * Optional params passed to OpenCage in order to customize geocoding - * @type {Object} + * @type {object} * @memberof OpenCageGeocoderService.prototype * @readonly */ @@ -78,7 +78,7 @@ Object.defineProperties(OpenCageGeocoderService.prototype, { /** * @function * - * @param {String} query The query to be sent to the geocoder service + * @param {string} query The query to be sent to the geocoder service * @returns {Promise} */ OpenCageGeocoderService.prototype.geocode = function (query) { diff --git a/packages/engine/Source/Core/OrientedBoundingBox.js b/packages/engine/Source/Core/OrientedBoundingBox.js index f18ebabd3d9d..59fe1d019aeb 100644 --- a/packages/engine/Source/Core/OrientedBoundingBox.js +++ b/packages/engine/Source/Core/OrientedBoundingBox.js @@ -55,7 +55,7 @@ function OrientedBoundingBox(center, halfAxes) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ OrientedBoundingBox.packedLength = Cartesian3.packedLength + Matrix3.packedLength; @@ -64,10 +64,10 @@ OrientedBoundingBox.packedLength = * Stores the provided instance into the provided array. * * @param {OrientedBoundingBox} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ OrientedBoundingBox.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -86,8 +86,8 @@ OrientedBoundingBox.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {OrientedBoundingBox} [result] The object into which to store the result. * @returns {OrientedBoundingBox} The modified result parameter or a new OrientedBoundingBox instance if one was not provided. */ @@ -328,8 +328,8 @@ const scratchPlane = new Plane(Cartesian3.UNIT_X, 0.0); * There are no guarantees about the orientation of the bounding box. * * @param {Rectangle} rectangle The cartographic rectangle on the surface of the ellipsoid. - * @param {Number} [minimumHeight=0.0] The minimum height (elevation) within the tile. - * @param {Number} [maximumHeight=0.0] The maximum height (elevation) within the tile. + * @param {number} [minimumHeight=0.0] The minimum height (elevation) within the tile. + * @param {number} [maximumHeight=0.0] The maximum height (elevation) within the tile. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle is defined. * @param {OrientedBoundingBox} [result] The object onto which to store the result. * @returns {OrientedBoundingBox} The modified result parameter or a new OrientedBoundingBox instance if none was provided. @@ -724,7 +724,7 @@ const scratchPPrime = new Cartesian3(); * * @param {OrientedBoundingBox} box The box. * @param {Cartesian3} cartesian The point - * @returns {Number} The distance squared from the oriented bounding box to the point. Returns 0 if the point is inside the box. + * @returns {number} The distance squared from the oriented bounding box to the point. Returns 0 if the point is inside the box. * * @example * // Sort bounding boxes from back to front @@ -1126,7 +1126,7 @@ const scratchBoundingSphere = new BoundingSphere(); * * @param {OrientedBoundingBox} box The bounding box surrounding the occludee object. * @param {Occluder} occluder The occluder. - * @returns {Boolean} true if the box is not visible; otherwise false. + * @returns {boolean} true if the box is not visible; otherwise false. */ OrientedBoundingBox.isOccluded = function (box, occluder) { //>>includeStart('debug', pragmas.debug); @@ -1163,7 +1163,7 @@ OrientedBoundingBox.prototype.intersectPlane = function (plane) { * Computes the estimated distance squared from the closest point on a bounding box to a point. * * @param {Cartesian3} cartesian The point - * @returns {Number} The estimated distance squared from the bounding sphere to the point. + * @returns {number} The estimated distance squared from the bounding sphere to the point. * * @example * // Sort bounding boxes from back to front @@ -1223,7 +1223,7 @@ OrientedBoundingBox.prototype.computeTransformation = function (result) { * Determines whether or not a bounding box is hidden from view by the occluder. * * @param {Occluder} occluder The occluder. - * @returns {Boolean} true if the sphere is not visible; otherwise false. + * @returns {boolean} true if the sphere is not visible; otherwise false. */ OrientedBoundingBox.prototype.isOccluded = function (occluder) { return OrientedBoundingBox.isOccluded(this, occluder); @@ -1235,7 +1235,7 @@ OrientedBoundingBox.prototype.isOccluded = function (occluder) { * * @param {OrientedBoundingBox} left The first OrientedBoundingBox. * @param {OrientedBoundingBox} right The second OrientedBoundingBox. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ OrientedBoundingBox.equals = function (left, right) { return ( @@ -1262,7 +1262,7 @@ OrientedBoundingBox.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {OrientedBoundingBox} [right] The right hand side OrientedBoundingBox. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ OrientedBoundingBox.prototype.equals = function (right) { return OrientedBoundingBox.equals(this, right); diff --git a/packages/engine/Source/Core/OrthographicFrustum.js b/packages/engine/Source/Core/OrthographicFrustum.js index c1a5e7974139..6e45f6b1b199 100644 --- a/packages/engine/Source/Core/OrthographicFrustum.js +++ b/packages/engine/Source/Core/OrthographicFrustum.js @@ -14,11 +14,11 @@ import OrthographicOffCenterFrustum from "./OrthographicOffCenterFrustum.js"; * @alias OrthographicFrustum * @constructor * - * @param {Object} [options] An object with the following properties: - * @param {Number} [options.width] The width of the frustum in meters. - * @param {Number} [options.aspectRatio] The aspect ratio of the frustum's width to it's height. - * @param {Number} [options.near=1.0] The distance of the near plane. - * @param {Number} [options.far=500000000.0] The distance of the far plane. + * @param {object} [options] An object with the following properties: + * @param {number} [options.width] The width of the frustum in meters. + * @param {number} [options.aspectRatio] The aspect ratio of the frustum's width to it's height. + * @param {number} [options.near=1.0] The distance of the near plane. + * @param {number} [options.far=500000000.0] The distance of the far plane. * * @example * const maxRadii = ellipsoid.maximumRadius; @@ -34,7 +34,7 @@ function OrthographicFrustum(options) { /** * The horizontal width of the frustum in meters. - * @type {Number} + * @type {number} * @default undefined */ this.width = options.width; @@ -42,7 +42,7 @@ function OrthographicFrustum(options) { /** * The aspect ratio of the frustum's width to it's height. - * @type {Number} + * @type {number} * @default undefined */ this.aspectRatio = options.aspectRatio; @@ -50,7 +50,7 @@ function OrthographicFrustum(options) { /** * The distance of the near plane. - * @type {Number} + * @type {number} * @default 1.0 */ this.near = defaultValue(options.near, 1.0); @@ -58,7 +58,7 @@ function OrthographicFrustum(options) { /** * The distance of the far plane. - * @type {Number} + * @type {number} * @default 500000000.0; */ this.far = defaultValue(options.far, 500000000.0); @@ -67,7 +67,7 @@ function OrthographicFrustum(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ OrthographicFrustum.packedLength = 4; @@ -75,10 +75,10 @@ OrthographicFrustum.packedLength = 4; * Stores the provided instance into the provided array. * * @param {OrthographicFrustum} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ OrthographicFrustum.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -99,8 +99,8 @@ OrthographicFrustum.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {OrthographicFrustum} [result] The object into which to store the result. * @returns {OrthographicFrustum} The modified result parameter or a new OrthographicFrustum instance if one was not provided. */ @@ -211,10 +211,10 @@ OrthographicFrustum.prototype.computeCullingVolume = function ( /** * Returns the pixel's width and height in meters. * - * @param {Number} drawingBufferWidth The width of the drawing buffer. - * @param {Number} drawingBufferHeight The height of the drawing buffer. - * @param {Number} distance The distance to the near plane in meters. - * @param {Number} pixelRatio The scaling factor from pixel space to coordinate space. + * @param {number} drawingBufferWidth The width of the drawing buffer. + * @param {number} drawingBufferHeight The height of the drawing buffer. + * @param {number} distance The distance to the near plane in meters. + * @param {number} pixelRatio The scaling factor from pixel space to coordinate space. * @param {Cartesian2} result The object onto which to store the result. * @returns {Cartesian2} The modified result parameter or a new instance of {@link Cartesian2} with the pixel's width and height in the x and y properties, respectively. * @@ -276,7 +276,7 @@ OrthographicFrustum.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {OrthographicFrustum} [other] The right hand side OrthographicFrustum. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ OrthographicFrustum.prototype.equals = function (other) { if (!defined(other) || !(other instanceof OrthographicFrustum)) { @@ -299,9 +299,9 @@ OrthographicFrustum.prototype.equals = function (other) { * false otherwise. * * @param {OrthographicFrustum} other The right hand side OrthographicFrustum. - * @param {Number} relativeEpsilon The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if this and other are within the provided epsilon, false otherwise. + * @param {number} relativeEpsilon The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if this and other are within the provided epsilon, false otherwise. */ OrthographicFrustum.prototype.equalsEpsilon = function ( other, diff --git a/packages/engine/Source/Core/OrthographicOffCenterFrustum.js b/packages/engine/Source/Core/OrthographicOffCenterFrustum.js index fafef3377a91..b99d0c5065bf 100644 --- a/packages/engine/Source/Core/OrthographicOffCenterFrustum.js +++ b/packages/engine/Source/Core/OrthographicOffCenterFrustum.js @@ -16,13 +16,13 @@ import Matrix4 from "./Matrix4.js"; * @alias OrthographicOffCenterFrustum * @constructor * - * @param {Object} [options] An object with the following properties: - * @param {Number} [options.left] The left clipping plane distance. - * @param {Number} [options.right] The right clipping plane distance. - * @param {Number} [options.top] The top clipping plane distance. - * @param {Number} [options.bottom] The bottom clipping plane distance. - * @param {Number} [options.near=1.0] The near clipping plane distance. - * @param {Number} [options.far=500000000.0] The far clipping plane distance. + * @param {object} [options] An object with the following properties: + * @param {number} [options.left] The left clipping plane distance. + * @param {number} [options.right] The right clipping plane distance. + * @param {number} [options.top] The top clipping plane distance. + * @param {number} [options.bottom] The bottom clipping plane distance. + * @param {number} [options.near=1.0] The near clipping plane distance. + * @param {number} [options.far=500000000.0] The far clipping plane distance. * * @example * const maxRadii = ellipsoid.maximumRadius; @@ -40,7 +40,7 @@ function OrthographicOffCenterFrustum(options) { /** * The left clipping plane. - * @type {Number} + * @type {number} * @default undefined */ this.left = options.left; @@ -48,7 +48,7 @@ function OrthographicOffCenterFrustum(options) { /** * The right clipping plane. - * @type {Number} + * @type {number} * @default undefined */ this.right = options.right; @@ -56,7 +56,7 @@ function OrthographicOffCenterFrustum(options) { /** * The top clipping plane. - * @type {Number} + * @type {number} * @default undefined */ this.top = options.top; @@ -64,7 +64,7 @@ function OrthographicOffCenterFrustum(options) { /** * The bottom clipping plane. - * @type {Number} + * @type {number} * @default undefined */ this.bottom = options.bottom; @@ -72,7 +72,7 @@ function OrthographicOffCenterFrustum(options) { /** * The distance of the near plane. - * @type {Number} + * @type {number} * @default 1.0 */ this.near = defaultValue(options.near, 1.0); @@ -80,7 +80,7 @@ function OrthographicOffCenterFrustum(options) { /** * The distance of the far plane. - * @type {Number} + * @type {number} * @default 500000000.0; */ this.far = defaultValue(options.far, 500000000.0); @@ -293,10 +293,10 @@ OrthographicOffCenterFrustum.prototype.computeCullingVolume = function ( /** * Returns the pixel's width and height in meters. * - * @param {Number} drawingBufferWidth The width of the drawing buffer. - * @param {Number} drawingBufferHeight The height of the drawing buffer. - * @param {Number} distance The distance to the near plane in meters. - * @param {Number} pixelRatio The scaling factor from pixel space to coordinate space. + * @param {number} drawingBufferWidth The width of the drawing buffer. + * @param {number} drawingBufferHeight The height of the drawing buffer. + * @param {number} distance The distance to the near plane in meters. + * @param {number} pixelRatio The scaling factor from pixel space to coordinate space. * @param {Cartesian2} result The object onto which to store the result. * @returns {Cartesian2} The modified result parameter or a new instance of {@link Cartesian2} with the pixel's width and height in the x and y properties, respectively. * @@ -388,7 +388,7 @@ OrthographicOffCenterFrustum.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {OrthographicOffCenterFrustum} [other] The right hand side OrthographicOffCenterFrustum. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ OrthographicOffCenterFrustum.prototype.equals = function (other) { return ( @@ -409,9 +409,9 @@ OrthographicOffCenterFrustum.prototype.equals = function (other) { * false otherwise. * * @param {OrthographicOffCenterFrustum} other The right hand side OrthographicOffCenterFrustum. - * @param {Number} relativeEpsilon The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if this and other are within the provided epsilon, false otherwise. + * @param {number} relativeEpsilon The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if this and other are within the provided epsilon, false otherwise. */ OrthographicOffCenterFrustum.prototype.equalsEpsilon = function ( other, diff --git a/packages/engine/Source/Core/Packable.js b/packages/engine/Source/Core/Packable.js index b27ecf00e150..ef167bed20d1 100644 --- a/packages/engine/Source/Core/Packable.js +++ b/packages/engine/Source/Core/Packable.js @@ -12,7 +12,7 @@ import DeveloperError from "./DeveloperError.js"; const Packable = { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ packedLength: undefined, @@ -21,8 +21,8 @@ const Packable = { * @function * * @param {*} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. */ pack: DeveloperError.throwInstantiationError, @@ -30,10 +30,10 @@ const Packable = { * Retrieves an instance from a packed array. * @function * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. - * @param {Object} [result] The object into which to store the result. - * @returns {Object} The modified result parameter or a new Object instance if one was not provided. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {object} [result] The object into which to store the result. + * @returns {object} The modified result parameter or a new Object instance if one was not provided. */ unpack: DeveloperError.throwInstantiationError, }; diff --git a/packages/engine/Source/Core/PackableForInterpolation.js b/packages/engine/Source/Core/PackableForInterpolation.js index caf6f1d1f999..11e4a3885884 100644 --- a/packages/engine/Source/Core/PackableForInterpolation.js +++ b/packages/engine/Source/Core/PackableForInterpolation.js @@ -12,7 +12,7 @@ import DeveloperError from "./DeveloperError.js"; const PackableForInterpolation = { /** * The number of elements used to store the object into an array in its interpolatable form. - * @type {Number} + * @type {number} */ packedInterpolationLength: undefined, @@ -20,10 +20,10 @@ const PackableForInterpolation = { * Converts a packed array into a form suitable for interpolation. * @function * - * @param {Number[]} packedArray The packed array. - * @param {Number} [startingIndex=0] The index of the first element to be converted. - * @param {Number} [lastIndex=packedArray.length] The index of the last element to be converted. - * @param {Number[]} [result] The object into which to store the result. + * @param {number[]} packedArray The packed array. + * @param {number} [startingIndex=0] The index of the first element to be converted. + * @param {number} [lastIndex=packedArray.length] The index of the last element to be converted. + * @param {number[]} [result] The object into which to store the result. */ convertPackedArrayForInterpolation: DeveloperError.throwInstantiationError, @@ -31,12 +31,12 @@ const PackableForInterpolation = { * Retrieves an instance from a packed array converted with {@link PackableForInterpolation.convertPackedArrayForInterpolation}. * @function * - * @param {Number[]} array The array previously packed for interpolation. - * @param {Number[]} sourceArray The original packed array. - * @param {Number} [startingIndex=0] The startingIndex used to convert the array. - * @param {Number} [lastIndex=packedArray.length] The lastIndex used to convert the array. - * @param {Object} [result] The object into which to store the result. - * @returns {Object} The modified result parameter or a new Object instance if one was not provided. + * @param {number[]} array The array previously packed for interpolation. + * @param {number[]} sourceArray The original packed array. + * @param {number} [startingIndex=0] The startingIndex used to convert the array. + * @param {number} [lastIndex=packedArray.length] The lastIndex used to convert the array. + * @param {object} [result] The object into which to store the result. + * @returns {object} The modified result parameter or a new Object instance if one was not provided. */ unpackInterpolationResult: DeveloperError.throwInstantiationError, }; diff --git a/packages/engine/Source/Core/PeliasGeocoderService.js b/packages/engine/Source/Core/PeliasGeocoderService.js index 42d9cc26b2b3..f859d8c07236 100644 --- a/packages/engine/Source/Core/PeliasGeocoderService.js +++ b/packages/engine/Source/Core/PeliasGeocoderService.js @@ -10,7 +10,7 @@ import Resource from "./Resource.js"; * @alias PeliasGeocoderService * @constructor * - * @param {Resource|String} url The endpoint to the Pelias server. + * @param {Resource|string} url The endpoint to the Pelias server. * * @example * // Configure a Viewer to use the Pelias server hosted by https://geocode.earth/ @@ -49,7 +49,7 @@ Object.defineProperties(PeliasGeocoderService.prototype, { /** * @function * - * @param {String} query The query to be sent to the geocoder service + * @param {string} query The query to be sent to the geocoder service * @param {GeocodeType} [type=GeocodeType.SEARCH] The type of geocode to perform. * @returns {Promise} */ diff --git a/packages/engine/Source/Core/PerspectiveFrustum.js b/packages/engine/Source/Core/PerspectiveFrustum.js index 0663a6ab3747..2290af9c9c03 100644 --- a/packages/engine/Source/Core/PerspectiveFrustum.js +++ b/packages/engine/Source/Core/PerspectiveFrustum.js @@ -14,13 +14,13 @@ import PerspectiveOffCenterFrustum from "./PerspectiveOffCenterFrustum.js"; * @alias PerspectiveFrustum * @constructor * - * @param {Object} [options] An object with the following properties: - * @param {Number} [options.fov] The angle of the field of view (FOV), in radians. - * @param {Number} [options.aspectRatio] The aspect ratio of the frustum's width to it's height. - * @param {Number} [options.near=1.0] The distance of the near plane. - * @param {Number} [options.far=500000000.0] The distance of the far plane. - * @param {Number} [options.xOffset=0.0] The offset in the x direction. - * @param {Number} [options.yOffset=0.0] The offset in the y direction. + * @param {object} [options] An object with the following properties: + * @param {number} [options.fov] The angle of the field of view (FOV), in radians. + * @param {number} [options.aspectRatio] The aspect ratio of the frustum's width to it's height. + * @param {number} [options.near=1.0] The distance of the near plane. + * @param {number} [options.far=500000000.0] The distance of the far plane. + * @param {number} [options.xOffset=0.0] The offset in the x direction. + * @param {number} [options.yOffset=0.0] The offset in the y direction. * * @example * const frustum = new Cesium.PerspectiveFrustum({ @@ -41,7 +41,7 @@ function PerspectiveFrustum(options) { * The angle of the field of view (FOV), in radians. This angle will be used * as the horizontal FOV if the width is greater than the height, otherwise * it will be the vertical FOV. - * @type {Number} + * @type {number} * @default undefined */ this.fov = options.fov; @@ -52,7 +52,7 @@ function PerspectiveFrustum(options) { /** * The aspect ratio of the frustum's width to it's height. - * @type {Number} + * @type {number} * @default undefined */ this.aspectRatio = options.aspectRatio; @@ -60,7 +60,7 @@ function PerspectiveFrustum(options) { /** * The distance of the near plane. - * @type {Number} + * @type {number} * @default 1.0 */ this.near = defaultValue(options.near, 1.0); @@ -68,7 +68,7 @@ function PerspectiveFrustum(options) { /** * The distance of the far plane. - * @type {Number} + * @type {number} * @default 500000000.0 */ this.far = defaultValue(options.far, 500000000.0); @@ -76,7 +76,7 @@ function PerspectiveFrustum(options) { /** * Offsets the frustum in the x direction. - * @type {Number} + * @type {number} * @default 0.0 */ this.xOffset = defaultValue(options.xOffset, 0.0); @@ -84,7 +84,7 @@ function PerspectiveFrustum(options) { /** * Offsets the frustum in the y direction. - * @type {Number} + * @type {number} * @default 0.0 */ this.yOffset = defaultValue(options.yOffset, 0.0); @@ -93,7 +93,7 @@ function PerspectiveFrustum(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ PerspectiveFrustum.packedLength = 6; @@ -101,10 +101,10 @@ PerspectiveFrustum.packedLength = 6; * Stores the provided instance into the provided array. * * @param {PerspectiveFrustum} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ PerspectiveFrustum.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -127,8 +127,8 @@ PerspectiveFrustum.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {PerspectiveFrustum} [result] The object into which to store the result. * @returns {PerspectiveFrustum} The modified result parameter or a new PerspectiveFrustum instance if one was not provided. */ @@ -253,7 +253,7 @@ Object.defineProperties(PerspectiveFrustum.prototype, { /** * Gets the angle of the vertical field of view, in radians. * @memberof PerspectiveFrustum.prototype - * @type {Number} + * @type {number} * @readonly * @default undefined */ @@ -301,10 +301,10 @@ PerspectiveFrustum.prototype.computeCullingVolume = function ( /** * Returns the pixel's width and height in meters. * - * @param {Number} drawingBufferWidth The width of the drawing buffer. - * @param {Number} drawingBufferHeight The height of the drawing buffer. - * @param {Number} distance The distance to the near plane in meters. - * @param {Number} pixelRatio The scaling factor from pixel space to coordinate space. + * @param {number} drawingBufferWidth The width of the drawing buffer. + * @param {number} drawingBufferHeight The height of the drawing buffer. + * @param {number} distance The distance to the near plane in meters. + * @param {number} pixelRatio The scaling factor from pixel space to coordinate space. * @param {Cartesian2} result The object onto which to store the result. * @returns {Cartesian2} The modified result parameter or a new instance of {@link Cartesian2} with the pixel's width and height in the x and y properties, respectively. * @@ -377,7 +377,7 @@ PerspectiveFrustum.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {PerspectiveFrustum} [other] The right hand side PerspectiveFrustum. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ PerspectiveFrustum.prototype.equals = function (other) { if (!defined(other) || !(other instanceof PerspectiveFrustum)) { @@ -400,9 +400,9 @@ PerspectiveFrustum.prototype.equals = function (other) { * false otherwise. * * @param {PerspectiveFrustum} other The right hand side PerspectiveFrustum. - * @param {Number} relativeEpsilon The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if this and other are within the provided epsilon, false otherwise. + * @param {number} relativeEpsilon The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if this and other are within the provided epsilon, false otherwise. */ PerspectiveFrustum.prototype.equalsEpsilon = function ( other, diff --git a/packages/engine/Source/Core/PerspectiveOffCenterFrustum.js b/packages/engine/Source/Core/PerspectiveOffCenterFrustum.js index 1cbd78bee16d..00339b199d60 100644 --- a/packages/engine/Source/Core/PerspectiveOffCenterFrustum.js +++ b/packages/engine/Source/Core/PerspectiveOffCenterFrustum.js @@ -16,13 +16,13 @@ import Matrix4 from "./Matrix4.js"; * @alias PerspectiveOffCenterFrustum * @constructor * - * @param {Object} [options] An object with the following properties: - * @param {Number} [options.left] The left clipping plane distance. - * @param {Number} [options.right] The right clipping plane distance. - * @param {Number} [options.top] The top clipping plane distance. - * @param {Number} [options.bottom] The bottom clipping plane distance. - * @param {Number} [options.near=1.0] The near clipping plane distance. - * @param {Number} [options.far=500000000.0] The far clipping plane distance. + * @param {object} [options] An object with the following properties: + * @param {number} [options.left] The left clipping plane distance. + * @param {number} [options.right] The right clipping plane distance. + * @param {number} [options.top] The top clipping plane distance. + * @param {number} [options.bottom] The bottom clipping plane distance. + * @param {number} [options.near=1.0] The near clipping plane distance. + * @param {number} [options.far=500000000.0] The far clipping plane distance. * * @example * const frustum = new Cesium.PerspectiveOffCenterFrustum({ @@ -41,7 +41,7 @@ function PerspectiveOffCenterFrustum(options) { /** * Defines the left clipping plane. - * @type {Number} + * @type {number} * @default undefined */ this.left = options.left; @@ -49,7 +49,7 @@ function PerspectiveOffCenterFrustum(options) { /** * Defines the right clipping plane. - * @type {Number} + * @type {number} * @default undefined */ this.right = options.right; @@ -57,7 +57,7 @@ function PerspectiveOffCenterFrustum(options) { /** * Defines the top clipping plane. - * @type {Number} + * @type {number} * @default undefined */ this.top = options.top; @@ -65,7 +65,7 @@ function PerspectiveOffCenterFrustum(options) { /** * Defines the bottom clipping plane. - * @type {Number} + * @type {number} * @default undefined */ this.bottom = options.bottom; @@ -73,7 +73,7 @@ function PerspectiveOffCenterFrustum(options) { /** * The distance of the near plane. - * @type {Number} + * @type {number} * @default 1.0 */ this.near = defaultValue(options.near, 1.0); @@ -81,7 +81,7 @@ function PerspectiveOffCenterFrustum(options) { /** * The distance of the far plane. - * @type {Number} + * @type {number} * @default 500000000.0 */ this.far = defaultValue(options.far, 500000000.0); @@ -339,10 +339,10 @@ PerspectiveOffCenterFrustum.prototype.computeCullingVolume = function ( /** * Returns the pixel's width and height in meters. * - * @param {Number} drawingBufferWidth The width of the drawing buffer. - * @param {Number} drawingBufferHeight The height of the drawing buffer. - * @param {Number} distance The distance to the near plane in meters. - * @param {Number} pixelRatio The scaling factor from pixel space to coordinate space. + * @param {number} drawingBufferWidth The width of the drawing buffer. + * @param {number} drawingBufferHeight The height of the drawing buffer. + * @param {number} distance The distance to the near plane in meters. + * @param {number} pixelRatio The scaling factor from pixel space to coordinate space. * @param {Cartesian2} result The object onto which to store the result. * @returns {Cartesian2} The modified result parameter or a new instance of {@link Cartesian2} with the pixel's width and height in the x and y properties, respectively. * @@ -448,7 +448,7 @@ PerspectiveOffCenterFrustum.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {PerspectiveOffCenterFrustum} [other] The right hand side PerspectiveOffCenterFrustum. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ PerspectiveOffCenterFrustum.prototype.equals = function (other) { return ( @@ -469,9 +469,9 @@ PerspectiveOffCenterFrustum.prototype.equals = function (other) { * false otherwise. * * @param {PerspectiveOffCenterFrustum} other The right hand side PerspectiveOffCenterFrustum. - * @param {Number} relativeEpsilon The relative epsilon tolerance to use for equality testing. - * @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if this and other are within the provided epsilon, false otherwise. + * @param {number} relativeEpsilon The relative epsilon tolerance to use for equality testing. + * @param {number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if this and other are within the provided epsilon, false otherwise. */ PerspectiveOffCenterFrustum.prototype.equalsEpsilon = function ( other, diff --git a/packages/engine/Source/Core/PinBuilder.js b/packages/engine/Source/Core/PinBuilder.js index 10953db75c2c..143477b41c9d 100644 --- a/packages/engine/Source/Core/PinBuilder.js +++ b/packages/engine/Source/Core/PinBuilder.js @@ -26,7 +26,7 @@ function PinBuilder() { * Creates an empty pin of the specified color and size. * * @param {Color} color The color of the pin. - * @param {Number} size The size of the pin, in pixels. + * @param {number} size The size of the pin, in pixels. * @returns {HTMLCanvasElement} The canvas element that represents the generated pin. */ PinBuilder.prototype.fromColor = function (color, size) { @@ -44,10 +44,10 @@ PinBuilder.prototype.fromColor = function (color, size) { /** * Creates a pin with the specified icon, color, and size. * - * @param {Resource|String} url The url of the image to be stamped onto the pin. + * @param {Resource|string} url The url of the image to be stamped onto the pin. * @param {Color} color The color of the pin. - * @param {Number} size The size of the pin, in pixels. - * @returns {HTMLCanvasElement|Promise.} The canvas element or a Promise to the canvas element that represents the generated pin. + * @param {number} size The size of the pin, in pixels. + * @returns {HTMLCanvasElement|Promise} The canvas element or a Promise to the canvas element that represents the generated pin. */ PinBuilder.prototype.fromUrl = function (url, color, size) { //>>includeStart('debug', pragmas.debug); @@ -67,10 +67,10 @@ PinBuilder.prototype.fromUrl = function (url, color, size) { /** * Creates a pin with the specified {@link https://www.mapbox.com/maki/|maki} icon identifier, color, and size. * - * @param {String} id The id of the maki icon to be stamped onto the pin. + * @param {string} id The id of the maki icon to be stamped onto the pin. * @param {Color} color The color of the pin. - * @param {Number} size The size of the pin, in pixels. - * @returns {HTMLCanvasElement|Promise.} The canvas element or a Promise to the canvas element that represents the generated pin. + * @param {number} size The size of the pin, in pixels. + * @returns {HTMLCanvasElement|Promise} The canvas element or a Promise to the canvas element that represents the generated pin. */ PinBuilder.prototype.fromMakiIconId = function (id, color, size) { //>>includeStart('debug', pragmas.debug); @@ -97,9 +97,9 @@ PinBuilder.prototype.fromMakiIconId = function (id, color, size) { * Creates a pin with the specified text, color, and size. The text will be sized to be as large as possible * while still being contained completely within the pin. * - * @param {String} text The text to be stamped onto the pin. + * @param {string} text The text to be stamped onto the pin. * @param {Color} color The color of the pin. - * @param {Number} size The size of the pin, in pixels. + * @param {number} size The size of the pin, in pixels. * @returns {HTMLCanvasElement} The canvas element that represents the generated pin. */ PinBuilder.prototype.fromText = function (text, color, size) { diff --git a/packages/engine/Source/Core/PixelFormat.js b/packages/engine/Source/Core/PixelFormat.js index 15c8f9bca391..f95c7a53dc9e 100644 --- a/packages/engine/Source/Core/PixelFormat.js +++ b/packages/engine/Source/Core/PixelFormat.js @@ -4,13 +4,13 @@ import WebGLConstants from "./WebGLConstants.js"; /** * The format of a pixel, i.e., the number of components it has and what they represent. * - * @enum {Number} + * @enum {number} */ const PixelFormat = { /** * A pixel format containing a depth value. * - * @type {Number} + * @type {number} * @constant */ DEPTH_COMPONENT: WebGLConstants.DEPTH_COMPONENT, @@ -18,7 +18,7 @@ const PixelFormat = { /** * A pixel format containing a depth and stencil value, most often used with {@link PixelDatatype.UNSIGNED_INT_24_8}. * - * @type {Number} + * @type {number} * @constant */ DEPTH_STENCIL: WebGLConstants.DEPTH_STENCIL, @@ -26,7 +26,7 @@ const PixelFormat = { /** * A pixel format containing an alpha channel. * - * @type {Number} + * @type {number} * @constant */ ALPHA: WebGLConstants.ALPHA, @@ -34,7 +34,7 @@ const PixelFormat = { /** * A pixel format containing a red channel * - * @type {Number} + * @type {number} * @constant */ RED: WebGLConstants.RED, @@ -42,7 +42,7 @@ const PixelFormat = { /** * A pixel format containing red and green channels. * - * @type {Number} + * @type {number} * @constant */ RG: WebGLConstants.RG, @@ -50,7 +50,7 @@ const PixelFormat = { /** * A pixel format containing red, green, and blue channels. * - * @type {Number} + * @type {number} * @constant */ RGB: WebGLConstants.RGB, @@ -58,7 +58,7 @@ const PixelFormat = { /** * A pixel format containing red, green, blue, and alpha channels. * - * @type {Number} + * @type {number} * @constant */ RGBA: WebGLConstants.RGBA, @@ -66,7 +66,7 @@ const PixelFormat = { /** * A pixel format containing a luminance (intensity) channel. * - * @type {Number} + * @type {number} * @constant */ LUMINANCE: WebGLConstants.LUMINANCE, @@ -74,7 +74,7 @@ const PixelFormat = { /** * A pixel format containing luminance (intensity) and alpha channels. * - * @type {Number} + * @type {number} * @constant */ LUMINANCE_ALPHA: WebGLConstants.LUMINANCE_ALPHA, @@ -82,7 +82,7 @@ const PixelFormat = { /** * A pixel format containing red, green, and blue channels that is DXT1 compressed. * - * @type {Number} + * @type {number} * @constant */ RGB_DXT1: WebGLConstants.COMPRESSED_RGB_S3TC_DXT1_EXT, @@ -90,7 +90,7 @@ const PixelFormat = { /** * A pixel format containing red, green, blue, and alpha channels that is DXT1 compressed. * - * @type {Number} + * @type {number} * @constant */ RGBA_DXT1: WebGLConstants.COMPRESSED_RGBA_S3TC_DXT1_EXT, @@ -98,7 +98,7 @@ const PixelFormat = { /** * A pixel format containing red, green, blue, and alpha channels that is DXT3 compressed. * - * @type {Number} + * @type {number} * @constant */ RGBA_DXT3: WebGLConstants.COMPRESSED_RGBA_S3TC_DXT3_EXT, @@ -106,7 +106,7 @@ const PixelFormat = { /** * A pixel format containing red, green, blue, and alpha channels that is DXT5 compressed. * - * @type {Number} + * @type {number} * @constant */ RGBA_DXT5: WebGLConstants.COMPRESSED_RGBA_S3TC_DXT5_EXT, @@ -114,7 +114,7 @@ const PixelFormat = { /** * A pixel format containing red, green, and blue channels that is PVR 4bpp compressed. * - * @type {Number} + * @type {number} * @constant */ RGB_PVRTC_4BPPV1: WebGLConstants.COMPRESSED_RGB_PVRTC_4BPPV1_IMG, @@ -122,7 +122,7 @@ const PixelFormat = { /** * A pixel format containing red, green, and blue channels that is PVR 2bpp compressed. * - * @type {Number} + * @type {number} * @constant */ RGB_PVRTC_2BPPV1: WebGLConstants.COMPRESSED_RGB_PVRTC_2BPPV1_IMG, @@ -130,7 +130,7 @@ const PixelFormat = { /** * A pixel format containing red, green, blue, and alpha channels that is PVR 4bpp compressed. * - * @type {Number} + * @type {number} * @constant */ RGBA_PVRTC_4BPPV1: WebGLConstants.COMPRESSED_RGBA_PVRTC_4BPPV1_IMG, @@ -138,7 +138,7 @@ const PixelFormat = { /** * A pixel format containing red, green, blue, and alpha channels that is PVR 2bpp compressed. * - * @type {Number} + * @type {number} * @constant */ RGBA_PVRTC_2BPPV1: WebGLConstants.COMPRESSED_RGBA_PVRTC_2BPPV1_IMG, @@ -146,7 +146,7 @@ const PixelFormat = { /** * A pixel format containing red, green, blue, and alpha channels that is ASTC compressed. * - * @type {Number} + * @type {number} * @constant */ RGBA_ASTC: WebGLConstants.COMPRESSED_RGBA_ASTC_4x4_WEBGL, @@ -154,7 +154,7 @@ const PixelFormat = { /** * A pixel format containing red, green, and blue channels that is ETC1 compressed. * - * @type {Number} + * @type {number} * @constant */ RGB_ETC1: WebGLConstants.COMPRESSED_RGB_ETC1_WEBGL, @@ -162,7 +162,7 @@ const PixelFormat = { /** * A pixel format containing red, green, and blue channels that is ETC2 compressed. * - * @type {Number} + * @type {number} * @constant */ RGB8_ETC2: WebGLConstants.COMPRESSED_RGB8_ETC2, @@ -170,7 +170,7 @@ const PixelFormat = { /** * A pixel format containing red, green, blue, and alpha channels that is ETC2 compressed. * - * @type {Number} + * @type {number} * @constant */ RGBA8_ETC2_EAC: WebGLConstants.COMPRESSED_RGBA8_ETC2_EAC, @@ -178,7 +178,7 @@ const PixelFormat = { /** * A pixel format containing red, green, blue, and alpha channels that is BC7 compressed. * - * @type {Number} + * @type {number} * @constant */ RGBA_BC7: WebGLConstants.COMPRESSED_RGBA_BPTC_UNORM, diff --git a/packages/engine/Source/Core/Plane.js b/packages/engine/Source/Core/Plane.js index a602c725fab4..ab9ee77567c9 100644 --- a/packages/engine/Source/Core/Plane.js +++ b/packages/engine/Source/Core/Plane.js @@ -19,7 +19,7 @@ import Matrix4 from "./Matrix4.js"; * @constructor * * @param {Cartesian3} normal The plane's normal (normalized). - * @param {Number} distance The shortest distance from the origin to the plane. The sign of + * @param {number} distance The shortest distance from the origin to the plane. The sign of * distance determines which side of the plane the origin * is on. If distance is positive, the origin is in the half-space * in the direction of the normal; if negative, the origin is in the half-space @@ -60,7 +60,7 @@ function Plane(normal, distance) { * in the direction of the normal; if negative, the origin is in the half-space * opposite to the normal; if zero, the plane passes through the origin. * - * @type {Number} + * @type {number} */ this.distance = distance; } @@ -153,7 +153,7 @@ Plane.fromCartesian4 = function (coefficients, result) { * * @param {Plane} plane The plane. * @param {Cartesian3} point The point. - * @returns {Number} The signed shortest distance of the point to the plane. + * @returns {number} The signed shortest distance of the point to the plane. */ Plane.getPointDistance = function (plane, point) { //>>includeStart('debug', pragmas.debug); @@ -272,7 +272,7 @@ Plane.clone = function (plane, result) { * * @param {Plane} left The first plane. * @param {Plane} right The second plane. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Plane.equals = function (left, right) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/PlaneGeometry.js b/packages/engine/Source/Core/PlaneGeometry.js index 7665cdaf052f..8bc861fd149f 100644 --- a/packages/engine/Source/Core/PlaneGeometry.js +++ b/packages/engine/Source/Core/PlaneGeometry.js @@ -16,7 +16,7 @@ import VertexFormat from "./VertexFormat.js"; * @alias PlaneGeometry * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * * @example @@ -35,7 +35,7 @@ function PlaneGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ PlaneGeometry.packedLength = VertexFormat.packedLength; @@ -43,10 +43,10 @@ PlaneGeometry.packedLength = VertexFormat.packedLength; * Stores the provided instance into the provided array. * * @param {PlaneGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ PlaneGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -69,8 +69,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {PlaneGeometry} [result] The object into which to store the result. * @returns {PlaneGeometry} The modified result parameter or a new PlaneGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/PlaneOutlineGeometry.js b/packages/engine/Source/Core/PlaneOutlineGeometry.js index 511a7f5e7be1..e116db3d6fe2 100644 --- a/packages/engine/Source/Core/PlaneOutlineGeometry.js +++ b/packages/engine/Source/Core/PlaneOutlineGeometry.js @@ -21,7 +21,7 @@ function PlaneOutlineGeometry() { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ PlaneOutlineGeometry.packedLength = 0; @@ -29,9 +29,9 @@ PlaneOutlineGeometry.packedLength = 0; * Stores the provided instance into the provided array. * * @param {PlaneOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. + * @param {number[]} array The array to pack into. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ PlaneOutlineGeometry.pack = function (value, array) { //>>includeStart('debug', pragmas.debug); @@ -45,8 +45,8 @@ PlaneOutlineGeometry.pack = function (value, array) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {PlaneOutlineGeometry} [result] The object into which to store the result. * @returns {PlaneOutlineGeometry} The modified result parameter or a new PlaneOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/PolygonGeometry.js b/packages/engine/Source/Core/PolygonGeometry.js index dcfe3c5c2a01..069c92707a52 100644 --- a/packages/engine/Source/Core/PolygonGeometry.js +++ b/packages/engine/Source/Core/PolygonGeometry.js @@ -700,17 +700,17 @@ function createGeometryFromPositionsExtruded( * @alias PolygonGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {PolygonHierarchy} options.polygonHierarchy A polygon hierarchy that can include holes. - * @param {Number} [options.height=0.0] The distance in meters between the polygon and the ellipsoid surface. - * @param {Number} [options.extrudedHeight] The distance in meters between the polygon's extruded face and the ellipsoid surface. + * @param {number} [options.height=0.0] The distance in meters between the polygon and the ellipsoid surface. + * @param {number} [options.extrudedHeight] The distance in meters between the polygon's extruded face and the ellipsoid surface. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. - * @param {Number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. + * @param {number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Boolean} [options.perPositionHeight=false] Use the height of options.positions for each position instead of using options.height to determine the height. - * @param {Boolean} [options.closeTop=true] When false, leaves off the top of an extruded polygon open. - * @param {Boolean} [options.closeBottom=true] When false, leaves off the bottom of an extruded polygon open. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {boolean} [options.perPositionHeight=false] Use the height of options.positions for each position instead of using options.height to determine the height. + * @param {boolean} [options.closeTop=true] When false, leaves off the top of an extruded polygon open. + * @param {boolean} [options.closeBottom=true] When false, leaves off the bottom of an extruded polygon open. * @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of line the polygon edges must follow. Valid options are {@link ArcType.GEODESIC} and {@link ArcType.RHUMB}. * @param {PolygonHierarchy} [options.textureCoordinates] Texture coordinates as a {@link PolygonHierarchy} of {@link Cartesian2} points. Has no effect for ground primitives. * @@ -853,7 +853,7 @@ function PolygonGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = PolygonGeometryLibrary.computeHierarchyPackedLength( @@ -874,17 +874,17 @@ function PolygonGeometry(options) { /** * A description of a polygon from an array of positions. Polygon geometry can be rendered with both {@link Primitive} and {@link GroundPrimitive}. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of positions that defined the corner points of the polygon. - * @param {Number} [options.height=0.0] The height of the polygon. - * @param {Number} [options.extrudedHeight] The height of the polygon extrusion. + * @param {number} [options.height=0.0] The height of the polygon. + * @param {number} [options.extrudedHeight] The height of the polygon extrusion. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. - * @param {Number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. + * @param {number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Boolean} [options.perPositionHeight=false] Use the height of options.positions for each position instead of using options.height to determine the height. - * @param {Boolean} [options.closeTop=true] When false, leaves off the top of an extruded polygon open. - * @param {Boolean} [options.closeBottom=true] When false, leaves off the bottom of an extruded polygon open. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {boolean} [options.perPositionHeight=false] Use the height of options.positions for each position instead of using options.height to determine the height. + * @param {boolean} [options.closeTop=true] When false, leaves off the top of an extruded polygon open. + * @param {boolean} [options.closeBottom=true] When false, leaves off the bottom of an extruded polygon open. * @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of line the polygon edges must follow. Valid options are {@link ArcType.GEODESIC} and {@link ArcType.RHUMB}. * @param {PolygonHierarchy} [options.textureCoordinates] Texture coordinates as a {@link PolygonHierarchy} of {@link Cartesian2} points. Has no effect for ground primitives. * @returns {PolygonGeometry} @@ -935,10 +935,10 @@ PolygonGeometry.fromPositions = function (options) { * Stores the provided instance into the provided array. * * @param {PolygonGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ PolygonGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -997,8 +997,8 @@ const dummyOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {PolygonGeometry} [result] The object into which to store the result. */ PolygonGeometry.unpack = function (array, startingIndex, result) { @@ -1081,9 +1081,9 @@ PolygonGeometry.unpack = function (array, startingIndex, result) { /** * Returns the bounding rectangle given the provided options * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {PolygonHierarchy} options.polygonHierarchy A polygon hierarchy that can include holes. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions sampled. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions sampled. * @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of line the polygon edges must follow. Valid options are {@link ArcType.GEODESIC} and {@link ArcType.RHUMB}. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. * @param {Rectangle} [result] An object in which to store the result. diff --git a/packages/engine/Source/Core/PolygonGeometryLibrary.js b/packages/engine/Source/Core/PolygonGeometryLibrary.js index c97adec4358f..b24e1ae9aaab 100644 --- a/packages/engine/Source/Core/PolygonGeometryLibrary.js +++ b/packages/engine/Source/Core/PolygonGeometryLibrary.js @@ -192,8 +192,8 @@ PolygonGeometryLibrary.subdivideRhumbLineCount = function ( * @param {Cartesian2} t1 Second texture coordinate. * @param {Cartesian3} p0 First world position. * @param {Cartesian3} p1 Second world position. - * @param {Number} minDistance Minimum distance for a segment. - * @param {Array} result The subdivided texture coordinates. + * @param {number} minDistance Minimum distance for a segment. + * @param {Cartesian2[]} result The subdivided texture coordinates. * * @private */ @@ -266,8 +266,8 @@ PolygonGeometryLibrary.subdivideLine = function (p0, p1, minDistance, result) { * @param {Ellipsoid} ellipsoid The ellipsoid. * @param {Cartesian3} p0 First world position. * @param {Cartesian3} p1 Second world position. - * @param {Number} minDistance Minimum distance for a segment. - * @param {Array} result The subdivided texture coordinates. + * @param {number} minDistance Minimum distance for a segment. + * @param {Cartesian2[]} result The subdivided texture coordinates. * * @private */ diff --git a/packages/engine/Source/Core/PolygonOutlineGeometry.js b/packages/engine/Source/Core/PolygonOutlineGeometry.js index 652357e702c1..14c235d55c48 100644 --- a/packages/engine/Source/Core/PolygonOutlineGeometry.js +++ b/packages/engine/Source/Core/PolygonOutlineGeometry.js @@ -268,14 +268,14 @@ function createGeometryFromPositionsExtruded( * @alias PolygonOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {PolygonHierarchy} options.polygonHierarchy A polygon hierarchy that can include holes. - * @param {Number} [options.height=0.0] The distance in meters between the polygon and the ellipsoid surface. - * @param {Number} [options.extrudedHeight] The distance in meters between the polygon's extruded face and the ellipsoid surface. + * @param {number} [options.height=0.0] The distance in meters between the polygon and the ellipsoid surface. + * @param {number} [options.extrudedHeight] The distance in meters between the polygon's extruded face and the ellipsoid surface. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Boolean} [options.perPositionHeight=false] Use the height of options.positions for each position instead of using options.height to determine the height. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {boolean} [options.perPositionHeight=false] Use the height of options.positions for each position instead of using options.height to determine the height. * @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of path the outline must follow. Valid options are {@link ArcType.GEODESIC} and {@link ArcType.RHUMB}. * * @see PolygonOutlineGeometry#createGeometry @@ -402,7 +402,7 @@ function PolygonOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = PolygonGeometryLibrary.computeHierarchyPackedLength( @@ -417,10 +417,10 @@ function PolygonOutlineGeometry(options) { * Stores the provided instance into the provided array. * * @param {PolygonOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ PolygonOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -460,8 +460,8 @@ const dummyOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {PolygonOutlineGeometry} [result] The object into which to store the result. * @returns {PolygonOutlineGeometry} The modified result parameter or a new PolygonOutlineGeometry instance if one was not provided. */ @@ -514,13 +514,13 @@ PolygonOutlineGeometry.unpack = function (array, startingIndex, result) { /** * A description of a polygon outline from an array of positions. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of positions that defined the corner points of the polygon. - * @param {Number} [options.height=0.0] The height of the polygon. - * @param {Number} [options.extrudedHeight] The height of the polygon extrusion. + * @param {number} [options.height=0.0] The height of the polygon. + * @param {number} [options.extrudedHeight] The height of the polygon extrusion. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Boolean} [options.perPositionHeight=false] Use the height of options.positions for each position instead of using options.height to determine the height. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {boolean} [options.perPositionHeight=false] Use the height of options.positions for each position instead of using options.height to determine the height. * @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of path the outline must follow. Valid options are {@link LinkType.GEODESIC} and {@link ArcType.RHUMB}. * @returns {PolygonOutlineGeometry} * diff --git a/packages/engine/Source/Core/PolygonPipeline.js b/packages/engine/Source/Core/PolygonPipeline.js index 19a3f1948611..539c656f8d29 100644 --- a/packages/engine/Source/Core/PolygonPipeline.js +++ b/packages/engine/Source/Core/PolygonPipeline.js @@ -62,8 +62,8 @@ PolygonPipeline.computeWindingOrder2D = function (positions) { * Triangulate a polygon. * * @param {Cartesian2[]} positions Cartesian2 array containing the vertices of the polygon - * @param {Number[]} [holes] An array of the staring indices of the holes. - * @returns {Number[]} Index array representing triangles that fill the polygon + * @param {number[]} [holes] An array of the staring indices of the holes. + * @returns {number[]} Index array representing triangles that fill the polygon */ PolygonPipeline.triangulate = function (positions, holes) { //>>includeStart('debug', pragmas.debug); @@ -91,9 +91,9 @@ const subdivisionTexcoordMidScratch = new Cartesian2(); * * @param {Ellipsoid} ellipsoid The ellipsoid the polygon in on. * @param {Cartesian3[]} positions An array of {@link Cartesian3} positions of the polygon. - * @param {Number[]} indices An array of indices that determines the triangles in the polygon. + * @param {number[]} indices An array of indices that determines the triangles in the polygon. * @param {Cartesian2[]} texcoords An optional array of {@link Cartesian2} texture coordinates of the polygon. - * @param {Number} [granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number} [granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * * @exception {DeveloperError} At least three indices are required. * @exception {DeveloperError} The number of indices must be divisable by three. @@ -326,9 +326,9 @@ const subdivisionCartographicScratch = new Cartographic(); * * @param {Ellipsoid} ellipsoid The ellipsoid the polygon in on. * @param {Cartesian3[]} positions An array of {@link Cartesian3} positions of the polygon. - * @param {Number[]} indices An array of indices that determines the triangles in the polygon. + * @param {number[]} indices An array of indices that determines the triangles in the polygon. * @param {Cartesian2[]} texcoords An optional array of {@link Cartesian2} texture coordinates of the polygon. - * @param {Number} [granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number} [granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * * @exception {DeveloperError} At least three indices are required. * @exception {DeveloperError} The number of indices must be divisable by three. @@ -585,11 +585,11 @@ PolygonPipeline.computeRhumbLineSubdivision = function ( /** * Scales each position of a geometry's position attribute to a height, in place. * - * @param {Number[]} positions The array of numbers representing the positions to be scaled - * @param {Number} [height=0.0] The desired height to add to the positions + * @param {number[]} positions The array of numbers representing the positions to be scaled + * @param {number} [height=0.0] The desired height to add to the positions * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the positions lie. - * @param {Boolean} [scaleToSurface=true] true if the positions need to be scaled to the surface before the height is added. - * @returns {Number[]} The input array of positions, scaled to height + * @param {boolean} [scaleToSurface=true] true if the positions need to be scaled to the surface before the height is added. + * @returns {number[]} The input array of positions, scaled to height */ PolygonPipeline.scaleToGeodeticHeight = function ( positions, diff --git a/packages/engine/Source/Core/PolylineGeometry.js b/packages/engine/Source/Core/PolylineGeometry.js index f1625e42aead..a5f50ef1680a 100644 --- a/packages/engine/Source/Core/PolylineGeometry.js +++ b/packages/engine/Source/Core/PolylineGeometry.js @@ -67,13 +67,13 @@ function interpolateColors(p0, p1, color0, color1, numPoints) { * @alias PolylineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip. - * @param {Number} [options.width=1.0] The width in pixels. + * @param {number} [options.width=1.0] The width in pixels. * @param {Color[]} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors. - * @param {Boolean} [options.colorsPerVertex=false] A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices. + * @param {boolean} [options.colorsPerVertex=false] A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices. * @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of line the polyline segments must follow. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude if options.arcType is not ArcType.NONE. Determines the number of positions in the buffer. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude if options.arcType is not ArcType.NONE. Determines the number of positions in the buffer. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. * @@ -143,7 +143,7 @@ function PolylineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = numComponents + Ellipsoid.packedLength + VertexFormat.packedLength + 4; @@ -153,10 +153,10 @@ function PolylineGeometry(options) { * Stores the provided instance into the provided array. * * @param {PolylineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ PolylineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -218,8 +218,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {PolylineGeometry} [result] The object into which to store the result. * @returns {PolylineGeometry} The modified result parameter or a new PolylineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/PolylinePipeline.js b/packages/engine/Source/Core/PolylinePipeline.js index 04b0e2fa7bf2..dccbae1ec08f 100644 --- a/packages/engine/Source/Core/PolylinePipeline.js +++ b/packages/engine/Source/Core/PolylinePipeline.js @@ -188,7 +188,7 @@ function generateCartesianRhumbArc( * transformation matrix, where the upper left 3x3 elements are a rotation matrix, and * the upper three elements in the fourth column are the translation. The bottom row is assumed to be [0, 0, 0, 1]. * The matrix is not verified to be in the proper form. - * @returns {Object} An object with a positions property that is an array of positions and a + * @returns {object} An object with a positions property that is an array of positions and a * segments property. * * @@ -307,12 +307,12 @@ PolylinePipeline.wrapLongitude = function (positions, modelMatrix) { /** * Subdivides polyline and raises all points to the specified height. Returns an array of numbers to represent the positions. - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions The array of type {Cartesian3} representing positions. - * @param {Number|Number[]} [options.height=0.0] A number or array of numbers representing the heights of each position. - * @param {Number} [options.granularity = CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number|number[]} [options.height=0.0] A number or array of numbers representing the heights of each position. + * @param {number} [options.granularity = CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the positions lie. - * @returns {Number[]} A new array of positions of type {Number} that have been subdivided and raised to the surface of the ellipsoid. + * @returns {number[]} A new array of positions of type {number} that have been subdivided and raised to the surface of the ellipsoid. * * @example * const positions = Cesium.Cartesian3.fromDegreesArray([ @@ -414,12 +414,12 @@ const scratchCartographic1 = new Cartographic(); /** * Subdivides polyline and raises all points to the specified height using Rhumb lines. Returns an array of numbers to represent the positions. - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions The array of type {Cartesian3} representing positions. - * @param {Number|Number[]} [options.height=0.0] A number or array of numbers representing the heights of each position. - * @param {Number} [options.granularity = CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number|number[]} [options.height=0.0] A number or array of numbers representing the heights of each position. + * @param {number} [options.granularity = CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the positions lie. - * @returns {Number[]} A new array of positions of type {Number} that have been subdivided and raised to the surface of the ellipsoid. + * @returns {number[]} A new array of positions of type {number} that have been subdivided and raised to the surface of the ellipsoid. * * @example * const positions = Cesium.Cartesian3.fromDegreesArray([ @@ -520,10 +520,10 @@ PolylinePipeline.generateRhumbArc = function (options) { /** * Subdivides polyline and raises all points to the specified height. Returns an array of new {Cartesian3} positions. - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions The array of type {Cartesian3} representing positions. - * @param {Number|Number[]} [options.height=0.0] A number or array of numbers representing the heights of each position. - * @param {Number} [options.granularity = CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number|number[]} [options.height=0.0] A number or array of numbers representing the heights of each position. + * @param {number} [options.granularity = CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the positions lie. * @returns {Cartesian3[]} A new array of cartesian3 positions that have been subdivided and raised to the surface of the ellipsoid. * @@ -550,10 +550,10 @@ PolylinePipeline.generateCartesianArc = function (options) { /** * Subdivides polyline and raises all points to the specified height using Rhumb Lines. Returns an array of new {Cartesian3} positions. - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions The array of type {Cartesian3} representing positions. - * @param {Number|Number[]} [options.height=0.0] A number or array of numbers representing the heights of each position. - * @param {Number} [options.granularity = CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number|number[]} [options.height=0.0] A number or array of numbers representing the heights of each position. + * @param {number} [options.granularity = CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the positions lie. * @returns {Cartesian3[]} A new array of cartesian3 positions that have been subdivided and raised to the surface of the ellipsoid. * diff --git a/packages/engine/Source/Core/PolylineVolumeGeometry.js b/packages/engine/Source/Core/PolylineVolumeGeometry.js index e7b9d4e391ea..fe5aa704bbfc 100644 --- a/packages/engine/Source/Core/PolylineVolumeGeometry.js +++ b/packages/engine/Source/Core/PolylineVolumeGeometry.js @@ -175,11 +175,11 @@ function computeAttributes( * @alias PolylineVolumeGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.polylinePositions An array of {@link Cartesian3} positions that define the center of the polyline volume. * @param {Cartesian2[]} options.shapePositions An array of {@link Cartesian2} positions that define the shape to be extruded along the polyline * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * @param {CornerType} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners. * @@ -240,7 +240,7 @@ function PolylineVolumeGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = numComponents + Ellipsoid.packedLength + VertexFormat.packedLength + 2; @@ -250,10 +250,10 @@ function PolylineVolumeGeometry(options) { * Stores the provided instance into the provided array. * * @param {PolylineVolumeGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ PolylineVolumeGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -311,8 +311,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {PolylineVolumeGeometry} [result] The object into which to store the result. * @returns {PolylineVolumeGeometry} The modified result parameter or a new PolylineVolumeGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/PolylineVolumeOutlineGeometry.js b/packages/engine/Source/Core/PolylineVolumeOutlineGeometry.js index 09328f83d98b..facd80c11dfd 100644 --- a/packages/engine/Source/Core/PolylineVolumeOutlineGeometry.js +++ b/packages/engine/Source/Core/PolylineVolumeOutlineGeometry.js @@ -80,11 +80,11 @@ function computeAttributes(positions, shape) { * @alias PolylineVolumeOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.polylinePositions An array of positions that define the center of the polyline volume. * @param {Cartesian2[]} options.shapePositions An array of positions that define the shape to be extruded along the polyline * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. * @param {CornerType} [options.cornerType=CornerType.ROUNDED] Determines the style of the corners. * * @see PolylineVolumeOutlineGeometry#createGeometry @@ -138,7 +138,7 @@ function PolylineVolumeOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = numComponents + Ellipsoid.packedLength + 2; } @@ -147,10 +147,10 @@ function PolylineVolumeOutlineGeometry(options) { * Stores the provided instance into the provided array. * * @param {PolylineVolumeOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ PolylineVolumeOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -204,8 +204,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {PolylineVolumeOutlineGeometry} [result] The object into which to store the result. * @returns {PolylineVolumeOutlineGeometry} The modified result parameter or a new PolylineVolumeOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/PrimitiveType.js b/packages/engine/Source/Core/PrimitiveType.js index 19a0887d9f2a..9be8354aa0b7 100644 --- a/packages/engine/Source/Core/PrimitiveType.js +++ b/packages/engine/Source/Core/PrimitiveType.js @@ -3,13 +3,13 @@ import WebGLConstants from "./WebGLConstants.js"; /** * The type of a geometric primitive, i.e., points, lines, and triangles. * - * @enum {Number} + * @enum {number} */ const PrimitiveType = { /** * Points primitive where each vertex (or index) is a separate point. * - * @type {Number} + * @type {number} * @constant */ POINTS: WebGLConstants.POINTS, @@ -17,7 +17,7 @@ const PrimitiveType = { /** * Lines primitive where each two vertices (or indices) is a line segment. Line segments are not necessarily connected. * - * @type {Number} + * @type {number} * @constant */ LINES: WebGLConstants.LINES, @@ -26,7 +26,7 @@ const PrimitiveType = { * Line loop primitive where each vertex (or index) after the first connects a line to * the previous vertex, and the last vertex implicitly connects to the first. * - * @type {Number} + * @type {number} * @constant */ LINE_LOOP: WebGLConstants.LINE_LOOP, @@ -34,7 +34,7 @@ const PrimitiveType = { /** * Line strip primitive where each vertex (or index) after the first connects a line to the previous vertex. * - * @type {Number} + * @type {number} * @constant */ LINE_STRIP: WebGLConstants.LINE_STRIP, @@ -42,7 +42,7 @@ const PrimitiveType = { /** * Triangles primitive where each three vertices (or indices) is a triangle. Triangles do not necessarily share edges. * - * @type {Number} + * @type {number} * @constant */ TRIANGLES: WebGLConstants.TRIANGLES, @@ -51,7 +51,7 @@ const PrimitiveType = { * Triangle strip primitive where each vertex (or index) after the first two connect to * the previous two vertices forming a triangle. For example, this can be used to model a wall. * - * @type {Number} + * @type {number} * @constant */ TRIANGLE_STRIP: WebGLConstants.TRIANGLE_STRIP, @@ -61,7 +61,7 @@ const PrimitiveType = { * the previous vertex and the first vertex forming a triangle. For example, this can be used * to model a cone or circle. * - * @type {Number} + * @type {number} * @constant */ TRIANGLE_FAN: WebGLConstants.TRIANGLE_FAN, diff --git a/packages/engine/Source/Core/Proxy.js b/packages/engine/Source/Core/Proxy.js index 43af4dbabc38..c16a27f1ad1f 100644 --- a/packages/engine/Source/Core/Proxy.js +++ b/packages/engine/Source/Core/Proxy.js @@ -15,8 +15,8 @@ function Proxy() { /** * Get the final URL to use to request a given resource. * - * @param {String} resource The resource to request. - * @returns {String} proxied resource + * @param {string} resource The resource to request. + * @returns {string} proxied resource * @function */ Proxy.prototype.getURL = DeveloperError.throwInstantiationError; diff --git a/packages/engine/Source/Core/QuadraticRealPolynomial.js b/packages/engine/Source/Core/QuadraticRealPolynomial.js index 7df6640c5489..17a0fe1031f8 100644 --- a/packages/engine/Source/Core/QuadraticRealPolynomial.js +++ b/packages/engine/Source/Core/QuadraticRealPolynomial.js @@ -11,10 +11,10 @@ const QuadraticRealPolynomial = {}; /** * Provides the discriminant of the quadratic equation from the supplied coefficients. * - * @param {Number} a The coefficient of the 2nd order monomial. - * @param {Number} b The coefficient of the 1st order monomial. - * @param {Number} c The coefficient of the 0th order monomial. - * @returns {Number} The value of the discriminant. + * @param {number} a The coefficient of the 2nd order monomial. + * @param {number} b The coefficient of the 1st order monomial. + * @param {number} c The coefficient of the 0th order monomial. + * @returns {number} The value of the discriminant. */ QuadraticRealPolynomial.computeDiscriminant = function (a, b, c) { //>>includeStart('debug', pragmas.debug); @@ -48,10 +48,10 @@ function addWithCancellationCheck(left, right, tolerance) { /** * Provides the real valued roots of the quadratic polynomial with the provided coefficients. * - * @param {Number} a The coefficient of the 2nd order monomial. - * @param {Number} b The coefficient of the 1st order monomial. - * @param {Number} c The coefficient of the 0th order monomial. - * @returns {Number[]} The real valued roots. + * @param {number} a The coefficient of the 2nd order monomial. + * @param {number} b The coefficient of the 1st order monomial. + * @param {number} c The coefficient of the 0th order monomial. + * @returns {number[]} The real valued roots. */ QuadraticRealPolynomial.computeRealRoots = function (a, b, c) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/QuantizedMeshTerrainData.js b/packages/engine/Source/Core/QuantizedMeshTerrainData.js index 0a88ed831cec..f3c8d45d7cad 100644 --- a/packages/engine/Source/Core/QuantizedMeshTerrainData.js +++ b/packages/engine/Source/Core/QuantizedMeshTerrainData.js @@ -24,26 +24,26 @@ import TerrainMesh from "./TerrainMesh.js"; * @alias QuantizedMeshTerrainData * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Uint16Array} options.quantizedVertices The buffer containing the quantized mesh. * @param {Uint16Array|Uint32Array} options.indices The indices specifying how the quantized vertices are linked * together into triangles. Each three indices specifies one triangle. - * @param {Number} options.minimumHeight The minimum terrain height within the tile, in meters above the ellipsoid. - * @param {Number} options.maximumHeight The maximum terrain height within the tile, in meters above the ellipsoid. + * @param {number} options.minimumHeight The minimum terrain height within the tile, in meters above the ellipsoid. + * @param {number} options.maximumHeight The maximum terrain height within the tile, in meters above the ellipsoid. * @param {BoundingSphere} options.boundingSphere A sphere bounding all of the vertices in the mesh. * @param {OrientedBoundingBox} [options.orientedBoundingBox] An OrientedBoundingBox bounding all of the vertices in the mesh. * @param {Cartesian3} options.horizonOcclusionPoint The horizon occlusion point of the mesh. If this point * is below the horizon, the entire tile is assumed to be below the horizon as well. * The point is expressed in ellipsoid-scaled coordinates. - * @param {Number[]} options.westIndices The indices of the vertices on the western edge of the tile. - * @param {Number[]} options.southIndices The indices of the vertices on the southern edge of the tile. - * @param {Number[]} options.eastIndices The indices of the vertices on the eastern edge of the tile. - * @param {Number[]} options.northIndices The indices of the vertices on the northern edge of the tile. - * @param {Number} options.westSkirtHeight The height of the skirt to add on the western edge of the tile. - * @param {Number} options.southSkirtHeight The height of the skirt to add on the southern edge of the tile. - * @param {Number} options.eastSkirtHeight The height of the skirt to add on the eastern edge of the tile. - * @param {Number} options.northSkirtHeight The height of the skirt to add on the northern edge of the tile. - * @param {Number} [options.childTileMask=15] A bit mask indicating which of this tile's four children exist. + * @param {number[]} options.westIndices The indices of the vertices on the western edge of the tile. + * @param {number[]} options.southIndices The indices of the vertices on the southern edge of the tile. + * @param {number[]} options.eastIndices The indices of the vertices on the eastern edge of the tile. + * @param {number[]} options.northIndices The indices of the vertices on the northern edge of the tile. + * @param {number} options.westSkirtHeight The height of the skirt to add on the western edge of the tile. + * @param {number} options.southSkirtHeight The height of the skirt to add on the southern edge of the tile. + * @param {number} options.eastSkirtHeight The height of the skirt to add on the eastern edge of the tile. + * @param {number} options.northSkirtHeight The height of the skirt to add on the northern edge of the tile. + * @param {number} [options.childTileMask=15] A bit mask indicating which of this tile's four children exist. * If a child's bit is set, geometry will be requested for that tile as well when it * is needed. If the bit is cleared, the child tile is not requested and geometry is * instead upsampled from the parent. The bit values are as follows: @@ -54,7 +54,7 @@ import TerrainMesh from "./TerrainMesh.js"; * 24Northwest * 38Northeast * - * @param {Boolean} [options.createdByUpsampling=false] True if this instance was created by upsampling another instance; + * @param {boolean} [options.createdByUpsampling=false] True if this instance was created by upsampling another instance; * otherwise, false. * @param {Uint8Array} [options.encodedNormals] The buffer containing per vertex normals, encoded using 'oct' encoding * @param {Uint8Array} [options.waterMask] The buffer containing the watermask. @@ -275,15 +275,15 @@ const createMeshTaskProcessorThrottle = new TaskProcessor( * * @private * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {TilingScheme} options.tilingScheme The tiling scheme to which this tile belongs. - * @param {Number} options.x The X coordinate of the tile for which to create the terrain data. - * @param {Number} options.y The Y coordinate of the tile for which to create the terrain data. - * @param {Number} options.level The level of the tile for which to create the terrain data. - * @param {Number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. - * @param {Number} [options.exaggerationRelativeHeight=0.0] The height relative to which terrain is exaggerated. - * @param {Boolean} [options.throttle=true] If true, indicates that this operation will need to be retried if too many asynchronous mesh creations are already in progress. - * @returns {Promise.|undefined} A promise for the terrain mesh, or undefined if too many + * @param {number} options.x The X coordinate of the tile for which to create the terrain data. + * @param {number} options.y The Y coordinate of the tile for which to create the terrain data. + * @param {number} options.level The level of the tile for which to create the terrain data. + * @param {number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. + * @param {number} [options.exaggerationRelativeHeight=0.0] The height relative to which terrain is exaggerated. + * @param {boolean} [options.throttle=true] If true, indicates that this operation will need to be retried if too many asynchronous mesh creations are already in progress. + * @returns {Promise|undefined} A promise for the terrain mesh, or undefined if too many * asynchronous mesh creations are already in progress and the operation should * be retried later. */ @@ -418,13 +418,13 @@ const upsampleTaskProcessor = new TaskProcessor( * vertices in this instance, interpolated if necessary. * * @param {TilingScheme} tilingScheme The tiling scheme of this terrain data. - * @param {Number} thisX The X coordinate of this tile in the tiling scheme. - * @param {Number} thisY The Y coordinate of this tile in the tiling scheme. - * @param {Number} thisLevel The level of this tile in the tiling scheme. - * @param {Number} descendantX The X coordinate within the tiling scheme of the descendant tile for which we are upsampling. - * @param {Number} descendantY The Y coordinate within the tiling scheme of the descendant tile for which we are upsampling. - * @param {Number} descendantLevel The level within the tiling scheme of the descendant tile for which we are upsampling. - * @returns {Promise.|undefined} A promise for upsampled heightmap terrain data for the descendant tile, + * @param {number} thisX The X coordinate of this tile in the tiling scheme. + * @param {number} thisY The Y coordinate of this tile in the tiling scheme. + * @param {number} thisLevel The level of this tile in the tiling scheme. + * @param {number} descendantX The X coordinate within the tiling scheme of the descendant tile for which we are upsampling. + * @param {number} descendantY The Y coordinate within the tiling scheme of the descendant tile for which we are upsampling. + * @param {number} descendantLevel The level within the tiling scheme of the descendant tile for which we are upsampling. + * @returns {Promise|undefined} A promise for upsampled heightmap terrain data for the descendant tile, * or undefined if too many asynchronous upsample operations are in progress and the request has been * deferred. */ @@ -563,9 +563,9 @@ const barycentricCoordinateScratch = new Cartesian3(); * Computes the terrain height at a specified longitude and latitude. * * @param {Rectangle} rectangle The rectangle covered by this terrain data. - * @param {Number} longitude The longitude in radians. - * @param {Number} latitude The latitude in radians. - * @returns {Number} The terrain height at the specified position. The position is clamped to + * @param {number} longitude The longitude in radians. + * @param {number} latitude The latitude in radians. + * @returns {number} The terrain height at the specified position. The position is clamped to * the rectangle, so expect incorrect results for positions far outside the rectangle. */ QuantizedMeshTerrainData.prototype.interpolateHeight = function ( @@ -720,11 +720,11 @@ function interpolateHeight(terrainData, u, v) { * to be one of the four children of this tile. If non-child tile coordinates are * given, the availability of the southeast child tile is returned. * - * @param {Number} thisX The tile X coordinate of this (the parent) tile. - * @param {Number} thisY The tile Y coordinate of this (the parent) tile. - * @param {Number} childX The tile X coordinate of the child tile to check for availability. - * @param {Number} childY The tile Y coordinate of the child tile to check for availability. - * @returns {Boolean} True if the child tile is available; otherwise, false. + * @param {number} thisX The tile X coordinate of this (the parent) tile. + * @param {number} thisY The tile Y coordinate of this (the parent) tile. + * @param {number} childX The tile X coordinate of the child tile to check for availability. + * @param {number} childY The tile Y coordinate of the child tile to check for availability. + * @returns {boolean} True if the child tile is available; otherwise, false. */ QuantizedMeshTerrainData.prototype.isChildAvailable = function ( thisX, @@ -764,7 +764,7 @@ QuantizedMeshTerrainData.prototype.isChildAvailable = function ( * as by downloading it from a remote server. This method should return true for instances * returned from a call to {@link HeightmapTerrainData#upsample}. * - * @returns {Boolean} True if this instance was created by upsampling; otherwise, false. + * @returns {boolean} True if this instance was created by upsampling; otherwise, false. */ QuantizedMeshTerrainData.prototype.wasCreatedByUpsampling = function () { return this._createdByUpsampling; diff --git a/packages/engine/Source/Core/QuarticRealPolynomial.js b/packages/engine/Source/Core/QuarticRealPolynomial.js index baa589c0558f..c71888ad4fae 100644 --- a/packages/engine/Source/Core/QuarticRealPolynomial.js +++ b/packages/engine/Source/Core/QuarticRealPolynomial.js @@ -13,12 +13,12 @@ const QuarticRealPolynomial = {}; /** * Provides the discriminant of the quartic equation from the supplied coefficients. * - * @param {Number} a The coefficient of the 4th order monomial. - * @param {Number} b The coefficient of the 3rd order monomial. - * @param {Number} c The coefficient of the 2nd order monomial. - * @param {Number} d The coefficient of the 1st order monomial. - * @param {Number} e The coefficient of the 0th order monomial. - * @returns {Number} The value of the discriminant. + * @param {number} a The coefficient of the 4th order monomial. + * @param {number} b The coefficient of the 3rd order monomial. + * @param {number} c The coefficient of the 2nd order monomial. + * @param {number} d The coefficient of the 1st order monomial. + * @param {number} e The coefficient of the 0th order monomial. + * @returns {number} The value of the discriminant. */ QuarticRealPolynomial.computeDiscriminant = function (a, b, c, d, e) { //>>includeStart('debug', pragmas.debug); @@ -263,12 +263,12 @@ function neumark(a3, a2, a1, a0) { /** * Provides the real valued roots of the quartic polynomial with the provided coefficients. * - * @param {Number} a The coefficient of the 4th order monomial. - * @param {Number} b The coefficient of the 3rd order monomial. - * @param {Number} c The coefficient of the 2nd order monomial. - * @param {Number} d The coefficient of the 1st order monomial. - * @param {Number} e The coefficient of the 0th order monomial. - * @returns {Number[]} The real valued roots. + * @param {number} a The coefficient of the 4th order monomial. + * @param {number} b The coefficient of the 3rd order monomial. + * @param {number} c The coefficient of the 2nd order monomial. + * @param {number} d The coefficient of the 1st order monomial. + * @param {number} e The coefficient of the 0th order monomial. + * @returns {number[]} The real valued roots. */ QuarticRealPolynomial.computeRealRoots = function (a, b, c, d, e) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/Quaternion.js b/packages/engine/Source/Core/Quaternion.js index 962b9cac0aca..b77cb770e1de 100644 --- a/packages/engine/Source/Core/Quaternion.js +++ b/packages/engine/Source/Core/Quaternion.js @@ -11,38 +11,38 @@ import Matrix3 from "./Matrix3.js"; * @alias Quaternion * @constructor * - * @param {Number} [x=0.0] The X component. - * @param {Number} [y=0.0] The Y component. - * @param {Number} [z=0.0] The Z component. - * @param {Number} [w=0.0] The W component. + * @param {number} [x=0.0] The X component. + * @param {number} [y=0.0] The Y component. + * @param {number} [z=0.0] The Z component. + * @param {number} [w=0.0] The W component. * * @see PackableForInterpolation */ function Quaternion(x, y, z, w) { /** * The X component. - * @type {Number} + * @type {number} * @default 0.0 */ this.x = defaultValue(x, 0.0); /** * The Y component. - * @type {Number} + * @type {number} * @default 0.0 */ this.y = defaultValue(y, 0.0); /** * The Z component. - * @type {Number} + * @type {number} * @default 0.0 */ this.z = defaultValue(z, 0.0); /** * The W component. - * @type {Number} + * @type {number} * @default 0.0 */ this.w = defaultValue(w, 0.0); @@ -54,7 +54,7 @@ let fromAxisAngleScratch = new Cartesian3(); * Computes a quaternion representing a rotation around an axis. * * @param {Cartesian3} axis The axis of rotation. - * @param {Number} angle The angle in radians to rotate around the axis. + * @param {number} angle The angle in radians to rotate around the axis. * @param {Quaternion} [result] The object onto which to store the result. * @returns {Quaternion} The modified result parameter or a new Quaternion instance if one was not provided. */ @@ -220,7 +220,7 @@ const sampledQuaternionQuaternion0Conjugate = new Quaternion(); /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Quaternion.packedLength = 4; @@ -228,10 +228,10 @@ Quaternion.packedLength = 4; * Stores the provided instance into the provided array. * * @param {Quaternion} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Quaternion.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -252,8 +252,8 @@ Quaternion.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Quaternion} [result] The object into which to store the result. * @returns {Quaternion} The modified result parameter or a new Quaternion instance if one was not provided. */ @@ -276,17 +276,17 @@ Quaternion.unpack = function (array, startingIndex, result) { /** * The number of elements used to store the object into an array in its interpolatable form. - * @type {Number} + * @type {number} */ Quaternion.packedInterpolationLength = 3; /** * Converts a packed array into a form suitable for interpolation. * - * @param {Number[]} packedArray The packed array. - * @param {Number} [startingIndex=0] The index of the first element to be converted. - * @param {Number} [lastIndex=packedArray.length] The index of the last element to be converted. - * @param {Number[]} [result] The object into which to store the result. + * @param {number[]} packedArray The packed array. + * @param {number} [startingIndex=0] The index of the first element to be converted. + * @param {number} [lastIndex=packedArray.length] The index of the last element to be converted. + * @param {number[]} [result] The object into which to store the result. */ Quaternion.convertPackedArrayForInterpolation = function ( packedArray, @@ -342,10 +342,10 @@ Quaternion.convertPackedArrayForInterpolation = function ( /** * Retrieves an instance from a packed array converted with {@link convertPackedArrayForInterpolation}. * - * @param {Number[]} array The array previously packed for interpolation. - * @param {Number[]} sourceArray The original packed array. - * @param {Number} [firstIndex=0] The firstIndex used to convert the array. - * @param {Number} [lastIndex=packedArray.length] The lastIndex used to convert the array. + * @param {number[]} array The array previously packed for interpolation. + * @param {number[]} sourceArray The original packed array. + * @param {number} [firstIndex=0] The firstIndex used to convert the array. + * @param {number} [lastIndex=packedArray.length] The lastIndex used to convert the array. * @param {Quaternion} [result] The object into which to store the result. * @returns {Quaternion} The modified result parameter or a new Quaternion instance if one was not provided. */ @@ -433,7 +433,7 @@ Quaternion.conjugate = function (quaternion, result) { * Computes magnitude squared for the provided quaternion. * * @param {Quaternion} quaternion The quaternion to conjugate. - * @returns {Number} The magnitude squared. + * @returns {number} The magnitude squared. */ Quaternion.magnitudeSquared = function (quaternion) { //>>includeStart('debug', pragmas.debug); @@ -452,7 +452,7 @@ Quaternion.magnitudeSquared = function (quaternion) { * Computes magnitude for the provided quaternion. * * @param {Quaternion} quaternion The quaternion to conjugate. - * @returns {Number} The magnitude. + * @returns {number} The magnitude. */ Quaternion.magnitude = function (quaternion) { return Math.sqrt(Quaternion.magnitudeSquared(quaternion)); @@ -569,7 +569,7 @@ Quaternion.negate = function (quaternion, result) { * * @param {Quaternion} left The first quaternion. * @param {Quaternion} right The second quaternion. - * @returns {Number} The dot product. + * @returns {number} The dot product. */ Quaternion.dot = function (left, right) { //>>includeStart('debug', pragmas.debug); @@ -623,7 +623,7 @@ Quaternion.multiply = function (left, right, result) { * Multiplies the provided quaternion componentwise by the provided scalar. * * @param {Quaternion} quaternion The quaternion to be scaled. - * @param {Number} scalar The scalar to multiply with. + * @param {number} scalar The scalar to multiply with. * @param {Quaternion} result The object onto which to store the result. * @returns {Quaternion} The modified result parameter. */ @@ -645,7 +645,7 @@ Quaternion.multiplyByScalar = function (quaternion, scalar, result) { * Divides the provided quaternion componentwise by the provided scalar. * * @param {Quaternion} quaternion The quaternion to be divided. - * @param {Number} scalar The scalar to divide by. + * @param {number} scalar The scalar to divide by. * @param {Quaternion} result The object onto which to store the result. * @returns {Quaternion} The modified result parameter. */ @@ -694,7 +694,7 @@ Quaternion.computeAxis = function (quaternion, result) { * Computes the angle of rotation of the provided quaternion. * * @param {Quaternion} quaternion The quaternion to use. - * @returns {Number} The angle of rotation. + * @returns {number} The angle of rotation. */ Quaternion.computeAngle = function (quaternion) { //>>includeStart('debug', pragmas.debug); @@ -713,7 +713,7 @@ let lerpScratch = new Quaternion(); * * @param {Quaternion} start The value corresponding to t at 0.0. * @param {Quaternion} end The value corresponding to t at 1.0. - * @param {Number} t The point along t at which to interpolate. + * @param {number} t The point along t at which to interpolate. * @param {Quaternion} result The object onto which to store the result. * @returns {Quaternion} The modified result parameter. */ @@ -738,7 +738,7 @@ let slerpScaledR = new Quaternion(); * * @param {Quaternion} start The value corresponding to t at 0.0. * @param {Quaternion} end The value corresponding to t at 1.0. - * @param {Number} t The point along t at which to interpolate. + * @param {number} t The point along t at which to interpolate. * @param {Quaternion} result The object onto which to store the result. * @returns {Quaternion} The modified result parameter. * @@ -881,7 +881,7 @@ Quaternion.computeInnerQuadrangle = function (q0, q1, q2, result) { * @param {Quaternion} q1 The second quaternion. * @param {Quaternion} s0 The first inner quadrangle. * @param {Quaternion} s1 The second inner quadrangle. - * @param {Number} t The time in [0,1] used to interpolate. + * @param {number} t The time in [0,1] used to interpolate. * @param {Quaternion} result The object onto which to store the result. * @returns {Quaternion} The modified result parameter. * @@ -937,7 +937,7 @@ v[7] = (opmu * 8.0) / 17.0; * * @param {Quaternion} start The value corresponding to t at 0.0. * @param {Quaternion} end The value corresponding to t at 1.0. - * @param {Number} t The point along t at which to interpolate. + * @param {number} t The point along t at which to interpolate. * @param {Quaternion} result The object onto which to store the result. * @returns {Quaternion} The modified result parameter. * @@ -1016,7 +1016,7 @@ Quaternion.fastSlerp = function (start, end, t, result) { * @param {Quaternion} q1 The second quaternion. * @param {Quaternion} s0 The first inner quadrangle. * @param {Quaternion} s1 The second inner quadrangle. - * @param {Number} t The time in [0,1] used to interpolate. + * @param {number} t The time in [0,1] used to interpolate. * @param {Quaternion} result The object onto which to store the result. * @returns {Quaternion} The modified result parameter or a new instance if none was provided. * @@ -1043,7 +1043,7 @@ Quaternion.fastSquad = function (q0, q1, s0, s1, t, result) { * * @param {Quaternion} [left] The first quaternion. * @param {Quaternion} [right] The second quaternion. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Quaternion.equals = function (left, right) { return ( @@ -1064,8 +1064,8 @@ Quaternion.equals = function (left, right) { * * @param {Quaternion} [left] The first quaternion. * @param {Quaternion} [right] The second quaternion. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Quaternion.equalsEpsilon = function (left, right, epsilon) { epsilon = defaultValue(epsilon, 0); @@ -1112,7 +1112,7 @@ Quaternion.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {Quaternion} [right] The right hand side quaternion. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Quaternion.prototype.equals = function (right) { return Quaternion.equals(this, right); @@ -1124,8 +1124,8 @@ Quaternion.prototype.equals = function (right) { * false otherwise. * * @param {Quaternion} [right] The right hand side quaternion. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Quaternion.prototype.equalsEpsilon = function (right, epsilon) { return Quaternion.equalsEpsilon(this, right, epsilon); @@ -1134,7 +1134,7 @@ Quaternion.prototype.equalsEpsilon = function (right, epsilon) { /** * Returns a string representing this quaternion in the format (x, y, z, w). * - * @returns {String} A string representing this Quaternion. + * @returns {string} A string representing this Quaternion. */ Quaternion.prototype.toString = function () { return `(${this.x}, ${this.y}, ${this.z}, ${this.w})`; diff --git a/packages/engine/Source/Core/QuaternionSpline.js b/packages/engine/Source/Core/QuaternionSpline.js index 295626cf2417..a469c068c92f 100644 --- a/packages/engine/Source/Core/QuaternionSpline.js +++ b/packages/engine/Source/Core/QuaternionSpline.js @@ -33,8 +33,8 @@ function createEvaluateFunction(spline) { * @alias QuaternionSpline * @constructor * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. + * @param {object} options Object with the following properties: + * @param {number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. * The values are in no way connected to the clock time. They are the parameterization for the curve. * @param {Quaternion[]} options.points The array of {@link Quaternion} control points. * @@ -82,7 +82,7 @@ Object.defineProperties(QuaternionSpline.prototype, { * * @memberof QuaternionSpline.prototype * - * @type {Number[]} + * @type {number[]} * @readonly */ times: { @@ -111,8 +111,8 @@ Object.defineProperties(QuaternionSpline.prototype, { * time is in the interval [times[i], times[i + 1]]. * @function * - * @param {Number} time The time. - * @returns {Number} The index for the element at the start of the interval. + * @param {number} time The time. + * @returns {number} The index for the element at the start of the interval. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element @@ -124,8 +124,8 @@ QuaternionSpline.prototype.findTimeInterval = Spline.prototype.findTimeInterval; * Wraps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, wrapped around to the updated animation. + * @param {number} time The time. + * @return {number} The time, wrapped around to the updated animation. */ QuaternionSpline.prototype.wrapTime = Spline.prototype.wrapTime; @@ -133,15 +133,15 @@ QuaternionSpline.prototype.wrapTime = Spline.prototype.wrapTime; * Clamps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, clamped to the animation period. + * @param {number} time The time. + * @return {number} The time, clamped to the animation period. */ QuaternionSpline.prototype.clampTime = Spline.prototype.clampTime; /** * Evaluates the curve at a given time. * - * @param {Number} time The time at which to evaluate the curve. + * @param {number} time The time at which to evaluate the curve. * @param {Quaternion} [result] The object onto which to store the result. * @returns {Quaternion} The modified result parameter or a new instance of the point on the curve at the given time. * diff --git a/packages/engine/Source/Core/Queue.js b/packages/engine/Source/Core/Queue.js index f26b1df586db..b21cff76d1a4 100644 --- a/packages/engine/Source/Core/Queue.js +++ b/packages/engine/Source/Core/Queue.js @@ -16,7 +16,7 @@ Object.defineProperties(Queue.prototype, { * * @memberof Queue.prototype * - * @type {Number} + * @type {number} * @readonly */ length: { @@ -114,7 +114,7 @@ Queue.prototype.sort = function (compareFunction) { * * @param {*} a An item in the array. * @param {*} b An item in the array. - * @returns {Number} Returns a negative value if a is less than b, + * @returns {number} Returns a negative value if a is less than b, * a positive value if a is greater than b, or * 0 if a is equal to b. * diff --git a/packages/engine/Source/Core/Ray.js b/packages/engine/Source/Core/Ray.js index ab2dd79e3fe6..6b63229d65b0 100644 --- a/packages/engine/Source/Core/Ray.js +++ b/packages/engine/Source/Core/Ray.js @@ -55,7 +55,7 @@ Ray.clone = function (ray, result) { * where o is the origin of the ray and d is the direction. * * @param {Ray} ray The ray. - * @param {Number} t A scalar value. + * @param {number} t A scalar value. * @param {Cartesian3} [result] The object in which the result will be stored. * @returns {Cartesian3} The modified result parameter, or a new instance if none was provided. * diff --git a/packages/engine/Source/Core/Rectangle.js b/packages/engine/Source/Core/Rectangle.js index 180350039523..36ca6fab850f 100644 --- a/packages/engine/Source/Core/Rectangle.js +++ b/packages/engine/Source/Core/Rectangle.js @@ -11,10 +11,10 @@ import CesiumMath from "./Math.js"; * @alias Rectangle * @constructor * - * @param {Number} [west=0.0] The westernmost longitude, in radians, in the range [-Pi, Pi]. - * @param {Number} [south=0.0] The southernmost latitude, in radians, in the range [-Pi/2, Pi/2]. - * @param {Number} [east=0.0] The easternmost longitude, in radians, in the range [-Pi, Pi]. - * @param {Number} [north=0.0] The northernmost latitude, in radians, in the range [-Pi/2, Pi/2]. + * @param {number} [west=0.0] The westernmost longitude, in radians, in the range [-Pi, Pi]. + * @param {number} [south=0.0] The southernmost latitude, in radians, in the range [-Pi/2, Pi/2]. + * @param {number} [east=0.0] The easternmost longitude, in radians, in the range [-Pi, Pi]. + * @param {number} [north=0.0] The northernmost latitude, in radians, in the range [-Pi/2, Pi/2]. * * @see Packable */ @@ -22,7 +22,7 @@ function Rectangle(west, south, east, north) { /** * The westernmost longitude in radians in the range [-Pi, Pi]. * - * @type {Number} + * @type {number} * @default 0.0 */ this.west = defaultValue(west, 0.0); @@ -30,7 +30,7 @@ function Rectangle(west, south, east, north) { /** * The southernmost latitude in radians in the range [-Pi/2, Pi/2]. * - * @type {Number} + * @type {number} * @default 0.0 */ this.south = defaultValue(south, 0.0); @@ -38,7 +38,7 @@ function Rectangle(west, south, east, north) { /** * The easternmost longitude in radians in the range [-Pi, Pi]. * - * @type {Number} + * @type {number} * @default 0.0 */ this.east = defaultValue(east, 0.0); @@ -46,7 +46,7 @@ function Rectangle(west, south, east, north) { /** * The northernmost latitude in radians in the range [-Pi/2, Pi/2]. * - * @type {Number} + * @type {number} * @default 0.0 */ this.north = defaultValue(north, 0.0); @@ -56,7 +56,7 @@ Object.defineProperties(Rectangle.prototype, { /** * Gets the width of the rectangle in radians. * @memberof Rectangle.prototype - * @type {Number} + * @type {number} * @readonly */ width: { @@ -68,7 +68,7 @@ Object.defineProperties(Rectangle.prototype, { /** * Gets the height of the rectangle in radians. * @memberof Rectangle.prototype - * @type {Number} + * @type {number} * @readonly */ height: { @@ -80,7 +80,7 @@ Object.defineProperties(Rectangle.prototype, { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ Rectangle.packedLength = 4; @@ -88,10 +88,10 @@ Rectangle.packedLength = 4; * Stores the provided instance into the provided array. * * @param {Rectangle} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ Rectangle.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -112,8 +112,8 @@ Rectangle.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Rectangle} [result] The object into which to store the result. * @returns {Rectangle} The modified result parameter or a new Rectangle instance if one was not provided. */ @@ -138,7 +138,7 @@ Rectangle.unpack = function (array, startingIndex, result) { /** * Computes the width of a rectangle in radians. * @param {Rectangle} rectangle The rectangle to compute the width of. - * @returns {Number} The width. + * @returns {number} The width. */ Rectangle.computeWidth = function (rectangle) { //>>includeStart('debug', pragmas.debug); @@ -155,7 +155,7 @@ Rectangle.computeWidth = function (rectangle) { /** * Computes the height of a rectangle in radians. * @param {Rectangle} rectangle The rectangle to compute the height of. - * @returns {Number} The height. + * @returns {number} The height. */ Rectangle.computeHeight = function (rectangle) { //>>includeStart('debug', pragmas.debug); @@ -167,10 +167,10 @@ Rectangle.computeHeight = function (rectangle) { /** * Creates a rectangle given the boundary longitude and latitude in degrees. * - * @param {Number} [west=0.0] The westernmost longitude in degrees in the range [-180.0, 180.0]. - * @param {Number} [south=0.0] The southernmost latitude in degrees in the range [-90.0, 90.0]. - * @param {Number} [east=0.0] The easternmost longitude in degrees in the range [-180.0, 180.0]. - * @param {Number} [north=0.0] The northernmost latitude in degrees in the range [-90.0, 90.0]. + * @param {number} [west=0.0] The westernmost longitude in degrees in the range [-180.0, 180.0]. + * @param {number} [south=0.0] The southernmost latitude in degrees in the range [-90.0, 90.0]. + * @param {number} [east=0.0] The easternmost longitude in degrees in the range [-180.0, 180.0]. + * @param {number} [north=0.0] The northernmost latitude in degrees in the range [-90.0, 90.0]. * @param {Rectangle} [result] The object onto which to store the result, or undefined if a new instance should be created. * @returns {Rectangle} The modified result parameter or a new Rectangle instance if none was provided. * @@ -198,10 +198,10 @@ Rectangle.fromDegrees = function (west, south, east, north, result) { /** * Creates a rectangle given the boundary longitude and latitude in radians. * - * @param {Number} [west=0.0] The westernmost longitude in radians in the range [-Math.PI, Math.PI]. - * @param {Number} [south=0.0] The southernmost latitude in radians in the range [-Math.PI/2, Math.PI/2]. - * @param {Number} [east=0.0] The easternmost longitude in radians in the range [-Math.PI, Math.PI]. - * @param {Number} [north=0.0] The northernmost latitude in radians in the range [-Math.PI/2, Math.PI/2]. + * @param {number} [west=0.0] The westernmost longitude in radians in the range [-Math.PI, Math.PI]. + * @param {number} [south=0.0] The southernmost latitude in radians in the range [-Math.PI/2, Math.PI/2]. + * @param {number} [east=0.0] The easternmost longitude in radians in the range [-Math.PI, Math.PI]. + * @param {number} [north=0.0] The northernmost latitude in radians in the range [-Math.PI/2, Math.PI/2]. * @param {Rectangle} [result] The object onto which to store the result, or undefined if a new instance should be created. * @returns {Rectangle} The modified result parameter or a new Rectangle instance if none was provided. * @@ -372,8 +372,8 @@ Rectangle.clone = function (rectangle, result) { * * @param {Rectangle} [left] The first Rectangle. * @param {Rectangle} [right] The second Rectangle. - * @param {Number} [absoluteEpsilon=0] The absolute epsilon tolerance to use for equality testing. - * @returns {Boolean} true if left and right are within the provided epsilon, false otherwise. + * @param {number} [absoluteEpsilon=0] The absolute epsilon tolerance to use for equality testing. + * @returns {boolean} true if left and right are within the provided epsilon, false otherwise. */ Rectangle.equalsEpsilon = function (left, right, absoluteEpsilon) { absoluteEpsilon = defaultValue(absoluteEpsilon, 0); @@ -404,7 +404,7 @@ Rectangle.prototype.clone = function (result) { * true if they are equal, false otherwise. * * @param {Rectangle} [other] The Rectangle to compare. - * @returns {Boolean} true if the Rectangles are equal, false otherwise. + * @returns {boolean} true if the Rectangles are equal, false otherwise. */ Rectangle.prototype.equals = function (other) { return Rectangle.equals(this, other); @@ -416,7 +416,7 @@ Rectangle.prototype.equals = function (other) { * * @param {Rectangle} [left] The first Rectangle. * @param {Rectangle} [right] The second Rectangle. - * @returns {Boolean} true if left and right are equal; otherwise false. + * @returns {boolean} true if left and right are equal; otherwise false. */ Rectangle.equals = function (left, right) { return ( @@ -436,8 +436,8 @@ Rectangle.equals = function (left, right) { * false otherwise. * * @param {Rectangle} [other] The Rectangle to compare. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. - * @returns {Boolean} true if the Rectangles are within the provided epsilon, false otherwise. + * @param {number} [epsilon=0] The epsilon to use for equality testing. + * @returns {boolean} true if the Rectangles are within the provided epsilon, false otherwise. */ Rectangle.prototype.equalsEpsilon = function (other, epsilon) { return Rectangle.equalsEpsilon(this, other, epsilon); @@ -786,7 +786,7 @@ Rectangle.expand = function (rectangle, cartographic, result) { * * @param {Rectangle} rectangle The rectangle * @param {Cartographic} cartographic The cartographic to test. - * @returns {Boolean} true if the provided cartographic is inside the rectangle, false otherwise. + * @returns {boolean} true if the provided cartographic is inside the rectangle, false otherwise. */ Rectangle.contains = function (rectangle, cartographic) { //>>includeStart('debug', pragmas.debug); @@ -824,7 +824,7 @@ const subsampleLlaScratch = new Cartographic(); * * @param {Rectangle} rectangle The rectangle to subsample. * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid to use. - * @param {Number} [surfaceHeight=0.0] The height of the rectangle above the ellipsoid. + * @param {number} [surfaceHeight=0.0] The height of the rectangle above the ellipsoid. * @param {Cartesian3[]} [result] The array of Cartesians onto which to store the result. * @returns {Cartesian3[]} The modified result parameter or a new Array of Cartesians instances if none was provided. */ @@ -898,10 +898,10 @@ Rectangle.subsample = function (rectangle, ellipsoid, surfaceHeight, result) { * Computes a subsection of a rectangle from normalized coordinates in the range [0.0, 1.0]. * * @param {Rectangle} rectangle The rectangle to subsection. - * @param {Number} westLerp The west interpolation factor in the range [0.0, 1.0]. Must be less than or equal to eastLerp. - * @param {Number} southLerp The south interpolation factor in the range [0.0, 1.0]. Must be less than or equal to northLerp. - * @param {Number} eastLerp The east interpolation factor in the range [0.0, 1.0]. Must be greater than or equal to westLerp. - * @param {Number} northLerp The north interpolation factor in the range [0.0, 1.0]. Must be greater than or equal to southLerp. + * @param {number} westLerp The west interpolation factor in the range [0.0, 1.0]. Must be less than or equal to eastLerp. + * @param {number} southLerp The south interpolation factor in the range [0.0, 1.0]. Must be less than or equal to northLerp. + * @param {number} eastLerp The east interpolation factor in the range [0.0, 1.0]. Must be greater than or equal to westLerp. + * @param {number} northLerp The north interpolation factor in the range [0.0, 1.0]. Must be greater than or equal to southLerp. * @param {Rectangle} [result] The object onto which to store the result. * @returns {Rectangle} The modified result parameter or a new Rectangle instance if none was provided. */ diff --git a/packages/engine/Source/Core/RectangleCollisionChecker.js b/packages/engine/Source/Core/RectangleCollisionChecker.js index b5801d9c982d..bb8cdb516840 100644 --- a/packages/engine/Source/Core/RectangleCollisionChecker.js +++ b/packages/engine/Source/Core/RectangleCollisionChecker.js @@ -29,7 +29,7 @@ RectangleWithId.fromRectangleAndId = function (id, rectangle, result) { /** * Insert a rectangle into the collision checker. * - * @param {String} id Unique string ID for the rectangle being inserted. + * @param {string} id Unique string ID for the rectangle being inserted. * @param {Rectangle} rectangle A Rectangle * @private */ @@ -55,7 +55,7 @@ const removalScratch = new RectangleWithId(); /** * Remove a rectangle from the collision checker. * - * @param {String} id Unique string ID for the rectangle being removed. + * @param {string} id Unique string ID for the rectangle being removed. * @param {Rectangle} rectangle A Rectangle * @private */ @@ -78,7 +78,7 @@ const collisionScratch = new RectangleWithId(); * Checks if a given rectangle collides with any of the rectangles in the collection. * * @param {Rectangle} rectangle A Rectangle that should be checked against the rectangles in the collision checker. - * @returns {Boolean} Whether the rectangle collides with any of the rectangles in the collision checker. + * @returns {boolean} Whether the rectangle collides with any of the rectangles in the collision checker. */ RectangleCollisionChecker.prototype.collides = function (rectangle) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/RectangleGeometry.js b/packages/engine/Source/Core/RectangleGeometry.js index ab1b4a4a4ab5..7e0b8d5ae7d7 100644 --- a/packages/engine/Source/Core/RectangleGeometry.js +++ b/packages/engine/Source/Core/RectangleGeometry.js @@ -975,15 +975,15 @@ function computeRectangle(rectangle, granularity, rotation, ellipsoid, result) { * @alias RectangleGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Number} [options.height=0.0] The distance in meters between the rectangle and the ellipsoid surface. - * @param {Number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise. - * @param {Number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. - * @param {Number} [options.extrudedHeight] The distance in meters between the rectangle's extruded face and the ellipsoid surface. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number} [options.height=0.0] The distance in meters between the rectangle and the ellipsoid surface. + * @param {number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise. + * @param {number} [options.stRotation=0.0] The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise. + * @param {number} [options.extrudedHeight] The distance in meters between the rectangle's extruded face and the ellipsoid surface. * * @exception {DeveloperError} options.rectangle.north must be in the interval [-Pi/2, Pi/2]. * @exception {DeveloperError} options.rectangle.south must be in the interval [-Pi/2, Pi/2]. @@ -1056,7 +1056,7 @@ function RectangleGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ RectangleGeometry.packedLength = Rectangle.packedLength + @@ -1068,10 +1068,10 @@ RectangleGeometry.packedLength = * Stores the provided instance into the provided array. * * @param {RectangleGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ RectangleGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -1119,8 +1119,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {RectangleGeometry} [result] The object into which to store the result. * @returns {RectangleGeometry} The modified result parameter or a new RectangleGeometry instance if one was not provided. */ @@ -1183,11 +1183,11 @@ RectangleGeometry.unpack = function (array, startingIndex, result) { /** * Computes the bounding rectangle based on the provided options * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise. * @param {Rectangle} [result] An object in which to store the result. * * @returns {Rectangle} The result rectangle diff --git a/packages/engine/Source/Core/RectangleOutlineGeometry.js b/packages/engine/Source/Core/RectangleOutlineGeometry.js index 5a8432d98b5d..03d7cd32d210 100644 --- a/packages/engine/Source/Core/RectangleOutlineGeometry.js +++ b/packages/engine/Source/Core/RectangleOutlineGeometry.js @@ -247,13 +247,13 @@ function constructExtrudedRectangle(rectangleGeometry, computedOptions) { * @alias RectangleOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Number} [options.height=0.0] The distance in meters between the rectangle and the ellipsoid surface. - * @param {Number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise. - * @param {Number} [options.extrudedHeight] The distance in meters between the rectangle's extruded face and the ellipsoid surface. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number} [options.height=0.0] The distance in meters between the rectangle and the ellipsoid surface. + * @param {number} [options.rotation=0.0] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise. + * @param {number} [options.extrudedHeight] The distance in meters between the rectangle's extruded face and the ellipsoid surface. * * @exception {DeveloperError} options.rectangle.north must be in the interval [-Pi/2, Pi/2]. * @exception {DeveloperError} options.rectangle.south must be in the interval [-Pi/2, Pi/2]. @@ -309,7 +309,7 @@ function RectangleOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ RectangleOutlineGeometry.packedLength = Rectangle.packedLength + Ellipsoid.packedLength + 5; @@ -318,10 +318,10 @@ RectangleOutlineGeometry.packedLength = * Stores the provided instance into the provided array. * * @param {RectangleOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ RectangleOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -366,8 +366,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {RectangleOutlineGeometry} [result] The object into which to store the result. * @returns {RectangleOutlineGeometry} The modified result parameter or a new Quaternion instance if one was not provided. */ diff --git a/packages/engine/Source/Core/ReferenceFrame.js b/packages/engine/Source/Core/ReferenceFrame.js index c4a15b4c454a..fdc899040355 100644 --- a/packages/engine/Source/Core/ReferenceFrame.js +++ b/packages/engine/Source/Core/ReferenceFrame.js @@ -1,13 +1,13 @@ /** * Constants for identifying well-known reference frames. * - * @enum {Number} + * @enum {number} */ const ReferenceFrame = { /** * The fixed frame. * - * @type {Number} + * @type {number} * @constant */ FIXED: 0, @@ -15,7 +15,7 @@ const ReferenceFrame = { /** * The inertial frame. * - * @type {Number} + * @type {number} * @constant */ INERTIAL: 1, diff --git a/packages/engine/Source/Core/Request.js b/packages/engine/Source/Core/Request.js index f37b13218733..9988f54c6cc6 100644 --- a/packages/engine/Source/Core/Request.js +++ b/packages/engine/Source/Core/Request.js @@ -9,14 +9,14 @@ import RequestType from "./RequestType.js"; * @alias Request * @constructor - * @param {Object} [options] An object with the following properties: - * @param {String} [options.url] The url to request. + * @param {object} [options] An object with the following properties: + * @param {string} [options.url] The url to request. * @param {Request.RequestCallback} [options.requestFunction] The function that makes the actual data request. * @param {Request.CancelCallback} [options.cancelFunction] The function that is called when the request is cancelled. * @param {Request.PriorityCallback} [options.priorityFunction] The function that is called to update the request's priority, which occurs once per frame. - * @param {Number} [options.priority=0.0] The initial priority of the request. - * @param {Boolean} [options.throttle=false] Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the request will be throttled and sent based on priority. - * @param {Boolean} [options.throttleByServer=false] Whether to throttle the request by server. + * @param {number} [options.priority=0.0] The initial priority of the request. + * @param {boolean} [options.throttle=false] Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the request will be throttled and sent based on priority. + * @param {boolean} [options.throttleByServer=false] Whether to throttle the request by server. * @param {RequestType} [options.type=RequestType.OTHER] The type of request. */ function Request(options) { @@ -28,7 +28,7 @@ function Request(options) { /** * The URL to request. * - * @type {String} + * @type {string} */ this.url = options.url; @@ -60,7 +60,7 @@ function Request(options) { * * If priorityFunction is defined, this value is updated every frame with the result of that call. * - * @type {Number} + * @type {number} * @default 0.0 */ this.priority = defaultValue(options.priority, 0.0); @@ -69,7 +69,7 @@ function Request(options) { * Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the * request will be throttled and sent based on priority. * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -81,7 +81,7 @@ function Request(options) { * for HTTP/1 servers, and an unlimited amount of connections for HTTP/2 servers. Setting this value * to true is preferable for requests going through HTTP/1 servers. * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -101,7 +101,7 @@ function Request(options) { /** * A key used to identify the server that a request is going to. It is derived from the url's authority and scheme. * - * @type {String} + * @type {string} * * @private */ @@ -118,7 +118,7 @@ function Request(options) { /** * The requests's deferred promise. * - * @type {Object} + * @type {object} * * @private */ @@ -127,7 +127,7 @@ function Request(options) { /** * Whether the request was explicitly cancelled. * - * @type {Boolean} + * @type {boolean} * * @private */ @@ -187,6 +187,6 @@ Request.prototype.clone = function (result) { /** * The function that is called to update the request's priority, which occurs once per frame. * @callback Request.PriorityCallback - * @returns {Number} The updated priority value. + * @returns {number} The updated priority value. */ export default Request; diff --git a/packages/engine/Source/Core/RequestErrorEvent.js b/packages/engine/Source/Core/RequestErrorEvent.js index eb4e97896738..41f0e685e550 100644 --- a/packages/engine/Source/Core/RequestErrorEvent.js +++ b/packages/engine/Source/Core/RequestErrorEvent.js @@ -7,9 +7,9 @@ import parseResponseHeaders from "./parseResponseHeaders.js"; * @constructor * @alias RequestErrorEvent * - * @param {Number} [statusCode] The HTTP error status code, such as 404. - * @param {Object} [response] The response included along with the error. - * @param {String|Object} [responseHeaders] The response headers, represented either as an object literal or as a + * @param {number} [statusCode] The HTTP error status code, such as 404. + * @param {object} [response] The response included along with the error. + * @param {string|object} [responseHeaders] The response headers, represented either as an object literal or as a * string in the format returned by XMLHttpRequest's getAllResponseHeaders() function. */ function RequestErrorEvent(statusCode, response, responseHeaders) { @@ -17,7 +17,7 @@ function RequestErrorEvent(statusCode, response, responseHeaders) { * The HTTP error status code, such as 404. If the error does not have a particular * HTTP code, this property will be undefined. * - * @type {Number} + * @type {number} */ this.statusCode = statusCode; @@ -25,7 +25,7 @@ function RequestErrorEvent(statusCode, response, responseHeaders) { * The response included along with the error. If the error does not include a response, * this property will be undefined. * - * @type {Object} + * @type {object} */ this.response = response; @@ -33,7 +33,7 @@ function RequestErrorEvent(statusCode, response, responseHeaders) { * The headers included in the response, represented as an object literal of key/value pairs. * If the error does not include any headers, this property will be undefined. * - * @type {Object} + * @type {object} */ this.responseHeaders = responseHeaders; @@ -46,7 +46,7 @@ function RequestErrorEvent(statusCode, response, responseHeaders) { * Creates a string representing this RequestErrorEvent. * @memberof RequestErrorEvent * - * @returns {String} A string representing the provided RequestErrorEvent. + * @returns {string} A string representing the provided RequestErrorEvent. */ RequestErrorEvent.prototype.toString = function () { let str = "Request has failed."; diff --git a/packages/engine/Source/Core/RequestScheduler.js b/packages/engine/Source/Core/RequestScheduler.js index 8a1a7145b5c8..a0e4b63c8e4e 100644 --- a/packages/engine/Source/Core/RequestScheduler.js +++ b/packages/engine/Source/Core/RequestScheduler.js @@ -51,7 +51,7 @@ function RequestScheduler() {} /** * The maximum number of simultaneous active requests. Un-throttled requests do not observe this limit. - * @type {Number} + * @type {number} * @default 50 */ RequestScheduler.maximumRequests = 50; @@ -59,14 +59,14 @@ RequestScheduler.maximumRequests = 50; /** * The maximum number of simultaneous active requests per server. Un-throttled requests or servers specifically * listed in {@link requestsByServer} do not observe this limit. - * @type {Number} + * @type {number} * @default 6 */ RequestScheduler.maximumRequestsPerServer = 6; /** * A per server key list of overrides to use for throttling instead of maximumRequestsPerServer - * @type {Object} + * @type {object} * * @example * RequestScheduler.requestsByServer = { @@ -81,14 +81,14 @@ RequestScheduler.requestsByServer = { /** * Specifies if the request scheduler should throttle incoming requests, or let the browser queue requests under its control. - * @type {Boolean} + * @type {boolean} * @default true */ RequestScheduler.throttleRequests = true; /** * When true, log statistics to the console every frame - * @type {Boolean} + * @type {boolean} * @default false * @private */ @@ -110,7 +110,7 @@ Object.defineProperties(RequestScheduler, { * * @memberof RequestScheduler * - * @type Object + * @type {object} * @readonly * @private */ @@ -125,7 +125,7 @@ Object.defineProperties(RequestScheduler, { * * @memberof RequestScheduler * - * @type {Number} + * @type {number} * @default 20 * @private */ @@ -157,9 +157,9 @@ function updatePriority(request) { /** * Check if there are open slots for a particular server key. If desiredRequests is greater than 1, this checks if the queue has room for scheduling multiple requests. - * @param {String} serverKey The server key returned by {@link RequestScheduler.getServerKey}. - * @param {Number} [desiredRequests=1] How many requests the caller plans to request - * @return {Boolean} True if there are enough open slots for desiredRequests more requests. + * @param {string} serverKey The server key returned by {@link RequestScheduler.getServerKey}. + * @param {number} [desiredRequests=1] How many requests the caller plans to request + * @return {boolean} True if there are enough open slots for desiredRequests more requests. * @private */ RequestScheduler.serverHasOpenSlots = function (serverKey, desiredRequests) { @@ -179,8 +179,8 @@ RequestScheduler.serverHasOpenSlots = function (serverKey, desiredRequests) { * Check if the priority heap has open slots, regardless of which server they * are from. This is used in {@link Multiple3DTileContent} for determining when * all requests can be scheduled - * @param {Number} desiredRequests The number of requests the caller intends to make - * @return {Boolean} true if the heap has enough available slots to meet the desiredRequests. false otherwise. + * @param {number} desiredRequests The number of requests the caller intends to make + * @return {boolean} true if the heap has enough available slots to meet the desiredRequests. false otherwise. * * @private */ @@ -341,8 +341,8 @@ RequestScheduler.update = function () { /** * Get the server key from a given url. * - * @param {String} url The url. - * @returns {String} The server key. + * @param {string} url The url. + * @returns {string} The server key. * @private */ RequestScheduler.getServerKey = function (url) { diff --git a/packages/engine/Source/Core/RequestState.js b/packages/engine/Source/Core/RequestState.js index a117d9e2b0be..fe83c4ffb640 100644 --- a/packages/engine/Source/Core/RequestState.js +++ b/packages/engine/Source/Core/RequestState.js @@ -1,13 +1,13 @@ /** * State of the request. * - * @enum {Number} + * @enum {number} */ const RequestState = { /** * Initial unissued state. * - * @type Number + * @type {number} * @constant */ UNISSUED: 0, @@ -15,7 +15,7 @@ const RequestState = { /** * Issued but not yet active. Will become active when open slots are available. * - * @type Number + * @type {number} * @constant */ ISSUED: 1, @@ -23,7 +23,7 @@ const RequestState = { /** * Actual http request has been sent. * - * @type Number + * @type {number} * @constant */ ACTIVE: 2, @@ -31,7 +31,7 @@ const RequestState = { /** * Request completed successfully. * - * @type Number + * @type {number} * @constant */ RECEIVED: 3, @@ -39,7 +39,7 @@ const RequestState = { /** * Request was cancelled, either explicitly or automatically because of low priority. * - * @type Number + * @type {number} * @constant */ CANCELLED: 4, @@ -47,7 +47,7 @@ const RequestState = { /** * Request failed. * - * @type Number + * @type {number} * @constant */ FAILED: 5, diff --git a/packages/engine/Source/Core/RequestType.js b/packages/engine/Source/Core/RequestType.js index 5cb89c0e44eb..e8cda3d64974 100644 --- a/packages/engine/Source/Core/RequestType.js +++ b/packages/engine/Source/Core/RequestType.js @@ -1,13 +1,13 @@ /** * An enum identifying the type of request. Used for finer grained logging and priority sorting. * - * @enum {Number} + * @enum {number} */ const RequestType = { /** * Terrain request. * - * @type Number + * @type {number} * @constant */ TERRAIN: 0, @@ -15,7 +15,7 @@ const RequestType = { /** * Imagery request. * - * @type Number + * @type {number} * @constant */ IMAGERY: 1, @@ -23,7 +23,7 @@ const RequestType = { /** * 3D Tiles request. * - * @type Number + * @type {number} * @constant */ TILES3D: 2, @@ -31,7 +31,7 @@ const RequestType = { /** * Other request. * - * @type Number + * @type {number} * @constant */ OTHER: 3, diff --git a/packages/engine/Source/Core/Resource.js b/packages/engine/Source/Core/Resource.js index a02c303f4b32..a13e79f0e958 100644 --- a/packages/engine/Source/Core/Resource.js +++ b/packages/engine/Source/Core/Resource.js @@ -41,8 +41,8 @@ const xhrBlobSupported = (function () { * * @param {Uri} uri The Uri with a query object. * @param {Resource} resource The Resource that will be assigned queryParameters. - * @param {Boolean} merge If true, we'll merge with the resource's existing queryParameters. Otherwise they will be replaced. - * @param {Boolean} preserveQueryParameters If true duplicate parameters will be concatenated into an array. If false, keys in uri will take precedence. + * @param {boolean} merge If true, we'll merge with the resource's existing queryParameters. Otherwise they will be replaced. + * @param {boolean} preserveQueryParameters If true duplicate parameters will be concatenated into an array. If false, keys in uri will take precedence. * * @private */ @@ -135,11 +135,11 @@ function checkAndResetRequest(request) { /** * This combines a map of query parameters. * - * @param {Object} q1 The first map of query parameters. Values in this map will take precedence if preserveQueryParameters is false. - * @param {Object} q2 The second map of query parameters. - * @param {Boolean} preserveQueryParameters If true duplicate parameters will be concatenated into an array. If false, keys in q1 will take precedence. + * @param {object} q1 The first map of query parameters. Values in this map will take precedence if preserveQueryParameters is false. + * @param {object} q2 The second map of query parameters. + * @param {boolean} preserveQueryParameters If true duplicate parameters will be concatenated into an array. If false, keys in q1 will take precedence. * - * @returns {Object} The combined map of query parameters. + * @returns {object} The combined map of query parameters. * * @example * const q1 = { @@ -215,17 +215,17 @@ function combineQueryParameters(q1, q2, preserveQueryParameters) { } /** - * @typedef {Object} Resource.ConstructorOptions + * @typedef {object} Resource.ConstructorOptions * * Initialization options for the Resource constructor * - * @property {String} url The url of the resource. - * @property {Object} [queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @property {Object} [templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @property {Object} [headers={}] Additional HTTP headers that will be sent. + * @property {string} url The url of the resource. + * @property {object} [queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @property {object} [templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @property {object} [headers={}] Additional HTTP headers that will be sent. * @property {Proxy} [proxy] A proxy to be used when loading the resource. * @property {Resource.RetryCallback} [retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @property {Number} [retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @property {number} [retryAttempts=0] The number of times the retryCallback should be called before giving up. * @property {Request} [request] A Request object that will be used. Intended for internal use only. */ @@ -235,7 +235,7 @@ function combineQueryParameters(q1, q2, preserveQueryParameters) { * @alias Resource * @constructor * - * @param {String|Resource.ConstructorOptions} options A url or an object describing initialization options + * @param {string|Resource.ConstructorOptions} options A url or an object describing initialization options * * @example * function refreshTokenRetryCallback(resource, error) { @@ -286,7 +286,7 @@ function Resource(options) { /** * Additional HTTP headers that will be sent with the request. * - * @type {Object} + * @type {object} */ this.headers = defaultClone(options.headers, {}); @@ -314,7 +314,7 @@ function Resource(options) { /** * The number of times the retryCallback should be called before giving up. * - * @type {Number} + * @type {number} */ this.retryAttempts = defaultValue(options.retryAttempts, 0); this._retryCount = 0; @@ -331,7 +331,7 @@ function Resource(options) { /** * A helper function to create a resource depending on whether we have a String or a Resource * - * @param {Resource|String} resource A Resource or a String to use when creating a new Resource. + * @param {Resource|string} resource A Resource or a String to use when creating a new Resource. * * @returns {Resource} If resource is a String, a Resource constructed with the url and options. Otherwise the resource parameter is returned. * @@ -361,7 +361,7 @@ let supportsImageBitmapOptionsPromise; /** * A helper function to check whether createImageBitmap supports passing ImageBitmapOptions. * - * @returns {Promise} A promise that resolves to true if this browser supports creating an ImageBitmap with options. + * @returns {Promise} A promise that resolves to true if this browser supports creating an ImageBitmap with options. * * @private */ @@ -420,7 +420,7 @@ Object.defineProperties(Resource, { * Returns true if blobs are supported. * * @memberof Resource - * @type {Boolean} + * @type {boolean} * * @readonly */ @@ -436,7 +436,7 @@ Object.defineProperties(Resource.prototype, { * Query parameters appended to the url. * * @memberof Resource.prototype - * @type {Object} + * @type {object} * * @readonly */ @@ -450,7 +450,7 @@ Object.defineProperties(Resource.prototype, { * The key/value pairs used to replace template parameters in the url. * * @memberof Resource.prototype - * @type {Object} + * @type {object} * * @readonly */ @@ -464,7 +464,7 @@ Object.defineProperties(Resource.prototype, { * The url to the resource with template values replaced, query string appended and encoded by proxy if one was set. * * @memberof Resource.prototype - * @type {String} + * @type {string} */ url: { get: function () { @@ -486,7 +486,7 @@ Object.defineProperties(Resource.prototype, { * The file extension of the resource. * * @memberof Resource.prototype - * @type {String} + * @type {string} * * @readonly */ @@ -500,7 +500,7 @@ Object.defineProperties(Resource.prototype, { * True if the Resource refers to a data URI. * * @memberof Resource.prototype - * @type {Boolean} + * @type {boolean} */ isDataUri: { get: function () { @@ -512,7 +512,7 @@ Object.defineProperties(Resource.prototype, { * True if the Resource refers to a blob URI. * * @memberof Resource.prototype - * @type {Boolean} + * @type {boolean} */ isBlobUri: { get: function () { @@ -524,7 +524,7 @@ Object.defineProperties(Resource.prototype, { * True if the Resource refers to a cross origin URL. * * @memberof Resource.prototype - * @type {Boolean} + * @type {boolean} */ isCrossOriginUrl: { get: function () { @@ -536,7 +536,7 @@ Object.defineProperties(Resource.prototype, { * True if the Resource has request headers. This is equivalent to checking if the headers property has any keys. * * @memberof Resource.prototype - * @type {Boolean} + * @type {boolean} */ hasHeaders: { get: function () { @@ -549,7 +549,7 @@ Object.defineProperties(Resource.prototype, { * Override Object#toString so that implicit string conversion gives the * complete URL represented by this Resource. * - * @returns {String} The URL represented by this Resource + * @returns {string} The URL represented by this Resource */ Resource.prototype.toString = function () { return this.getUrlComponent(true, true); @@ -558,10 +558,10 @@ Resource.prototype.toString = function () { /** * Returns the url, optional with the query string and processed by a proxy. * - * @param {Boolean} [query=false] If true, the query string is included. - * @param {Boolean} [proxy=false] If true, the url is processed by the proxy object, if defined. + * @param {boolean} [query=false] If true, the query string is included. + * @param {boolean} [proxy=false] If true, the url is processed by the proxy object, if defined. * - * @returns {String} The url with all the requested components. + * @returns {string} The url with all the requested components. */ Resource.prototype.getUrlComponent = function (query, proxy) { if (this.isDataUri) { @@ -598,8 +598,8 @@ Resource.prototype.getUrlComponent = function (query, proxy) { * Combines the specified object and the existing query parameters. This allows you to add many parameters at once, * as opposed to adding them one at a time to the queryParameters property. If a value is already set, it will be replaced with the new value. * - * @param {Object} params The query parameters - * @param {Boolean} [useAsDefault=false] If true the params will be used as the default values, so they will only be set if they are undefined. + * @param {object} params The query parameters + * @param {boolean} [useAsDefault=false] If true the params will be used as the default values, so they will only be set if they are undefined. */ Resource.prototype.setQueryParameters = function (params, useAsDefault) { if (useAsDefault) { @@ -621,7 +621,7 @@ Resource.prototype.setQueryParameters = function (params, useAsDefault) { * Combines the specified object and the existing query parameters. This allows you to add many parameters at once, * as opposed to adding them one at a time to the queryParameters property. * - * @param {Object} params The query parameters + * @param {object} params The query parameters */ Resource.prototype.appendQueryParameters = function (params) { this._queryParameters = combineQueryParameters( @@ -635,8 +635,8 @@ Resource.prototype.appendQueryParameters = function (params) { * Combines the specified object and the existing template values. This allows you to add many values at once, * as opposed to adding them one at a time to the templateValues property. If a value is already set, it will become an array and the new value will be appended. * - * @param {Object} template The template values - * @param {Boolean} [useAsDefault=false] If true the values will be used as the default values, so they will only be set if they are undefined. + * @param {object} template The template values + * @param {boolean} [useAsDefault=false] If true the values will be used as the default values, so they will only be set if they are undefined. */ Resource.prototype.setTemplateValues = function (template, useAsDefault) { if (useAsDefault) { @@ -649,16 +649,16 @@ Resource.prototype.setTemplateValues = function (template, useAsDefault) { /** * Returns a resource relative to the current instance. All properties remain the same as the current instance unless overridden in options. * - * @param {Object} options An object with the following properties - * @param {String} [options.url] The url that will be resolved relative to the url of the current instance. - * @param {Object} [options.queryParameters] An object containing query parameters that will be combined with those of the current instance. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). These will be combined with those of the current instance. - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {object} options An object with the following properties + * @param {string} [options.url] The url that will be resolved relative to the url of the current instance. + * @param {object} [options.queryParameters] An object containing query parameters that will be combined with those of the current instance. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). These will be combined with those of the current instance. + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The function to call when loading the resource fails. - * @param {Number} [options.retryAttempts] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {Boolean} [options.preserveQueryParameters=false] If true, this will keep all query parameters from the current resource and derived resource. If false, derived parameters will replace those of the current resource. + * @param {boolean} [options.preserveQueryParameters=false] If true, this will keep all query parameters from the current resource and derived resource. If false, derived parameters will replace those of the current resource. * * @returns {Resource} The resource derived from the current one. */ @@ -723,7 +723,7 @@ Resource.prototype.getDerivedResource = function (options) { * * @param {Error} [error] The error that was encountered. * - * @returns {Promise} A promise to a boolean, that if true will cause the resource request to be retried. + * @returns {Promise} A promise to a boolean, that if true will cause the resource request to be retried. * * @private */ @@ -774,9 +774,9 @@ Resource.prototype.clone = function (result) { /** * Returns the base path of the Resource. * - * @param {Boolean} [includeQuery = false] Whether or not to include the query string and fragment form the uri + * @param {boolean} [includeQuery = false] Whether or not to include the query string and fragment form the uri * - * @returns {String} The base URI of the resource + * @returns {string} The base URI of the resource */ Resource.prototype.getBaseUri = function (includeQuery) { return getBaseUri(this.getUrlComponent(includeQuery), includeQuery); @@ -795,7 +795,7 @@ Resource.prototype.appendForwardSlash = function () { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * @example * // load a single URL asynchronously @@ -817,16 +817,16 @@ Resource.prototype.fetchArrayBuffer = function () { /** * Creates a Resource and calls fetchArrayBuffer() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.fetchArrayBuffer = function (options) { const resource = new Resource(options); @@ -839,7 +839,7 @@ Resource.fetchArrayBuffer = function (options) { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * @example * // load a single URL asynchronously @@ -861,16 +861,16 @@ Resource.prototype.fetchBlob = function () { /** * Creates a Resource and calls fetchBlob() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.fetchBlob = function (options) { const resource = new Resource(options); @@ -882,12 +882,12 @@ Resource.fetchBlob = function (options) { * an {@link https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap|ImageBitmap} if preferImageBitmap is true and the browser supports createImageBitmap or otherwise an * {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement|Image} once loaded, or reject if the image failed to load. * - * @param {Object} [options] An object with the following properties. - * @param {Boolean} [options.preferBlob=false] If true, we will load the image via a blob. - * @param {Boolean} [options.preferImageBitmap=false] If true, image will be decoded during fetch and an ImageBitmap is returned. - * @param {Boolean} [options.flipY=false] If true, image will be vertically flipped during decode. Only applies if the browser supports createImageBitmap. - * @param {Boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the image will be ignored. Only applies if the browser supports createImageBitmap. - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {object} [options] An object with the following properties. + * @param {boolean} [options.preferBlob=false] If true, we will load the image via a blob. + * @param {boolean} [options.preferImageBitmap=false] If true, image will be decoded during fetch and an ImageBitmap is returned. + * @param {boolean} [options.flipY=false] If true, image will be vertically flipped during decode. Only applies if the browser supports createImageBitmap. + * @param {boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the image will be ignored. Only applies if the browser supports createImageBitmap. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1009,11 +1009,11 @@ Resource.prototype.fetchImage = function (options) { /** * Fetches an image and returns a promise to it. * - * @param {Object} [options] An object with the following properties. + * @param {object} [options] An object with the following properties. * @param {Resource} [options.resource] Resource object that points to an image to fetch. - * @param {Boolean} [options.preferImageBitmap] If true, image will be decoded during fetch and an ImageBitmap is returned. - * @param {Boolean} [options.flipY] If true, image will be vertically flipped during decode. Only applies if the browser supports createImageBitmap. - * @param {Boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the image will be ignored. Only applies if the browser supports createImageBitmap. + * @param {boolean} [options.preferImageBitmap] If true, image will be decoded during fetch and an ImageBitmap is returned. + * @param {boolean} [options.flipY] If true, image will be vertically flipped during decode. Only applies if the browser supports createImageBitmap. + * @param {boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the image will be ignored. Only applies if the browser supports createImageBitmap. * @private */ function fetchImage(options) { @@ -1076,20 +1076,20 @@ function fetchImage(options) { /** * Creates a Resource and calls fetchImage() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. - * @param {Boolean} [options.flipY=false] Whether to vertically flip the image during fetch and decode. Only applies when requesting an image and the browser supports createImageBitmap. + * @param {boolean} [options.flipY=false] Whether to vertically flip the image during fetch and decode. Only applies when requesting an image and the browser supports createImageBitmap. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {Boolean} [options.preferBlob=false] If true, we will load the image via a blob. - * @param {Boolean} [options.preferImageBitmap=false] If true, image will be decoded during fetch and an ImageBitmap is returned. - * @param {Boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the image will be ignored. Only applies when requesting an image and the browser supports createImageBitmap. - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {boolean} [options.preferBlob=false] If true, we will load the image via a blob. + * @param {boolean} [options.preferImageBitmap=false] If true, image will be decoded during fetch and an ImageBitmap is returned. + * @param {boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the image will be ignored. Only applies when requesting an image and the browser supports createImageBitmap. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.fetchImage = function (options) { const resource = new Resource(options); @@ -1107,7 +1107,7 @@ Resource.fetchImage = function (options) { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * @example * // load text from a URL, setting a custom header @@ -1136,16 +1136,16 @@ Resource.prototype.fetchText = function () { /** * Creates a Resource and calls fetchText() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.fetchText = function (options) { const resource = new Resource(options); @@ -1161,7 +1161,7 @@ Resource.fetchText = function (options) { * adds 'Accept: application/json,*/*;q=0.01' to the request headers, if not * already specified. * - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1197,16 +1197,16 @@ Resource.prototype.fetchJson = function () { /** * Creates a Resource and calls fetchJson() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.fetchJson = function (options) { const resource = new Resource(options); @@ -1219,7 +1219,7 @@ Resource.fetchJson = function (options) { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1246,16 +1246,16 @@ Resource.prototype.fetchXML = function () { /** * Creates a Resource and calls fetchXML() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @returns {Promise.|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.fetchXML = function (options) { const resource = new Resource(options); @@ -1265,8 +1265,8 @@ Resource.fetchXML = function (options) { /** * Requests a resource using JSONP. * - * @param {String} [callbackParameterName='callback'] The callback parameter name that the server expects. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {string} [callbackParameterName='callback'] The callback parameter name that the server expects. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1351,17 +1351,17 @@ function fetchJsonp(resource, callbackParameterName, functionName) { /** * Creates a Resource from a URL and calls fetchJsonp() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {String} [options.callbackParameterName='callback'] The callback parameter name that the server expects. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {string} [options.callbackParameterName='callback'] The callback parameter name that the server expects. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.fetchJsonp = function (options) { const resource = new Resource(options); @@ -1494,11 +1494,11 @@ function decodeDataUri(dataUriRegexResult, responseType) { * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. It's recommended that you use * the more specific functions eg. fetchJson, fetchBlob, etc. * - * @param {Object} [options] Object with the following properties: - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {Object} [options.headers] Additional HTTP headers to send with the request, if any. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {object} [options] Object with the following properties: + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {object} [options.headers] Additional HTTP headers to send with the request, if any. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1522,18 +1522,18 @@ Resource.prototype.fetch = function (options) { /** * Creates a Resource from a URL and calls fetch() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.fetch = function (options) { const resource = new Resource(options); @@ -1550,11 +1550,11 @@ Resource.fetch = function (options) { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @param {Object} [options] Object with the following properties: - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {Object} [options.headers] Additional HTTP headers to send with the request, if any. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {object} [options] Object with the following properties: + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {object} [options.headers] Additional HTTP headers to send with the request, if any. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1578,19 +1578,19 @@ Resource.prototype.delete = function (options) { /** * Creates a Resource from a URL and calls delete() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.data] Data that is posted with the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.data] Data that is posted with the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.delete = function (options) { const resource = new Resource(options); @@ -1608,11 +1608,11 @@ Resource.delete = function (options) { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @param {Object} [options] Object with the following properties: - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {Object} [options.headers] Additional HTTP headers to send with the request, if any. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {object} [options] Object with the following properties: + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {object} [options.headers] Additional HTTP headers to send with the request, if any. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1636,18 +1636,18 @@ Resource.prototype.head = function (options) { /** * Creates a Resource from a URL and calls head() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.head = function (options) { const resource = new Resource(options); @@ -1664,11 +1664,11 @@ Resource.head = function (options) { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @param {Object} [options] Object with the following properties: - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {Object} [options.headers] Additional HTTP headers to send with the request, if any. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {object} [options] Object with the following properties: + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {object} [options.headers] Additional HTTP headers to send with the request, if any. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1692,18 +1692,18 @@ Resource.prototype.options = function (options) { /** * Creates a Resource from a URL and calls options() on it. * - * @param {String|Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {string|object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.options = function (options) { const resource = new Resource(options); @@ -1720,13 +1720,13 @@ Resource.options = function (options) { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @param {Object} data Data that is posted with the resource. - * @param {Object} [options] Object with the following properties: - * @param {Object} [options.data] Data that is posted with the resource. - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {Object} [options.headers] Additional HTTP headers to send with the request, if any. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {object} data Data that is posted with the resource. + * @param {object} [options] Object with the following properties: + * @param {object} [options.data] Data that is posted with the resource. + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {object} [options.headers] Additional HTTP headers to send with the request, if any. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1753,19 +1753,19 @@ Resource.prototype.post = function (data, options) { /** * Creates a Resource from a URL and calls post() on it. * - * @param {Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} options.data Data that is posted with the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} options.data Data that is posted with the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.post = function (options) { const resource = new Resource(options); @@ -1782,12 +1782,12 @@ Resource.post = function (options) { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @param {Object} data Data that is posted with the resource. - * @param {Object} [options] Object with the following properties: - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {Object} [options.headers] Additional HTTP headers to send with the request, if any. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {object} data Data that is posted with the resource. + * @param {object} [options] Object with the following properties: + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {object} [options.headers] Additional HTTP headers to send with the request, if any. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1814,19 +1814,19 @@ Resource.prototype.put = function (data, options) { /** * Creates a Resource from a URL and calls put() on it. * - * @param {Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} options.data Data that is posted with the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} options.data Data that is posted with the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.put = function (options) { const resource = new Resource(options); @@ -1843,12 +1843,12 @@ Resource.put = function (options) { * using XMLHttpRequest, which means that in order to make requests to another origin, * the server must have Cross-Origin Resource Sharing (CORS) headers enabled. * - * @param {Object} data Data that is posted with the resource. - * @param {Object} [options] Object with the following properties: - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {Object} [options.headers] Additional HTTP headers to send with the request, if any. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {object} data Data that is posted with the resource. + * @param {object} [options] Object with the following properties: + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {object} [options.headers] Additional HTTP headers to send with the request, if any. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * * @example @@ -1875,19 +1875,19 @@ Resource.prototype.patch = function (data, options) { /** * Creates a Resource from a URL and calls patch() on it. * - * @param {Object} options A url or an object with the following properties - * @param {String} options.url The url of the resource. - * @param {Object} options.data Data that is posted with the resource. - * @param {Object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. - * @param {Object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). - * @param {Object} [options.headers={}] Additional HTTP headers that will be sent. + * @param {object} options A url or an object with the following properties + * @param {string} options.url The url of the resource. + * @param {object} options.data Data that is posted with the resource. + * @param {object} [options.queryParameters] An object containing query parameters that will be sent when retrieving the resource. + * @param {object} [options.templateValues] Key/Value pairs that are used to replace template values (eg. {x}). + * @param {object} [options.headers={}] Additional HTTP headers that will be sent. * @param {Proxy} [options.proxy] A proxy to be used when loading the resource. * @param {Resource.RetryCallback} [options.retryCallback] The Function to call when a request for this resource fails. If it returns true, the request will be retried. - * @param {Number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. + * @param {number} [options.retryAttempts=0] The number of times the retryCallback should be called before giving up. * @param {Request} [options.request] A Request object that will be used. Intended for internal use only. - * @param {String} [options.responseType] The type of response. This controls the type of item returned. - * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server. - * @returns {Promise.<*>|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {string} [options.responseType] The type of response. This controls the type of item returned. + * @param {string} [options.overrideMimeType] Overrides the MIME type returned by the server. + * @returns {Promise|undefined} a promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. */ Resource.patch = function (options) { const resource = new Resource(options); @@ -2302,6 +2302,6 @@ Resource.DEFAULT = Object.freeze( * * @param {Resource} [resource] The resource that failed to load. * @param {Error} [error] The error that occurred during the loading of the resource. - * @returns {Boolean|Promise} If true or a promise that resolved to true, the resource will be retried. Otherwise the failure will be returned. + * @returns {boolean|Promise} If true or a promise that resolved to true, the resource will be retried. Otherwise the failure will be returned. */ export default Resource; diff --git a/packages/engine/Source/Core/RuntimeError.js b/packages/engine/Source/Core/RuntimeError.js index 3a8f2a557dd5..8bbd56d74efe 100644 --- a/packages/engine/Source/Core/RuntimeError.js +++ b/packages/engine/Source/Core/RuntimeError.js @@ -13,21 +13,21 @@ import defined from "./defined.js"; * @constructor * @extends Error * - * @param {String} [message] The error message for this exception. + * @param {string} [message] The error message for this exception. * * @see DeveloperError */ function RuntimeError(message) { /** * 'RuntimeError' indicating that this exception was thrown due to a runtime error. - * @type {String} + * @type {string} * @readonly */ this.name = "RuntimeError"; /** * The explanation for why this exception was thrown. - * @type {String} + * @type {string} * @readonly */ this.message = message; @@ -42,7 +42,7 @@ function RuntimeError(message) { /** * The stack trace of this exception, if available. - * @type {String} + * @type {string} * @readonly */ this.stack = stack; diff --git a/packages/engine/Source/Core/S2Cell.js b/packages/engine/Source/Core/S2Cell.js index 495c97c86b8f..67a05266fce4 100644 --- a/packages/engine/Source/Core/S2Cell.js +++ b/packages/engine/Source/Core/S2Cell.js @@ -154,7 +154,7 @@ const S2_POSITION_TO_ORIENTATION_MASK = [ * @alias S2Cell * @constructor * - * @param {BigInt} [cellId] The 64-bit S2CellId. + * @param {bigint} [cellId] The 64-bit S2CellId. * @private */ function S2Cell(cellId) { @@ -177,7 +177,7 @@ function S2Cell(cellId) { /** * Creates a new S2Cell from a token. A token is a hexadecimal representation of the 64-bit S2CellId. * - * @param {String} token The token for the S2 Cell. + * @param {string} token The token for the S2 Cell. * @returns {S2Cell} Returns a new S2Cell. * @private */ @@ -195,8 +195,8 @@ S2Cell.fromToken = function (token) { /** * Validates an S2 cell ID. * - * @param {BigInt} [cellId] The S2CellId. - * @returns {Boolean} Returns true if the cell ID is valid, returns false otherwise. + * @param {bigint} [cellId] The S2CellId. + * @returns {boolean} Returns true if the cell ID is valid, returns false otherwise. * @private */ S2Cell.isValidId = function (cellId) { @@ -229,8 +229,8 @@ S2Cell.isValidId = function (cellId) { /** * Validates an S2 cell token. * - * @param {String} [token] The hexadecimal representation of an S2CellId. - * @returns {Boolean} Returns true if the token is valid, returns false otherwise. + * @param {string} [token] The hexadecimal representation of an S2CellId. + * @returns {boolean} Returns true if the token is valid, returns false otherwise. * @private */ S2Cell.isValidToken = function (token) { @@ -248,8 +248,8 @@ S2Cell.isValidToken = function (token) { /** * Converts an S2 cell token to a 64-bit S2 cell ID. * - * @param {String} [token] The hexadecimal representation of an S2CellId. Expected to be a valid S2 token. - * @returns {BigInt} Returns the S2 cell ID. + * @param {string} [token] The hexadecimal representation of an S2CellId. Expected to be a valid S2 token. + * @returns {bigint} Returns the S2 cell ID. * @private */ S2Cell.getIdFromToken = function (token) { @@ -263,7 +263,7 @@ S2Cell.getIdFromToken = function (token) { /** * Converts a 64-bit S2 cell ID to an S2 cell token. * - * @param {BigInt} [cellId] The S2 cell ID. + * @param {bigint} [cellId] The S2 cell ID. * @returns {string} Returns hexadecimal representation of an S2CellId. * @private */ @@ -284,7 +284,7 @@ S2Cell.getTokenFromId = function (cellId) { /** * Gets the level of the cell from the cell ID. * - * @param {BigInt} [cellId] The S2 cell ID. + * @param {bigint} [cellId] The S2 cell ID. * @returns {number} Returns the level of the cell. * @private */ @@ -314,7 +314,7 @@ S2Cell.getLevel = function (cellId) { /** * Gets the child cell of the cell at the given index. * - * @param {Number} index An integer index of the child. + * @param {number} index An integer index of the child. * @returns {S2Cell} The child of the S2Cell. * @private */ @@ -398,7 +398,7 @@ S2Cell.prototype.getCenter = function (ellipsoid) { /** * Get vertex of the S2 cell. Vertices are indexed in CCW order. * - * @param {Number} index An integer index of the vertex. Must be in the range [0-3]. + * @param {number} index An integer index of the vertex. Must be in the range [0-3]. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid. * @returns {Cartesian3} The position of the vertex of the S2 cell. * @private @@ -427,9 +427,9 @@ S2Cell.prototype.getVertex = function (index, ellipsoid) { /** * Creates an S2Cell from its face, position along the Hilbert curve for a given level. * - * @param {Number} face The root face of S2 this cell is on. Must be in the range [0-5]. - * @param {BigInt} position The position along the Hilbert curve. Must be in the range [0-4**level). - * @param {Number} level The level of the S2 curve. Must be in the range [0-30]. + * @param {number} face The root face of S2 this cell is on. Must be in the range [0-5]. + * @param {bigint} position The position along the Hilbert curve. Must be in the range [0-4**level). + * @param {number} level The level of the S2 curve. Must be in the range [0-30]. * @returns {S2Cell} A new S2Cell from the given parameters. * @private */ diff --git a/packages/engine/Source/Core/ScreenSpaceEventHandler.js b/packages/engine/Source/Core/ScreenSpaceEventHandler.js index bac2b72e2ad6..0c2fb86c6079 100644 --- a/packages/engine/Source/Core/ScreenSpaceEventHandler.js +++ b/packages/engine/Source/Core/ScreenSpaceEventHandler.js @@ -893,7 +893,7 @@ function handlePointerMove(screenSpaceEventHandler, event) { } /** - * @typedef {Object} ScreenSpaceEventHandler.PositionedEvent + * @typedef {object} ScreenSpaceEventHandler.PositionedEvent * * An Event that occurs at a single position on screen. * @@ -909,7 +909,7 @@ function handlePointerMove(screenSpaceEventHandler, event) { */ /** - * @typedef {Object} ScreenSpaceEventHandler.MotionEvent + * @typedef {object} ScreenSpaceEventHandler.MotionEvent * * An Event that starts at one position and ends at another. * @@ -926,7 +926,7 @@ function handlePointerMove(screenSpaceEventHandler, event) { */ /** - * @typedef {Object} ScreenSpaceEventHandler.TwoPointEvent + * @typedef {object} ScreenSpaceEventHandler.TwoPointEvent * * An Event that occurs at a two positions on screen. * @@ -943,7 +943,7 @@ function handlePointerMove(screenSpaceEventHandler, event) { */ /** - * @typedef {Object} ScreenSpaceEventHandler.TwoPointMotionEvent + * @typedef {object} ScreenSpaceEventHandler.TwoPointMotionEvent * * An Event that starts at a two positions on screen and moves to two other positions. * @@ -1093,7 +1093,7 @@ ScreenSpaceEventHandler.prototype.removeInputAction = function ( * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see ScreenSpaceEventHandler#destroy */ @@ -1125,7 +1125,7 @@ ScreenSpaceEventHandler.prototype.destroy = function () { /** * The amount of time, in milliseconds, that mouse events will be disabled after * receiving any touch events, such that any emulated mouse events will be ignored. - * @type {Number} + * @type {number} * @default 800 */ ScreenSpaceEventHandler.mouseEmulationIgnoreMilliseconds = 800; @@ -1133,7 +1133,7 @@ ScreenSpaceEventHandler.mouseEmulationIgnoreMilliseconds = 800; /** * The amount of time, in milliseconds, before a touch on the screen becomes a * touch and hold. - * @type {Number} + * @type {number} * @default 1500 */ ScreenSpaceEventHandler.touchHoldDelayMilliseconds = 1500; diff --git a/packages/engine/Source/Core/ScreenSpaceEventType.js b/packages/engine/Source/Core/ScreenSpaceEventType.js index ca9af078e34d..cb5f633f39b4 100644 --- a/packages/engine/Source/Core/ScreenSpaceEventType.js +++ b/packages/engine/Source/Core/ScreenSpaceEventType.js @@ -1,13 +1,13 @@ /** * This enumerated type is for classifying mouse events: down, up, click, double click, move and move while a button is held down. * - * @enum {Number} + * @enum {number} */ const ScreenSpaceEventType = { /** * Represents a mouse left button down event. * - * @type {Number} + * @type {number} * @constant */ LEFT_DOWN: 0, @@ -15,7 +15,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse left button up event. * - * @type {Number} + * @type {number} * @constant */ LEFT_UP: 1, @@ -23,7 +23,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse left click event. * - * @type {Number} + * @type {number} * @constant */ LEFT_CLICK: 2, @@ -31,7 +31,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse left double click event. * - * @type {Number} + * @type {number} * @constant */ LEFT_DOUBLE_CLICK: 3, @@ -39,7 +39,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse left button down event. * - * @type {Number} + * @type {number} * @constant */ RIGHT_DOWN: 5, @@ -47,7 +47,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse right button up event. * - * @type {Number} + * @type {number} * @constant */ RIGHT_UP: 6, @@ -55,7 +55,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse right click event. * - * @type {Number} + * @type {number} * @constant */ RIGHT_CLICK: 7, @@ -63,7 +63,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse middle button down event. * - * @type {Number} + * @type {number} * @constant */ MIDDLE_DOWN: 10, @@ -71,7 +71,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse middle button up event. * - * @type {Number} + * @type {number} * @constant */ MIDDLE_UP: 11, @@ -79,7 +79,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse middle click event. * - * @type {Number} + * @type {number} * @constant */ MIDDLE_CLICK: 12, @@ -87,7 +87,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse move event. * - * @type {Number} + * @type {number} * @constant */ MOUSE_MOVE: 15, @@ -95,7 +95,7 @@ const ScreenSpaceEventType = { /** * Represents a mouse wheel event. * - * @type {Number} + * @type {number} * @constant */ WHEEL: 16, @@ -103,7 +103,7 @@ const ScreenSpaceEventType = { /** * Represents the start of a two-finger event on a touch surface. * - * @type {Number} + * @type {number} * @constant */ PINCH_START: 17, @@ -111,7 +111,7 @@ const ScreenSpaceEventType = { /** * Represents the end of a two-finger event on a touch surface. * - * @type {Number} + * @type {number} * @constant */ PINCH_END: 18, @@ -119,7 +119,7 @@ const ScreenSpaceEventType = { /** * Represents a change of a two-finger event on a touch surface. * - * @type {Number} + * @type {number} * @constant */ PINCH_MOVE: 19, diff --git a/packages/engine/Source/Core/ShowGeometryInstanceAttribute.js b/packages/engine/Source/Core/ShowGeometryInstanceAttribute.js index 18e224151e42..ddef78ca7af9 100644 --- a/packages/engine/Source/Core/ShowGeometryInstanceAttribute.js +++ b/packages/engine/Source/Core/ShowGeometryInstanceAttribute.js @@ -9,7 +9,7 @@ import DeveloperError from "./DeveloperError.js"; * @alias ShowGeometryInstanceAttribute * @constructor * - * @param {Boolean} [show=true] Determines if the geometry instance will be shown. + * @param {boolean} [show=true] Determines if the geometry instance will be shown. * * * @example @@ -66,7 +66,7 @@ Object.defineProperties(ShowGeometryInstanceAttribute.prototype, { * * @memberof ShowGeometryInstanceAttribute.prototype * - * @type {Number} + * @type {number} * @readonly * * @default 1 @@ -84,7 +84,7 @@ Object.defineProperties(ShowGeometryInstanceAttribute.prototype, { * * @memberof ShowGeometryInstanceAttribute.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -99,7 +99,7 @@ Object.defineProperties(ShowGeometryInstanceAttribute.prototype, { /** * Converts a boolean show to a typed array that can be used to assign a show attribute. * - * @param {Boolean} show The show value. + * @param {boolean} show The show value. * @param {Uint8Array} [result] The array to store the result in, if undefined a new instance will be created. * @returns {Uint8Array} The modified result parameter or a new instance if result was undefined. * diff --git a/packages/engine/Source/Core/SimplePolylineGeometry.js b/packages/engine/Source/Core/SimplePolylineGeometry.js index de72f8b0b602..cabcb2312d4b 100644 --- a/packages/engine/Source/Core/SimplePolylineGeometry.js +++ b/packages/engine/Source/Core/SimplePolylineGeometry.js @@ -62,12 +62,12 @@ function interpolateColors(p0, p1, color0, color1, minDistance, array, offset) { * @alias SimplePolylineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip. * @param {Color[]} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors. - * @param {Boolean} [options.colorsPerVertex=false] A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices. + * @param {boolean} [options.colorsPerVertex=false] A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices. * @param {ArcType} [options.arcType=ArcType.GEODESIC] The type of line the polyline segments must follow. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude if options.arcType is not ArcType.NONE. Determines the number of positions in the buffer. + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude if options.arcType is not ArcType.NONE. Determines the number of positions in the buffer. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference. * * @exception {DeveloperError} At least two positions are required. @@ -122,7 +122,7 @@ function SimplePolylineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = numComponents + Ellipsoid.packedLength + 3; } @@ -131,10 +131,10 @@ function SimplePolylineGeometry(options) { * Stores the provided instance into the provided array. * * @param {SimplePolylineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ SimplePolylineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -179,8 +179,8 @@ SimplePolylineGeometry.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {SimplePolylineGeometry} [result] The object into which to store the result. * @returns {SimplePolylineGeometry} The modified result parameter or a new SimplePolylineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/SphereGeometry.js b/packages/engine/Source/Core/SphereGeometry.js index 3e9b5ebf512c..14246063e2f2 100644 --- a/packages/engine/Source/Core/SphereGeometry.js +++ b/packages/engine/Source/Core/SphereGeometry.js @@ -11,10 +11,10 @@ import VertexFormat from "./VertexFormat.js"; * @alias SphereGeometry * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Number} [options.radius=1.0] The radius of the sphere. - * @param {Number} [options.stackPartitions=64] The number of times to partition the ellipsoid into stacks. - * @param {Number} [options.slicePartitions=64] The number of times to partition the ellipsoid into radial slices. + * @param {object} [options] Object with the following properties: + * @param {number} [options.radius=1.0] The radius of the sphere. + * @param {number} [options.stackPartitions=64] The number of times to partition the ellipsoid into stacks. + * @param {number} [options.slicePartitions=64] The number of times to partition the ellipsoid into radial slices. * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. * * @exception {DeveloperError} options.slicePartitions cannot be less than three. @@ -45,7 +45,7 @@ function SphereGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ SphereGeometry.packedLength = EllipsoidGeometry.packedLength; @@ -53,10 +53,10 @@ SphereGeometry.packedLength = EllipsoidGeometry.packedLength; * Stores the provided instance into the provided array. * * @param {SphereGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ SphereGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -78,8 +78,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {SphereGeometry} [result] The object into which to store the result. * @returns {SphereGeometry} The modified result parameter or a new SphereGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/SphereOutlineGeometry.js b/packages/engine/Source/Core/SphereOutlineGeometry.js index 7a86fadf0e6b..f8a182129a04 100644 --- a/packages/engine/Source/Core/SphereOutlineGeometry.js +++ b/packages/engine/Source/Core/SphereOutlineGeometry.js @@ -10,11 +10,11 @@ import EllipsoidOutlineGeometry from "./EllipsoidOutlineGeometry.js"; * @alias SphereOutlineGeometry * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Number} [options.radius=1.0] The radius of the sphere. - * @param {Number} [options.stackPartitions=10] The count of stacks for the sphere (1 greater than the number of parallel lines). - * @param {Number} [options.slicePartitions=8] The count of slices for the sphere (Equal to the number of radial lines). - * @param {Number} [options.subdivisions=200] The number of points per line, determining the granularity of the curvature . + * @param {object} [options] Object with the following properties: + * @param {number} [options.radius=1.0] The radius of the sphere. + * @param {number} [options.stackPartitions=10] The count of stacks for the sphere (1 greater than the number of parallel lines). + * @param {number} [options.slicePartitions=8] The count of slices for the sphere (Equal to the number of radial lines). + * @param {number} [options.subdivisions=200] The number of points per line, determining the granularity of the curvature . * * @exception {DeveloperError} options.stackPartitions must be greater than or equal to one. * @exception {DeveloperError} options.slicePartitions must be greater than or equal to zero. @@ -44,7 +44,7 @@ function SphereOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ SphereOutlineGeometry.packedLength = EllipsoidOutlineGeometry.packedLength; @@ -52,10 +52,10 @@ SphereOutlineGeometry.packedLength = EllipsoidOutlineGeometry.packedLength; * Stores the provided instance into the provided array. * * @param {SphereOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ SphereOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -81,8 +81,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {SphereOutlineGeometry} [result] The object into which to store the result. * @returns {SphereOutlineGeometry} The modified result parameter or a new SphereOutlineGeometry instance if one was not provided. */ diff --git a/packages/engine/Source/Core/Spherical.js b/packages/engine/Source/Core/Spherical.js index 67c10b544bc5..57dca19407fd 100644 --- a/packages/engine/Source/Core/Spherical.js +++ b/packages/engine/Source/Core/Spherical.js @@ -8,26 +8,26 @@ import defined from "./defined.js"; * @alias Spherical * @constructor * - * @param {Number} [clock=0.0] The angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. - * @param {Number} [cone=0.0] The angular coordinate measured from the positive z-axis and toward the negative z-axis. - * @param {Number} [magnitude=1.0] The linear coordinate measured from the origin. + * @param {number} [clock=0.0] The angular coordinate lying in the xy-plane measured from the positive x-axis and toward the positive y-axis. + * @param {number} [cone=0.0] The angular coordinate measured from the positive z-axis and toward the negative z-axis. + * @param {number} [magnitude=1.0] The linear coordinate measured from the origin. */ function Spherical(clock, cone, magnitude) { /** * The clock component. - * @type {Number} + * @type {number} * @default 0.0 */ this.clock = defaultValue(clock, 0.0); /** * The cone component. - * @type {Number} + * @type {number} * @default 0.0 */ this.cone = defaultValue(cone, 0.0); /** * The magnitude component. - * @type {Number} + * @type {number} * @default 1.0 */ this.magnitude = defaultValue(magnitude, 1.0); @@ -109,7 +109,7 @@ Spherical.normalize = function (spherical, result) { * * @param {Spherical} left The first Spherical to be compared. * @param {Spherical} right The second Spherical to be compared. - * @returns {Boolean} true if the first spherical is equal to the second spherical, false otherwise. + * @returns {boolean} true if the first spherical is equal to the second spherical, false otherwise. */ Spherical.equals = function (left, right) { return ( @@ -127,8 +127,8 @@ Spherical.equals = function (left, right) { * * @param {Spherical} left The first Spherical to be compared. * @param {Spherical} right The second Spherical to be compared. - * @param {Number} [epsilon=0.0] The epsilon to compare against. - * @returns {Boolean} true if the first spherical is within the provided epsilon of the second spherical, false otherwise. + * @param {number} [epsilon=0.0] The epsilon to compare against. + * @returns {boolean} true if the first spherical is within the provided epsilon of the second spherical, false otherwise. */ Spherical.equalsEpsilon = function (left, right, epsilon) { epsilon = defaultValue(epsilon, 0.0); @@ -146,7 +146,7 @@ Spherical.equalsEpsilon = function (left, right, epsilon) { * Returns true if this spherical is equal to the provided spherical, false otherwise. * * @param {Spherical} other The Spherical to be compared. - * @returns {Boolean} true if this spherical is equal to the provided spherical, false otherwise. + * @returns {boolean} true if this spherical is equal to the provided spherical, false otherwise. */ Spherical.prototype.equals = function (other) { return Spherical.equals(this, other); @@ -166,8 +166,8 @@ Spherical.prototype.clone = function (result) { * Returns true if this spherical is within the provided epsilon of the provided spherical, false otherwise. * * @param {Spherical} other The Spherical to be compared. - * @param {Number} epsilon The epsilon to compare against. - * @returns {Boolean} true if this spherical is within the provided epsilon of the provided spherical, false otherwise. + * @param {number} epsilon The epsilon to compare against. + * @returns {boolean} true if this spherical is within the provided epsilon of the provided spherical, false otherwise. */ Spherical.prototype.equalsEpsilon = function (other, epsilon) { return Spherical.equalsEpsilon(this, other, epsilon); @@ -176,7 +176,7 @@ Spherical.prototype.equalsEpsilon = function (other, epsilon) { /** * Returns a string representing this instance in the format (clock, cone, magnitude). * - * @returns {String} A string representing this instance. + * @returns {string} A string representing this instance. */ Spherical.prototype.toString = function () { return `(${this.clock}, ${this.cone}, ${this.magnitude})`; diff --git a/packages/engine/Source/Core/Spline.js b/packages/engine/Source/Core/Spline.js index 9c28766f10ae..5dba9c6d77e6 100644 --- a/packages/engine/Source/Core/Spline.js +++ b/packages/engine/Source/Core/Spline.js @@ -21,7 +21,7 @@ import Quaternion from "./Quaternion.js"; function Spline() { /** * An array of times for the control points. - * @type {Number[]} + * @type {number[]} * @default undefined */ this.times = undefined; @@ -40,10 +40,10 @@ function Spline() { * Gets the type of the point. This helps a spline determine how to interpolate * and return its values. * - * @param {Number|Cartesian3|Quaternion} point + * @param {number|Cartesian3|Quaternion} point * @returns {*} The type of the point. * - * @exception {DeveloperError} value must be a Cartesian3, Quaternion, or Number. + * @exception {DeveloperError} value must be a Cartesian3, Quaternion, or number. * * @private */ @@ -60,7 +60,7 @@ Spline.getPointType = function (point) { //>>includeStart('debug', pragmas.debug); throw new DeveloperError( - "point must be a Cartesian3, Quaternion, or Number." + "point must be a Cartesian3, Quaternion, or number." ); //>>includeEnd('debug'); }; @@ -69,9 +69,9 @@ Spline.getPointType = function (point) { * Evaluates the curve at a given time. * @function * - * @param {Number} time The time at which to evaluate the curve. - * @param {Cartesian3|Quaternion|Number[]} [result] The object onto which to store the result. - * @returns {Cartesian3|Quaternion|Number[]} The modified result parameter or a new instance of the point on the curve at the given time. + * @param {number} time The time at which to evaluate the curve. + * @param {Cartesian3|Quaternion|number[]} [result] The object onto which to store the result. + * @returns {Cartesian3|Quaternion|number[]} The modified result parameter or a new instance of the point on the curve at the given time. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element @@ -83,9 +83,9 @@ Spline.prototype.evaluate = DeveloperError.throwInstantiationError; * Finds an index i in times such that the parameter * time is in the interval [times[i], times[i + 1]]. * - * @param {Number} time The time. - * @param {Number} startIndex The index from which to start the search. - * @returns {Number} The index for the element at the start of the interval. + * @param {number} time The time. + * @param {number} startIndex The index from which to start the search. + * @returns {number} The index for the element at the start of the interval. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element @@ -146,8 +146,8 @@ Spline.prototype.findTimeInterval = function (time, startIndex) { * Wraps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, wrapped around the animation period. + * @param {number} time The time. + * @return {number} The time, wrapped around the animation period. */ Spline.prototype.wrapTime = function (time) { //>>includeStart('debug', pragmas.debug); @@ -174,8 +174,8 @@ Spline.prototype.wrapTime = function (time) { * Clamps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, clamped to the animation period. + * @param {number} time The time. + * @return {number} The time, clamped to the animation period. */ Spline.prototype.clampTime = function (time) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Core/SteppedSpline.js b/packages/engine/Source/Core/SteppedSpline.js index f861184be86e..4f3242a2f0db 100644 --- a/packages/engine/Source/Core/SteppedSpline.js +++ b/packages/engine/Source/Core/SteppedSpline.js @@ -9,9 +9,9 @@ import Spline from "./Spline.js"; * @alias SteppedSpline * @constructor * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. The values are in no way connected to the clock time. They are the parameterization for the curve. - * @param {Number[]|Cartesian3[]|Quaternion[]} options.points The array of control points. + * @param {object} options Object with the following properties: + * @param {number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point. The values are in no way connected to the clock time. They are the parameterization for the curve. + * @param {number[]|Cartesian3[]|Quaternion[]} options.points The array of control points. * * @exception {DeveloperError} points.length must be greater than or equal to 2. * @exception {DeveloperError} times.length must be equal to points.length. @@ -71,7 +71,7 @@ Object.defineProperties(SteppedSpline.prototype, { * * @memberof SteppedSpline.prototype * - * @type {Number[]} + * @type {number[]} * @readonly */ times: { @@ -85,7 +85,7 @@ Object.defineProperties(SteppedSpline.prototype, { * * @memberof SteppedSpline.prototype * - * @type {Number[]|Cartesian3[]|Quaternion[]} + * @type {number[]|Cartesian3[]|Quaternion[]} * @readonly */ points: { @@ -100,9 +100,9 @@ Object.defineProperties(SteppedSpline.prototype, { * time is in the interval [times[i], times[i + 1]]. * @function * - * @param {Number} time The time. - * @param {Number} startIndex The index from which to start the search. - * @returns {Number} The index for the element at the start of the interval. + * @param {number} time The time. + * @param {number} startIndex The index from which to start the search. + * @returns {number} The index for the element at the start of the interval. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element @@ -114,8 +114,8 @@ SteppedSpline.prototype.findTimeInterval = Spline.prototype.findTimeInterval; * Wraps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, wrapped around to the updated animation. + * @param {number} time The time. + * @return {number} The time, wrapped around to the updated animation. */ SteppedSpline.prototype.wrapTime = Spline.prototype.wrapTime; @@ -123,17 +123,17 @@ SteppedSpline.prototype.wrapTime = Spline.prototype.wrapTime; * Clamps the given time to the period covered by the spline. * @function * - * @param {Number} time The time. - * @return {Number} The time, clamped to the animation period. + * @param {number} time The time. + * @return {number} The time, clamped to the animation period. */ SteppedSpline.prototype.clampTime = Spline.prototype.clampTime; /** * Evaluates the curve at a given time. * - * @param {Number} time The time at which to evaluate the curve. + * @param {number} time The time at which to evaluate the curve. * @param {Cartesian3|Quaternion} [result] The object onto which to store the result. - * @returns {Number|Cartesian3|Quaternion} The modified result parameter or a new instance of the point on the curve at the given time. + * @returns {number|Cartesian3|Quaternion} The modified result parameter or a new instance of the point on the curve at the given time. * * @exception {DeveloperError} time must be in the range [t0, tn], where t0 * is the first element in the array times and tn is the last element diff --git a/packages/engine/Source/Core/TaskProcessor.js b/packages/engine/Source/Core/TaskProcessor.js index 0414c34fa467..699aaa136537 100644 --- a/packages/engine/Source/Core/TaskProcessor.js +++ b/packages/engine/Source/Core/TaskProcessor.js @@ -195,8 +195,8 @@ function getWebAssemblyLoaderConfig(processor, wasmOptions) { * @alias TaskProcessor * @constructor * - * @param {String} workerPath The Url to the worker. This can either be an absolute path or relative to the Cesium Workers folder. - * @param {Number} [maximumActiveTasks=Number.POSITIVE_INFINITY] The maximum number of active tasks. Once exceeded, + * @param {string} workerPath The Url to the worker. This can either be an absolute path or relative to the Cesium Workers folder. + * @param {number} [maximumActiveTasks=Number.POSITIVE_INFINITY] The maximum number of active tasks. Once exceeded, * scheduleTask will not queue any more tasks, allowing * work to be rescheduled in future frames. */ @@ -223,10 +223,10 @@ const emptyTransferableObjectArray = []; * Otherwise, returns a promise that will resolve to the result posted back by the worker when * finished. * - * @param {Object} parameters Any input data that will be posted to the worker. + * @param {object} parameters Any input data that will be posted to the worker. * @param {Object[]} [transferableObjects] An array of objects contained in parameters that should be * transferred to the worker instead of copied. - * @returns {Promise.|undefined} Either a promise that will resolve to the result when available, or undefined + * @returns {Promise|undefined} Either a promise that will resolve to the result when available, or undefined * if there are too many active tasks, * * @example @@ -289,11 +289,11 @@ TaskProcessor.prototype.scheduleTask = function ( * and compiling a web assembly module asychronously, as well as an optional * fallback JavaScript module to use if Web Assembly is not supported. * - * @param {Object} [webAssemblyOptions] An object with the following properties: - * @param {String} [webAssemblyOptions.modulePath] The path of the web assembly JavaScript wrapper module. - * @param {String} [webAssemblyOptions.wasmBinaryFile] The path of the web assembly binary file. - * @param {String} [webAssemblyOptions.fallbackModulePath] The path of the fallback JavaScript module to use if web assembly is not supported. - * @returns {Promise.} A promise that resolves to the result when the web worker has loaded and compiled the web assembly module and is ready to process tasks. + * @param {object} [webAssemblyOptions] An object with the following properties: + * @param {string} [webAssemblyOptions.modulePath] The path of the web assembly JavaScript wrapper module. + * @param {string} [webAssemblyOptions.wasmBinaryFile] The path of the web assembly binary file. + * @param {string} [webAssemblyOptions.fallbackModulePath] The path of the fallback JavaScript module to use if web assembly is not supported. + * @returns {Promise} A promise that resolves to the result when the web worker has loaded and compiled the web assembly module and is ready to process tasks. */ TaskProcessor.prototype.initWebAssemblyModule = function (webAssemblyOptions) { if (!defined(this._worker)) { @@ -339,7 +339,7 @@ TaskProcessor.prototype.initWebAssemblyModule = function (webAssemblyOptions) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see TaskProcessor#destroy */ diff --git a/packages/engine/Source/Core/TerrainData.js b/packages/engine/Source/Core/TerrainData.js index 13e8430e03e8..029c30687e1e 100644 --- a/packages/engine/Source/Core/TerrainData.js +++ b/packages/engine/Source/Core/TerrainData.js @@ -41,9 +41,9 @@ Object.defineProperties(TerrainData.prototype, { * @function * * @param {Rectangle} rectangle The rectangle covered by this terrain data. - * @param {Number} longitude The longitude in radians. - * @param {Number} latitude The latitude in radians. - * @returns {Number} The terrain height at the specified position. If the position + * @param {number} longitude The longitude in radians. + * @param {number} latitude The latitude in radians. + * @returns {number} The terrain height at the specified position. If the position * is outside the rectangle, this method will extrapolate the height, which is likely to be wildly * incorrect for positions far outside the rectangle. */ @@ -57,11 +57,11 @@ TerrainData.prototype.interpolateHeight = * given, the availability of the southeast child tile is returned. * @function * - * @param {Number} thisX The tile X coordinate of this (the parent) tile. - * @param {Number} thisY The tile Y coordinate of this (the parent) tile. - * @param {Number} childX The tile X coordinate of the child tile to check for availability. - * @param {Number} childY The tile Y coordinate of the child tile to check for availability. - * @returns {Boolean} True if the child tile is available; otherwise, false. + * @param {number} thisX The tile X coordinate of this (the parent) tile. + * @param {number} thisY The tile Y coordinate of this (the parent) tile. + * @param {number} childX The tile X coordinate of the child tile to check for availability. + * @param {number} childY The tile Y coordinate of the child tile to check for availability. + * @returns {boolean} True if the child tile is available; otherwise, false. */ TerrainData.prototype.isChildAvailable = DeveloperError.throwInstantiationError; @@ -71,15 +71,15 @@ TerrainData.prototype.isChildAvailable = DeveloperError.throwInstantiationError; * * @private * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {TilingScheme} options.tilingScheme The tiling scheme to which this tile belongs. - * @param {Number} options.x The X coordinate of the tile for which to create the terrain data. - * @param {Number} options.y The Y coordinate of the tile for which to create the terrain data. - * @param {Number} options.level The level of the tile for which to create the terrain data. - * @param {Number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. - * @param {Number} [options.exaggerationRelativeHeight=0.0] The height relative to which terrain is exaggerated. - * @param {Boolean} [options.throttle=true] If true, indicates that this operation will need to be retried if too many asynchronous mesh creations are already in progress. - * @returns {Promise.|undefined} A promise for the terrain mesh, or undefined if too many + * @param {number} options.x The X coordinate of the tile for which to create the terrain data. + * @param {number} options.y The Y coordinate of the tile for which to create the terrain data. + * @param {number} options.level The level of the tile for which to create the terrain data. + * @param {number} [options.exaggeration=1.0] The scale used to exaggerate the terrain. + * @param {number} [options.exaggerationRelativeHeight=0.0] The height relative to which terrain is exaggerated. + * @param {boolean} [options.throttle=true] If true, indicates that this operation will need to be retried if too many asynchronous mesh creations are already in progress. + * @returns {Promise|undefined} A promise for the terrain mesh, or undefined if too many * asynchronous mesh creations are already in progress and the operation should * be retried later. */ @@ -90,13 +90,13 @@ TerrainData.prototype.createMesh = DeveloperError.throwInstantiationError; * @function * * @param {TilingScheme} tilingScheme The tiling scheme of this terrain data. - * @param {Number} thisX The X coordinate of this tile in the tiling scheme. - * @param {Number} thisY The Y coordinate of this tile in the tiling scheme. - * @param {Number} thisLevel The level of this tile in the tiling scheme. - * @param {Number} descendantX The X coordinate within the tiling scheme of the descendant tile for which we are upsampling. - * @param {Number} descendantY The Y coordinate within the tiling scheme of the descendant tile for which we are upsampling. - * @param {Number} descendantLevel The level within the tiling scheme of the descendant tile for which we are upsampling. - * @returns {Promise.|undefined} A promise for upsampled terrain data for the descendant tile, + * @param {number} thisX The X coordinate of this tile in the tiling scheme. + * @param {number} thisY The Y coordinate of this tile in the tiling scheme. + * @param {number} thisLevel The level of this tile in the tiling scheme. + * @param {number} descendantX The X coordinate within the tiling scheme of the descendant tile for which we are upsampling. + * @param {number} descendantY The Y coordinate within the tiling scheme of the descendant tile for which we are upsampling. + * @param {number} descendantLevel The level within the tiling scheme of the descendant tile for which we are upsampling. + * @returns {Promise|undefined} A promise for upsampled terrain data for the descendant tile, * or undefined if too many asynchronous upsample operations are in progress and the request has been * deferred. */ @@ -109,7 +109,7 @@ TerrainData.prototype.upsample = DeveloperError.throwInstantiationError; * returned from a call to {@link TerrainData#upsample}. * @function * - * @returns {Boolean} True if this instance was created by upsampling; otherwise, false. + * @returns {boolean} True if this instance was created by upsampling; otherwise, false. */ TerrainData.prototype.wasCreatedByUpsampling = DeveloperError.throwInstantiationError; @@ -117,7 +117,7 @@ TerrainData.prototype.wasCreatedByUpsampling = /** * The maximum number of asynchronous tasks used for terrain processing. * - * @type {Number} + * @type {number} * @private */ TerrainData.maximumAsynchronousTasks = 5; diff --git a/packages/engine/Source/Core/TerrainEncoding.js b/packages/engine/Source/Core/TerrainEncoding.js index a6faa36c07be..f6a6702babdc 100644 --- a/packages/engine/Source/Core/TerrainEncoding.js +++ b/packages/engine/Source/Core/TerrainEncoding.js @@ -26,14 +26,14 @@ const SHIFT_LEFT_12 = Math.pow(2.0, 12.0); * * @param {Cartesian3} center The center point of the vertices. * @param {AxisAlignedBoundingBox} axisAlignedBoundingBox The bounds of the tile in the east-north-up coordinates at the tiles center. - * @param {Number} minimumHeight The minimum height. - * @param {Number} maximumHeight The maximum height. + * @param {number} minimumHeight The minimum height. + * @param {number} maximumHeight The maximum height. * @param {Matrix4} fromENU The east-north-up to fixed frame matrix at the center of the terrain mesh. - * @param {Boolean} hasVertexNormals If the mesh has vertex normals. - * @param {Boolean} [hasWebMercatorT=false] true if the terrain data includes a Web Mercator texture coordinate; otherwise, false. - * @param {Boolean} [hasGeodeticSurfaceNormals=false] true if the terrain data includes geodetic surface normals; otherwise, false. - * @param {Number} [exaggeration=1.0] A scalar used to exaggerate terrain. - * @param {Number} [exaggerationRelativeHeight=0.0] The relative height from which terrain is exaggerated. + * @param {boolean} hasVertexNormals If the mesh has vertex normals. + * @param {boolean} [hasWebMercatorT=false] true if the terrain data includes a Web Mercator texture coordinate; otherwise, false. + * @param {boolean} [hasGeodeticSurfaceNormals=false] true if the terrain data includes geodetic surface normals; otherwise, false. + * @param {number} [exaggeration=1.0] A scalar used to exaggerate terrain. + * @param {number} [exaggerationRelativeHeight=0.0] The relative height from which terrain is exaggerated. * * @private */ @@ -112,13 +112,13 @@ function TerrainEncoding( /** * The minimum height of the tile including the skirts. - * @type {Number} + * @type {number} */ this.minimumHeight = minimumHeight; /** * The maximum height of the tile. - * @type {Number} + * @type {number} */ this.maximumHeight = maximumHeight; @@ -149,19 +149,19 @@ function TerrainEncoding( /** * The terrain mesh contains normals. - * @type {Boolean} + * @type {boolean} */ this.hasVertexNormals = hasVertexNormals; /** * The terrain mesh contains a vertical texture coordinate following the Web Mercator projection. - * @type {Boolean} + * @type {boolean} */ this.hasWebMercatorT = defaultValue(hasWebMercatorT, false); /** * The terrain mesh contains geodetic surface normals, used for terrain exaggeration. - * @type {Boolean} + * @type {boolean} */ this.hasGeodeticSurfaceNormals = defaultValue( hasGeodeticSurfaceNormals, @@ -170,7 +170,7 @@ function TerrainEncoding( /** * A scalar used to exaggerate terrain. - * @type {Number} + * @type {number} */ this.exaggeration = defaultValue(exaggeration, 1.0); @@ -184,7 +184,7 @@ function TerrainEncoding( /** * The number of components in each vertex. This value can differ with different quantizations. - * @type {Number} + * @type {number} */ this.stride = 0; diff --git a/packages/engine/Source/Core/TerrainExaggeration.js b/packages/engine/Source/Core/TerrainExaggeration.js index 7773584c7415..fa5e68377f80 100644 --- a/packages/engine/Source/Core/TerrainExaggeration.js +++ b/packages/engine/Source/Core/TerrainExaggeration.js @@ -8,9 +8,9 @@ const TerrainExaggeration = {}; /** * Scales a height relative to an offset. * - * @param {Number} height The height. - * @param {Number} scale A scalar used to exaggerate the terrain. If the value is 1.0 there will be no effect. - * @param {Number} relativeHeight The height relative to which terrain is exaggerated. If the value is 0.0 terrain will be exaggerated relative to the ellipsoid surface. + * @param {number} height The height. + * @param {number} scale A scalar used to exaggerate the terrain. If the value is 1.0 there will be no effect. + * @param {number} relativeHeight The height relative to which terrain is exaggerated. If the value is 0.0 terrain will be exaggerated relative to the ellipsoid surface. */ TerrainExaggeration.getHeight = function (height, scale, relativeHeight) { return (height - relativeHeight) * scale + relativeHeight; diff --git a/packages/engine/Source/Core/TerrainMesh.js b/packages/engine/Source/Core/TerrainMesh.js index 6ea2c33e118c..60a939b5404b 100644 --- a/packages/engine/Source/Core/TerrainMesh.js +++ b/packages/engine/Source/Core/TerrainMesh.js @@ -13,21 +13,21 @@ import defaultValue from "./defaultValue.js"; * the Cartesian position of the vertex, H is the height above the ellipsoid, and * U and V are the texture coordinates. * @param {Uint8Array|Uint16Array|Uint32Array} indices The indices describing how the vertices are connected to form triangles. - * @param {Number} indexCountWithoutSkirts The index count of the mesh not including skirts. - * @param {Number} vertexCountWithoutSkirts The vertex count of the mesh not including skirts. - * @param {Number} minimumHeight The lowest height in the tile, in meters above the ellipsoid. - * @param {Number} maximumHeight The highest height in the tile, in meters above the ellipsoid. + * @param {number} indexCountWithoutSkirts The index count of the mesh not including skirts. + * @param {number} vertexCountWithoutSkirts The vertex count of the mesh not including skirts. + * @param {number} minimumHeight The lowest height in the tile, in meters above the ellipsoid. + * @param {number} maximumHeight The highest height in the tile, in meters above the ellipsoid. * @param {BoundingSphere} boundingSphere3D A bounding sphere that completely contains the tile. * @param {Cartesian3} occludeePointInScaledSpace The occludee point of the tile, represented in ellipsoid- * scaled space, and used for horizon culling. If this point is below the horizon, * the tile is considered to be entirely below the horizon. - * @param {Number} [vertexStride=6] The number of components in each vertex. + * @param {number} [vertexStride=6] The number of components in each vertex. * @param {OrientedBoundingBox} [orientedBoundingBox] A bounding box that completely contains the tile. * @param {TerrainEncoding} encoding Information used to decode the mesh. - * @param {Number[]} westIndicesSouthToNorth The indices of the vertices on the Western edge of the tile, ordered from South to North (clockwise). - * @param {Number[]} southIndicesEastToWest The indices of the vertices on the Southern edge of the tile, ordered from East to West (clockwise). - * @param {Number[]} eastIndicesNorthToSouth The indices of the vertices on the Eastern edge of the tile, ordered from North to South (clockwise). - * @param {Number[]} northIndicesWestToEast The indices of the vertices on the Northern edge of the tile, ordered from West to East (clockwise). + * @param {number[]} westIndicesSouthToNorth The indices of the vertices on the Western edge of the tile, ordered from South to North (clockwise). + * @param {number[]} southIndicesEastToWest The indices of the vertices on the Southern edge of the tile, ordered from East to West (clockwise). + * @param {number[]} eastIndicesNorthToSouth The indices of the vertices on the Eastern edge of the tile, ordered from North to South (clockwise). + * @param {number[]} northIndicesWestToEast The indices of the vertices on the Northern edge of the tile, ordered from West to East (clockwise). * * @private */ @@ -69,7 +69,7 @@ function TerrainMesh( * The number of components in each vertex. Typically this is 6 for the 6 components * [X, Y, Z, H, U, V], but if each vertex has additional data (such as a vertex normal), this value * may be higher. - * @type {Number} + * @type {number} */ this.stride = defaultValue(vertexStride, 6); @@ -81,25 +81,25 @@ function TerrainMesh( /** * The index count of the mesh not including skirts. - * @type {Number} + * @type {number} */ this.indexCountWithoutSkirts = indexCountWithoutSkirts; /** * The vertex count of the mesh not including skirts. - * @type {Number} + * @type {number} */ this.vertexCountWithoutSkirts = vertexCountWithoutSkirts; /** * The lowest height in the tile, in meters above the ellipsoid. - * @type {Number} + * @type {number} */ this.minimumHeight = minimumHeight; /** * The highest height in the tile, in meters above the ellipsoid. - * @type {Number} + * @type {number} */ this.maximumHeight = maximumHeight; @@ -131,25 +131,25 @@ function TerrainMesh( /** * The indices of the vertices on the Western edge of the tile, ordered from South to North (clockwise). - * @type {Number[]} + * @type {number[]} */ this.westIndicesSouthToNorth = westIndicesSouthToNorth; /** * The indices of the vertices on the Southern edge of the tile, ordered from East to West (clockwise). - * @type {Number[]} + * @type {number[]} */ this.southIndicesEastToWest = southIndicesEastToWest; /** * The indices of the vertices on the Eastern edge of the tile, ordered from North to South (clockwise). - * @type {Number[]} + * @type {number[]} */ this.eastIndicesNorthToSouth = eastIndicesNorthToSouth; /** * The indices of the vertices on the Northern edge of the tile, ordered from West to East (clockwise). - * @type {Number[]} + * @type {number[]} */ this.northIndicesWestToEast = northIndicesWestToEast; } diff --git a/packages/engine/Source/Core/TerrainProvider.js b/packages/engine/Source/Core/TerrainProvider.js index e7f5d035bf2d..e1ad2c170691 100644 --- a/packages/engine/Source/Core/TerrainProvider.js +++ b/packages/engine/Source/Core/TerrainProvider.js @@ -59,7 +59,7 @@ Object.defineProperties(TerrainProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof TerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -69,7 +69,7 @@ Object.defineProperties(TerrainProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof TerrainProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -82,7 +82,7 @@ Object.defineProperties(TerrainProvider.prototype, { * as a reflective surface with animated waves. This function should not be * called before {@link TerrainProvider#ready} returns true. * @memberof TerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasWaterMask: { @@ -93,7 +93,7 @@ Object.defineProperties(TerrainProvider.prototype, { * Gets a value indicating whether or not the requested tiles include vertex normals. * This function should not be called before {@link TerrainProvider#ready} returns true. * @memberof TerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasVertexNormals: { @@ -122,8 +122,8 @@ const regularGridIndicesCache = []; * same list of indices. The total number of vertices must be less than or equal * to 65536. * - * @param {Number} width The number of vertices in the regular grid in the horizontal direction. - * @param {Number} height The number of vertices in the regular grid in the vertical direction. + * @param {number} width The number of vertices in the regular grid in the horizontal direction. + * @param {number} height The number of vertices in the regular grid in the vertical direction. * @returns {Uint16Array|Uint32Array} The list of indices. Uint16Array gets returned for 64KB or less and Uint32Array for 4GB or less. */ TerrainProvider.getRegularGridIndices = function (width, height) { @@ -372,7 +372,7 @@ function addSkirtIndices(edgeIndices, vertexIndex, indices, offset) { * {@link Globe.maximumScreenSpaceError} screen pixels and will probably go very slowly. * A value of 0.5 will cut the estimated level zero geometric error in half, allowing twice the * screen pixels between adjacent heightmap vertices and thus rendering more quickly. - * @type {Number} + * @type {number} */ TerrainProvider.heightmapTerrainQuality = 0.25; @@ -380,9 +380,9 @@ TerrainProvider.heightmapTerrainQuality = 0.25; * Determines an appropriate geometric error estimate when the geometry comes from a heightmap. * * @param {Ellipsoid} ellipsoid The ellipsoid to which the terrain is attached. - * @param {Number} tileImageWidth The width, in pixels, of the heightmap associated with a single tile. - * @param {Number} numberOfTilesAtLevelZero The number of tiles in the horizontal direction at tile level zero. - * @returns {Number} An estimated geometric error. + * @param {number} tileImageWidth The width, in pixels, of the heightmap associated with a single tile. + * @param {number} numberOfTilesAtLevelZero The number of tiles in the horizontal direction at tile level zero. + * @returns {number} An estimated geometric error. */ TerrainProvider.getEstimatedLevelZeroGeometricErrorForAHeightmap = function ( ellipsoid, @@ -404,12 +404,12 @@ TerrainProvider.getEstimatedLevelZeroGeometricErrorForAHeightmap = function ( * may optionally include a water mask and an indication of which child tiles are available. * @function * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @param {Request} [request] The request object. Intended for internal use only. * - * @returns {Promise.|undefined} A promise for the requested geometry. If this method + * @returns {Promise|undefined} A promise for the requested geometry. If this method * returns undefined instead of a promise, it is an indication that too many requests are already * pending and the request will be retried later. */ @@ -421,8 +421,8 @@ TerrainProvider.prototype.requestTileGeometry = * called before {@link TerrainProvider#ready} returns true. * @function * - * @param {Number} level The tile level for which to get the maximum geometric error. - * @returns {Number} The maximum geometric error. + * @param {number} level The tile level for which to get the maximum geometric error. + * @returns {number} The maximum geometric error. */ TerrainProvider.prototype.getLevelMaximumGeometricError = DeveloperError.throwInstantiationError; @@ -431,10 +431,10 @@ TerrainProvider.prototype.getLevelMaximumGeometricError = * Determines whether data for a tile is available to be loaded. * @function * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. - * @returns {Boolean|undefined} Undefined if not supported by the terrain provider, otherwise true or false. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. + * @returns {boolean|undefined} Undefined if not supported by the terrain provider, otherwise true or false. */ TerrainProvider.prototype.getTileDataAvailable = DeveloperError.throwInstantiationError; @@ -443,9 +443,9 @@ TerrainProvider.prototype.getTileDataAvailable = * Makes sure we load availability data for a tile * @function * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @returns {undefined|Promise} Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded */ TerrainProvider.prototype.loadTileDataAvailability = diff --git a/packages/engine/Source/Core/TerrainQuantization.js b/packages/engine/Source/Core/TerrainQuantization.js index 2d0dcb984cb3..8e623e6ca988 100644 --- a/packages/engine/Source/Core/TerrainQuantization.js +++ b/packages/engine/Source/Core/TerrainQuantization.js @@ -1,7 +1,7 @@ /** * This enumerated type is used to determine how the vertices of the terrain mesh are compressed. * - * @enum {Number} + * @enum {number} * * @private */ @@ -9,7 +9,7 @@ const TerrainQuantization = { /** * The vertices are not compressed. * - * @type {Number} + * @type {number} * @constant */ NONE: 0, @@ -17,7 +17,7 @@ const TerrainQuantization = { /** * The vertices are compressed to 12 bits. * - * @type {Number} + * @type {number} * @constant */ BITS12: 1, diff --git a/packages/engine/Source/Core/TileAvailability.js b/packages/engine/Source/Core/TileAvailability.js index 2ff06c9c0e21..0a6a74a3eed7 100644 --- a/packages/engine/Source/Core/TileAvailability.js +++ b/packages/engine/Source/Core/TileAvailability.js @@ -10,7 +10,7 @@ import Rectangle from "./Rectangle.js"; * @constructor * * @param {TilingScheme} tilingScheme The tiling scheme in which to report availability. - * @param {Number} maximumLevel The maximum tile level that is potentially available. + * @param {number} maximumLevel The maximum tile level that is potentially available. */ function TileAvailability(tilingScheme, maximumLevel) { this._tilingScheme = tilingScheme; @@ -37,11 +37,11 @@ function findNode(level, x, y, nodes) { * Marks a rectangular range of tiles in a particular level as being available. For best performance, * add your ranges in order of increasing level. * - * @param {Number} level The level. - * @param {Number} startX The X coordinate of the first available tiles at the level. - * @param {Number} startY The Y coordinate of the first available tiles at the level. - * @param {Number} endX The X coordinate of the last available tiles at the level. - * @param {Number} endY The Y coordinate of the last available tiles at the level. + * @param {number} level The level. + * @param {number} startX The X coordinate of the first available tiles at the level. + * @param {number} startY The Y coordinate of the first available tiles at the level. + * @param {number} endX The X coordinate of the last available tiles at the level. + * @param {number} endY The Y coordinate of the last available tiles at the level. */ TileAvailability.prototype.addAvailableTileRange = function ( level, @@ -93,7 +93,7 @@ TileAvailability.prototype.addAvailableTileRange = function ( * {@link TileAvailability#addAvailableTileRange}. * * @param {Cartographic} position The position for which to determine the maximum available level. The height component is ignored. - * @return {Number} The level of the most detailed tile covering the position. + * @return {number} The level of the most detailed tile covering the position. * @throws {DeveloperError} If position is outside any tile according to the tiling scheme. */ TileAvailability.prototype.computeMaximumLevelAtPosition = function (position) { @@ -127,7 +127,7 @@ const eastScratch = new Rectangle(); * {@link TileAvailability#addAvailableTileRange}. * * @param {Rectangle} rectangle The rectangle. - * @return {Number} The best available level for the entire rectangle. + * @return {number} The best available level for the entire rectangle. */ TileAvailability.prototype.computeBestAvailableLevelOverRectangle = function ( rectangle @@ -187,10 +187,10 @@ const cartographicScratch = new Cartographic(); /** * Determines if a particular tile is available. - * @param {Number} level The tile level to check. - * @param {Number} x The X coordinate of the tile to check. - * @param {Number} y The Y coordinate of the tile to check. - * @return {Boolean} True if the tile is available; otherwise, false. + * @param {number} level The tile level to check. + * @param {number} x The X coordinate of the tile to check. + * @param {number} y The Y coordinate of the tile to check. + * @return {boolean} True if the tile is available; otherwise, false. */ TileAvailability.prototype.isTileAvailable = function (level, x, y) { // Get the center of the tile and find the maximum level at that position. @@ -220,10 +220,10 @@ TileAvailability.prototype.isTileAvailable = function (level, x, y) { * 38Northeast * * - * @param {Number} level The level of the parent tile. - * @param {Number} x The X coordinate of the parent tile. - * @param {Number} y The Y coordinate of the parent tile. - * @return {Number} The bit mask indicating child availability. + * @param {number} level The level of the parent tile. + * @param {number} x The X coordinate of the parent tile. + * @param {number} y The Y coordinate of the parent tile. + * @return {number} The bit mask indicating child availability. */ TileAvailability.prototype.computeChildMaskForTile = function (level, x, y) { const childLevel = level + 1; diff --git a/packages/engine/Source/Core/TileProviderError.js b/packages/engine/Source/Core/TileProviderError.js index cf02dd30a067..4e006ef0744b 100644 --- a/packages/engine/Source/Core/TileProviderError.js +++ b/packages/engine/Source/Core/TileProviderError.js @@ -9,14 +9,14 @@ import formatError from "./formatError.js"; * @constructor * * @param {ImageryProvider|TerrainProvider} provider The imagery or terrain provider that experienced the error. - * @param {String} message A message describing the error. - * @param {Number} [x] The X coordinate of the tile that experienced the error, or undefined if the error + * @param {string} message A message describing the error. + * @param {number} [x] The X coordinate of the tile that experienced the error, or undefined if the error * is not specific to a particular tile. - * @param {Number} [y] The Y coordinate of the tile that experienced the error, or undefined if the error + * @param {number} [y] The Y coordinate of the tile that experienced the error, or undefined if the error * is not specific to a particular tile. - * @param {Number} [level] The level of the tile that experienced the error, or undefined if the error + * @param {number} [level] The level of the tile that experienced the error, or undefined if the error * is not specific to a particular tile. - * @param {Number} [timesRetried=0] The number of times this operation has been retried. + * @param {number} [timesRetried=0] The number of times this operation has been retried. * @param {Error} [error] The error or exception that occurred, if any. */ function TileProviderError( @@ -36,34 +36,34 @@ function TileProviderError( /** * The message describing the error. - * @type {String} + * @type {string} */ this.message = message; /** * The X coordinate of the tile that experienced the error. If the error is not specific * to a particular tile, this property will be undefined. - * @type {Number} + * @type {number} */ this.x = x; /** * The Y coordinate of the tile that experienced the error. If the error is not specific * to a particular tile, this property will be undefined. - * @type {Number} + * @type {number} */ this.y = y; /** * The level-of-detail of the tile that experienced the error. If the error is not specific * to a particular tile, this property will be undefined. - * @type {Number} + * @type {number} */ this.level = level; /** * The number of times this operation has been retried. - * @type {Number} + * @type {number} * @default 0 */ this.timesRetried = defaultValue(timesRetried, 0); @@ -72,7 +72,7 @@ function TileProviderError( * True if the failed operation should be retried; otherwise, false. The imagery or terrain provider * will set the initial value of this property before raising the event, but any listeners * can change it. The value after the last listener is invoked will be acted upon. - * @type {Boolean} + * @type {boolean} * @default false */ this.retry = false; @@ -94,12 +94,12 @@ function TileProviderError( * occurred. * @param {ImageryProvider|TerrainProvider} provider The imagery or terrain provider that encountered the error. * @param {Event} event The event to raise to inform listeners of the error. - * @param {String} message The message describing the error. - * @param {Number} x The X coordinate of the tile that experienced the error, or undefined if the + * @param {string} message The message describing the error. + * @param {number} x The X coordinate of the tile that experienced the error, or undefined if the * error is not specific to a particular tile. - * @param {Number} y The Y coordinate of the tile that experienced the error, or undefined if the + * @param {number} y The Y coordinate of the tile that experienced the error, or undefined if the * error is not specific to a particular tile. - * @param {Number} level The level-of-detail of the tile that experienced the error, or undefined if the + * @param {number} level The level-of-detail of the tile that experienced the error, or undefined if the * error is not specific to a particular tile. * @param {Error} [errorDetails] The error or exception that occurred, if any. * @returns {TileProviderError} The error instance that was passed to the event listeners and that diff --git a/packages/engine/Source/Core/TilingScheme.js b/packages/engine/Source/Core/TilingScheme.js index a76fad8adca2..7429de380a95 100644 --- a/packages/engine/Source/Core/TilingScheme.js +++ b/packages/engine/Source/Core/TilingScheme.js @@ -54,8 +54,8 @@ Object.defineProperties(TilingScheme.prototype, { * Gets the total number of tiles in the X direction at a specified level-of-detail. * @function * - * @param {Number} level The level-of-detail. - * @returns {Number} The number of tiles in the X direction at the given level. + * @param {number} level The level-of-detail. + * @returns {number} The number of tiles in the X direction at the given level. */ TilingScheme.prototype.getNumberOfXTilesAtLevel = DeveloperError.throwInstantiationError; @@ -64,8 +64,8 @@ TilingScheme.prototype.getNumberOfXTilesAtLevel = * Gets the total number of tiles in the Y direction at a specified level-of-detail. * @function * - * @param {Number} level The level-of-detail. - * @returns {Number} The number of tiles in the Y direction at the given level. + * @param {number} level The level-of-detail. + * @returns {number} The number of tiles in the Y direction at the given level. */ TilingScheme.prototype.getNumberOfYTilesAtLevel = DeveloperError.throwInstantiationError; @@ -89,10 +89,10 @@ TilingScheme.prototype.rectangleToNativeRectangle = * of the tiling scheme. * @function * - * @param {Number} x The integer x coordinate of the tile. - * @param {Number} y The integer y coordinate of the tile. - * @param {Number} level The tile level-of-detail. Zero is the least detailed. - * @param {Object} [result] The instance to which to copy the result, or undefined if a new instance + * @param {number} x The integer x coordinate of the tile. + * @param {number} y The integer y coordinate of the tile. + * @param {number} level The tile level-of-detail. Zero is the least detailed. + * @param {object} [result] The instance to which to copy the result, or undefined if a new instance * should be created. * @returns {Rectangle} The specified 'result', or a new object containing the rectangle * if 'result' is undefined. @@ -104,10 +104,10 @@ TilingScheme.prototype.tileXYToNativeRectangle = * Converts tile x, y coordinates and level to a cartographic rectangle in radians. * @function * - * @param {Number} x The integer x coordinate of the tile. - * @param {Number} y The integer y coordinate of the tile. - * @param {Number} level The tile level-of-detail. Zero is the least detailed. - * @param {Object} [result] The instance to which to copy the result, or undefined if a new instance + * @param {number} x The integer x coordinate of the tile. + * @param {number} y The integer y coordinate of the tile. + * @param {number} level The tile level-of-detail. Zero is the least detailed. + * @param {object} [result] The instance to which to copy the result, or undefined if a new instance * should be created. * @returns {Rectangle} The specified 'result', or a new object containing the rectangle * if 'result' is undefined. @@ -121,7 +121,7 @@ TilingScheme.prototype.tileXYToRectangle = * @function * * @param {Cartographic} position The position. - * @param {Number} level The tile level-of-detail. Zero is the least detailed. + * @param {number} level The tile level-of-detail. Zero is the least detailed. * @param {Cartesian2} [result] The instance to which to copy the result, or undefined if a new instance * should be created. * @returns {Cartesian2} The specified 'result', or a new object containing the tile x, y coordinates diff --git a/packages/engine/Source/Core/TimeConstants.js b/packages/engine/Source/Core/TimeConstants.js index a65133d175b0..72ae3cad38d7 100644 --- a/packages/engine/Source/Core/TimeConstants.js +++ b/packages/engine/Source/Core/TimeConstants.js @@ -10,63 +10,63 @@ const TimeConstants = { /** * The number of seconds in one millisecond: 0.001 - * @type {Number} + * @type {number} * @constant */ SECONDS_PER_MILLISECOND: 0.001, /** * The number of seconds in one minute: 60. - * @type {Number} + * @type {number} * @constant */ SECONDS_PER_MINUTE: 60.0, /** * The number of minutes in one hour: 60. - * @type {Number} + * @type {number} * @constant */ MINUTES_PER_HOUR: 60.0, /** * The number of hours in one day: 24. - * @type {Number} + * @type {number} * @constant */ HOURS_PER_DAY: 24.0, /** * The number of seconds in one hour: 3600. - * @type {Number} + * @type {number} * @constant */ SECONDS_PER_HOUR: 3600.0, /** * The number of minutes in one day: 1440. - * @type {Number} + * @type {number} * @constant */ MINUTES_PER_DAY: 1440.0, /** * The number of seconds in one day, ignoring leap seconds: 86400. - * @type {Number} + * @type {number} * @constant */ SECONDS_PER_DAY: 86400.0, /** * The number of days in one Julian century: 36525. - * @type {Number} + * @type {number} * @constant */ DAYS_PER_JULIAN_CENTURY: 36525.0, /** * One trillionth of a second. - * @type {Number} + * @type {number} * @constant */ PICOSECOND: 0.000000001, @@ -75,7 +75,7 @@ const TimeConstants = { * The number of days to subtract from a Julian date to determine the * modified Julian date, which gives the number of days since midnight * on November 17, 1858. - * @type {Number} + * @type {number} * @constant */ MODIFIED_JULIAN_DATE_DIFFERENCE: 2400000.5, diff --git a/packages/engine/Source/Core/TimeInterval.js b/packages/engine/Source/Core/TimeInterval.js index 497483ef5db4..6350ce23ca35 100644 --- a/packages/engine/Source/Core/TimeInterval.js +++ b/packages/engine/Source/Core/TimeInterval.js @@ -11,12 +11,12 @@ import JulianDate from "./JulianDate.js"; * @alias TimeInterval * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {JulianDate} [options.start=new JulianDate()] The start time of the interval. * @param {JulianDate} [options.stop=new JulianDate()] The stop time of the interval. - * @param {Boolean} [options.isStartIncluded=true] true if options.start is included in the interval, false otherwise. - * @param {Boolean} [options.isStopIncluded=true] true if options.stop is included in the interval, false otherwise. - * @param {Object} [options.data] Arbitrary data associated with this interval. + * @param {boolean} [options.isStartIncluded=true] true if options.start is included in the interval, false otherwise. + * @param {boolean} [options.isStopIncluded=true] true if options.stop is included in the interval, false otherwise. + * @param {object} [options.data] Arbitrary data associated with this interval. * * @example * // Create an instance that spans August 1st, 1980 and is associated @@ -83,14 +83,14 @@ function TimeInterval(options) { /** * Gets or sets whether or not the start time is included in this interval. - * @type {Boolean} + * @type {boolean} * @default true */ this.isStartIncluded = defaultValue(options.isStartIncluded, true); /** * Gets or sets whether or not the stop time is included in this interval. - * @type {Boolean} + * @type {boolean} * @default true */ this.isStopIncluded = defaultValue(options.isStopIncluded, true); @@ -100,7 +100,7 @@ Object.defineProperties(TimeInterval.prototype, { /** * Gets whether or not this interval is empty. * @memberof TimeInterval.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ isEmpty: { @@ -128,11 +128,11 @@ const scratchInterval = { * * @throws DeveloperError if options.iso8601 does not match proper formatting. * - * @param {Object} options Object with the following properties: - * @param {String} options.iso8601 An ISO 8601 interval. - * @param {Boolean} [options.isStartIncluded=true] true if options.start is included in the interval, false otherwise. - * @param {Boolean} [options.isStopIncluded=true] true if options.stop is included in the interval, false otherwise. - * @param {Object} [options.data] Arbitrary data associated with this interval. + * @param {object} options Object with the following properties: + * @param {string} options.iso8601 An ISO 8601 interval. + * @param {boolean} [options.isStartIncluded=true] true if options.start is included in the interval, false otherwise. + * @param {boolean} [options.isStopIncluded=true] true if options.stop is included in the interval, false otherwise. + * @param {object} [options.data] Arbitrary data associated with this interval. * @param {TimeInterval} [result] An existing instance to use for the result. * @returns {TimeInterval} The modified result parameter or a new instance if none was provided. */ @@ -175,8 +175,8 @@ TimeInterval.fromIso8601 = function (options, result) { * Creates an ISO8601 representation of the provided interval. * * @param {TimeInterval} timeInterval The interval to be converted. - * @param {Number} [precision] The number of fractional digits used to represent the seconds component. By default, the most precise representation is used. - * @returns {String} The ISO8601 representation of the provided interval. + * @param {number} [precision] The number of fractional digits used to represent the seconds component. By default, the most precise representation is used. + * @returns {string} The ISO8601 representation of the provided interval. */ TimeInterval.toIso8601 = function (timeInterval, precision) { //>>includeStart('debug', pragmas.debug); @@ -217,7 +217,7 @@ TimeInterval.clone = function (timeInterval, result) { * @param {TimeInterval} [left] The first instance. * @param {TimeInterval} [right] The second instance. * @param {TimeInterval.DataComparer} [dataComparer] A function which compares the data of the two intervals. If omitted, reference equality is used. - * @returns {Boolean} true if the dates are equal; otherwise, false. + * @returns {boolean} true if the dates are equal; otherwise, false. */ TimeInterval.equals = function (left, right, dataComparer) { return ( @@ -242,9 +242,9 @@ TimeInterval.equals = function (left, right, dataComparer) { * * @param {TimeInterval} [left] The first instance. * @param {TimeInterval} [right] The second instance. - * @param {Number} [epsilon=0] The maximum number of seconds that should separate the two instances. + * @param {number} [epsilon=0] The maximum number of seconds that should separate the two instances. * @param {TimeInterval.DataComparer} [dataComparer] A function which compares the data of the two intervals. If omitted, reference equality is used. - * @returns {Boolean} true if the two dates are within epsilon seconds of each other; otherwise false. + * @returns {boolean} true if the two dates are within epsilon seconds of each other; otherwise false. */ TimeInterval.equalsEpsilon = function (left, right, epsilon, dataComparer) { epsilon = defaultValue(epsilon, 0); @@ -331,7 +331,7 @@ TimeInterval.intersect = function (left, right, result, mergeCallback) { * * @param {TimeInterval} timeInterval The interval. * @param {JulianDate} julianDate The date to check. - * @returns {Boolean} true if the interval contains the specified date, false otherwise. + * @returns {boolean} true if the interval contains the specified date, false otherwise. */ TimeInterval.contains = function (timeInterval, julianDate) { //>>includeStart('debug', pragmas.debug); @@ -375,7 +375,7 @@ TimeInterval.prototype.clone = function (result) { * * @param {TimeInterval} [right] The right hand side interval. * @param {TimeInterval.DataComparer} [dataComparer] A function which compares the data of the two intervals. If omitted, reference equality is used. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ TimeInterval.prototype.equals = function (right, dataComparer) { return TimeInterval.equals(this, right, dataComparer); @@ -387,9 +387,9 @@ TimeInterval.prototype.equals = function (right, dataComparer) { * false otherwise. * * @param {TimeInterval} [right] The right hand side interval. - * @param {Number} [epsilon=0] The epsilon to use for equality testing. + * @param {number} [epsilon=0] The epsilon to use for equality testing. * @param {TimeInterval.DataComparer} [dataComparer] A function which compares the data of the two intervals. If omitted, reference equality is used. - * @returns {Boolean} true if they are within the provided epsilon, false otherwise. + * @returns {boolean} true if they are within the provided epsilon, false otherwise. */ TimeInterval.prototype.equalsEpsilon = function (right, epsilon, dataComparer) { return TimeInterval.equalsEpsilon(this, right, epsilon, dataComparer); @@ -398,7 +398,7 @@ TimeInterval.prototype.equalsEpsilon = function (right, epsilon, dataComparer) { /** * Creates a string representing this TimeInterval in ISO8601 format. * - * @returns {String} A string representing this TimeInterval in ISO8601 format. + * @returns {string} A string representing this TimeInterval in ISO8601 format. */ TimeInterval.prototype.toString = function () { return TimeInterval.toIso8601(this); @@ -433,6 +433,6 @@ TimeInterval.EMPTY = Object.freeze( * @callback TimeInterval.DataComparer * @param {*} leftData The first data instance. * @param {*} rightData The second data instance. - * @returns {Boolean} true if the provided instances are equal, false otherwise. + * @returns {boolean} true if the provided instances are equal, false otherwise. */ export default TimeInterval; diff --git a/packages/engine/Source/Core/TimeIntervalCollection.js b/packages/engine/Source/Core/TimeIntervalCollection.js index 804fd6398a91..0d17ace07214 100644 --- a/packages/engine/Source/Core/TimeIntervalCollection.js +++ b/packages/engine/Source/Core/TimeIntervalCollection.js @@ -61,7 +61,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, { /** * Gets whether or not the start time is included in the collection. * @memberof TimeIntervalCollection.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ isStartIncluded: { @@ -88,7 +88,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, { /** * Gets whether or not the stop time is included in the collection. * @memberof TimeIntervalCollection.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ isStopIncluded: { @@ -102,7 +102,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, { /** * Gets the number of intervals in the collection. * @memberof TimeIntervalCollection.prototype - * @type {Number} + * @type {number} * @readonly */ length: { @@ -114,7 +114,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, { /** * Gets whether or not the collection is empty. * @memberof TimeIntervalCollection.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ isEmpty: { @@ -130,7 +130,7 @@ Object.defineProperties(TimeIntervalCollection.prototype, { * * @param {TimeIntervalCollection} [right] The right hand side collection. * @param {TimeInterval.DataComparer} [dataComparer] A function which compares the data of the two intervals. If omitted, reference equality is used. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ TimeIntervalCollection.prototype.equals = function (right, dataComparer) { if (this === right) { @@ -156,7 +156,7 @@ TimeIntervalCollection.prototype.equals = function (right, dataComparer) { /** * Gets the interval at the specified index. * - * @param {Number} index The index of the interval to retrieve. + * @param {number} index The index of the interval to retrieve. * @returns {TimeInterval|undefined} The interval at the specified index, or undefined if no interval exists as that index. */ TimeIntervalCollection.prototype.get = function (index) { @@ -194,7 +194,7 @@ TimeIntervalCollection.prototype.findIntervalContainingDate = function (date) { * Finds and returns the data for the interval that contains the specified date. * * @param {JulianDate} date The date to search for. - * @returns {Object} The data for the interval containing the specified date, or undefined if no such interval exists. + * @returns {object} The data for the interval containing the specified date, or undefined if no such interval exists. */ TimeIntervalCollection.prototype.findDataForIntervalContainingDate = function ( date @@ -207,7 +207,7 @@ TimeIntervalCollection.prototype.findDataForIntervalContainingDate = function ( * Checks if the specified date is inside this collection. * * @param {JulianDate} julianDate The date to check. - * @returns {Boolean} true if the collection contains the specified date, false otherwise. + * @returns {boolean} true if the collection contains the specified date, false otherwise. */ TimeIntervalCollection.prototype.contains = function (julianDate) { return this.indexOf(julianDate) >= 0; @@ -219,7 +219,7 @@ const indexOfScratch = new TimeInterval(); * Finds and returns the index of the interval in the collection that contains the specified date. * * @param {JulianDate} date The date to search for. - * @returns {Number} The index of the interval that contains the specified date, if no such interval exists, + * @returns {number} The index of the interval that contains the specified date, if no such interval exists, * it returns a negative number which is the bitwise complement of the index of the next interval that * starts after the date, or if no interval starts after the specified date, the bitwise complement of * the length of the collection. @@ -269,11 +269,11 @@ TimeIntervalCollection.prototype.indexOf = function (date) { * Returns the first interval in the collection that matches the specified parameters. * All parameters are optional and undefined parameters are treated as a don't care condition. * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {JulianDate} [options.start] The start time of the interval. * @param {JulianDate} [options.stop] The stop time of the interval. - * @param {Boolean} [options.isStartIncluded] true if options.start is included in the interval, false otherwise. - * @param {Boolean} [options.isStopIncluded] true if options.stop is included in the interval, false otherwise. + * @param {boolean} [options.isStartIncluded] true if options.start is included in the interval, false otherwise. + * @param {boolean} [options.isStopIncluded] true if options.stop is included in the interval, false otherwise. * @returns {TimeInterval|undefined} The first interval in the collection that matches the specified parameters. */ TimeIntervalCollection.prototype.findInterval = function (options) { @@ -505,7 +505,7 @@ TimeIntervalCollection.prototype.addInterval = function ( * The data property of the input interval is ignored. * * @param {TimeInterval} interval The interval to remove. - * @returns {Boolean} true if the interval was removed, false if no part of the interval was in the collection. + * @returns {boolean} true if the interval was removed, false if no part of the interval was in the collection. */ TimeIntervalCollection.prototype.removeInterval = function (interval) { //>>includeStart('debug', pragmas.debug); @@ -731,12 +731,12 @@ TimeIntervalCollection.prototype.intersect = function ( /** * Creates a new instance from a JulianDate array. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {JulianDate[]} options.julianDates An array of ISO 8601 dates. - * @param {Boolean} [options.isStartIncluded=true] true if start time is included in the interval, false otherwise. - * @param {Boolean} [options.isStopIncluded=true] true if stop time is included in the interval, false otherwise. - * @param {Boolean} [options.leadingInterval=false] true if you want to add a interval from Iso8601.MINIMUM_VALUE to start time, false otherwise. - * @param {Boolean} [options.trailingInterval=false] true if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE, false otherwise. + * @param {boolean} [options.isStartIncluded=true] true if start time is included in the interval, false otherwise. + * @param {boolean} [options.isStopIncluded=true] true if stop time is included in the interval, false otherwise. + * @param {boolean} [options.leadingInterval=false] true if you want to add a interval from Iso8601.MINIMUM_VALUE to start time, false otherwise. + * @param {boolean} [options.trailingInterval=false] true if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE, false otherwise. * @param {Function} [options.dataCallback] A function that will be return the data that is called with each interval before it is added to the collection. If unspecified, the data will be the index in the collection. * @param {TimeIntervalCollection} [result] An existing instance to use for the result. * @returns {TimeIntervalCollection} The modified result parameter or a new instance if none was provided. @@ -898,9 +898,9 @@ const durationRegex = /P(?:([\d.,]+)Y)?(?:([\d.,]+)M)?(?:([\d.,]+)W)?(?:([\d.,]+ /** * Parses ISO8601 duration string * - * @param {String} iso8601 An ISO 8601 duration. + * @param {string} iso8601 An ISO 8601 duration. * @param {GregorianDate} result An existing instance to use for the result. - * @returns {Boolean} True is parsing succeeded, false otherwise + * @returns {boolean} True is parsing succeeded, false otherwise * * @private */ @@ -981,12 +981,12 @@ const scratchDuration = new GregorianDate(); /** * Creates a new instance from an {@link http://en.wikipedia.org/wiki/ISO_8601|ISO 8601} time interval (start/end/duration). * - * @param {Object} options Object with the following properties: - * @param {String} options.iso8601 An ISO 8601 interval. - * @param {Boolean} [options.isStartIncluded=true] true if start time is included in the interval, false otherwise. - * @param {Boolean} [options.isStopIncluded=true] true if stop time is included in the interval, false otherwise. - * @param {Boolean} [options.leadingInterval=false] true if you want to add a interval from Iso8601.MINIMUM_VALUE to start time, false otherwise. - * @param {Boolean} [options.trailingInterval=false] true if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE, false otherwise. + * @param {object} options Object with the following properties: + * @param {string} options.iso8601 An ISO 8601 interval. + * @param {boolean} [options.isStartIncluded=true] true if start time is included in the interval, false otherwise. + * @param {boolean} [options.isStopIncluded=true] true if stop time is included in the interval, false otherwise. + * @param {boolean} [options.leadingInterval=false] true if you want to add a interval from Iso8601.MINIMUM_VALUE to start time, false otherwise. + * @param {boolean} [options.trailingInterval=false] true if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE, false otherwise. * @param {Function} [options.dataCallback] A function that will be return the data that is called with each interval before it is added to the collection. If unspecified, the data will be the index in the collection. * @param {TimeIntervalCollection} [result] An existing instance to use for the result. * @returns {TimeIntervalCollection} The modified result parameter or a new instance if none was provided. @@ -1038,12 +1038,12 @@ TimeIntervalCollection.fromIso8601 = function (options, result) { /** * Creates a new instance from a {@link http://en.wikipedia.org/wiki/ISO_8601|ISO 8601} date array. * - * @param {Object} options Object with the following properties: - * @param {String[]} options.iso8601Dates An array of ISO 8601 dates. - * @param {Boolean} [options.isStartIncluded=true] true if start time is included in the interval, false otherwise. - * @param {Boolean} [options.isStopIncluded=true] true if stop time is included in the interval, false otherwise. - * @param {Boolean} [options.leadingInterval=false] true if you want to add a interval from Iso8601.MINIMUM_VALUE to start time, false otherwise. - * @param {Boolean} [options.trailingInterval=false] true if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE, false otherwise. + * @param {object} options Object with the following properties: + * @param {string[]} options.iso8601Dates An array of ISO 8601 dates. + * @param {boolean} [options.isStartIncluded=true] true if start time is included in the interval, false otherwise. + * @param {boolean} [options.isStopIncluded=true] true if stop time is included in the interval, false otherwise. + * @param {boolean} [options.leadingInterval=false] true if you want to add a interval from Iso8601.MINIMUM_VALUE to start time, false otherwise. + * @param {boolean} [options.trailingInterval=false] true if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE, false otherwise. * @param {Function} [options.dataCallback] A function that will be return the data that is called with each interval before it is added to the collection. If unspecified, the data will be the index in the collection. * @param {TimeIntervalCollection} [result] An existing instance to use for the result. * @returns {TimeIntervalCollection} The modified result parameter or a new instance if none was provided. @@ -1076,14 +1076,14 @@ TimeIntervalCollection.fromIso8601DateArray = function (options, result) { /** * Creates a new instance from a {@link http://en.wikipedia.org/wiki/ISO_8601|ISO 8601} duration array. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {JulianDate} options.epoch An date that the durations are relative to. - * @param {String} options.iso8601Durations An array of ISO 8601 durations. - * @param {Boolean} [options.relativeToPrevious=false] true if durations are relative to previous date, false if always relative to the epoch. - * @param {Boolean} [options.isStartIncluded=true] true if start time is included in the interval, false otherwise. - * @param {Boolean} [options.isStopIncluded=true] true if stop time is included in the interval, false otherwise. - * @param {Boolean} [options.leadingInterval=false] true if you want to add a interval from Iso8601.MINIMUM_VALUE to start time, false otherwise. - * @param {Boolean} [options.trailingInterval=false] true if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE, false otherwise. + * @param {string} options.iso8601Durations An array of ISO 8601 durations. + * @param {boolean} [options.relativeToPrevious=false] true if durations are relative to previous date, false if always relative to the epoch. + * @param {boolean} [options.isStartIncluded=true] true if start time is included in the interval, false otherwise. + * @param {boolean} [options.isStopIncluded=true] true if stop time is included in the interval, false otherwise. + * @param {boolean} [options.leadingInterval=false] true if you want to add a interval from Iso8601.MINIMUM_VALUE to start time, false otherwise. + * @param {boolean} [options.trailingInterval=false] true if you want to add a interval from stop time to Iso8601.MAXIMUM_VALUE, false otherwise. * @param {Function} [options.dataCallback] A function that will be return the data that is called with each interval before it is added to the collection. If unspecified, the data will be the index in the collection. * @param {TimeIntervalCollection} [result] An existing instance to use for the result. * @returns {TimeIntervalCollection} The modified result parameter or a new instance if none was provided. diff --git a/packages/engine/Source/Core/TimeStandard.js b/packages/engine/Source/Core/TimeStandard.js index cd1bc3b1941c..022772f8f3ee 100644 --- a/packages/engine/Source/Core/TimeStandard.js +++ b/packages/engine/Source/Core/TimeStandard.js @@ -1,7 +1,7 @@ /** * Provides the type of time standards which JulianDate can take as input. * - * @enum {Number} + * @enum {number} * * @see JulianDate */ @@ -13,7 +13,7 @@ const TimeStandard = { * UTC = TAI - deltaT where deltaT is the number of leap * seconds which have been introduced as of the time in TAI. * - * @type {Number} + * @type {number} * @constant */ UTC: 0, @@ -22,7 +22,7 @@ const TimeStandard = { * Represents the International Atomic Time (TAI) time standard. * TAI is the principal time standard to which the other time standards are related. * - * @type {Number} + * @type {number} * @constant */ TAI: 1, diff --git a/packages/engine/Source/Core/Tipsify.js b/packages/engine/Source/Core/Tipsify.js index 87d89ef2d00a..d40e9ac5cfa7 100644 --- a/packages/engine/Source/Core/Tipsify.js +++ b/packages/engine/Source/Core/Tipsify.js @@ -21,13 +21,13 @@ const Tipsify = {}; /** * Calculates the average cache miss ratio (ACMR) for a given set of indices. * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices + * @param {object} options Object with the following properties: + * @param {number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices * in the vertex buffer that define the geometry's triangles. - * @param {Number} [options.maximumIndex] The maximum value of the elements in args.indices. + * @param {number} [options.maximumIndex] The maximum value of the elements in args.indices. * If not supplied, this value will be computed. - * @param {Number} [options.cacheSize=24] The number of vertices that can be stored in the cache at any one time. - * @returns {Number} The average cache miss ratio (ACMR). + * @param {number} [options.cacheSize=24] The number of vertices that can be stored in the cache at any one time. + * @returns {number} The average cache miss ratio (ACMR). * * @exception {DeveloperError} indices length must be a multiple of three. * @exception {DeveloperError} cacheSize must be greater than two. @@ -99,13 +99,13 @@ Tipsify.calculateACMR = function (options) { /** * Optimizes triangles for the post-vertex shader cache. * - * @param {Object} options Object with the following properties: - * @param {Number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices + * @param {object} options Object with the following properties: + * @param {number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices * in the vertex buffer that define the geometry's triangles. - * @param {Number} [options.maximumIndex] The maximum value of the elements in args.indices. + * @param {number} [options.maximumIndex] The maximum value of the elements in args.indices. * If not supplied, this value will be computed. - * @param {Number} [options.cacheSize=24] The number of vertices that can be stored in the cache at any one time. - * @returns {Number[]} A list of the input indices in an optimized order. + * @param {number} [options.cacheSize=24] The number of vertices that can be stored in the cache at any one time. + * @returns {number[]} A list of the input indices in an optimized order. * * @exception {DeveloperError} indices length must be a multiple of three. * @exception {DeveloperError} cacheSize must be greater than two. diff --git a/packages/engine/Source/Core/Transforms.js b/packages/engine/Source/Core/Transforms.js index 1642351d1383..a643478bb433 100644 --- a/packages/engine/Source/Core/Transforms.js +++ b/packages/engine/Source/Core/Transforms.js @@ -90,9 +90,9 @@ let scratchThirdCartesian = new Cartesian3(); /** * Generates a function that computes a 4x4 transformation matrix from a reference frame * centered at the provided origin to the provided ellipsoid's fixed reference frame. - * @param {String} firstAxis name of the first axis of the local reference frame. Must be + * @param {string} firstAxis name of the first axis of the local reference frame. Must be * 'east', 'north', 'up', 'west', 'south' or 'down'. - * @param {String} secondAxis name of the second axis of the local reference frame. Must be + * @param {string} secondAxis name of the second axis of the local reference frame. Must be * 'east', 'north', 'up', 'west', 'south' or 'down'. * @return {Transforms.LocalFrameToFixedFrame} The function that will computes a * 4x4 transformation matrix from a reference frame, with first axis and second axis compliant with the parameters, diff --git a/packages/engine/Source/Core/TranslationRotationScale.js b/packages/engine/Source/Core/TranslationRotationScale.js index 12ad68444040..f3ce144596a3 100644 --- a/packages/engine/Source/Core/TranslationRotationScale.js +++ b/packages/engine/Source/Core/TranslationRotationScale.js @@ -46,7 +46,7 @@ function TranslationRotationScale(translation, rotation, scale) { * true if they are equal, false otherwise. * * @param {TranslationRotationScale} [right] The right hand side TranslationRotationScale. - * @returns {Boolean} true if they are equal, false otherwise. + * @returns {boolean} true if they are equal, false otherwise. */ TranslationRotationScale.prototype.equals = function (right) { return ( diff --git a/packages/engine/Source/Core/TridiagonalSystemSolver.js b/packages/engine/Source/Core/TridiagonalSystemSolver.js index 817881a03c32..b53dabc7e3e4 100644 --- a/packages/engine/Source/Core/TridiagonalSystemSolver.js +++ b/packages/engine/Source/Core/TridiagonalSystemSolver.js @@ -13,9 +13,9 @@ const TridiagonalSystemSolver = {}; /** * Solves a tridiagonal system of linear equations. * - * @param {Number[]} diagonal An array with length n that contains the diagonal of the coefficient matrix. - * @param {Number[]} lower An array with length n - 1 that contains the lower diagonal of the coefficient matrix. - * @param {Number[]} upper An array with length n - 1 that contains the upper diagonal of the coefficient matrix. + * @param {number[]} diagonal An array with length n that contains the diagonal of the coefficient matrix. + * @param {number[]} lower An array with length n - 1 that contains the lower diagonal of the coefficient matrix. + * @param {number[]} upper An array with length n - 1 that contains the upper diagonal of the coefficient matrix. * @param {Cartesian3[]} right An array of Cartesians with length n that is the right side of the system of equations. * * @exception {DeveloperError} diagonal and right must have the same lengths. diff --git a/packages/engine/Source/Core/TrustedServers.js b/packages/engine/Source/Core/TrustedServers.js index 933cf90ffc1a..92b24ae7cef5 100644 --- a/packages/engine/Source/Core/TrustedServers.js +++ b/packages/engine/Source/Core/TrustedServers.js @@ -16,8 +16,8 @@ let _servers = {}; /** * Adds a trusted server to the registry * - * @param {String} host The host to be added. - * @param {Number} port The port used to access the host. + * @param {string} host The host to be added. + * @param {number} port The port used to access the host. * * @example * // Add a trusted server @@ -42,8 +42,8 @@ TrustedServers.add = function (host, port) { /** * Removes a trusted server from the registry * - * @param {String} host The host to be removed. - * @param {Number} port The port used to access the host. + * @param {string} host The host to be removed. + * @param {number} port The port used to access the host. * * @example * // Remove a trusted server @@ -103,7 +103,7 @@ function getAuthority(url) { /** * Tests whether a server is trusted or not. The server must have been added with the port if it is included in the url. * - * @param {String} url The url to be tested against the trusted list + * @param {string} url The url to be tested against the trusted list * * @returns {boolean} Returns true if url is trusted, false otherwise. * diff --git a/packages/engine/Source/Core/VRTheWorldTerrainProvider.js b/packages/engine/Source/Core/VRTheWorldTerrainProvider.js index fae254756aa6..dda00d9a795d 100644 --- a/packages/engine/Source/Core/VRTheWorldTerrainProvider.js +++ b/packages/engine/Source/Core/VRTheWorldTerrainProvider.js @@ -26,11 +26,11 @@ function DataRectangle(rectangle, maxLevel) { * @alias VRTheWorldTerrainProvider * @constructor * - * @param {Object} options Object with the following properties: - * @param {Resource|String} options.url The URL of the VR-TheWorld TileMap. + * @param {object} options Object with the following properties: + * @param {Resource|string} options.url The URL of the VR-TheWorld TileMap. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid. If this parameter is not * specified, the WGS84 ellipsoid is used. - * @param {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas. + * @param {Credit|string} [options.credit] A credit for the data source, which is displayed on the canvas. * * * @example @@ -204,7 +204,7 @@ Object.defineProperties(VRTheWorldTerrainProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof VRTheWorldTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -216,7 +216,7 @@ Object.defineProperties(VRTheWorldTerrainProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof VRTheWorldTerrainProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -231,7 +231,7 @@ Object.defineProperties(VRTheWorldTerrainProvider.prototype, { * as a reflective surface with animated waves. This function should not be * called before {@link VRTheWorldTerrainProvider#ready} returns true. * @memberof VRTheWorldTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasWaterMask: { @@ -244,7 +244,7 @@ Object.defineProperties(VRTheWorldTerrainProvider.prototype, { * Gets a value indicating whether or not the requested tiles include vertex normals. * This function should not be called before {@link VRTheWorldTerrainProvider#ready} returns true. * @memberof VRTheWorldTerrainProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasVertexNormals: { @@ -273,11 +273,11 @@ Object.defineProperties(VRTheWorldTerrainProvider.prototype, { * {@link VRTheWorldTerrainProvider#ready} returns true. The result includes terrain * data and indicates that all child tiles are available. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @param {Request} [request] The request object. Intended for internal use only. - * @returns {Promise.|undefined} A promise for the requested geometry. If this method + * @returns {Promise|undefined} A promise for the requested geometry. If this method * returns undefined instead of a promise, it is an indication that too many requests are already * pending and the request will be retried later. */ @@ -325,8 +325,8 @@ VRTheWorldTerrainProvider.prototype.requestTileGeometry = function ( /** * Gets the maximum geometric error allowed in a tile at a given level. * - * @param {Number} level The tile level for which to get the maximum geometric error. - * @returns {Number} The maximum geometric error. + * @param {number} level The tile level for which to get the maximum geometric error. + * @returns {number} The maximum geometric error. */ VRTheWorldTerrainProvider.prototype.getLevelMaximumGeometricError = function ( level @@ -419,10 +419,10 @@ function isTileInRectangle(tilingScheme, rectangle, x, y, level) { /** * Determines whether data for a tile is available to be loaded. * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. - * @returns {Boolean|undefined} Undefined if not supported, otherwise true or false. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. + * @returns {boolean|undefined} Undefined if not supported, otherwise true or false. */ VRTheWorldTerrainProvider.prototype.getTileDataAvailable = function ( x, @@ -435,9 +435,9 @@ VRTheWorldTerrainProvider.prototype.getTileDataAvailable = function ( /** * Makes sure we load availability data for a tile * - * @param {Number} x The X coordinate of the tile for which to request geometry. - * @param {Number} y The Y coordinate of the tile for which to request geometry. - * @param {Number} level The level of the tile for which to request geometry. + * @param {number} x The X coordinate of the tile for which to request geometry. + * @param {number} y The Y coordinate of the tile for which to request geometry. + * @param {number} level The level of the tile for which to request geometry. * @returns {undefined|Promise} Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded */ VRTheWorldTerrainProvider.prototype.loadTileDataAvailability = function ( diff --git a/packages/engine/Source/Core/VertexFormat.js b/packages/engine/Source/Core/VertexFormat.js index 5baf95dcbca3..9754d06ba676 100644 --- a/packages/engine/Source/Core/VertexFormat.js +++ b/packages/engine/Source/Core/VertexFormat.js @@ -7,7 +7,7 @@ import DeveloperError from "./DeveloperError.js"; * to a {@link Geometry} to request that certain properties be computed, e.g., just position, * position and normal, etc. * - * @param {Object} [options] An object with boolean properties corresponding to VertexFormat properties as shown in the code example. + * @param {object} [options] An object with boolean properties corresponding to VertexFormat properties as shown in the code example. * * @alias VertexFormat * @constructor @@ -31,7 +31,7 @@ function VertexFormat(options) { * 64-bit floating-point (for precision). 3 components per attribute. *

* - * @type Boolean + * @type {boolean} * * @default false */ @@ -43,7 +43,7 @@ function VertexFormat(options) { * 32-bit floating-point. 3 components per attribute. *

* - * @type Boolean + * @type {boolean} * * @default false */ @@ -55,7 +55,7 @@ function VertexFormat(options) { * 32-bit floating-point. 2 components per attribute *

* - * @type Boolean + * @type {boolean} * * @default false */ @@ -67,7 +67,7 @@ function VertexFormat(options) { * 32-bit floating-point. 3 components per attribute. *

* - * @type Boolean + * @type {boolean} * * @default false */ @@ -79,7 +79,7 @@ function VertexFormat(options) { * 32-bit floating-point. 3 components per attribute. *

* - * @type Boolean + * @type {boolean} * * @default false */ @@ -91,7 +91,7 @@ function VertexFormat(options) { * 8-bit unsigned byte. 3 components per attribute. *

* - * @type Boolean + * @type {boolean} * * @default false */ @@ -220,7 +220,7 @@ VertexFormat.DEFAULT = VertexFormat.POSITION_NORMAL_AND_ST; /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ VertexFormat.packedLength = 6; @@ -228,10 +228,10 @@ VertexFormat.packedLength = 6; * Stores the provided instance into the provided array. * * @param {VertexFormat} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ VertexFormat.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -258,8 +258,8 @@ VertexFormat.pack = function (value, array, startingIndex) { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {VertexFormat} [result] The object into which to store the result. * @returns {VertexFormat} The modified result parameter or a new VertexFormat instance if one was not provided. */ diff --git a/packages/engine/Source/Core/VideoSynchronizer.js b/packages/engine/Source/Core/VideoSynchronizer.js index cd4e3b7af448..5599dcae75cf 100644 --- a/packages/engine/Source/Core/VideoSynchronizer.js +++ b/packages/engine/Source/Core/VideoSynchronizer.js @@ -10,11 +10,11 @@ import JulianDate from "./JulianDate.js"; * @alias VideoSynchronizer * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Clock} [options.clock] The clock instance used to drive the video. * @param {HTMLVideoElement} [options.element] The video element to be synchronized. * @param {JulianDate} [options.epoch=Iso8601.MINIMUM_VALUE] The simulation time that marks the start of the video. - * @param {Number} [options.tolerance=1.0] The maximum amount of time, in seconds, that the clock and video can diverge. + * @param {number} [options.tolerance=1.0] The maximum amount of time, in seconds, that the clock and video can diverge. * * @demo {@link https://sandcastle.cesium.com/index.html?src=Video.html|Video Material Demo} */ @@ -43,7 +43,7 @@ function VideoSynchronizer(options) { * Lower values make the synchronization more accurate but video * performance might suffer. Higher values provide better performance * but at the cost of accuracy. - * @type {Number} + * @type {number} * @default 1.0 */ this.tolerance = defaultValue(options.tolerance, 1.0); @@ -134,7 +134,7 @@ VideoSynchronizer.prototype.destroy = function () { /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ VideoSynchronizer.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Core/Visibility.js b/packages/engine/Source/Core/Visibility.js index 60f5758d7c9e..21c80db3db8e 100644 --- a/packages/engine/Source/Core/Visibility.js +++ b/packages/engine/Source/Core/Visibility.js @@ -4,13 +4,13 @@ * it has no visibility, may partially block an occludee from view, or may not block it at all, * leading to full visibility. * - * @enum {Number} + * @enum {number} */ const Visibility = { /** * Represents that no part of an object is visible. * - * @type {Number} + * @type {number} * @constant */ NONE: -1, @@ -18,7 +18,7 @@ const Visibility = { /** * Represents that part, but not all, of an object is visible * - * @type {Number} + * @type {number} * @constant */ PARTIAL: 0, @@ -26,7 +26,7 @@ const Visibility = { /** * Represents that an object is visible in its entirety. * - * @type {Number} + * @type {number} * @constant */ FULL: 1, diff --git a/packages/engine/Source/Core/VulkanConstants.js b/packages/engine/Source/Core/VulkanConstants.js index 5a8205c33db0..5252ff1df36d 100644 --- a/packages/engine/Source/Core/VulkanConstants.js +++ b/packages/engine/Source/Core/VulkanConstants.js @@ -3,7 +3,7 @@ * * These match the constants from the {@link https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-definition|Vulkan 1.2 specification}. * - * @enum {Number} + * @enum {number} * @private */ const VulkanConstants = { diff --git a/packages/engine/Source/Core/WallGeometry.js b/packages/engine/Source/Core/WallGeometry.js index 2c086757b18d..a67e0a882268 100644 --- a/packages/engine/Source/Core/WallGeometry.js +++ b/packages/engine/Source/Core/WallGeometry.js @@ -29,12 +29,12 @@ const scratchNormal = new Cartesian3(); * @alias WallGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Number[]} [options.maximumHeights] An array parallel to positions that give the maximum height of the + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number[]} [options.maximumHeights] An array parallel to positions that give the maximum height of the * wall at positions. If undefined, the height of each position in used. - * @param {Number[]} [options.minimumHeights] An array parallel to positions that give the minimum height of the + * @param {number[]} [options.minimumHeights] An array parallel to positions that give the minimum height of the * wall at positions. If undefined, the height at each position is 0.0. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. @@ -115,7 +115,7 @@ function WallGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = numComponents + Ellipsoid.packedLength + VertexFormat.packedLength + 1; @@ -125,10 +125,10 @@ function WallGeometry(options) { * Stores the provided instance into the provided array. * * @param {WallGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ WallGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -197,8 +197,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {WallGeometry} [result] The object into which to store the result. * @returns {WallGeometry} The modified result parameter or a new WallGeometry instance if one was not provided. */ @@ -274,11 +274,11 @@ WallGeometry.unpack = function (array, startingIndex, result) { * A description of a wall, which is similar to a KML line string. A wall is defined by a series of points, * which extrude down to the ground. Optionally, they can extrude downwards to a specified height. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall. - * @param {Number} [options.maximumHeight] A constant that defines the maximum height of the + * @param {number} [options.maximumHeight] A constant that defines the maximum height of the * wall at positions. If undefined, the height of each position in used. - * @param {Number} [options.minimumHeight] A constant that defines the minimum height of the + * @param {number} [options.minimumHeight] A constant that defines the minimum height of the * wall at positions. If undefined, the height at each position is 0.0. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed. diff --git a/packages/engine/Source/Core/WallOutlineGeometry.js b/packages/engine/Source/Core/WallOutlineGeometry.js index 842541376db2..e68299c14144 100644 --- a/packages/engine/Source/Core/WallOutlineGeometry.js +++ b/packages/engine/Source/Core/WallOutlineGeometry.js @@ -23,12 +23,12 @@ const scratchCartesian3Position2 = new Cartesian3(); * @alias WallOutlineGeometry * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall. - * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. - * @param {Number[]} [options.maximumHeights] An array parallel to positions that give the maximum height of the + * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer. + * @param {number[]} [options.maximumHeights] An array parallel to positions that give the maximum height of the * wall at positions. If undefined, the height of each position in used. - * @param {Number[]} [options.minimumHeights] An array parallel to positions that give the minimum height of the + * @param {number[]} [options.minimumHeights] An array parallel to positions that give the minimum height of the * wall at positions. If undefined, the height at each position is 0.0. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation * @@ -104,7 +104,7 @@ function WallOutlineGeometry(options) { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ this.packedLength = numComponents + Ellipsoid.packedLength + 1; } @@ -113,10 +113,10 @@ function WallOutlineGeometry(options) { * Stores the provided instance into the provided array. * * @param {WallOutlineGeometry} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ WallOutlineGeometry.pack = function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -180,8 +180,8 @@ const scratchOptions = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {WallOutlineGeometry} [result] The object into which to store the result. * @returns {WallOutlineGeometry} The modified result parameter or a new WallOutlineGeometry instance if one was not provided. */ @@ -249,11 +249,11 @@ WallOutlineGeometry.unpack = function (array, startingIndex, result) { * A description of a walloutline. A wall is defined by a series of points, * which extrude down to the ground. Optionally, they can extrude downwards to a specified height. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall. - * @param {Number} [options.maximumHeight] A constant that defines the maximum height of the + * @param {number} [options.maximumHeight] A constant that defines the maximum height of the * wall at positions. If undefined, the height of each position in used. - * @param {Number} [options.minimumHeight] A constant that defines the minimum height of the + * @param {number} [options.minimumHeight] A constant that defines the minimum height of the * wall at positions. If undefined, the height at each position is 0.0. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation * @returns {WallOutlineGeometry} diff --git a/packages/engine/Source/Core/WebGLConstants.js b/packages/engine/Source/Core/WebGLConstants.js index 7ff6a6710629..8e99cd67b542 100644 --- a/packages/engine/Source/Core/WebGLConstants.js +++ b/packages/engine/Source/Core/WebGLConstants.js @@ -7,7 +7,7 @@ * and [WebGL 2.0]{@link https://www.khronos.org/registry/webgl/specs/latest/2.0/} * specifications. * - * @enum {Number} + * @enum {number} */ const WebGLConstants = { DEPTH_BUFFER_BIT: 0x00000100, diff --git a/packages/engine/Source/Core/WebMercatorProjection.js b/packages/engine/Source/Core/WebMercatorProjection.js index 82e269ef95cd..79a7cb309ec2 100644 --- a/packages/engine/Source/Core/WebMercatorProjection.js +++ b/packages/engine/Source/Core/WebMercatorProjection.js @@ -44,8 +44,8 @@ Object.defineProperties(WebMercatorProjection.prototype, { * Converts a Mercator angle, in the range -PI to PI, to a geodetic latitude * in the range -PI/2 to PI/2. * - * @param {Number} mercatorAngle The angle to convert. - * @returns {Number} The geodetic latitude in radians. + * @param {number} mercatorAngle The angle to convert. + * @returns {number} The geodetic latitude in radians. */ WebMercatorProjection.mercatorAngleToGeodeticLatitude = function ( mercatorAngle @@ -57,8 +57,8 @@ WebMercatorProjection.mercatorAngleToGeodeticLatitude = function ( * Converts a geodetic latitude in radians, in the range -PI/2 to PI/2, to a Mercator * angle in the range -PI to PI. * - * @param {Number} latitude The geodetic latitude in radians. - * @returns {Number} The Mercator angle. + * @param {number} latitude The geodetic latitude in radians. + * @returns {number} The Mercator angle. */ WebMercatorProjection.geodeticLatitudeToMercatorAngle = function (latitude) { // Clamp the latitude coordinate to the valid Mercator bounds. @@ -83,7 +83,7 @@ WebMercatorProjection.geodeticLatitudeToMercatorAngle = function (latitude) { * The constant value is computed by calling: * WebMercatorProjection.mercatorAngleToGeodeticLatitude(Math.PI) * - * @type {Number} + * @type {number} */ WebMercatorProjection.MaximumLatitude = WebMercatorProjection.mercatorAngleToGeodeticLatitude( Math.PI diff --git a/packages/engine/Source/Core/WebMercatorTilingScheme.js b/packages/engine/Source/Core/WebMercatorTilingScheme.js index c835a8f246ca..2266870b131e 100644 --- a/packages/engine/Source/Core/WebMercatorTilingScheme.js +++ b/packages/engine/Source/Core/WebMercatorTilingScheme.js @@ -12,12 +12,12 @@ import WebMercatorProjection from "./WebMercatorProjection.js"; * @alias WebMercatorTilingScheme * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid whose surface is being tiled. Defaults to * the WGS84 ellipsoid. - * @param {Number} [options.numberOfLevelZeroTilesX=1] The number of tiles in the X direction at level zero of + * @param {number} [options.numberOfLevelZeroTilesX=1] The number of tiles in the X direction at level zero of * the tile tree. - * @param {Number} [options.numberOfLevelZeroTilesY=1] The number of tiles in the Y direction at level zero of + * @param {number} [options.numberOfLevelZeroTilesY=1] The number of tiles in the Y direction at level zero of * the tile tree. * @param {Cartesian2} [options.rectangleSouthwestInMeters] The southwest corner of the rectangle covered by the * tiling scheme, in meters. If this parameter or rectangleNortheastInMeters is not specified, the entire @@ -113,8 +113,8 @@ Object.defineProperties(WebMercatorTilingScheme.prototype, { /** * Gets the total number of tiles in the X direction at a specified level-of-detail. * - * @param {Number} level The level-of-detail. - * @returns {Number} The number of tiles in the X direction at the given level. + * @param {number} level The level-of-detail. + * @returns {number} The number of tiles in the X direction at the given level. */ WebMercatorTilingScheme.prototype.getNumberOfXTilesAtLevel = function (level) { return this._numberOfLevelZeroTilesX << level; @@ -123,8 +123,8 @@ WebMercatorTilingScheme.prototype.getNumberOfXTilesAtLevel = function (level) { /** * Gets the total number of tiles in the Y direction at a specified level-of-detail. * - * @param {Number} level The level-of-detail. - * @returns {Number} The number of tiles in the Y direction at the given level. + * @param {number} level The level-of-detail. + * @returns {number} The number of tiles in the Y direction at the given level. */ WebMercatorTilingScheme.prototype.getNumberOfYTilesAtLevel = function (level) { return this._numberOfLevelZeroTilesY << level; @@ -163,10 +163,10 @@ WebMercatorTilingScheme.prototype.rectangleToNativeRectangle = function ( * Converts tile x, y coordinates and level to a rectangle expressed in the native coordinates * of the tiling scheme. * - * @param {Number} x The integer x coordinate of the tile. - * @param {Number} y The integer y coordinate of the tile. - * @param {Number} level The tile level-of-detail. Zero is the least detailed. - * @param {Object} [result] The instance to which to copy the result, or undefined if a new instance + * @param {number} x The integer x coordinate of the tile. + * @param {number} y The integer y coordinate of the tile. + * @param {number} level The tile level-of-detail. Zero is the least detailed. + * @param {object} [result] The instance to which to copy the result, or undefined if a new instance * should be created. * @returns {Rectangle} The specified 'result', or a new object containing the rectangle * if 'result' is undefined. @@ -206,10 +206,10 @@ WebMercatorTilingScheme.prototype.tileXYToNativeRectangle = function ( /** * Converts tile x, y coordinates and level to a cartographic rectangle in radians. * - * @param {Number} x The integer x coordinate of the tile. - * @param {Number} y The integer y coordinate of the tile. - * @param {Number} level The tile level-of-detail. Zero is the least detailed. - * @param {Object} [result] The instance to which to copy the result, or undefined if a new instance + * @param {number} x The integer x coordinate of the tile. + * @param {number} y The integer y coordinate of the tile. + * @param {number} level The tile level-of-detail. Zero is the least detailed. + * @param {object} [result] The instance to which to copy the result, or undefined if a new instance * should be created. * @returns {Rectangle} The specified 'result', or a new object containing the rectangle * if 'result' is undefined. @@ -242,7 +242,7 @@ WebMercatorTilingScheme.prototype.tileXYToRectangle = function ( * a given cartographic position. * * @param {Cartographic} position The position. - * @param {Number} level The tile level-of-detail. Zero is the least detailed. + * @param {number} level The tile level-of-detail. Zero is the least detailed. * @param {Cartesian2} [result] The instance to which to copy the result, or undefined if a new instance * should be created. * @returns {Cartesian2} The specified 'result', or a new object containing the tile x, y coordinates diff --git a/packages/engine/Source/Core/WindingOrder.js b/packages/engine/Source/Core/WindingOrder.js index 7be369dc9955..e9696c5ebb53 100644 --- a/packages/engine/Source/Core/WindingOrder.js +++ b/packages/engine/Source/Core/WindingOrder.js @@ -3,13 +3,13 @@ import WebGLConstants from "./WebGLConstants.js"; /** * Winding order defines the order of vertices for a triangle to be considered front-facing. * - * @enum {Number} + * @enum {number} */ const WindingOrder = { /** * Vertices are in clockwise order. * - * @type {Number} + * @type {number} * @constant */ CLOCKWISE: WebGLConstants.CW, @@ -17,7 +17,7 @@ const WindingOrder = { /** * Vertices are in counter-clockwise order. * - * @type {Number} + * @type {number} * @constant */ COUNTER_CLOCKWISE: WebGLConstants.CCW, diff --git a/packages/engine/Source/Core/WireframeIndexGenerator.js b/packages/engine/Source/Core/WireframeIndexGenerator.js index cdb3cbc72f61..6100dad6effd 100644 --- a/packages/engine/Source/Core/WireframeIndexGenerator.js +++ b/packages/engine/Source/Core/WireframeIndexGenerator.js @@ -164,7 +164,7 @@ function createWireframeFromTriangleFanIndices(vertexCount, originalIndices) { * or creating them from scratch if the model had none. * * @param {PrimitiveType} primitiveType The primitive type. - * @param {Number} vertexCount The number of vertices in the primitive. + * @param {number} vertexCount The number of vertices in the primitive. * @param {Uint8Array|Uint16Array|Uint32Array} [originalIndices] A typed array containing the original indices of the primitive. * * @return {Uint16Array|Uint32Array} A typed array with the wireframe indices, or undefined if the primitive type does not use triangles. @@ -202,8 +202,8 @@ WireframeIndexGenerator.createWireframeIndices = function ( * Gets the number of indices in the wireframe index buffer of a primitive type. * * @param {PrimitiveType} primitiveType The primitive type. - * @param {Number} originalCount The original number of vertices or indices in the primitive. - * @return {Number} The number of indices in the primitive's wireframe. + * @param {number} originalCount The original number of vertices or indices in the primitive. + * @return {number} The number of indices in the primitive's wireframe. * * @private */ diff --git a/packages/engine/Source/Core/arrayRemoveDuplicates.js b/packages/engine/Source/Core/arrayRemoveDuplicates.js index 0f1a08844cb9..c001def63001 100644 --- a/packages/engine/Source/Core/arrayRemoveDuplicates.js +++ b/packages/engine/Source/Core/arrayRemoveDuplicates.js @@ -8,11 +8,11 @@ const removeDuplicatesEpsilon = CesiumMath.EPSILON10; /** * Removes adjacent duplicate values in an array of values. * - * @param {Array.<*>} [values] The array of values. + * @param {any[]} [values] The array of values. * @param {Function} equalsEpsilon Function to compare values with an epsilon. Boolean equalsEpsilon(left, right, epsilon). - * @param {Boolean} [wrapAround=false] Compare the last value in the array against the first value. If they are equal, the last value is removed. - * @param {Array.} [removedIndices=undefined] Store the indices that correspond to the duplicate items removed from the array, if there were any. - * @returns {Array.<*>|undefined} A new array of values with no adjacent duplicate values or the input array if no duplicates were found. + * @param {boolean} [wrapAround=false] Compare the last value in the array against the first value. If they are equal, the last value is removed. + * @param {number[]} [removedIndices=undefined] Store the indices that correspond to the duplicate items removed from the array, if there were any. + * @returns {any[]|undefined} A new array of values with no adjacent duplicate values or the input array if no duplicates were found. * * @example * // Returns [(1.0, 1.0, 1.0), (2.0, 2.0, 2.0), (3.0, 3.0, 3.0), (1.0, 1.0, 1.0)] diff --git a/packages/engine/Source/Core/binarySearch.js b/packages/engine/Source/Core/binarySearch.js index c14b7631c64c..5cbb2890b96a 100644 --- a/packages/engine/Source/Core/binarySearch.js +++ b/packages/engine/Source/Core/binarySearch.js @@ -8,7 +8,7 @@ import Check from "./Check.js"; * @param {*} itemToFind The item to find in the array. * @param {binarySearchComparator} comparator The function to use to compare the item to * elements in the array. - * @returns {Number} The index of itemToFind in the array, if it exists. If itemToFind + * @returns {number} The index of itemToFind in the array, if it exists. If itemToFind * does not exist, the return value is a negative number which is the bitwise complement (~) * of the index before which the itemToFind should be inserted in order to maintain the * sorted order of the array. @@ -55,7 +55,7 @@ function binarySearch(array, itemToFind, comparator) { * * @param {*} a An item in the array. * @param {*} b The item being searched for. - * @returns {Number} Returns a negative value if a is less than b, + * @returns {number} Returns a negative value if a is less than b, * a positive value if a is greater than b, or * 0 if a is equal to b. * diff --git a/packages/engine/Source/Core/buildModuleUrl.js b/packages/engine/Source/Core/buildModuleUrl.js index 44b878a3c9b6..026faec9f040 100644 --- a/packages/engine/Source/Core/buildModuleUrl.js +++ b/packages/engine/Source/Core/buildModuleUrl.js @@ -93,8 +93,8 @@ let implementation; * Given a relative URL under the Cesium base URL, returns an absolute URL. * @function * - * @param {String} relativeUrl The relative path. - * @returns {String} The absolutely URL representation of the provided path. + * @param {string} relativeUrl The relative path. + * @returns {string} The absolutely URL representation of the provided path. * * @example * const viewer = new Cesium.Viewer("cesiumContainer", { @@ -132,7 +132,7 @@ buildModuleUrl._clearBaseResource = function () { /** * Sets the base URL for resolving modules. - * @param {String} value The new base URL. + * @param {string} value The new base URL. */ buildModuleUrl.setBaseUrl = function (value) { baseResource = Resource.DEFAULT.getDerivedResource({ @@ -144,7 +144,7 @@ buildModuleUrl.setBaseUrl = function (value) { * Gets the base URL for resolving modules. * * @function - * @returns {String} The configured base URL + * @returns {string} The configured base URL */ buildModuleUrl.getCesiumBaseUrl = getCesiumBaseUrl; diff --git a/packages/engine/Source/Core/cancelAnimationFrame.js b/packages/engine/Source/Core/cancelAnimationFrame.js deleted file mode 100644 index d86c38ef1cbc..000000000000 --- a/packages/engine/Source/Core/cancelAnimationFrame.js +++ /dev/null @@ -1,53 +0,0 @@ -import defined from "./defined.js"; -import deprecationWarning from "./deprecationWarning.js"; - -let implementation; -if (typeof cancelAnimationFrame !== "undefined") { - implementation = cancelAnimationFrame; -} - -(function () { - // look for vendor prefixed function - if (!defined(implementation) && typeof window !== "undefined") { - const vendors = ["webkit", "moz", "ms", "o"]; - let i = 0; - const len = vendors.length; - while (i < len && !defined(implementation)) { - implementation = window[`${vendors[i]}CancelAnimationFrame`]; - if (!defined(implementation)) { - implementation = window[`${vendors[i]}CancelRequestAnimationFrame`]; - } - ++i; - } - } - - // otherwise, assume requestAnimationFrame is based on setTimeout, so use clearTimeout - if (!defined(implementation)) { - implementation = clearTimeout; - } -})(); - -/** - * A browser-independent function to cancel an animation frame requested using {@link requestAnimationFrame}. - * - * @function cancelAnimationFrame - * - * @param {Number} requestID The value returned by {@link requestAnimationFrame}. - * - * @see {@link http://www.w3.org/TR/animation-timing/#the-WindowAnimationTiming-interface|The WindowAnimationTiming interface} - * - * @deprecated - */ -function cancelAnimationFramePolyfill(requestID) { - // we need this extra wrapper function because the native cancelAnimationFrame - // functions must be invoked on the global scope (window), which is not the case - // if invoked as Cesium.cancelAnimationFrame(requestID) - - deprecationWarning( - "Cesium.cancelAnimationFrame", - "Cesium.cancelAnimationFrame was deprecated in CesiumJS 1.96 and will be removed in 1.99. Use the native cancelAnimationFrame method instead." - ); - - implementation(requestID); -} -export default cancelAnimationFramePolyfill; diff --git a/packages/engine/Source/Core/clone.js b/packages/engine/Source/Core/clone.js index 2532c8853d13..f366c04b1826 100644 --- a/packages/engine/Source/Core/clone.js +++ b/packages/engine/Source/Core/clone.js @@ -5,9 +5,9 @@ import defaultValue from "./defaultValue.js"; * * @function * - * @param {Object} object The object to clone. - * @param {Boolean} [deep=false] If true, all properties will be deep cloned recursively. - * @returns {Object} The cloned object. + * @param {object} object The object to clone. + * @param {boolean} [deep=false] If true, all properties will be deep cloned recursively. + * @returns {object} The cloned object. */ function clone(object, deep) { if (object === null || typeof object !== "object") { diff --git a/packages/engine/Source/Core/combine.js b/packages/engine/Source/Core/combine.js index f166b9f00c7c..98d5cf74c6d0 100644 --- a/packages/engine/Source/Core/combine.js +++ b/packages/engine/Source/Core/combine.js @@ -25,10 +25,10 @@ import defined from "./defined.js"; * // } * // } * - * @param {Object} [object1] The first object to merge. - * @param {Object} [object2] The second object to merge. - * @param {Boolean} [deep=false] Perform a recursive merge. - * @returns {Object} The combined object containing all properties from both objects. + * @param {object} [object1] The first object to merge. + * @param {object} [object2] The second object to merge. + * @param {boolean} [deep=false] Perform a recursive merge. + * @returns {object} The combined object containing all properties from both objects. * * @function */ diff --git a/packages/engine/Source/Core/createGuid.js b/packages/engine/Source/Core/createGuid.js index 783eccebe756..f11200d302a2 100644 --- a/packages/engine/Source/Core/createGuid.js +++ b/packages/engine/Source/Core/createGuid.js @@ -3,7 +3,7 @@ * * @function * - * @returns {String} + * @returns {string} * * * @example diff --git a/packages/engine/Source/Core/createWorldTerrain.js b/packages/engine/Source/Core/createWorldTerrain.js index 0fcc7c9c0cb9..3a0406b982a4 100644 --- a/packages/engine/Source/Core/createWorldTerrain.js +++ b/packages/engine/Source/Core/createWorldTerrain.js @@ -7,9 +7,9 @@ import IonResource from "./IonResource.js"; * * @function * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server if available. - * @param {Boolean} [options.requestWaterMask=false] Flag that indicates if the client should request per tile water masks from the server if available. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server if available. + * @param {boolean} [options.requestWaterMask=false] Flag that indicates if the client should request per tile water masks from the server if available. * @returns {CesiumTerrainProvider} * * @see Ion diff --git a/packages/engine/Source/Core/defaultValue.js b/packages/engine/Source/Core/defaultValue.js index 9a52e51ecfb6..50c20d554986 100644 --- a/packages/engine/Source/Core/defaultValue.js +++ b/packages/engine/Source/Core/defaultValue.js @@ -21,7 +21,7 @@ function defaultValue(a, b) { /** * A frozen empty object that can be used as the default value for options passed as * an object literal. - * @type {Object} + * @type {object} * @memberof defaultValue */ defaultValue.EMPTY_OBJECT = Object.freeze({}); diff --git a/packages/engine/Source/Core/defer.js b/packages/engine/Source/Core/defer.js index 8ea507f022b9..2e6c510fc22c 100644 --- a/packages/engine/Source/Core/defer.js +++ b/packages/engine/Source/Core/defer.js @@ -15,7 +15,7 @@ /** * An object which contains a promise object, and functions to resolve or reject the promise. * - * @typedef {Object} defer.deferred + * @typedef {object} defer.deferred * @property {defer.resolve} resolve Resolves the promise when called. * @property {defer.reject} reject Rejects the promise when called. * @property {Promise} promise Promise object. diff --git a/packages/engine/Source/Core/defined.js b/packages/engine/Source/Core/defined.js index d9125ecd06b0..5040c613e7c3 100644 --- a/packages/engine/Source/Core/defined.js +++ b/packages/engine/Source/Core/defined.js @@ -2,7 +2,7 @@ * @function * * @param {*} value The object. - * @returns {Boolean} Returns true if the object is defined, returns false otherwise. + * @returns {boolean} Returns true if the object is defined, returns false otherwise. * * @example * if (Cesium.defined(positions)) { diff --git a/packages/engine/Source/Core/deprecationWarning.js b/packages/engine/Source/Core/deprecationWarning.js index 6e762389326f..0b9c727b8290 100644 --- a/packages/engine/Source/Core/deprecationWarning.js +++ b/packages/engine/Source/Core/deprecationWarning.js @@ -9,8 +9,8 @@ import oneTimeWarning from "./oneTimeWarning.js"; * * @function deprecationWarning * - * @param {String} identifier The unique identifier for this deprecated API. - * @param {String} message The message to log to the console. + * @param {string} identifier The unique identifier for this deprecated API. + * @param {string} message The message to log to the console. * * @example * // Deprecated function or class diff --git a/packages/engine/Source/Core/destroyObject.js b/packages/engine/Source/Core/destroyObject.js index bbec29ffa31a..40093a8ba362 100644 --- a/packages/engine/Source/Core/destroyObject.js +++ b/packages/engine/Source/Core/destroyObject.js @@ -18,8 +18,8 @@ function returnTrue() { * * @function * - * @param {Object} object The object to destroy. - * @param {String} [message] The message to include in the exception that is thrown if + * @param {object} object The object to destroy. + * @param {string} [message] The message to include in the exception that is thrown if * a destroyed object's function is called. * * diff --git a/packages/engine/Source/Core/formatError.js b/packages/engine/Source/Core/formatError.js index 83256927296e..3ef17614f97a 100644 --- a/packages/engine/Source/Core/formatError.js +++ b/packages/engine/Source/Core/formatError.js @@ -7,7 +7,7 @@ import defined from "./defined.js"; * @function * * @param {*} object The item to find in the array. - * @returns {String} A string containing the formatted error. + * @returns {string} A string containing the formatted error. */ function formatError(object) { let result; diff --git a/packages/engine/Source/Core/getAbsoluteUri.js b/packages/engine/Source/Core/getAbsoluteUri.js index b80320cac15c..63f5e7cb9d92 100644 --- a/packages/engine/Source/Core/getAbsoluteUri.js +++ b/packages/engine/Source/Core/getAbsoluteUri.js @@ -7,9 +7,9 @@ import DeveloperError from "./DeveloperError.js"; * Given a relative Uri and a base Uri, returns the absolute Uri of the relative Uri. * @function * - * @param {String} relative The relative Uri. - * @param {String} [base] The base Uri. - * @returns {String} The absolute Uri of the given relative Uri. + * @param {string} relative The relative Uri. + * @param {string} [base] The base Uri. + * @returns {string} The absolute Uri of the given relative Uri. * * @example * //absolute Uri will be "https://test.com/awesome.png"; diff --git a/packages/engine/Source/Core/getBaseUri.js b/packages/engine/Source/Core/getBaseUri.js index 96c36b599c34..78c600cafbcb 100644 --- a/packages/engine/Source/Core/getBaseUri.js +++ b/packages/engine/Source/Core/getBaseUri.js @@ -6,9 +6,9 @@ import DeveloperError from "./DeveloperError.js"; * Given a URI, returns the base path of the URI. * @function * - * @param {String} uri The Uri. - * @param {Boolean} [includeQuery = false] Whether or not to include the query string and fragment form the uri - * @returns {String} The base path of the Uri. + * @param {string} uri The Uri. + * @param {boolean} [includeQuery = false] Whether or not to include the query string and fragment form the uri + * @returns {string} The base path of the Uri. * * @example * // basePath will be "/Gallery/"; diff --git a/packages/engine/Source/Core/getExtensionFromUri.js b/packages/engine/Source/Core/getExtensionFromUri.js index 05fda9b6818a..f51ea912d353 100644 --- a/packages/engine/Source/Core/getExtensionFromUri.js +++ b/packages/engine/Source/Core/getExtensionFromUri.js @@ -6,8 +6,8 @@ import DeveloperError from "./DeveloperError.js"; * Given a URI, returns the extension of the URI. * @function getExtensionFromUri * - * @param {String} uri The Uri. - * @returns {String} The extension of the Uri. + * @param {string} uri The Uri. + * @returns {string} The extension of the Uri. * * @example * //extension will be "czml"; diff --git a/packages/engine/Source/Core/getFilenameFromUri.js b/packages/engine/Source/Core/getFilenameFromUri.js index 54a1fbbfba16..ee250c0173ec 100644 --- a/packages/engine/Source/Core/getFilenameFromUri.js +++ b/packages/engine/Source/Core/getFilenameFromUri.js @@ -6,8 +6,8 @@ import DeveloperError from "./DeveloperError.js"; * Given a URI, returns the last segment of the URI, removing any path or query information. * @function getFilenameFromUri * - * @param {String} uri The Uri. - * @returns {String} The last segment of the Uri. + * @param {string} uri The Uri. + * @returns {string} The last segment of the Uri. * * @example * //fileName will be"simple.czml"; diff --git a/packages/engine/Source/Core/getImageFromTypedArray.js b/packages/engine/Source/Core/getImageFromTypedArray.js index 75204caea805..43d32b93d780 100644 --- a/packages/engine/Source/Core/getImageFromTypedArray.js +++ b/packages/engine/Source/Core/getImageFromTypedArray.js @@ -2,8 +2,8 @@ * Constructs an image from a TypedArray of pixel values * * @param {Uint8Array} typedArray The array of pixel values - * @param {Number} width The width of the image to create - * @param {Number} height The height of the image to create + * @param {number} width The width of the image to create + * @param {number} height The height of the image to create * @returns {HTMLCanvasElement} A new canvas containing the constructed image * * @private diff --git a/packages/engine/Source/Core/getImagePixels.js b/packages/engine/Source/Core/getImagePixels.js index 7c46c8e54c03..b027c3d6a3b7 100644 --- a/packages/engine/Source/Core/getImagePixels.js +++ b/packages/engine/Source/Core/getImagePixels.js @@ -9,8 +9,8 @@ const context2DsByWidthAndHeight = {}; * @function getImagePixels * * @param {HTMLImageElement|ImageBitmap} image The image to extract pixels from. - * @param {Number} width The width of the image. If not defined, then image.width is assigned. - * @param {Number} height The height of the image. If not defined, then image.height is assigned. + * @param {number} width The width of the image. If not defined, then image.width is assigned. + * @param {number} height The height of the image. If not defined, then image.height is assigned. * @returns {ImageData} The pixels of the image. */ function getImagePixels(image, width, height) { diff --git a/packages/engine/Source/Core/getJsonFromTypedArray.js b/packages/engine/Source/Core/getJsonFromTypedArray.js index 02db059e05d4..ff5e2f4c51f9 100644 --- a/packages/engine/Source/Core/getJsonFromTypedArray.js +++ b/packages/engine/Source/Core/getJsonFromTypedArray.js @@ -6,9 +6,9 @@ import getStringFromTypedArray from "./getStringFromTypedArray.js"; * @function * * @param {Uint8Array} uint8Array The Uint8Array to read from. - * @param {Number} [byteOffset=0] The byte offset to start reading from. - * @param {Number} [byteLength] The byte length to read. If byteLength is omitted the remainder of the buffer is read. - * @returns {Object} An object containing the parsed JSON. + * @param {number} [byteOffset=0] The byte offset to start reading from. + * @param {number} [byteLength] The byte length to read. If byteLength is omitted the remainder of the buffer is read. + * @returns {object} An object containing the parsed JSON. * * @private */ diff --git a/packages/engine/Source/Core/getStringFromTypedArray.js b/packages/engine/Source/Core/getStringFromTypedArray.js index 8fb220a9de40..2b3c04fe394b 100644 --- a/packages/engine/Source/Core/getStringFromTypedArray.js +++ b/packages/engine/Source/Core/getStringFromTypedArray.js @@ -9,9 +9,9 @@ import RuntimeError from "./RuntimeError.js"; * @function * * @param {Uint8Array} uint8Array The Uint8Array to read from. - * @param {Number} [byteOffset=0] The byte offset to start reading from. - * @param {Number} [byteLength] The byte length to read. If byteLength is omitted the remainder of the buffer is read. - * @returns {String} The string. + * @param {number} [byteOffset=0] The byte offset to start reading from. + * @param {number} [byteLength] The byte length to read. If byteLength is omitted the remainder of the buffer is read. + * @returns {string} The string. * * @private */ diff --git a/packages/engine/Source/Core/getTimestamp.js b/packages/engine/Source/Core/getTimestamp.js index 6eafcdcaff9c..6c1ce26a1874 100644 --- a/packages/engine/Source/Core/getTimestamp.js +++ b/packages/engine/Source/Core/getTimestamp.js @@ -6,7 +6,7 @@ * * @function getTimestamp * - * @returns {Number} The timestamp in milliseconds since some unspecified reference time. + * @returns {number} The timestamp in milliseconds since some unspecified reference time. */ let getTimestamp; diff --git a/packages/engine/Source/Core/isBlobUri.js b/packages/engine/Source/Core/isBlobUri.js index c29b33cb7614..9e3f6c384599 100644 --- a/packages/engine/Source/Core/isBlobUri.js +++ b/packages/engine/Source/Core/isBlobUri.js @@ -7,8 +7,8 @@ const blobUriRegex = /^blob:/i; * * @function isBlobUri * - * @param {String} uri The uri to test. - * @returns {Boolean} true when the uri is a blob uri; otherwise, false. + * @param {string} uri The uri to test. + * @returns {boolean} true when the uri is a blob uri; otherwise, false. * * @private */ diff --git a/packages/engine/Source/Core/isDataUri.js b/packages/engine/Source/Core/isDataUri.js index 73fd785828b1..bb5ef14bef0f 100644 --- a/packages/engine/Source/Core/isDataUri.js +++ b/packages/engine/Source/Core/isDataUri.js @@ -7,8 +7,8 @@ const dataUriRegex = /^data:/i; * * @function isDataUri * - * @param {String} uri The uri to test. - * @returns {Boolean} true when the uri is a data uri; otherwise, false. + * @param {string} uri The uri to test. + * @returns {boolean} true when the uri is a data uri; otherwise, false. * * @private */ diff --git a/packages/engine/Source/Core/isLeapYear.js b/packages/engine/Source/Core/isLeapYear.js index 6de7117cdd88..404b3725b9e8 100644 --- a/packages/engine/Source/Core/isLeapYear.js +++ b/packages/engine/Source/Core/isLeapYear.js @@ -5,8 +5,8 @@ import DeveloperError from "./DeveloperError.js"; * * @function isLeapYear * - * @param {Number} year The year to be tested. - * @returns {Boolean} True if year is a leap year. + * @param {number} year The year to be tested. + * @returns {boolean} True if year is a leap year. * * @example * const leapYear = Cesium.isLeapYear(2000); // true diff --git a/packages/engine/Source/Core/loadKTX2.js b/packages/engine/Source/Core/loadKTX2.js index f73207439e5b..8359640fc854 100644 --- a/packages/engine/Source/Core/loadKTX2.js +++ b/packages/engine/Source/Core/loadKTX2.js @@ -5,12 +5,12 @@ import KTX2Transcoder from "./KTX2Transcoder.js"; /** * Stores the supported formats that KTX2 can transcode to. Called during context creation. * - * @param {Boolean} s3tc Whether or not S3TC is supported - * @param {Boolean} pvrtc Whether or not PVRTC is supported - * @param {Boolean} astc Whether or not ASTC is supported - * @param {Boolean} etc Whether or not ETC is supported - * @param {Boolean} etc1 Whether or not ETC1 is supported - * @param {Boolean} bc7 Whether or not BC7 is supported + * @param {boolean} s3tc Whether or not S3TC is supported + * @param {boolean} pvrtc Whether or not PVRTC is supported + * @param {boolean} astc Whether or not ASTC is supported + * @param {boolean} etc Whether or not ETC is supported + * @param {boolean} etc1 Whether or not ETC1 is supported + * @param {boolean} bc7 Whether or not BC7 is supported * @private */ let supportedTranscoderFormats; @@ -51,8 +51,8 @@ loadKTX2.setKTX2SupportedFormats = function ( * * @function loadKTX2 * - * @param {Resource|String|ArrayBuffer} resourceOrUrlOrBuffer The URL of the binary data or an ArrayBuffer. - * @returns {Promise.|undefined} A promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. + * @param {Resource|string|ArrayBuffer} resourceOrUrlOrBuffer The URL of the binary data or an ArrayBuffer. + * @returns {Promise|undefined} A promise that will resolve to the requested data when loaded. Returns undefined if request.throttle is true and the request does not have high enough priority. * * @exception {RuntimeError} Invalid KTX2 file. * @exception {RuntimeError} KTX2 texture arrays are not supported. diff --git a/packages/engine/Source/Core/mergeSort.js b/packages/engine/Source/Core/mergeSort.js index a5250b12b800..ea60bd763811 100644 --- a/packages/engine/Source/Core/mergeSort.js +++ b/packages/engine/Source/Core/mergeSort.js @@ -99,7 +99,7 @@ function mergeSort(array, comparator, userDefinedObject) { * @param {*} a An item in the array. * @param {*} b An item in the array. * @param {*} [userDefinedObject] An object that was passed to {@link mergeSort}. - * @returns {Number} Returns a negative value if a is less than b, + * @returns {number} Returns a negative value if a is less than b, * a positive value if a is greater than b, or * 0 if a is equal to b. * diff --git a/packages/engine/Source/Core/objectToQuery.js b/packages/engine/Source/Core/objectToQuery.js index b0b5f6c86154..c9a6e960f338 100644 --- a/packages/engine/Source/Core/objectToQuery.js +++ b/packages/engine/Source/Core/objectToQuery.js @@ -7,8 +7,8 @@ import DeveloperError from "./DeveloperError.js"; * will produce multiple values with the same name. * @function objectToQuery * - * @param {Object} obj The object containing data to encode. - * @returns {String} An encoded query string. + * @param {object} obj The object containing data to encode. + * @returns {string} An encoded query string. * * * @example diff --git a/packages/engine/Source/Core/oneTimeWarning.js b/packages/engine/Source/Core/oneTimeWarning.js index cd26c4450d01..4231bd3eae41 100644 --- a/packages/engine/Source/Core/oneTimeWarning.js +++ b/packages/engine/Source/Core/oneTimeWarning.js @@ -11,8 +11,8 @@ const warnings = {}; * * @function oneTimeWarning * - * @param {String} identifier The unique identifier for this warning. - * @param {String} [message=identifier] The message to log to the console. + * @param {string} identifier The unique identifier for this warning. + * @param {string} [message=identifier] The message to log to the console. * * @example * for(let i=0;itrue if the point is inside the triangle; otherwise, false. + * @returns {boolean} true if the point is inside the triangle; otherwise, false. * * @example * // Returns true diff --git a/packages/engine/Source/Core/queryToObject.js b/packages/engine/Source/Core/queryToObject.js index 9a0c80b62b5a..0aa374bab876 100644 --- a/packages/engine/Source/Core/queryToObject.js +++ b/packages/engine/Source/Core/queryToObject.js @@ -7,8 +7,8 @@ import DeveloperError from "./DeveloperError.js"; * the value in the object will be an array of values. * @function queryToObject * - * @param {String} queryString The query string. - * @returns {Object} An object containing the parameters parsed from the query string. + * @param {string} queryString The query string. + * @returns {object} An object containing the parameters parsed from the query string. * * * @example diff --git a/packages/engine/Source/Core/requestAnimationFrame.js b/packages/engine/Source/Core/requestAnimationFrame.js deleted file mode 100644 index bd873996ee2c..000000000000 --- a/packages/engine/Source/Core/requestAnimationFrame.js +++ /dev/null @@ -1,83 +0,0 @@ -import defined from "./defined.js"; -import deprecationWarning from "./deprecationWarning.js"; -import getTimestamp from "./getTimestamp.js"; - -let implementation; -if (typeof requestAnimationFrame !== "undefined") { - implementation = requestAnimationFrame; -} - -(function () { - // look for vendor prefixed function - if (!defined(implementation) && typeof window !== "undefined") { - const vendors = ["webkit", "moz", "ms", "o"]; - let i = 0; - const len = vendors.length; - while (i < len && !defined(implementation)) { - implementation = window[`${vendors[i]}RequestAnimationFrame`]; - ++i; - } - } - - // build an implementation based on setTimeout - if (!defined(implementation)) { - const msPerFrame = 1000.0 / 60.0; - let lastFrameTime = 0; - implementation = function (callback) { - const currentTime = getTimestamp(); - - // schedule the callback to target 60fps, 16.7ms per frame, - // accounting for the time taken by the callback - const delay = Math.max(msPerFrame - (currentTime - lastFrameTime), 0); - lastFrameTime = currentTime + delay; - - return setTimeout(function () { - callback(lastFrameTime); - }, delay); - }; - } -})(); - -/** - * A browser-independent function to request a new animation frame. This is used to create - * an application's draw loop as shown in the example below. - * - * @function requestAnimationFrame - * - * @param {requestAnimationFrameCallback} callback The function to call when the next frame should be drawn. - * @returns {Number} An ID that can be passed to {@link cancelAnimationFrame} to cancel the request. - * - * - * @example - * // Create a draw loop using requestAnimationFrame. The - * // tick callback function is called for every animation frame. - * function tick() { - * scene.render(); - * Cesium.requestAnimationFrame(tick); - * } - * tick(); - * - * @see {@link https://www.w3.org/TR/html51/webappapis.html#animation-frames|The Web API Animation Frames interface} - * - * @deprecated - */ -function requestAnimationFramePolyFill(callback) { - // we need this extra wrapper function because the native requestAnimationFrame - // functions must be invoked on the global scope (window), which is not the case - // if invoked as Cesium.requestAnimationFrame(callback) - - deprecationWarning( - "Cesium.requestAnimationFrame", - "Cesium.requestAnimationFrame was deprecated in CesiumJS 1.96 and will be removed in 1.99. Use the native requestAnimationFrame method instead." - ); - - return implementation(callback); -} - -/** - * A function that will be called when the next frame should be drawn. - * @callback requestAnimationFrameCallback - * - * @param {Number} timestamp A timestamp for the frame, in milliseconds. - */ -export default requestAnimationFramePolyFill; diff --git a/packages/engine/Source/Core/sampleTerrain.js b/packages/engine/Source/Core/sampleTerrain.js index f23a2f55be6b..f8fd9ea76ff2 100644 --- a/packages/engine/Source/Core/sampleTerrain.js +++ b/packages/engine/Source/Core/sampleTerrain.js @@ -18,9 +18,9 @@ import defined from "./defined.js"; * @function sampleTerrain * * @param {TerrainProvider} terrainProvider The terrain provider from which to query heights. - * @param {Number} level The terrain level-of-detail from which to query terrain heights. + * @param {number} level The terrain level-of-detail from which to query terrain heights. * @param {Cartographic[]} positions The positions to update with terrain heights. - * @returns {Promise.} A promise that resolves to the provided list of positions when terrain the query has completed. + * @returns {Promise} A promise that resolves to the provided list of positions when terrain the query has completed. * * @see sampleTerrainMostDetailed * @@ -50,8 +50,8 @@ function sampleTerrain(terrainProvider, level, positions) { } /** - * @param {Array.} tileRequests The mutated list of requests, the first one will be attempted - * @param {Array.>} results The list to put the result promises into + * @param {object[]} tileRequests The mutated list of requests, the first one will be attempted + * @param {Array>} results The list to put the result promises into * @returns {boolean} true if the request was made, and we are okay to attempt the next item immediately, * or false if we were throttled and should wait awhile before retrying. * @@ -97,8 +97,8 @@ function delay(ms) { /** * Recursively consumes all the tileRequests until the list has been emptied * and a Promise of each result has been put into the results list - * @param {Array.} tileRequests The list of requests desired to be made - * @param {Array.>} results The list to put all the result promises into + * @param {object[]} tileRequests The list of requests desired to be made + * @param {Array>} results The list to put all the result promises into * @returns {Promise} A promise which resolves once all requests have been started * * @private @@ -176,7 +176,7 @@ function doSampling(terrainProvider, level, positions) { * @param {Cartographic} position The position to interpolate for and assign the height value to * @param {TerrainData} terrainData * @param {Rectangle} rectangle - * @returns {Boolean} If the height was actually interpolated and assigned + * @returns {boolean} If the height was actually interpolated and assigned * @private */ function interpolateAndAssignHeight(position, terrainData, rectangle) { diff --git a/packages/engine/Source/Core/sampleTerrainMostDetailed.js b/packages/engine/Source/Core/sampleTerrainMostDetailed.js index 621bba06c5d7..54160a04f6cb 100644 --- a/packages/engine/Source/Core/sampleTerrainMostDetailed.js +++ b/packages/engine/Source/Core/sampleTerrainMostDetailed.js @@ -12,7 +12,7 @@ const scratchCartesian2 = new Cartesian2(); * * @param {TerrainProvider} terrainProvider The terrain provider from which to query heights. * @param {Cartographic[]} positions The positions to update with terrain heights. - * @returns {Promise.} A promise that resolves to the provided list of positions when terrain the query has completed. This + * @returns {Promise} A promise that resolves to the provided list of positions when terrain the query has completed. This * promise will reject if the terrain provider's `availability` property is undefined. * * @example diff --git a/packages/engine/Source/Core/scaleToGeodeticSurface.js b/packages/engine/Source/Core/scaleToGeodeticSurface.js index 968c7271ab69..99b2a8b75b60 100644 --- a/packages/engine/Source/Core/scaleToGeodeticSurface.js +++ b/packages/engine/Source/Core/scaleToGeodeticSurface.js @@ -14,7 +14,7 @@ const scaleToGeodeticSurfaceGradient = new Cartesian3(); * @param {Cartesian3} cartesian The Cartesian position to scale. * @param {Cartesian3} oneOverRadii One over radii of the ellipsoid. * @param {Cartesian3} oneOverRadiiSquared One over radii squared of the ellipsoid. - * @param {Number} centerToleranceSquared Tolerance for closeness to the center. + * @param {number} centerToleranceSquared Tolerance for closeness to the center. * @param {Cartesian3} [result] The object onto which to store the result. * @returns {Cartesian3} The modified result parameter, a new Cartesian3 instance if none was provided, or undefined if the position is at the center. * diff --git a/packages/engine/Source/Core/subdivideArray.js b/packages/engine/Source/Core/subdivideArray.js index d7003ee11738..9404c76f43c4 100644 --- a/packages/engine/Source/Core/subdivideArray.js +++ b/packages/engine/Source/Core/subdivideArray.js @@ -7,7 +7,7 @@ import DeveloperError from "./DeveloperError.js"; * @function subdivideArray * * @param {Array} array The array to divide. - * @param {Number} numberOfArrays The number of arrays to divide the provided array into. + * @param {number} numberOfArrays The number of arrays to divide the provided array into. * * @exception {DeveloperError} numberOfArrays must be greater than 0. */ diff --git a/packages/engine/Source/Core/writeTextToCanvas.js b/packages/engine/Source/Core/writeTextToCanvas.js index eeb4a4141ca9..599ced41b785 100644 --- a/packages/engine/Source/Core/writeTextToCanvas.js +++ b/packages/engine/Source/Core/writeTextToCanvas.js @@ -101,17 +101,17 @@ let imageSmoothingEnabledName; * Writes the given text into a new canvas. The canvas will be sized to fit the text. * If text is blank, returns undefined. * - * @param {String} text The text to write. - * @param {Object} [options] Object with the following properties: - * @param {String} [options.font='10px sans-serif'] The CSS font to use. - * @param {String} [options.textBaseline='bottom'] The baseline of the text. - * @param {Boolean} [options.fill=true] Whether to fill the text. - * @param {Boolean} [options.stroke=false] Whether to stroke the text. + * @param {string} text The text to write. + * @param {object} [options] Object with the following properties: + * @param {string} [options.font='10px sans-serif'] The CSS font to use. + * @param {string} [options.textBaseline='bottom'] The baseline of the text. + * @param {boolean} [options.fill=true] Whether to fill the text. + * @param {boolean} [options.stroke=false] Whether to stroke the text. * @param {Color} [options.fillColor=Color.WHITE] The fill color. * @param {Color} [options.strokeColor=Color.BLACK] The stroke color. - * @param {Number} [options.strokeWidth=1] The stroke width. + * @param {number} [options.strokeWidth=1] The stroke width. * @param {Color} [options.backgroundColor=Color.TRANSPARENT] The background color of the canvas. - * @param {Number} [options.padding=0] The pixel size of the padding to add around the text. + * @param {number} [options.padding=0] The pixel size of the padding to add around the text. * @returns {HTMLCanvasElement|undefined} A new canvas with the given text drawn into it. The dimensions object * from measureText will also be added to the returned canvas. If text is * blank, returns undefined. diff --git a/packages/engine/Source/DataSources/BillboardGraphics.js b/packages/engine/Source/DataSources/BillboardGraphics.js index fe5144eb4944..e6686ecaf4ff 100644 --- a/packages/engine/Source/DataSources/BillboardGraphics.js +++ b/packages/engine/Source/DataSources/BillboardGraphics.js @@ -5,7 +5,7 @@ import Event from "../Core/Event.js"; import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} BillboardGraphics.ConstructorOptions + * @typedef {object} BillboardGraphics.ConstructorOptions * * Initialization options for the BillboardGraphics constructor * diff --git a/packages/engine/Source/DataSources/BillboardVisualizer.js b/packages/engine/Source/DataSources/BillboardVisualizer.js index c91287224943..954e72047a6a 100644 --- a/packages/engine/Source/DataSources/BillboardVisualizer.js +++ b/packages/engine/Source/DataSources/BillboardVisualizer.js @@ -75,7 +75,7 @@ function BillboardVisualizer(entityCluster, entityCollection) { * Entity counterpart at the given time. * * @param {JulianDate} time The time to update to. - * @returns {Boolean} This function always returns true. + * @returns {boolean} This function always returns true. */ BillboardVisualizer.prototype.update = function (time) { //>>includeStart('debug', pragmas.debug); @@ -274,7 +274,7 @@ BillboardVisualizer.prototype.getBoundingSphere = function (entity, result) { /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ BillboardVisualizer.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/BoundingSphereState.js b/packages/engine/Source/DataSources/BoundingSphereState.js index c7027f5924c7..a317884f522a 100644 --- a/packages/engine/Source/DataSources/BoundingSphereState.js +++ b/packages/engine/Source/DataSources/BoundingSphereState.js @@ -1,6 +1,6 @@ /** * The state of a BoundingSphere computation being performed by a {@link Visualizer}. - * @enum {Number} + * @enum {number} * @private */ const BoundingSphereState = { diff --git a/packages/engine/Source/DataSources/BoxGraphics.js b/packages/engine/Source/DataSources/BoxGraphics.js index 9be7f8a0d06c..d922d1022850 100644 --- a/packages/engine/Source/DataSources/BoxGraphics.js +++ b/packages/engine/Source/DataSources/BoxGraphics.js @@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} BoxGraphics.ConstructorOptions + * @typedef {object} BoxGraphics.ConstructorOptions * * Initialization options for the BoxGraphics constructor * diff --git a/packages/engine/Source/DataSources/CallbackProperty.js b/packages/engine/Source/DataSources/CallbackProperty.js index d264814cdf89..c3609030cd92 100644 --- a/packages/engine/Source/DataSources/CallbackProperty.js +++ b/packages/engine/Source/DataSources/CallbackProperty.js @@ -9,7 +9,7 @@ import Event from "../Core/Event.js"; * @constructor * * @param {CallbackProperty.Callback} callback The function to be called when the property is evaluated. - * @param {Boolean} isConstant true when the callback function returns the same value every time, false if the value will change. + * @param {boolean} isConstant true when the callback function returns the same value every time, false if the value will change. */ function CallbackProperty(callback, isConstant) { this._callback = undefined; @@ -23,7 +23,7 @@ Object.defineProperties(CallbackProperty.prototype, { * Gets a value indicating if this property is constant. * @memberof CallbackProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -50,8 +50,8 @@ Object.defineProperties(CallbackProperty.prototype, { * Gets the value of the property. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied or is unsupported. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied or is unsupported. */ CallbackProperty.prototype.getValue = function (time, result) { return this._callback(time, result); @@ -61,7 +61,7 @@ CallbackProperty.prototype.getValue = function (time, result) { * Sets the callback to be used. * * @param {CallbackProperty.Callback} callback The function to be called when the property is evaluated. - * @param {Boolean} isConstant true when the callback function returns the same value every time, false if the value will change. + * @param {boolean} isConstant true when the callback function returns the same value every time, false if the value will change. */ CallbackProperty.prototype.setCallback = function (callback, isConstant) { //>>includeStart('debug', pragmas.debug); @@ -89,7 +89,7 @@ CallbackProperty.prototype.setCallback = function (callback, isConstant) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ CallbackProperty.prototype.equals = function (other) { return ( @@ -105,7 +105,7 @@ CallbackProperty.prototype.equals = function (other) { * @callback CallbackProperty.Callback * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into. If omitted, the function must create and return a new instance. - * @returns {Object} The modified result parameter, or a new instance if the result parameter was not supplied or is unsupported. + * @param {object} [result] The object to store the value into. If omitted, the function must create and return a new instance. + * @returns {object} The modified result parameter, or a new instance if the result parameter was not supplied or is unsupported. */ export default CallbackProperty; diff --git a/packages/engine/Source/DataSources/Cesium3DTilesetGraphics.js b/packages/engine/Source/DataSources/Cesium3DTilesetGraphics.js index 3caf31975b3f..6eb239dd7e6b 100644 --- a/packages/engine/Source/DataSources/Cesium3DTilesetGraphics.js +++ b/packages/engine/Source/DataSources/Cesium3DTilesetGraphics.js @@ -5,7 +5,7 @@ import Event from "../Core/Event.js"; import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} Cesium3DTilesetGraphics.ConstructorOptions + * @typedef {object} Cesium3DTilesetGraphics.ConstructorOptions * * Initialization options for the Cesium3DTilesetGraphics constructor * diff --git a/packages/engine/Source/DataSources/Cesium3DTilesetVisualizer.js b/packages/engine/Source/DataSources/Cesium3DTilesetVisualizer.js index 36b6487505ba..f0c5a9f794df 100644 --- a/packages/engine/Source/DataSources/Cesium3DTilesetVisualizer.js +++ b/packages/engine/Source/DataSources/Cesium3DTilesetVisualizer.js @@ -47,7 +47,7 @@ function Cesium3DTilesetVisualizer(scene, entityCollection) { * Entity counterpart at the given time. * * @param {JulianDate} time The time to update to. - * @returns {Boolean} This function always returns true. + * @returns {boolean} This function always returns true. */ Cesium3DTilesetVisualizer.prototype.update = function (time) { //>>includeStart('debug', pragmas.debug); @@ -127,7 +127,7 @@ Cesium3DTilesetVisualizer.prototype.update = function (time) { /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ Cesium3DTilesetVisualizer.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/CheckerboardMaterialProperty.js b/packages/engine/Source/DataSources/CheckerboardMaterialProperty.js index c60116fb1629..547e29eafba4 100644 --- a/packages/engine/Source/DataSources/CheckerboardMaterialProperty.js +++ b/packages/engine/Source/DataSources/CheckerboardMaterialProperty.js @@ -15,7 +15,7 @@ const defaultRepeat = new Cartesian2(2.0, 2.0); * @alias CheckerboardMaterialProperty * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Property|Color} [options.evenColor=Color.WHITE] A Property specifying the first {@link Color}. * @param {Property|Color} [options.oddColor=Color.BLACK] A Property specifying the second {@link Color}. * @param {Property|Cartesian2} [options.repeat=new Cartesian2(2.0, 2.0)] A {@link Cartesian2} Property specifying how many times the tiles repeat in each direction. @@ -42,7 +42,7 @@ Object.defineProperties(CheckerboardMaterialProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof CheckerboardMaterialProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -99,7 +99,7 @@ Object.defineProperties(CheckerboardMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ CheckerboardMaterialProperty.prototype.getType = function (time) { return "Checkerboard"; @@ -109,8 +109,8 @@ CheckerboardMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ CheckerboardMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { @@ -137,7 +137,7 @@ CheckerboardMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ CheckerboardMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/ColorMaterialProperty.js b/packages/engine/Source/DataSources/ColorMaterialProperty.js index f5e60c7dd5f9..c6abf36e56d4 100644 --- a/packages/engine/Source/DataSources/ColorMaterialProperty.js +++ b/packages/engine/Source/DataSources/ColorMaterialProperty.js @@ -26,7 +26,7 @@ Object.defineProperties(ColorMaterialProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof ColorMaterialProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -63,7 +63,7 @@ Object.defineProperties(ColorMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ ColorMaterialProperty.prototype.getType = function (time) { return "Color"; @@ -73,8 +73,8 @@ ColorMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ ColorMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { @@ -94,7 +94,7 @@ ColorMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ ColorMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/CompositeEntityCollection.js b/packages/engine/Source/DataSources/CompositeEntityCollection.js index ff0cf4d86b5e..56dcf75fc3cd 100644 --- a/packages/engine/Source/DataSources/CompositeEntityCollection.js +++ b/packages/engine/Source/DataSources/CompositeEntityCollection.js @@ -157,7 +157,7 @@ Object.defineProperties(CompositeEntityCollection.prototype, { * Gets a globally unique identifier for this collection. * @memberof CompositeEntityCollection.prototype * @readonly - * @type {String} + * @type {string} */ id: { get: function () { @@ -193,7 +193,7 @@ Object.defineProperties(CompositeEntityCollection.prototype, { * Adds a collection to the composite. * * @param {EntityCollection} collection the collection to add. - * @param {Number} [index] the index to add the collection at. If omitted, the collection will + * @param {number} [index] the index to add the collection at. If omitted, the collection will * added on top of all existing collections. * * @exception {DeveloperError} index, if supplied, must be greater than or equal to zero and less than or equal to the number of collections. @@ -232,7 +232,7 @@ CompositeEntityCollection.prototype.addCollection = function ( * Removes a collection from this composite, if present. * * @param {EntityCollection} collection The collection to remove. - * @returns {Boolean} true if the collection was in the composite and was removed, + * @returns {boolean} true if the collection was in the composite and was removed, * false if the collection was not in the composite. */ CompositeEntityCollection.prototype.removeCollection = function (collection) { @@ -257,7 +257,7 @@ CompositeEntityCollection.prototype.removeAllCollections = function () { * Checks to see if the composite contains a given collection. * * @param {EntityCollection} collection the collection to check for. - * @returns {Boolean} true if the composite contains the collection, false otherwise. + * @returns {boolean} true if the composite contains the collection, false otherwise. */ CompositeEntityCollection.prototype.containsCollection = function (collection) { return this._collections.indexOf(collection) !== -1; @@ -267,7 +267,7 @@ CompositeEntityCollection.prototype.containsCollection = function (collection) { * Returns true if the provided entity is in this collection, false otherwise. * * @param {Entity} entity The entity. - * @returns {Boolean} true if the provided entity is in this collection, false otherwise. + * @returns {boolean} true if the provided entity is in this collection, false otherwise. */ CompositeEntityCollection.prototype.contains = function (entity) { return this._composite.contains(entity); @@ -277,7 +277,7 @@ CompositeEntityCollection.prototype.contains = function (entity) { * Determines the index of a given collection in the composite. * * @param {EntityCollection} collection The collection to find the index of. - * @returns {Number} The index of the collection in the composite, or -1 if the collection does not exist in the composite. + * @returns {number} The index of the collection in the composite, or -1 if the collection does not exist in the composite. */ CompositeEntityCollection.prototype.indexOfCollection = function (collection) { return this._collections.indexOf(collection); @@ -286,7 +286,7 @@ CompositeEntityCollection.prototype.indexOfCollection = function (collection) { /** * Gets a collection by index from the composite. * - * @param {Number} index the index to retrieve. + * @param {number} index the index to retrieve. */ CompositeEntityCollection.prototype.getCollection = function (index) { //>>includeStart('debug', pragmas.debug); @@ -462,7 +462,7 @@ CompositeEntityCollection.prototype.computeAvailability = function () { /** * Gets an entity with the specified id. * - * @param {String} id The id of the entity to retrieve. + * @param {string} id The id of the entity to retrieve. * @returns {Entity|undefined} The entity with the provided id or undefined if the id did not exist in the collection. */ CompositeEntityCollection.prototype.getById = function (id) { diff --git a/packages/engine/Source/DataSources/CompositeMaterialProperty.js b/packages/engine/Source/DataSources/CompositeMaterialProperty.js index 00528197d20a..7827c7ad61f6 100644 --- a/packages/engine/Source/DataSources/CompositeMaterialProperty.js +++ b/packages/engine/Source/DataSources/CompositeMaterialProperty.js @@ -25,7 +25,7 @@ Object.defineProperties(CompositeMaterialProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof CompositeMaterialProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -64,7 +64,7 @@ Object.defineProperties(CompositeMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ CompositeMaterialProperty.prototype.getType = function (time) { //>>includeStart('debug', pragmas.debug); @@ -86,8 +86,8 @@ CompositeMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ CompositeMaterialProperty.prototype.getValue = function (time, result) { //>>includeStart('debug', pragmas.debug); @@ -110,7 +110,7 @@ CompositeMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ CompositeMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/CompositePositionProperty.js b/packages/engine/Source/DataSources/CompositePositionProperty.js index d8f5c9bd49c6..e5e74a7951eb 100644 --- a/packages/engine/Source/DataSources/CompositePositionProperty.js +++ b/packages/engine/Source/DataSources/CompositePositionProperty.js @@ -30,7 +30,7 @@ Object.defineProperties(CompositePositionProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof CompositePositionProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -129,7 +129,7 @@ CompositePositionProperty.prototype.getValueInReferenceFrame = function ( * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ CompositePositionProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/CompositeProperty.js b/packages/engine/Source/DataSources/CompositeProperty.js index 16033145b4aa..703d7d5df478 100644 --- a/packages/engine/Source/DataSources/CompositeProperty.js +++ b/packages/engine/Source/DataSources/CompositeProperty.js @@ -68,7 +68,7 @@ Object.defineProperties(CompositeProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof CompositeProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -107,8 +107,8 @@ Object.defineProperties(CompositeProperty.prototype, { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ CompositeProperty.prototype.getValue = function (time, result) { //>>includeStart('debug', pragmas.debug); @@ -129,7 +129,7 @@ CompositeProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ CompositeProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/ConstantPositionProperty.js b/packages/engine/Source/DataSources/ConstantPositionProperty.js index 461591cdd82b..7fe47c720e81 100644 --- a/packages/engine/Source/DataSources/ConstantPositionProperty.js +++ b/packages/engine/Source/DataSources/ConstantPositionProperty.js @@ -28,7 +28,7 @@ Object.defineProperties(ConstantPositionProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof ConstantPositionProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -69,8 +69,8 @@ Object.defineProperties(ConstantPositionProperty.prototype, { * Gets the value of the property at the provided time in the fixed frame. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ ConstantPositionProperty.prototype.getValue = function (time, result) { return this.getValueInReferenceFrame(time, ReferenceFrame.FIXED, result); @@ -133,7 +133,7 @@ ConstantPositionProperty.prototype.getValueInReferenceFrame = function ( * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ ConstantPositionProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/ConstantProperty.js b/packages/engine/Source/DataSources/ConstantProperty.js index 773703065413..79cbec143a33 100644 --- a/packages/engine/Source/DataSources/ConstantProperty.js +++ b/packages/engine/Source/DataSources/ConstantProperty.js @@ -25,7 +25,7 @@ Object.defineProperties(ConstantProperty.prototype, { * This property always returns true. * @memberof ConstantProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -51,8 +51,8 @@ Object.defineProperties(ConstantProperty.prototype, { * Gets the value of the property. * * @param {JulianDate} [time] The time for which to retrieve the value. This parameter is unused since the value does not change with respect to time. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ ConstantProperty.prototype.getValue = function (time, result) { return this._hasClone ? this._value.clone(result) : this._value; @@ -85,7 +85,7 @@ ConstantProperty.prototype.setValue = function (value) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ ConstantProperty.prototype.equals = function (other) { return ( @@ -108,7 +108,7 @@ ConstantProperty.prototype.valueOf = function () { /** * Creates a string representing this property's value. * - * @returns {String} A string representing the property's value. + * @returns {string} A string representing the property's value. */ ConstantProperty.prototype.toString = function () { return String(this._value); diff --git a/packages/engine/Source/DataSources/CorridorGraphics.js b/packages/engine/Source/DataSources/CorridorGraphics.js index 9858c8c8e728..b33c6ee21cd0 100644 --- a/packages/engine/Source/DataSources/CorridorGraphics.js +++ b/packages/engine/Source/DataSources/CorridorGraphics.js @@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} CorridorGraphics.ConstructorOptions + * @typedef {object} CorridorGraphics.ConstructorOptions * * Initialization options for the CorridorGraphics constructor * diff --git a/packages/engine/Source/DataSources/CustomDataSource.js b/packages/engine/Source/DataSources/CustomDataSource.js index 94a896ab7423..a853be4c438a 100644 --- a/packages/engine/Source/DataSources/CustomDataSource.js +++ b/packages/engine/Source/DataSources/CustomDataSource.js @@ -11,7 +11,7 @@ import EntityCollection from "./EntityCollection.js"; * @alias CustomDataSource * @constructor * - * @param {String} [name] A human-readable name for this instance. + * @param {string} [name] A human-readable name for this instance. * * @example * const dataSource = new Cesium.CustomDataSource('myData'); @@ -40,7 +40,7 @@ Object.defineProperties(CustomDataSource.prototype, { /** * Gets or sets a human-readable name for this instance. * @memberof CustomDataSource.prototype - * @type {String} + * @type {string} */ name: { get: function () { @@ -82,7 +82,7 @@ Object.defineProperties(CustomDataSource.prototype, { /** * Gets or sets whether the data source is currently loading data. * @memberof CustomDataSource.prototype - * @type {Boolean} + * @type {boolean} */ isLoading: { get: function () { @@ -125,7 +125,7 @@ Object.defineProperties(CustomDataSource.prototype, { /** * Gets whether or not this data source should be displayed. * @memberof CustomDataSource.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -164,7 +164,7 @@ Object.defineProperties(CustomDataSource.prototype, { * If implemented, update will be called by {@link DataSourceDisplay} once a frame. * * @param {JulianDate} time The simulation time. - * @returns {Boolean} True if this data source is ready to be displayed at the provided time, false otherwise. + * @returns {boolean} True if this data source is ready to be displayed at the provided time, false otherwise. */ CustomDataSource.prototype.update = function (time) { return true; diff --git a/packages/engine/Source/DataSources/CylinderGraphics.js b/packages/engine/Source/DataSources/CylinderGraphics.js index fd9935367d96..9f25286c042f 100644 --- a/packages/engine/Source/DataSources/CylinderGraphics.js +++ b/packages/engine/Source/DataSources/CylinderGraphics.js @@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} CylinderGraphics.ConstructorOptions + * @typedef {object} CylinderGraphics.ConstructorOptions * * Initialization options for the CylinderGraphics constructor * diff --git a/packages/engine/Source/DataSources/CzmlDataSource.js b/packages/engine/Source/DataSources/CzmlDataSource.js index 5d38d99591f9..ed733a1cca9b 100644 --- a/packages/engine/Source/DataSources/CzmlDataSource.js +++ b/packages/engine/Source/DataSources/CzmlDataSource.js @@ -4824,7 +4824,7 @@ function DocumentPacket() { } /** - * @typedef {Object} CzmlDataSource.LoadOptions + * @typedef {object} CzmlDataSource.LoadOptions * * Initialization options for the load method. * @@ -4837,7 +4837,7 @@ function DocumentPacket() { * @alias CzmlDataSource * @constructor * - * @param {String} [name] An optional name for the data source. This value will be overwritten if a loaded document contains a name. + * @param {string} [name] An optional name for the data source. This value will be overwritten if a loaded document contains a name. * * @demo {@link https://sandcastle.cesium.com/index.html?src=CZML.html|Cesium Sandcastle CZML Demo} */ @@ -4859,10 +4859,10 @@ function CzmlDataSource(name) { /** * Creates a Promise to a new instance loaded with the provided CZML data. * - * @param {Resource|String|Object} czml A url or CZML object to be processed. + * @param {Resource|string|object} czml A url or CZML object to be processed. * @param {CzmlDataSource.LoadOptions} [options] An object specifying configuration options * - * @returns {Promise.} A promise that resolves to the new instance once the data is processed. + * @returns {Promise} A promise that resolves to the new instance once the data is processed. */ CzmlDataSource.load = function (czml, options) { return new CzmlDataSource().load(czml, options); @@ -4872,7 +4872,7 @@ Object.defineProperties(CzmlDataSource.prototype, { /** * Gets a human-readable name for this instance. * @memberof CzmlDataSource.prototype - * @type {String} + * @type {string} */ name: { get: function () { @@ -4904,7 +4904,7 @@ Object.defineProperties(CzmlDataSource.prototype, { /** * Gets a value indicating if the data source is currently loading data. * @memberof CzmlDataSource.prototype - * @type {Boolean} + * @type {boolean} */ isLoading: { get: function () { @@ -4944,7 +4944,7 @@ Object.defineProperties(CzmlDataSource.prototype, { /** * Gets whether or not this data source should be displayed. * @memberof CzmlDataSource.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -4993,7 +4993,7 @@ Object.defineProperties(CzmlDataSource.prototype, { * collection based on the provided CZML packet. * * @param {Entity} entity - * @param {Object} packet + * @param {object} packet * @param {EntityCollection} entityCollection * @param {string} sourceUri */ @@ -5001,7 +5001,7 @@ Object.defineProperties(CzmlDataSource.prototype, { /** * Gets the array of CZML processing functions. * @memberof CzmlDataSource - * @type {Array.} + * @type {CzmlDataSource.UpdaterFunction[]} */ CzmlDataSource.updaters = [ processBillboard, // @@ -5032,10 +5032,10 @@ CzmlDataSource.updaters = [ /** * Processes the provided url or CZML object without clearing any existing data. * - * @param {Resource|String|Object} czml A url or CZML object to be processed. + * @param {Resource|string|object} czml A url or CZML object to be processed. * @param {CzmlDataSource.LoadOptions} [options] An object specifying configuration options * - * @returns {Promise.} A promise that resolves to this instances once the data is processed. + * @returns {Promise} A promise that resolves to this instances once the data is processed. */ CzmlDataSource.prototype.process = function (czml, options) { return load(this, czml, options, false); @@ -5044,10 +5044,10 @@ CzmlDataSource.prototype.process = function (czml, options) { /** * Loads the provided url or CZML object, replacing any existing data. * - * @param {Resource|String|Object} czml A url or CZML object to be processed. + * @param {Resource|string|object} czml A url or CZML object to be processed. * @param {CzmlDataSource.LoadOptions} [options] An object specifying configuration options * - * @returns {Promise.} A promise that resolves to this instances once the data is processed. + * @returns {Promise} A promise that resolves to this instances once the data is processed. */ CzmlDataSource.prototype.load = function (czml, options) { return load(this, czml, options, true); @@ -5060,7 +5060,7 @@ CzmlDataSource.prototype.load = function (czml, options) { * If implemented, update will be called by {@link DataSourceDisplay} once a frame. * * @param {JulianDate} time The simulation time. - * @returns {Boolean} True if this data source is ready to be displayed at the provided time, false otherwise. + * @returns {boolean} True if this data source is ready to be displayed at the provided time, false otherwise. */ CzmlDataSource.prototype.update = function (time) { return true; @@ -5072,11 +5072,11 @@ CzmlDataSource.prototype.update = function (time) { * @function * * @param {Function} type The constructor function for the property being processed. - * @param {Object} object The object on which the property will be added or updated. - * @param {String} propertyName The name of the property on the object. - * @param {Object} packetData The CZML packet being processed. + * @param {object} object The object on which the property will be added or updated. + * @param {string} propertyName The name of the property on the object. + * @param {object} packetData The CZML packet being processed. * @param {TimeInterval} interval A constraining interval for which the data is valid. - * @param {String} sourceUri The originating uri of the data being processed. + * @param {string} sourceUri The originating uri of the data being processed. * @param {EntityCollection} entityCollection The collection being processsed. */ CzmlDataSource.processPacketData = processPacketData; @@ -5086,11 +5086,11 @@ CzmlDataSource.processPacketData = processPacketData; * which creates or updates a {@link PositionProperty} from a CZML packet. * @function * - * @param {Object} object The object on which the property will be added or updated. - * @param {String} propertyName The name of the property on the object. - * @param {Object} packetData The CZML packet being processed. + * @param {object} object The object on which the property will be added or updated. + * @param {string} propertyName The name of the property on the object. + * @param {object} packetData The CZML packet being processed. * @param {TimeInterval} interval A constraining interval for which the data is valid. - * @param {String} sourceUri The originating uri of the data being processed. + * @param {string} sourceUri The originating uri of the data being processed. * @param {EntityCollection} entityCollection The collection being processsed. */ CzmlDataSource.processPositionPacketData = processPositionPacketData; @@ -5100,11 +5100,11 @@ CzmlDataSource.processPositionPacketData = processPositionPacketData; * which creates or updates a {@link MaterialProperty} from a CZML packet. * @function * - * @param {Object} object The object on which the property will be added or updated. - * @param {String} propertyName The name of the property on the object. - * @param {Object} packetData The CZML packet being processed. + * @param {object} object The object on which the property will be added or updated. + * @param {string} propertyName The name of the property on the object. + * @param {object} packetData The CZML packet being processed. * @param {TimeInterval} interval A constraining interval for which the data is valid. - * @param {String} sourceUri The originating uri of the data being processed. + * @param {string} sourceUri The originating uri of the data being processed. * @param {EntityCollection} entityCollection The collection being processsed. */ CzmlDataSource.processMaterialPacketData = processMaterialPacketData; diff --git a/packages/engine/Source/DataSources/DataSource.js b/packages/engine/Source/DataSources/DataSource.js index 4ac760371721..8f72f258ae59 100644 --- a/packages/engine/Source/DataSources/DataSource.js +++ b/packages/engine/Source/DataSources/DataSource.js @@ -18,7 +18,7 @@ Object.defineProperties(DataSource.prototype, { /** * Gets a human-readable name for this instance. * @memberof DataSource.prototype - * @type {String} + * @type {string} */ name: { get: DeveloperError.throwInstantiationError, @@ -42,7 +42,7 @@ Object.defineProperties(DataSource.prototype, { /** * Gets a value indicating if the data source is currently loading data. * @memberof DataSource.prototype - * @type {Boolean} + * @type {boolean} */ isLoading: { get: DeveloperError.throwInstantiationError, @@ -74,7 +74,7 @@ Object.defineProperties(DataSource.prototype, { /** * Gets whether or not this data source should be displayed. * @memberof DataSource.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: DeveloperError.throwInstantiationError, @@ -98,7 +98,7 @@ Object.defineProperties(DataSource.prototype, { * If implemented, update will be called by {@link DataSourceDisplay} once a frame. * * @param {JulianDate} time The simulation time. - * @returns {Boolean} True if this data source is ready to be displayed at the provided time, false otherwise. + * @returns {boolean} True if this data source is ready to be displayed at the provided time, false otherwise. */ DataSource.prototype.update = function (time) { DeveloperError.throwInstantiationError(); diff --git a/packages/engine/Source/DataSources/DataSourceClock.js b/packages/engine/Source/DataSources/DataSourceClock.js index f267a4bafa6a..58d55e2a3f0f 100644 --- a/packages/engine/Source/DataSources/DataSourceClock.js +++ b/packages/engine/Source/DataSources/DataSourceClock.js @@ -81,7 +81,7 @@ Object.defineProperties(DataSourceClock.prototype, { * Gets or sets the desired clock multiplier. * See {@link Clock#multiplier}. * @memberof DataSourceClock.prototype - * @type {Number} + * @type {number} */ multiplier: createRawPropertyDescriptor("multiplier"), }); @@ -109,7 +109,7 @@ DataSourceClock.prototype.clone = function (result) { * Returns true if this DataSourceClock is equivalent to the other * * @param {DataSourceClock} other The other DataSourceClock to compare to. - * @returns {Boolean} true if the DataSourceClocks are equal; otherwise, false. + * @returns {boolean} true if the DataSourceClocks are equal; otherwise, false. */ DataSourceClock.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/DataSourceCollection.js b/packages/engine/Source/DataSources/DataSourceCollection.js index 46ca82cba16b..17e33f50b45a 100644 --- a/packages/engine/Source/DataSources/DataSourceCollection.js +++ b/packages/engine/Source/DataSources/DataSourceCollection.js @@ -21,7 +21,7 @@ Object.defineProperties(DataSourceCollection.prototype, { /** * Gets the number of data sources in this collection. * @memberof DataSourceCollection.prototype - * @type {Number} + * @type {number} * @readonly */ length: { @@ -73,10 +73,10 @@ Object.defineProperties(DataSourceCollection.prototype, { /** * Adds a data source to the collection. * - * @param {DataSource|Promise.} dataSource A data source or a promise to a data source to add to the collection. + * @param {DataSource|Promise} dataSource A data source or a promise to a data source to add to the collection. * When passing a promise, the data source will not actually be added * to the collection until the promise resolves successfully. - * @returns {Promise.} A Promise that resolves once the data source has been added to the collection. + * @returns {Promise} A Promise that resolves once the data source has been added to the collection. */ DataSourceCollection.prototype.add = function (dataSource) { //>>includeStart('debug', pragmas.debug); @@ -102,8 +102,8 @@ DataSourceCollection.prototype.add = function (dataSource) { * Removes a data source from this collection, if present. * * @param {DataSource} dataSource The data source to remove. - * @param {Boolean} [destroy=false] Whether to destroy the data source in addition to removing it. - * @returns {Boolean} true if the data source was in the collection and was removed, + * @param {boolean} [destroy=false] Whether to destroy the data source in addition to removing it. + * @returns {boolean} true if the data source was in the collection and was removed, * false if the data source was not in the collection. */ DataSourceCollection.prototype.remove = function (dataSource, destroy) { @@ -127,7 +127,7 @@ DataSourceCollection.prototype.remove = function (dataSource, destroy) { /** * Removes all data sources from this collection. * - * @param {Boolean} [destroy=false] whether to destroy the data sources in addition to removing them. + * @param {boolean} [destroy=false] whether to destroy the data sources in addition to removing them. */ DataSourceCollection.prototype.removeAll = function (destroy) { destroy = defaultValue(destroy, false); @@ -148,7 +148,7 @@ DataSourceCollection.prototype.removeAll = function (destroy) { * Checks to see if the collection contains a given data source. * * @param {DataSource} dataSource The data source to check for. - * @returns {Boolean} true if the collection contains the data source, false otherwise. + * @returns {boolean} true if the collection contains the data source, false otherwise. */ DataSourceCollection.prototype.contains = function (dataSource) { return this.indexOf(dataSource) !== -1; @@ -158,7 +158,7 @@ DataSourceCollection.prototype.contains = function (dataSource) { * Determines the index of a given data source in the collection. * * @param {DataSource} dataSource The data source to find the index of. - * @returns {Number} The index of the data source in the collection, or -1 if the data source does not exist in the collection. + * @returns {number} The index of the data source in the collection, or -1 if the data source does not exist in the collection. */ DataSourceCollection.prototype.indexOf = function (dataSource) { return this._dataSources.indexOf(dataSource); @@ -167,7 +167,7 @@ DataSourceCollection.prototype.indexOf = function (dataSource) { /** * Gets a data source by index from the collection. * - * @param {Number} index the index to retrieve. + * @param {number} index the index to retrieve. * @returns {DataSource} The data source at the specified index. */ DataSourceCollection.prototype.get = function (index) { @@ -183,7 +183,7 @@ DataSourceCollection.prototype.get = function (index) { /** * Gets a data source by name from the collection. * - * @param {String} name The name to retrieve. + * @param {string} name The name to retrieve. * @returns {DataSource[]} A list of all data sources matching the provided name. */ DataSourceCollection.prototype.getByName = function (name) { @@ -306,7 +306,7 @@ DataSourceCollection.prototype.lowerToBottom = function (dataSource) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see DataSourceCollection#destroy */ diff --git a/packages/engine/Source/DataSources/DataSourceDisplay.js b/packages/engine/Source/DataSources/DataSourceDisplay.js index ccf908f322b2..691855fff522 100644 --- a/packages/engine/Source/DataSources/DataSourceDisplay.js +++ b/packages/engine/Source/DataSources/DataSourceDisplay.js @@ -25,7 +25,7 @@ import PolylineVisualizer from "./PolylineVisualizer.js"; * @alias DataSourceDisplay * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Scene} options.scene The scene in which to display the data. * @param {DataSourceCollection} options.dataSourceCollection The data sources to display. * @param {DataSourceDisplay.VisualizersCallback} [options.visualizersCallback=DataSourceDisplay.defaultVisualizersCallback] @@ -192,7 +192,7 @@ Object.defineProperties(DataSourceDisplay.prototype, { /** * Gets a value indicating whether or not all entities in the data source are ready * @memberof DataSourceDisplay.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -208,7 +208,7 @@ Object.defineProperties(DataSourceDisplay.prototype, { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see DataSourceDisplay#destroy */ @@ -259,7 +259,7 @@ DataSourceDisplay.prototype.destroy = function () { * Updates the display to the provided time. * * @param {JulianDate} time The simulation time. - * @returns {Boolean} True if all data sources are ready to be displayed, false otherwise. + * @returns {boolean} True if all data sources are ready to be displayed, false otherwise. */ DataSourceDisplay.prototype.update = function (time) { //>>includeStart('debug', pragmas.debug); @@ -335,7 +335,7 @@ const getBoundingSphereBoundingSphereScratch = new BoundingSphere(); * The bounding sphere is in the fixed frame of the scene's globe. * * @param {Entity} entity The entity whose bounding sphere to compute. - * @param {Boolean} allowPartial If true, pending bounding spheres are ignored and an answer will be returned from the currently available data. + * @param {boolean} allowPartial If true, pending bounding spheres are ignored and an answer will be returned from the currently available data. * If false, the the function will halt and return pending if any of the bounding spheres are pending. * @param {BoundingSphere} result The bounding sphere onto which to store the result. * @returns {BoundingSphereState} BoundingSphereState.DONE if the result contains the bounding sphere, diff --git a/packages/engine/Source/DataSources/DynamicGeometryUpdater.js b/packages/engine/Source/DataSources/DynamicGeometryUpdater.js index caa202a93a81..23963ef14faf 100644 --- a/packages/engine/Source/DataSources/DynamicGeometryUpdater.js +++ b/packages/engine/Source/DataSources/DynamicGeometryUpdater.js @@ -247,7 +247,7 @@ DynamicGeometryUpdater.prototype.getBoundingSphere = function (result) { * @memberof DynamicGeometryUpdater * @function * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ DynamicGeometryUpdater.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/EllipseGraphics.js b/packages/engine/Source/DataSources/EllipseGraphics.js index 86a2adfab7bd..4c85aee9acf0 100644 --- a/packages/engine/Source/DataSources/EllipseGraphics.js +++ b/packages/engine/Source/DataSources/EllipseGraphics.js @@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} EllipseGraphics.ConstructorOptions + * @typedef {object} EllipseGraphics.ConstructorOptions * * Initialization options for the EllipseGraphics constructor * diff --git a/packages/engine/Source/DataSources/EllipsoidGeometryUpdater.js b/packages/engine/Source/DataSources/EllipsoidGeometryUpdater.js index f67ef84aa8d3..8984d6ea1d32 100644 --- a/packages/engine/Source/DataSources/EllipsoidGeometryUpdater.js +++ b/packages/engine/Source/DataSources/EllipsoidGeometryUpdater.js @@ -105,7 +105,7 @@ Object.defineProperties(EllipsoidGeometryUpdater.prototype, { * Creates the geometry instance which represents the fill of the geometry. * * @param {JulianDate} time The time to use when retrieving initial attribute values. - * @param {Boolean} [skipModelMatrix=false] Whether to compute a model matrix for the geometry instance + * @param {boolean} [skipModelMatrix=false] Whether to compute a model matrix for the geometry instance * @param {Matrix4} [modelMatrixResult] Used to store the result of the model matrix calculation * @returns {GeometryInstance} The geometry instance representing the filled portion of the geometry. * @@ -189,7 +189,7 @@ EllipsoidGeometryUpdater.prototype.createFillGeometryInstance = function ( * Creates the geometry instance which represents the outline of the geometry. * * @param {JulianDate} time The time to use when retrieving initial attribute values. - * @param {Boolean} [skipModelMatrix=false] Whether to compute a model matrix for the geometry instance + * @param {boolean} [skipModelMatrix=false] Whether to compute a model matrix for the geometry instance * @param {Matrix4} [modelMatrixResult] Used to store the result of the model matrix calculation * @returns {GeometryInstance} The geometry instance representing the outline portion of the geometry. * diff --git a/packages/engine/Source/DataSources/EllipsoidGraphics.js b/packages/engine/Source/DataSources/EllipsoidGraphics.js index 23d2fd970afd..ea68b330a751 100644 --- a/packages/engine/Source/DataSources/EllipsoidGraphics.js +++ b/packages/engine/Source/DataSources/EllipsoidGraphics.js @@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} EllipsoidGraphics.ConstructorOptions + * @typedef {object} EllipsoidGraphics.ConstructorOptions * * Initialization options for the EllipsoidGraphics constructor * diff --git a/packages/engine/Source/DataSources/Entity.js b/packages/engine/Source/DataSources/Entity.js index ab803c910cac..6b00702c16ef 100644 --- a/packages/engine/Source/DataSources/Entity.js +++ b/packages/engine/Source/DataSources/Entity.js @@ -61,14 +61,14 @@ function createPropertyTypeDescriptor(name, Type) { } /** - * @typedef {Object} Entity.ConstructorOptions + * @typedef {object} Entity.ConstructorOptions * * Initialization options for the Entity constructor * - * @property {String} [id] A unique identifier for this object. If none is provided, a GUID is generated. - * @property {String} [name] A human readable name to display to users. It does not have to be unique. + * @property {string} [id] A unique identifier for this object. If none is provided, a GUID is generated. + * @property {string} [name] A human readable name to display to users. It does not have to be unique. * @property {TimeIntervalCollection} [availability] The availability, if any, associated with this object. - * @property {Boolean} [show] A boolean value indicating if the entity and its children are displayed. + * @property {boolean} [show] A boolean value indicating if the entity and its children are displayed. * @property {Property | string} [description] A string Property specifying an HTML description for this entity. * @property {PositionProperty | Cartesian3} [position] A Property specifying the entity position. * @property {Property} [orientation] A Property specifying the entity orientation. @@ -88,7 +88,7 @@ function createPropertyTypeDescriptor(name, Type) { * @property {PointGraphics | PointGraphics.ConstructorOptions} [point] A point to associate with this entity. * @property {PolygonGraphics | PolygonGraphics.ConstructorOptions} [polygon] A polygon to associate with this entity. * @property {PolylineGraphics | PolylineGraphics.ConstructorOptions} [polyline] A polyline to associate with this entity. - * @property {PropertyBag | Object.} [properties] Arbitrary properties to associate with this entity. + * @property {PropertyBag | Object} [properties] Arbitrary properties to associate with this entity. * @property {PolylineVolumeGraphics | PolylineVolumeGraphics.ConstructorOptions} [polylineVolume] A polylineVolume to associate with this entity. * @property {RectangleGraphics | RectangleGraphics.ConstructorOptions} [rectangle] A rectangle to associate with this entity. * @property {WallGraphics | WallGraphics.ConstructorOptions} [wall] A wall to associate with this entity. @@ -233,7 +233,7 @@ Object.defineProperties(Entity.prototype, { /** * Gets the unique ID associated with this object. * @memberof Entity.prototype - * @type {String} + * @type {string} */ id: { get: function () { @@ -256,14 +256,14 @@ Object.defineProperties(Entity.prototype, { * Gets or sets the name of the object. The name is intended for end-user * consumption and does not need to be unique. * @memberof Entity.prototype - * @type {String|undefined} + * @type {string|undefined} */ name: createRawPropertyDescriptor("name"), /** * Gets or sets whether this entity should be displayed. When set to true, * the entity is only displayed if the parent entity's show property is also true. * @memberof Entity.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -295,7 +295,7 @@ Object.defineProperties(Entity.prototype, { * Gets whether this entity is being displayed, taking into account * the visibility of any ancestor entities. * @memberof Entity.prototype - * @type {Boolean} + * @type {boolean} */ isShowing: { get: function () { @@ -495,7 +495,7 @@ Object.defineProperties(Entity.prototype, { * Given a time, returns true if this object should have data during that time. * * @param {JulianDate} time The time to check availability for. - * @returns {Boolean} true if the object should have data during the provided time, false otherwise. + * @returns {boolean} true if the object should have data during the provided time, false otherwise. */ Entity.prototype.isAvailable = function (time) { //>>includeStart('debug', pragmas.debug); @@ -513,7 +513,7 @@ Entity.prototype.isAvailable = function (time) { * observed with {@link Entity#definitionChanged} and composited * with {@link CompositeEntityCollection} * - * @param {String} propertyName The name of the property to add. + * @param {string} propertyName The name of the property to add. * * @exception {DeveloperError} "propertyName" is a reserved property name. * @exception {DeveloperError} "propertyName" is already a registered property. @@ -546,7 +546,7 @@ Entity.prototype.addProperty = function (propertyName) { /** * Removed a property previously added with addProperty. * - * @param {String} propertyName The name of the property to remove. + * @param {string} propertyName The name of the property to remove. * * @exception {DeveloperError} "propertyName" is a reserved property name. * @exception {DeveloperError} "propertyName" is not a registered property. @@ -732,7 +732,7 @@ Entity.prototype.computeModelMatrixForHeightReference = function ( * instead be rendered as if height is 0. * * @param {Scene} scene The current scene. - * @returns {Boolean} Whether or not the current scene supports materials for entities on terrain. + * @returns {boolean} Whether or not the current scene supports materials for entities on terrain. */ Entity.supportsMaterialsforEntitiesOnTerrain = function (scene) { return GroundPrimitive.supportsMaterials(scene); @@ -744,7 +744,7 @@ Entity.supportsMaterialsforEntitiesOnTerrain = function (scene) { * the provided heights and using the `arcType` parameter instead of clamped to the ground. * * @param {Scene} scene The current scene. - * @returns {Boolean} Whether or not the current scene supports polylines on terrain or 3D TIles. + * @returns {boolean} Whether or not the current scene supports polylines on terrain or 3D TIles. */ Entity.supportsPolylinesOnTerrain = function (scene) { return GroundPolylinePrimitive.isSupported(scene); diff --git a/packages/engine/Source/DataSources/EntityCluster.js b/packages/engine/Source/DataSources/EntityCluster.js index 444eaa0e7cea..164aa48ca8e1 100644 --- a/packages/engine/Source/DataSources/EntityCluster.js +++ b/packages/engine/Source/DataSources/EntityCluster.js @@ -18,14 +18,14 @@ import KDBush from "kdbush"; /** * Defines how screen space objects (billboards, points, labels) are clustered. * - * @param {Object} [options] An object with the following properties: - * @param {Boolean} [options.enabled=false] Whether or not to enable clustering. - * @param {Number} [options.pixelRange=80] The pixel range to extend the screen space bounding box. - * @param {Number} [options.minimumClusterSize=2] The minimum number of screen space objects that can be clustered. - * @param {Boolean} [options.clusterBillboards=true] Whether or not to cluster the billboards of an entity. - * @param {Boolean} [options.clusterLabels=true] Whether or not to cluster the labels of an entity. - * @param {Boolean} [options.clusterPoints=true] Whether or not to cluster the points of an entity. - * @param {Boolean} [options.show=true] Determines if the entities in the cluster will be shown. + * @param {object} [options] An object with the following properties: + * @param {boolean} [options.enabled=false] Whether or not to enable clustering. + * @param {number} [options.pixelRange=80] The pixel range to extend the screen space bounding box. + * @param {number} [options.minimumClusterSize=2] The minimum number of screen space objects that can be clustered. + * @param {boolean} [options.clusterBillboards=true] Whether or not to cluster the billboards of an entity. + * @param {boolean} [options.clusterLabels=true] Whether or not to cluster the labels of an entity. + * @param {boolean} [options.clusterPoints=true] Whether or not to cluster the points of an entity. + * @param {boolean} [options.show=true] Determines if the entities in the cluster will be shown. * * @alias EntityCluster * @constructor @@ -70,7 +70,7 @@ function EntityCluster(options) { /** * Determines if entities in this collection will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -517,7 +517,7 @@ Object.defineProperties(EntityCluster.prototype, { /** * Gets or sets whether clustering is enabled. * @memberof EntityCluster.prototype - * @type {Boolean} + * @type {boolean} */ enabled: { get: function () { @@ -531,7 +531,7 @@ Object.defineProperties(EntityCluster.prototype, { /** * Gets or sets the pixel range to extend the screen space bounding box. * @memberof EntityCluster.prototype - * @type {Number} + * @type {number} */ pixelRange: { get: function () { @@ -545,7 +545,7 @@ Object.defineProperties(EntityCluster.prototype, { /** * Gets or sets the minimum number of screen space objects that can be clustered. * @memberof EntityCluster.prototype - * @type {Number} + * @type {number} */ minimumClusterSize: { get: function () { @@ -570,7 +570,7 @@ Object.defineProperties(EntityCluster.prototype, { /** * Gets or sets whether clustering billboard entities is enabled. * @memberof EntityCluster.prototype - * @type {Boolean} + * @type {boolean} */ clusterBillboards: { get: function () { @@ -585,7 +585,7 @@ Object.defineProperties(EntityCluster.prototype, { /** * Gets or sets whether clustering labels entities is enabled. * @memberof EntityCluster.prototype - * @type {Boolean} + * @type {boolean} */ clusterLabels: { get: function () { @@ -599,7 +599,7 @@ Object.defineProperties(EntityCluster.prototype, { /** * Gets or sets whether clustering point entities is enabled. * @memberof EntityCluster.prototype - * @type {Boolean} + * @type {boolean} */ clusterPoints: { get: function () { @@ -981,7 +981,7 @@ EntityCluster.prototype.destroy = function () { * @callback EntityCluster.newClusterCallback * * @param {Entity[]} clusteredEntities An array of the entities contained in the cluster. - * @param {Object} cluster An object containing the Billboard, Label, and Point + * @param {object} cluster An object containing the Billboard, Label, and Point * primitives that represent this cluster of entities. * @param {Billboard} cluster.billboard * @param {Label} cluster.label diff --git a/packages/engine/Source/DataSources/EntityCollection.js b/packages/engine/Source/DataSources/EntityCollection.js index f780851c6b9d..5a3a3c1d670c 100644 --- a/packages/engine/Source/DataSources/EntityCollection.js +++ b/packages/engine/Source/DataSources/EntityCollection.js @@ -128,7 +128,7 @@ Object.defineProperties(EntityCollection.prototype, { * Gets a globally unique identifier for this collection. * @memberof EntityCollection.prototype * @readonly - * @type {String} + * @type {string} */ id: { get: function () { @@ -152,7 +152,7 @@ Object.defineProperties(EntityCollection.prototype, { * displayed. When true, each entity is only displayed if * its own show property is also true. * @memberof EntityCollection.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -305,7 +305,7 @@ EntityCollection.prototype.add = function (entity) { * Removes an entity from the collection. * * @param {Entity} entity The entity to be removed. - * @returns {Boolean} true if the item was removed, false if it did not exist in the collection. + * @returns {boolean} true if the item was removed, false if it did not exist in the collection. */ EntityCollection.prototype.remove = function (entity) { if (!defined(entity)) { @@ -318,7 +318,7 @@ EntityCollection.prototype.remove = function (entity) { * Returns true if the provided entity is in this collection, false otherwise. * * @param {Entity} entity The entity. - * @returns {Boolean} true if the provided entity is in this collection, false otherwise. + * @returns {boolean} true if the provided entity is in this collection, false otherwise. */ EntityCollection.prototype.contains = function (entity) { //>>includeStart('debug', pragmas.debug); @@ -332,8 +332,8 @@ EntityCollection.prototype.contains = function (entity) { /** * Removes an entity with the provided id from the collection. * - * @param {String} id The id of the entity to remove. - * @returns {Boolean} true if the item was removed, false if no item with the provided id existed in the collection. + * @param {string} id The id of the entity to remove. + * @returns {boolean} true if the item was removed, false if no item with the provided id existed in the collection. */ EntityCollection.prototype.removeById = function (id) { if (!defined(id)) { @@ -395,7 +395,7 @@ EntityCollection.prototype.removeAll = function () { /** * Gets an entity with the specified id. * - * @param {String} id The id of the entity to retrieve. + * @param {string} id The id of the entity to retrieve. * @returns {Entity|undefined} The entity with the provided id or undefined if the id did not exist in the collection. */ EntityCollection.prototype.getById = function (id) { @@ -411,7 +411,7 @@ EntityCollection.prototype.getById = function (id) { /** * Gets an entity with the specified id or creates it and adds it to the collection if it does not exist. * - * @param {String} id The id of the entity to retrieve or create. + * @param {string} id The id of the entity to retrieve or create. * @returns {Entity} The new or existing object. */ EntityCollection.prototype.getOrCreateEntity = function (id) { diff --git a/packages/engine/Source/DataSources/GeoJsonDataSource.js b/packages/engine/Source/DataSources/GeoJsonDataSource.js index 4c465f677cbc..ce8429d476ed 100644 --- a/packages/engine/Source/DataSources/GeoJsonDataSource.js +++ b/packages/engine/Source/DataSources/GeoJsonDataSource.js @@ -550,20 +550,20 @@ function processTopology(dataSource, geoJson, geometry, crsFunction, options) { } /** - * @typedef {Object} GeoJsonDataSource.LoadOptions + * @typedef {object} GeoJsonDataSource.LoadOptions * * Initialization options for the load method. * - * @property {String} [sourceUri] Overrides the url to use for resolving relative links. + * @property {string} [sourceUri] Overrides the url to use for resolving relative links. * @property {GeoJsonDataSource.describe} [describe=GeoJsonDataSource.defaultDescribeProperty] A function which returns a Property object (or just a string). - * @property {Number} [markerSize=GeoJsonDataSource.markerSize] The default size of the map pin created for each point, in pixels. - * @property {String} [markerSymbol=GeoJsonDataSource.markerSymbol] The default symbol of the map pin created for each point. + * @property {number} [markerSize=GeoJsonDataSource.markerSize] The default size of the map pin created for each point, in pixels. + * @property {string} [markerSymbol=GeoJsonDataSource.markerSymbol] The default symbol of the map pin created for each point. * @property {Color} [markerColor=GeoJsonDataSource.markerColor] The default color of the map pin created for each point. * @property {Color} [stroke=GeoJsonDataSource.stroke] The default color of polylines and polygon outlines. - * @property {Number} [strokeWidth=GeoJsonDataSource.strokeWidth] The default width of polylines and polygon outlines. + * @property {number} [strokeWidth=GeoJsonDataSource.strokeWidth] The default width of polylines and polygon outlines. * @property {Color} [fill=GeoJsonDataSource.fill] The default color for polygon interiors. - * @property {Boolean} [clampToGround=GeoJsonDataSource.clampToGround] true if we want the geometry features (polygons or linestrings) clamped to the ground. - * @property {Credit|String} [credit] A credit for the data source, which is displayed on the canvas. + * @property {boolean} [clampToGround=GeoJsonDataSource.clampToGround] true if we want the geometry features (polygons or linestrings) clamped to the ground. + * @property {Credit|string} [credit] A credit for the data source, which is displayed on the canvas. */ /** @@ -575,7 +575,7 @@ function processTopology(dataSource, geoJson, geometry, crsFunction, options) { * @alias GeoJsonDataSource * @constructor * - * @param {String} [name] The name of this data source. If undefined, a name will be taken from + * @param {string} [name] The name of this data source. If undefined, a name will be taken from * the name of the GeoJSON file. * * @demo {@link https://sandcastle.cesium.com/index.html?src=GeoJSON%20and%20TopoJSON.html|Cesium Sandcastle GeoJSON and TopoJSON Demo} @@ -607,10 +607,10 @@ function GeoJsonDataSource(name) { /** * Creates a Promise to a new instance loaded with the provided GeoJSON or TopoJSON data. * - * @param {Resource|String|Object} data A url, GeoJSON object, or TopoJSON object to be loaded. + * @param {Resource|string|object} data A url, GeoJSON object, or TopoJSON object to be loaded. * @param {GeoJsonDataSource.LoadOptions} [options] An object specifying configuration options * - * @returns {Promise.} A promise that will resolve when the data is loaded. + * @returns {Promise} A promise that will resolve when the data is loaded. */ GeoJsonDataSource.load = function (data, options) { return new GeoJsonDataSource().load(data, options); @@ -620,7 +620,7 @@ Object.defineProperties(GeoJsonDataSource, { /** * Gets or sets the default size of the map pin created for each point, in pixels. * @memberof GeoJsonDataSource - * @type {Number} + * @type {number} * @default 48 */ markerSize: { @@ -636,7 +636,7 @@ Object.defineProperties(GeoJsonDataSource, { * This can be any valid {@link http://mapbox.com/maki/|Maki} identifier, any single character, * or blank if no symbol is to be used. * @memberof GeoJsonDataSource - * @type {String} + * @type {string} */ markerSymbol: { get: function () { @@ -677,7 +677,7 @@ Object.defineProperties(GeoJsonDataSource, { /** * Gets or sets the default width of polylines and polygon outlines. * @memberof GeoJsonDataSource - * @type {Number} + * @type {number} * @default 2.0 */ strokeWidth: { @@ -705,7 +705,7 @@ Object.defineProperties(GeoJsonDataSource, { /** * Gets or sets default of whether to clamp to the ground. * @memberof GeoJsonDataSource - * @type {Boolean} + * @type {boolean} * @default false */ clampToGround: { @@ -723,7 +723,7 @@ Object.defineProperties(GeoJsonDataSource, { * supported the EPSG type can be added to this list as well, by specifying the complete EPSG name, * for example 'EPSG:4326'. * @memberof GeoJsonDataSource - * @type {Object} + * @type {object} */ crsNames: { get: function () { @@ -738,7 +738,7 @@ Object.defineProperties(GeoJsonDataSource, { * Items in this object take precedence over those defined in crsLinkHrefs, assuming * the link has a type specified. * @memberof GeoJsonDataSource - * @type {Object} + * @type {object} */ crsLinkHrefs: { get: function () { @@ -752,7 +752,7 @@ Object.defineProperties(GeoJsonDataSource, { * to a function that takes a GeoJSON coordinate and transforms it into a WGS84 Earth-fixed Cartesian. * Items in crsLinkHrefs take precedence over this object. * @memberof GeoJsonDataSource - * @type {Object} + * @type {object} */ crsLinkTypes: { get: function () { @@ -765,7 +765,7 @@ Object.defineProperties(GeoJsonDataSource.prototype, { /** * Gets or sets a human-readable name for this instance. * @memberof GeoJsonDataSource.prototype - * @type {String} + * @type {string} */ name: { get: function () { @@ -800,7 +800,7 @@ Object.defineProperties(GeoJsonDataSource.prototype, { /** * Gets a value indicating if the data source is currently loading data. * @memberof GeoJsonDataSource.prototype - * @type {Boolean} + * @type {boolean} */ isLoading: { get: function () { @@ -840,7 +840,7 @@ Object.defineProperties(GeoJsonDataSource.prototype, { /** * Gets whether or not this data source should be displayed. * @memberof GeoJsonDataSource.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -885,10 +885,10 @@ Object.defineProperties(GeoJsonDataSource.prototype, { /** * Asynchronously loads the provided GeoJSON or TopoJSON data, replacing any existing data. * - * @param {Resource|String|Object} data A url, GeoJSON object, or TopoJSON object to be loaded. + * @param {Resource|string|object} data A url, GeoJSON object, or TopoJSON object to be loaded. * @param {GeoJsonDataSource.LoadOptions} [options] An object specifying configuration options * - * @returns {Promise.} a promise that will resolve when the GeoJSON is loaded. + * @returns {Promise} a promise that will resolve when the GeoJSON is loaded. */ GeoJsonDataSource.prototype.load = function (data, options) { return preload(this, data, options, true); @@ -897,10 +897,10 @@ GeoJsonDataSource.prototype.load = function (data, options) { /** * Asynchronously loads the provided GeoJSON or TopoJSON data, without replacing any existing data. * - * @param {Resource|String|Object} data A url, GeoJSON object, or TopoJSON object to be loaded. + * @param {Resource|string|object} data A url, GeoJSON object, or TopoJSON object to be loaded. * @param {GeoJsonDataSource.LoadOptions} [options] An object specifying configuration options * - * @returns {Promise.} a promise that will resolve when the GeoJSON is loaded. + * @returns {Promise} a promise that will resolve when the GeoJSON is loaded. */ GeoJsonDataSource.prototype.process = function (data, options) { return preload(this, data, options, false); @@ -976,7 +976,7 @@ function preload(that, data, options, clear) { * If implemented, update will be called by {@link DataSourceDisplay} once a frame. * * @param {JulianDate} time The simulation time. - * @returns {Boolean} True if this data source is ready to be displayed at the provided time, false otherwise. + * @returns {boolean} True if this data source is ready to be displayed at the provided time, false otherwise. */ GeoJsonDataSource.prototype.update = function (time) { return true; @@ -1058,7 +1058,7 @@ function load(that, geoJson, options, sourceUri, clear) { /** * This callback is displayed as part of the GeoJsonDataSource class. * @callback GeoJsonDataSource.describe - * @param {Object} properties The properties of the feature. - * @param {String} nameProperty The property key that Cesium estimates to have the name of the feature. + * @param {object} properties The properties of the feature. + * @param {string} nameProperty The property key that Cesium estimates to have the name of the feature. */ export default GeoJsonDataSource; diff --git a/packages/engine/Source/DataSources/GeometryUpdater.js b/packages/engine/Source/DataSources/GeometryUpdater.js index 85d5b5d66594..982f2c7fe48e 100644 --- a/packages/engine/Source/DataSources/GeometryUpdater.js +++ b/packages/engine/Source/DataSources/GeometryUpdater.js @@ -31,12 +31,12 @@ const defaultClassificationType = new ConstantProperty(ClassificationType.BOTH); * @alias GeometryUpdater * @constructor * - * @param {Object} options An object with the following properties: + * @param {object} options An object with the following properties: * @param {Entity} options.entity The entity containing the geometry to be visualized. * @param {Scene} options.scene The scene where visualization is taking place. - * @param {Object} options.geometryOptions Options for the geometry - * @param {String} options.geometryPropertyName The geometry property name - * @param {String[]} options.observedPropertyNames The entity properties this geometry cares about + * @param {object} options.geometryOptions Options for the geometry + * @param {string} options.geometryPropertyName The geometry property name + * @param {string[]} options.observedPropertyNames The entity properties this geometry cares about */ function GeometryUpdater(options) { //>>includeStart('debug', pragmas.debug); @@ -79,7 +79,7 @@ Object.defineProperties(GeometryUpdater.prototype, { /** * Gets the unique ID associated with this updater * @memberof GeometryUpdater.prototype - * @type {String} + * @type {string} * @readonly */ id: { @@ -103,7 +103,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * Gets a value indicating if the geometry has a fill component. * @memberof GeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ fillEnabled: { @@ -115,7 +115,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * Gets a value indicating if fill visibility varies with simulation time. * @memberof GeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ hasConstantFill: { @@ -144,7 +144,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * Gets a value indicating if the geometry has an outline component. * @memberof GeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ outlineEnabled: { @@ -156,7 +156,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * Gets a value indicating if the geometry has an outline component. * @memberof GeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ hasConstantOutline: { @@ -186,7 +186,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * This value is only valid if isDynamic is false. * @memberof GeometryUpdater.prototype * - * @type {Number} + * @type {number} * @readonly */ outlineWidth: { @@ -237,7 +237,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * returned by GeometryUpdater#createDynamicUpdater. * @memberof GeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isDynamic: { @@ -250,7 +250,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * This property is only valid for static geometry. * @memberof GeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isClosed: { @@ -262,7 +262,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * Gets a value indicating if the geometry should be drawn on terrain. * @memberof EllipseGeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ onTerrain: { @@ -275,7 +275,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * of this updater change. * @memberof GeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ geometryChanged: { @@ -289,7 +289,7 @@ Object.defineProperties(GeometryUpdater.prototype, { * Checks if the geometry is outlined at the provided time. * * @param {JulianDate} time The time for which to retrieve visibility. - * @returns {Boolean} true if geometry is outlined at the provided time, false otherwise. + * @returns {boolean} true if geometry is outlined at the provided time, false otherwise. */ GeometryUpdater.prototype.isOutlineVisible = function (time) { const entity = this._entity; @@ -305,7 +305,7 @@ GeometryUpdater.prototype.isOutlineVisible = function (time) { * Checks if the geometry is filled at the provided time. * * @param {JulianDate} time The time for which to retrieve visibility. - * @returns {Boolean} true if geometry is filled at the provided time, false otherwise. + * @returns {boolean} true if geometry is filled at the provided time, false otherwise. */ GeometryUpdater.prototype.isFilled = function (time) { const entity = this._entity; @@ -344,7 +344,7 @@ GeometryUpdater.prototype.createOutlineGeometryInstance = /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ GeometryUpdater.prototype.isDestroyed = function () { return false; @@ -360,7 +360,7 @@ GeometryUpdater.prototype.destroy = function () { }; /** * @param {Entity} entity - * @param {Object} geometry + * @param {object} geometry * @private */ GeometryUpdater.prototype._isHidden = function (entity, geometry) { @@ -372,7 +372,7 @@ GeometryUpdater.prototype._isHidden = function (entity, geometry) { /** * @param {Entity} entity - * @param {Object} geometry + * @param {object} geometry * @private */ GeometryUpdater.prototype._isOnTerrain = function (entity, geometry) { @@ -389,14 +389,14 @@ GeometryUpdater.prototype._getIsClosed = function (options) { /** * @param {Entity} entity - * @param {Object} geometry + * @param {object} geometry * @private */ GeometryUpdater.prototype._isDynamic = DeveloperError.throwInstantiationError; /** * @param {Entity} entity - * @param {Object} geometry + * @param {object} geometry * @private */ GeometryUpdater.prototype._setStaticOptions = @@ -404,7 +404,7 @@ GeometryUpdater.prototype._setStaticOptions = /** * @param {Entity} entity - * @param {String} propertyName + * @param {string} propertyName * @param {*} newValue * @param {*} oldValue * @private diff --git a/packages/engine/Source/DataSources/GeometryVisualizer.js b/packages/engine/Source/DataSources/GeometryVisualizer.js index 63a65b327ecb..710478944371 100644 --- a/packages/engine/Source/DataSources/GeometryVisualizer.js +++ b/packages/engine/Source/DataSources/GeometryVisualizer.js @@ -298,7 +298,7 @@ function GeometryVisualizer( * Entity counterpart at the given time. * * @param {JulianDate} time The time to update to. - * @returns {Boolean} True if the visualizer successfully updated to the provided time, + * @returns {boolean} True if the visualizer successfully updated to the provided time, * false if the visualizer is waiting for asynchronous primitives to be created. */ GeometryVisualizer.prototype.update = function (time) { @@ -441,7 +441,7 @@ GeometryVisualizer.prototype.getBoundingSphere = function (entity, result) { /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ GeometryVisualizer.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/GpxDataSource.js b/packages/engine/Source/DataSources/GpxDataSource.js index cd3b78cab7e5..887af0f2c47d 100644 --- a/packages/engine/Source/DataSources/GpxDataSource.js +++ b/packages/engine/Source/DataSources/GpxDataSource.js @@ -765,14 +765,14 @@ function GpxDataSource() { /** * Creates a Promise to a new instance loaded with the provided GPX data. * - * @param {String|Document|Blob} data A url, parsed GPX document, or Blob containing binary GPX data. - * @param {Object} [options] An object with the following properties: - * @param {Boolean} [options.clampToGround] True if the symbols should be rendered at the same height as the terrain - * @param {String} [options.waypointImage] Image to use for waypoint billboards. - * @param {String} [options.trackImage] Image to use for track billboards. - * @param {String} [options.trackColor] Color to use for track lines. - * @param {String} [options.routeColor] Color to use for route lines. - * @returns {Promise.} A promise that will resolve to a new GpxDataSource instance once the gpx is loaded. + * @param {string|Document|Blob} data A url, parsed GPX document, or Blob containing binary GPX data. + * @param {object} [options] An object with the following properties: + * @param {boolean} [options.clampToGround] True if the symbols should be rendered at the same height as the terrain + * @param {string} [options.waypointImage] Image to use for waypoint billboards. + * @param {string} [options.trackImage] Image to use for track billboards. + * @param {string} [options.trackColor] Color to use for track lines. + * @param {string} [options.routeColor] Color to use for route lines. + * @returns {Promise} A promise that will resolve to a new GpxDataSource instance once the gpx is loaded. */ GpxDataSource.load = function (data, options) { return new GpxDataSource().load(data, options); @@ -783,7 +783,7 @@ Object.defineProperties(GpxDataSource.prototype, { * Gets a human-readable name for this instance. * This will be automatically be set to the GPX document name on load. * @memberof GpxDataSource.prototype - * @type {String} + * @type {string} */ name: { get: function () { @@ -793,7 +793,7 @@ Object.defineProperties(GpxDataSource.prototype, { /** * Gets the version of the GPX Schema in use. * @memberof GpxDataSource.prototype - * @type {String} + * @type {string} */ version: { get: function () { @@ -803,7 +803,7 @@ Object.defineProperties(GpxDataSource.prototype, { /** * Gets the creator of the GPX document. * @memberof GpxDataSource.prototype - * @type {String} + * @type {string} */ creator: { get: function () { @@ -813,7 +813,7 @@ Object.defineProperties(GpxDataSource.prototype, { /** * Gets an object containing metadata about the GPX file. * @memberof GpxDataSource.prototype - * @type {Object} + * @type {object} */ metadata: { get: function () { @@ -845,7 +845,7 @@ Object.defineProperties(GpxDataSource.prototype, { /** * Gets a value indicating if the data source is currently loading data. * @memberof GpxDataSource.prototype - * @type {Boolean} + * @type {boolean} */ isLoading: { get: function () { @@ -885,7 +885,7 @@ Object.defineProperties(GpxDataSource.prototype, { /** * Gets whether or not this data source should be displayed. * @memberof GpxDataSource.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -924,7 +924,7 @@ Object.defineProperties(GpxDataSource.prototype, { * If implemented, update will be called by {@link DataSourceDisplay} once a frame. * * @param {JulianDate} time The simulation time. - * @returns {Boolean} True if this data source is ready to be displayed at the provided time, false otherwise. + * @returns {boolean} True if this data source is ready to be displayed at the provided time, false otherwise. */ GpxDataSource.prototype.update = function (time) { return true; @@ -933,14 +933,14 @@ GpxDataSource.prototype.update = function (time) { /** * Asynchronously loads the provided GPX data, replacing any existing data. * - * @param {String|Document|Blob} data A url, parsed GPX document, or Blob containing binary GPX data or a parsed GPX document. - * @param {Object} [options] An object with the following properties: - * @param {Boolean} [options.clampToGround] True if the symbols should be rendered at the same height as the terrain - * @param {String} [options.waypointImage] Image to use for waypoint billboards. - * @param {String} [options.trackImage] Image to use for track billboards. - * @param {String} [options.trackColor] Color to use for track lines. - * @param {String} [options.routeColor] Color to use for route lines. - * @returns {Promise.} A promise that will resolve to this instances once the GPX is loaded. + * @param {string|Document|Blob} data A url, parsed GPX document, or Blob containing binary GPX data or a parsed GPX document. + * @param {object} [options] An object with the following properties: + * @param {boolean} [options.clampToGround] True if the symbols should be rendered at the same height as the terrain + * @param {string} [options.waypointImage] Image to use for waypoint billboards. + * @param {string} [options.trackImage] Image to use for track billboards. + * @param {string} [options.trackColor] Color to use for track lines. + * @param {string} [options.routeColor] Color to use for route lines. + * @returns {Promise} A promise that will resolve to this instances once the GPX is loaded. */ GpxDataSource.prototype.load = function (data, options) { if (!defined(data)) { diff --git a/packages/engine/Source/DataSources/GridMaterialProperty.js b/packages/engine/Source/DataSources/GridMaterialProperty.js index 133b55ffa357..1304ddd745e0 100644 --- a/packages/engine/Source/DataSources/GridMaterialProperty.js +++ b/packages/engine/Source/DataSources/GridMaterialProperty.js @@ -16,9 +16,9 @@ const defaultLineThickness = new Cartesian2(1, 1); * A {@link MaterialProperty} that maps to grid {@link Material} uniforms. * @alias GridMaterialProperty * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Property|Color} [options.color=Color.WHITE] A Property specifying the grid {@link Color}. - * @param {Property|Number} [options.cellAlpha=0.1] A numeric Property specifying cell alpha values. + * @param {Property|number} [options.cellAlpha=0.1] A numeric Property specifying cell alpha values. * @param {Property|Cartesian2} [options.lineCount=new Cartesian2(8, 8)] A {@link Cartesian2} Property specifying the number of grid lines along each axis. * @param {Property|Cartesian2} [options.lineThickness=new Cartesian2(1.0, 1.0)] A {@link Cartesian2} Property specifying the thickness of grid lines along each axis. * @param {Property|Cartesian2} [options.lineOffset=new Cartesian2(0.0, 0.0)] A {@link Cartesian2} Property specifying starting offset of grid lines along each axis. @@ -53,7 +53,7 @@ Object.defineProperties(GridMaterialProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof GridMaterialProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -128,7 +128,7 @@ Object.defineProperties(GridMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ GridMaterialProperty.prototype.getType = function (time) { return "Grid"; @@ -138,8 +138,8 @@ GridMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ GridMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { @@ -182,7 +182,7 @@ GridMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ GridMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/GroundGeometryUpdater.js b/packages/engine/Source/DataSources/GroundGeometryUpdater.js index 47d8fd267503..5373bb70d37b 100644 --- a/packages/engine/Source/DataSources/GroundGeometryUpdater.js +++ b/packages/engine/Source/DataSources/GroundGeometryUpdater.js @@ -17,12 +17,12 @@ const defaultZIndex = new ConstantProperty(0); * An abstract class for updating ground geometry entities. * @constructor * @alias GroundGeometryUpdater - * @param {Object} options An object with the following properties: + * @param {object} options An object with the following properties: * @param {Entity} options.entity The entity containing the geometry to be visualized. * @param {Scene} options.scene The scene where visualization is taking place. - * @param {Object} options.geometryOptions Options for the geometry - * @param {String} options.geometryPropertyName The geometry property name - * @param {String[]} options.observedPropertyNames The entity properties this geometry cares about + * @param {object} options.geometryOptions Options for the geometry + * @param {string} options.geometryPropertyName The geometry property name + * @param {string[]} options.observedPropertyNames The entity properties this geometry cares about */ function GroundGeometryUpdater(options) { GeometryUpdater.call(this, options); @@ -39,7 +39,7 @@ if (defined(Object.create)) { Object.defineProperties(GroundGeometryUpdater.prototype, { /** * Gets the zindex - * @type {Number} + * @type {number} * @memberof GroundGeometryUpdater.prototype * @readonly */ diff --git a/packages/engine/Source/DataSources/ImageMaterialProperty.js b/packages/engine/Source/DataSources/ImageMaterialProperty.js index 0c7a377275de..5aa8c5b713fa 100644 --- a/packages/engine/Source/DataSources/ImageMaterialProperty.js +++ b/packages/engine/Source/DataSources/ImageMaterialProperty.js @@ -15,11 +15,11 @@ const defaultColor = Color.WHITE; * @alias ImageMaterialProperty * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Property|String|HTMLImageElement|HTMLCanvasElement|HTMLVideoElement} [options.image] A Property specifying the Image, URL, Canvas, or Video. + * @param {object} [options] Object with the following properties: + * @param {Property|string|HTMLImageElement|HTMLCanvasElement|HTMLVideoElement} [options.image] A Property specifying the Image, URL, Canvas, or Video. * @param {Property|Cartesian2} [options.repeat=new Cartesian2(1.0, 1.0)] A {@link Cartesian2} Property specifying the number of times the image repeats in each direction. * @param {Property|Color} [options.color=Color.WHITE] The color applied to the image - * @param {Property|Boolean} [options.transparent=false] Set to true when the image has transparency (for example, when a png has transparent sections) + * @param {Property|boolean} [options.transparent=false] Set to true when the image has transparency (for example, when a png has transparent sections) */ function ImageMaterialProperty(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -46,7 +46,7 @@ Object.defineProperties(ImageMaterialProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof ImageMaterialProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -108,7 +108,7 @@ Object.defineProperties(ImageMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ ImageMaterialProperty.prototype.getType = function (time) { return "Image"; @@ -118,8 +118,8 @@ ImageMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ ImageMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { @@ -151,7 +151,7 @@ ImageMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ ImageMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/KmlDataSource.js b/packages/engine/Source/DataSources/KmlDataSource.js index a1ba044f6085..474f252406bf 100644 --- a/packages/engine/Source/DataSources/KmlDataSource.js +++ b/packages/engine/Source/DataSources/KmlDataSource.js @@ -3539,29 +3539,29 @@ function load(dataSource, entityCollection, data, options) { // https://github.com/microsoft/TypeScript/issues/20077 and/or // https://github.com/jsdoc/jsdoc/issues/1199 actually get resolved /** - * @typedef {Object} KmlDataSource.LoadOptions + * @typedef {object} KmlDataSource.LoadOptions * * Initialization options for the `load` method. * - * @property {String} [sourceUri] Overrides the url to use for resolving relative links and other KML network features. - * @property {Boolean} [clampToGround=false] true if we want the geometry features (Polygons, LineStrings and LinearRings) clamped to the ground. + * @property {string} [sourceUri] Overrides the url to use for resolving relative links and other KML network features. + * @property {boolean} [clampToGround=false] true if we want the geometry features (Polygons, LineStrings and LinearRings) clamped to the ground. * @property {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The global ellipsoid used for geographical calculations. - * @property {Element|String} [screenOverlayContainer] A container for ScreenOverlay images. + * @property {Element|string} [screenOverlayContainer] A container for ScreenOverlay images. */ /** - * @typedef {Object} KmlDataSource.ConstructorOptions + * @typedef {object} KmlDataSource.ConstructorOptions * * Options for constructing a new KmlDataSource, or calling the static `load` method. * * @property {Camera} [camera] The camera that is used for viewRefreshModes and sending camera properties to network links. * @property {HTMLCanvasElement} [canvas] The canvas that is used for sending viewer properties to network links. - * @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. * - * @property {String} [sourceUri] Overrides the url to use for resolving relative links and other KML network features. - * @property {Boolean} [clampToGround=false] true if we want the geometry features (Polygons, LineStrings and LinearRings) clamped to the ground. + * @property {string} [sourceUri] Overrides the url to use for resolving relative links and other KML network features. + * @property {boolean} [clampToGround=false] true if we want the geometry features (Polygons, LineStrings and LinearRings) clamped to the ground. * @property {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The global ellipsoid used for geographical calculations. - * @property {Element|String} [screenOverlayContainer] A container for ScreenOverlay images. + * @property {Element|string} [screenOverlayContainer] A container for ScreenOverlay images. */ @@ -3667,10 +3667,10 @@ function KmlDataSource(options) { /** * Creates a Promise to a new instance loaded with the provided KML data. * - * @param {Resource|String|Document|Blob} data A url, parsed KML document, or Blob containing binary KMZ data or a parsed KML document. + * @param {Resource|string|Document|Blob} data A url, parsed KML document, or Blob containing binary KMZ data or a parsed KML document. * @param {KmlDataSource.ConstructorOptions} [options] An object specifying configuration options * - * @returns {Promise.} A promise that will resolve to a new KmlDataSource instance once the KML is loaded. + * @returns {Promise} A promise that will resolve to a new KmlDataSource instance once the KML is loaded. */ KmlDataSource.load = function (data, options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -3683,7 +3683,7 @@ Object.defineProperties(KmlDataSource.prototype, { * Gets or sets a human-readable name for this instance. * This will be automatically be set to the KML document name on load. * @memberof KmlDataSource.prototype - * @type {String} + * @type {string} */ name: { get: function () { @@ -3721,7 +3721,7 @@ Object.defineProperties(KmlDataSource.prototype, { /** * Gets a value indicating if the data source is currently loading data. * @memberof KmlDataSource.prototype - * @type {Boolean} + * @type {boolean} */ isLoading: { get: function () { @@ -3781,7 +3781,7 @@ Object.defineProperties(KmlDataSource.prototype, { /** * Gets whether or not this data source should be displayed. * @memberof KmlDataSource.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -3836,10 +3836,10 @@ Object.defineProperties(KmlDataSource.prototype, { /** * Asynchronously loads the provided KML data, replacing any existing data. * - * @param {Resource|String|Document|Blob} data A url, parsed KML document, or Blob containing binary KMZ data or a parsed KML document. + * @param {Resource|string|Document|Blob} data A url, parsed KML document, or Blob containing binary KMZ data or a parsed KML document. * @param {KmlDataSource.LoadOptions} [options] An object specifying configuration options * - * @returns {Promise.} A promise that will resolve to this instances once the KML is loaded. + * @returns {Promise} A promise that will resolve to this instances once the KML is loaded. */ KmlDataSource.prototype.load = function (data, options) { //>>includeStart('debug', pragmas.debug); @@ -4113,7 +4113,7 @@ const entitiesToIgnore = new AssociativeArray(); * Updates any NetworkLink that require updating. * * @param {JulianDate} time The simulation time. - * @returns {Boolean} True if this data source is ready to be displayed at the provided time, false otherwise. + * @returns {boolean} True if this data source is ready to be displayed at the provided time, false otherwise. */ KmlDataSource.prototype.update = function (time) { const networkLinks = this._networkLinks; @@ -4253,10 +4253,10 @@ KmlDataSource.prototype.update = function (time) { function KmlFeatureData() { /** * @typedef KmlFeatureData.Author - * @type {Object} - * @property {String} name Gets the name. - * @property {String} uri Gets the URI. - * @property {Number} age Gets the email. + * @type {object} + * @property {string} name Gets the name. + * @property {string} uri Gets the URI. + * @property {number} age Gets the email. */ /** @@ -4271,13 +4271,13 @@ function KmlFeatureData() { /** * @typedef KmlFeatureData.Link - * @type {Object} - * @property {String} href Gets the href. - * @property {String} hreflang Gets the language of the linked resource. - * @property {String} rel Gets the link relation. - * @property {String} type Gets the link type. - * @property {String} title Gets the link title. - * @property {String} length Gets the link length. + * @type {object} + * @property {string} href Gets the href. + * @property {string} hreflang Gets the language of the linked resource. + * @property {string} rel Gets the link relation. + * @property {string} type Gets the link type. + * @property {string} title Gets the link title. + * @property {string} length Gets the link length. */ /** @@ -4295,24 +4295,24 @@ function KmlFeatureData() { /** * Gets the unstructured address field. - * @type {String} + * @type {string} */ this.address = undefined; /** * Gets the phone number. - * @type {String} + * @type {string} */ this.phoneNumber = undefined; /** * Gets the snippet. - * @type {String} + * @type {string} */ this.snippet = undefined; /** * Gets the extended data, parsed into a JSON object. * Currently only the Data property is supported. * SchemaData and custom data are ignored. - * @type {String} + * @type {string} */ this.extendedData = undefined; } diff --git a/packages/engine/Source/DataSources/KmlTour.js b/packages/engine/Source/DataSources/KmlTour.js index 637a6a7968af..f66f1e5a2a8d 100644 --- a/packages/engine/Source/DataSources/KmlTour.js +++ b/packages/engine/Source/DataSources/KmlTour.js @@ -8,8 +8,8 @@ import Event from "../Core/Event.js"; * @alias KmlTour * @constructor * - * @param {String} name name parsed from KML - * @param {String} id id parsed from KML + * @param {string} name name parsed from KML + * @param {string} id id parsed from KML * @param {Array} playlist array with KmlTourFlyTos and KmlTourWaits * * @see KmlTourFlyTo @@ -20,22 +20,22 @@ import Event from "../Core/Event.js"; function KmlTour(name, id) { /** * Id of kml gx:Tour entry - * @type String + * @type {string} */ this.id = id; /** * Tour name - * @type String + * @type {string} */ this.name = name; /** * Index of current entry from playlist - * @type Number + * @type {number} */ this.playlistIndex = 0; /** * Array of playlist entries - * @type Array + * @type {Array} */ this.playlist = []; /** @@ -86,7 +86,7 @@ KmlTour.prototype.addPlaylistEntry = function (entry) { * Play this tour. * * @param {Viewer|CesiumWidget} widget The widget. - * @param {Object} [cameraOptions] these options will be merged with {@link Camera#flyTo} + * @param {object} [cameraOptions] these options will be merged with {@link Camera#flyTo} * options for FlyTo playlist entries. */ KmlTour.prototype.play = function (widget, cameraOptions) { diff --git a/packages/engine/Source/DataSources/KmlTourFlyTo.js b/packages/engine/Source/DataSources/KmlTourFlyTo.js index dedba2cab68f..405279eb5668 100644 --- a/packages/engine/Source/DataSources/KmlTourFlyTo.js +++ b/packages/engine/Source/DataSources/KmlTourFlyTo.js @@ -9,8 +9,8 @@ import EasingFunction from "../Core/EasingFunction.js"; * @alias KmlTourFlyTo * @constructor * - * @param {Number} duration entry duration - * @param {String} flyToMode KML fly to mode: bounce, smooth, etc + * @param {number} duration entry duration + * @param {string} flyToMode KML fly to mode: bounce, smooth, etc * @param {KmlCamera|KmlLookAt} view KmlCamera or KmlLookAt * * @see KmlTour @@ -32,7 +32,7 @@ function KmlTourFlyTo(duration, flyToMode, view) { * * @param {KmlTourFlyTo.DoneCallback} done function which will be called when playback ends * @param {Camera} camera Cesium camera - * @param {Object} [cameraOptions] which will be merged with camera flyTo options. See {@link Camera#flyTo} + * @param {object} [cameraOptions] which will be merged with camera flyTo options. See {@link Camera#flyTo} */ KmlTourFlyTo.prototype.play = function (done, camera, cameraOptions) { this.activeCamera = camera; @@ -70,8 +70,8 @@ KmlTourFlyTo.prototype.stop = function () { * Returns options for {@link Camera#flyTo} or {@link Camera#flyToBoundingSphere} * depends on this.view type. * - * @param {Object} cameraOptions options to merge with generated. See {@link Camera#flyTo} - * @returns {Object} {@link Camera#flyTo} or {@link Camera#flyToBoundingSphere} options + * @param {object} cameraOptions options to merge with generated. See {@link Camera#flyTo} + * @returns {object} {@link Camera#flyTo} or {@link Camera#flyToBoundingSphere} options */ KmlTourFlyTo.prototype.getCameraOptions = function (cameraOptions) { let options = { @@ -103,7 +103,7 @@ KmlTourFlyTo.prototype.getCameraOptions = function (cameraOptions) { * A function that will be executed when the flight completes. * @callback KmlTourFlyTo.DoneCallback * - * @param {Boolean} terminated true if {@link KmlTourFlyTo#stop} was + * @param {boolean} terminated true if {@link KmlTourFlyTo#stop} was * called before entry done playback. */ export default KmlTourFlyTo; diff --git a/packages/engine/Source/DataSources/KmlTourWait.js b/packages/engine/Source/DataSources/KmlTourWait.js index 0be6e7403dce..d59da1e50557 100644 --- a/packages/engine/Source/DataSources/KmlTourWait.js +++ b/packages/engine/Source/DataSources/KmlTourWait.js @@ -5,7 +5,7 @@ import defined from "../Core/defined.js"; * @alias KmlTourWait * @constructor * - * @param {Number} duration entry duration + * @param {number} duration entry duration * * @see KmlTour * @see KmlTourFlyTo @@ -46,7 +46,7 @@ KmlTourWait.prototype.stop = function () { * A function which will be called when playback ends. * * @callback KmlTourWait.DoneCallback - * @param {Boolean} terminated true if {@link KmlTourWait#stop} was + * @param {boolean} terminated true if {@link KmlTourWait#stop} was * called before entry done playback. */ export default KmlTourWait; diff --git a/packages/engine/Source/DataSources/LabelGraphics.js b/packages/engine/Source/DataSources/LabelGraphics.js index 3495a7e88e08..0622b72bb66c 100644 --- a/packages/engine/Source/DataSources/LabelGraphics.js +++ b/packages/engine/Source/DataSources/LabelGraphics.js @@ -5,7 +5,7 @@ import Event from "../Core/Event.js"; import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} LabelGraphics.ConstructorOptions + * @typedef {object} LabelGraphics.ConstructorOptions * * Initialization options for the LabelGraphics constructor * diff --git a/packages/engine/Source/DataSources/LabelVisualizer.js b/packages/engine/Source/DataSources/LabelVisualizer.js index 94392355dda3..e88281164f29 100644 --- a/packages/engine/Source/DataSources/LabelVisualizer.js +++ b/packages/engine/Source/DataSources/LabelVisualizer.js @@ -84,7 +84,7 @@ function LabelVisualizer(entityCluster, entityCollection) { * Entity counterpart at the given time. * * @param {JulianDate} time The time to update to. - * @returns {Boolean} This function always returns true. + * @returns {boolean} This function always returns true. */ LabelVisualizer.prototype.update = function (time) { //>>includeStart('debug', pragmas.debug); @@ -293,7 +293,7 @@ LabelVisualizer.prototype.getBoundingSphere = function (entity, result) { /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ LabelVisualizer.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/MaterialProperty.js b/packages/engine/Source/DataSources/MaterialProperty.js index c6aec1da45b1..c6a957f79e77 100644 --- a/packages/engine/Source/DataSources/MaterialProperty.js +++ b/packages/engine/Source/DataSources/MaterialProperty.js @@ -29,7 +29,7 @@ Object.defineProperties(MaterialProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof MaterialProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -54,7 +54,7 @@ Object.defineProperties(MaterialProperty.prototype, { * @function * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ MaterialProperty.prototype.getType = DeveloperError.throwInstantiationError; @@ -63,8 +63,8 @@ MaterialProperty.prototype.getType = DeveloperError.throwInstantiationError; * @function * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ MaterialProperty.prototype.getValue = DeveloperError.throwInstantiationError; @@ -74,7 +74,7 @@ MaterialProperty.prototype.getValue = DeveloperError.throwInstantiationError; * @function * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ MaterialProperty.prototype.equals = DeveloperError.throwInstantiationError; diff --git a/packages/engine/Source/DataSources/ModelGraphics.js b/packages/engine/Source/DataSources/ModelGraphics.js index 42ee8fea00b9..2c4f33792469 100644 --- a/packages/engine/Source/DataSources/ModelGraphics.js +++ b/packages/engine/Source/DataSources/ModelGraphics.js @@ -19,7 +19,7 @@ function createArticulationStagePropertyBag(value) { } /** - * @typedef {Object} ModelGraphics.ConstructorOptions + * @typedef {object} ModelGraphics.ConstructorOptions * * Initialization options for the ModelGraphics constructor * @@ -41,8 +41,8 @@ function createArticulationStagePropertyBag(value) { * @property {Property | Cartesian2} [imageBasedLightingFactor=new Cartesian2(1.0, 1.0)] A property specifying the contribution from diffuse and specular image-based lighting. * @property {Property | Color} [lightColor] A property specifying the light color when shading the model. When undefined the scene's light color is used instead. * @property {Property | DistanceDisplayCondition} [distanceDisplayCondition] A Property specifying at what distance from the camera that this model will be displayed. - * @property {PropertyBag | Object.} [nodeTransformations] An object, where keys are names of nodes, and values are {@link TranslationRotationScale} Properties describing the transformation to apply to that node. The transformation is applied after the node's existing transformation as specified in the glTF, and does not replace the node's existing transformation. - * @property {PropertyBag | Object.} [articulations] An object, where keys are composed of an articulation name, a single space, and a stage name, and the values are numeric properties. + * @property {PropertyBag | Object} [nodeTransformations] An object, where keys are names of nodes, and values are {@link TranslationRotationScale} Properties describing the transformation to apply to that node. The transformation is applied after the node's existing transformation as specified in the glTF, and does not replace the node's existing transformation. + * @property {PropertyBag | Object} [articulations] An object, where keys are composed of an articulation name, a single space, and a stage name, and the values are numeric properties. * @property {Property | ClippingPlaneCollection} [clippingPlanes] A property specifying the {@link ClippingPlaneCollection} used to selectively disable rendering the model. * @property {Property | CustomShader} [customShader] A property specifying the {@link CustomShader} to apply to this model. */ diff --git a/packages/engine/Source/DataSources/ModelVisualizer.js b/packages/engine/Source/DataSources/ModelVisualizer.js index b86c061ffc55..f70b8d382fca 100644 --- a/packages/engine/Source/DataSources/ModelVisualizer.js +++ b/packages/engine/Source/DataSources/ModelVisualizer.js @@ -68,7 +68,7 @@ function ModelVisualizer(scene, entityCollection) { * Entity counterpart at the given time. * * @param {JulianDate} time The time to update to. - * @returns {Boolean} This function always returns true. + * @returns {boolean} This function always returns true. */ ModelVisualizer.prototype.update = function (time) { //>>includeStart('debug', pragmas.debug); @@ -315,7 +315,7 @@ ModelVisualizer.prototype.update = function (time) { /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ ModelVisualizer.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/NodeTransformationProperty.js b/packages/engine/Source/DataSources/NodeTransformationProperty.js index 516b3c41217e..f6513cd05972 100644 --- a/packages/engine/Source/DataSources/NodeTransformationProperty.js +++ b/packages/engine/Source/DataSources/NodeTransformationProperty.js @@ -12,7 +12,7 @@ const defaultNodeTransformation = new TranslationRotationScale(); * @alias NodeTransformationProperty * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Property|Cartesian3} [options.translation=Cartesian3.ZERO] A {@link Cartesian3} Property specifying the (x, y, z) translation to apply to the node. * @param {Property|Quaternion} [options.rotation=Quaternion.IDENTITY] A {@link Quaternion} Property specifying the (x, y, z, w) rotation to apply to the node. * @param {Property|Cartesian3} [options.scale=new Cartesian3(1.0, 1.0, 1.0)] A {@link Cartesian3} Property specifying the (x, y, z) scaling to apply to the node. @@ -39,7 +39,7 @@ Object.defineProperties(NodeTransformationProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof NodeTransformationProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -130,7 +130,7 @@ NodeTransformationProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ NodeTransformationProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/PathGraphics.js b/packages/engine/Source/DataSources/PathGraphics.js index 4e95e18792de..d914bb4424e6 100644 --- a/packages/engine/Source/DataSources/PathGraphics.js +++ b/packages/engine/Source/DataSources/PathGraphics.js @@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} PathGraphics.ConstructorOptions + * @typedef {object} PathGraphics.ConstructorOptions * * Initialization options for the PathGraphics constructor * diff --git a/packages/engine/Source/DataSources/PathVisualizer.js b/packages/engine/Source/DataSources/PathVisualizer.js index 9394f4858013..47aac6026255 100644 --- a/packages/engine/Source/DataSources/PathVisualizer.js +++ b/packages/engine/Source/DataSources/PathVisualizer.js @@ -612,7 +612,7 @@ function PathVisualizer(scene, entityCollection) { * Entity counterpart at the given time. * * @param {JulianDate} time The time to update to. - * @returns {Boolean} This function always returns true. + * @returns {boolean} This function always returns true. */ PathVisualizer.prototype.update = function (time) { //>>includeStart('debug', pragmas.debug); @@ -682,7 +682,7 @@ PathVisualizer.prototype.update = function (time) { /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ PathVisualizer.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/PlaneGraphics.js b/packages/engine/Source/DataSources/PlaneGraphics.js index 01169fadeec0..519ff7d449f1 100644 --- a/packages/engine/Source/DataSources/PlaneGraphics.js +++ b/packages/engine/Source/DataSources/PlaneGraphics.js @@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} PlaneGraphics.ConstructorOptions + * @typedef {object} PlaneGraphics.ConstructorOptions * * Initialization options for the PlaneGraphics constructor * diff --git a/packages/engine/Source/DataSources/PointGraphics.js b/packages/engine/Source/DataSources/PointGraphics.js index 982d86906ff8..6f1cbba104eb 100644 --- a/packages/engine/Source/DataSources/PointGraphics.js +++ b/packages/engine/Source/DataSources/PointGraphics.js @@ -5,7 +5,7 @@ import Event from "../Core/Event.js"; import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} PointGraphics.ConstructorOptions + * @typedef {object} PointGraphics.ConstructorOptions * * Initialization options for the PointGraphics constructor * diff --git a/packages/engine/Source/DataSources/PointVisualizer.js b/packages/engine/Source/DataSources/PointVisualizer.js index 798bb03cd9ca..2210646daa9a 100644 --- a/packages/engine/Source/DataSources/PointVisualizer.js +++ b/packages/engine/Source/DataSources/PointVisualizer.js @@ -68,7 +68,7 @@ function PointVisualizer(entityCluster, entityCollection) { * Entity counterpart at the given time. * * @param {JulianDate} time The time to update to. - * @returns {Boolean} This function always returns true. + * @returns {boolean} This function always returns true. */ PointVisualizer.prototype.update = function (time) { //>>includeStart('debug', pragmas.debug); @@ -350,7 +350,7 @@ PointVisualizer.prototype.getBoundingSphere = function (entity, result) { /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ PointVisualizer.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/PolygonGraphics.js b/packages/engine/Source/DataSources/PolygonGraphics.js index 29db7184144e..d0339c682fd2 100644 --- a/packages/engine/Source/DataSources/PolygonGraphics.js +++ b/packages/engine/Source/DataSources/PolygonGraphics.js @@ -16,7 +16,7 @@ function createPolygonHierarchyProperty(value) { } /** - * @typedef {Object} PolygonGraphics.ConstructorOptions + * @typedef {object} PolygonGraphics.ConstructorOptions * * Initialization options for the PolygonGraphics constructor * @@ -34,8 +34,8 @@ function createPolygonHierarchyProperty(value) { * @property {Property | Color} [outlineColor=Color.BLACK] A Property specifying the {@link Color} of the outline. * @property {Property | number} [outlineWidth=1.0] A numeric Property specifying the width of the outline. * @property {Property | boolean} [perPositionHeight=false] A boolean specifying whether or not the height of each position is used. - * @property {Boolean | boolean} [closeTop=true] When false, leaves off the top of an extruded polygon open. - * @property {Boolean | boolean} [closeBottom=true] When false, leaves off the bottom of an extruded polygon open. + * @property {boolean | boolean} [closeTop=true] When false, leaves off the top of an extruded polygon open. + * @property {boolean | boolean} [closeBottom=true] When false, leaves off the bottom of an extruded polygon open. * @property {Property | ArcType} [arcType=ArcType.GEODESIC] The type of line the polygon edges must follow. * @property {Property | ShadowMode} [shadows=ShadowMode.DISABLED] An enum Property specifying whether the polygon casts or receives shadows from light sources. * @property {Property | DistanceDisplayCondition} [distanceDisplayCondition] A Property specifying at what distance from the camera that this polygon will be displayed. diff --git a/packages/engine/Source/DataSources/PolylineArrowMaterialProperty.js b/packages/engine/Source/DataSources/PolylineArrowMaterialProperty.js index cd413dce829a..78ad0b87c94d 100644 --- a/packages/engine/Source/DataSources/PolylineArrowMaterialProperty.js +++ b/packages/engine/Source/DataSources/PolylineArrowMaterialProperty.js @@ -26,7 +26,7 @@ Object.defineProperties(PolylineArrowMaterialProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof PolylineArrowMaterialProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -61,7 +61,7 @@ Object.defineProperties(PolylineArrowMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ PolylineArrowMaterialProperty.prototype.getType = function (time) { return "PolylineArrow"; @@ -71,8 +71,8 @@ PolylineArrowMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ PolylineArrowMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { @@ -92,7 +92,7 @@ PolylineArrowMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ PolylineArrowMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/PolylineDashMaterialProperty.js b/packages/engine/Source/DataSources/PolylineDashMaterialProperty.js index 7240e1caf20b..1ff9c6675f99 100644 --- a/packages/engine/Source/DataSources/PolylineDashMaterialProperty.js +++ b/packages/engine/Source/DataSources/PolylineDashMaterialProperty.js @@ -15,11 +15,11 @@ const defaultDashPattern = 255.0; * @alias PolylineDashMaterialProperty * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Property|Color} [options.color=Color.WHITE] A Property specifying the {@link Color} of the line. * @param {Property|Color} [options.gapColor=Color.TRANSPARENT] A Property specifying the {@link Color} of the gaps in the line. - * @param {Property|Number} [options.dashLength=16.0] A numeric Property specifying the length of the dash pattern in pixels. - * @param {Property|Number} [options.dashPattern=255.0] A numeric Property specifying a 16 bit pattern for the dash + * @param {Property|number} [options.dashLength=16.0] A numeric Property specifying the length of the dash pattern in pixels. + * @param {Property|number} [options.dashPattern=255.0] A numeric Property specifying a 16 bit pattern for the dash */ function PolylineDashMaterialProperty(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -45,7 +45,7 @@ Object.defineProperties(PolylineDashMaterialProperty.prototype, { * Gets a value indicating if this property is constant. A property is considered * constant if getValue always returns the same result for the current definition. * @memberof PolylineDashMaterialProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -104,7 +104,7 @@ Object.defineProperties(PolylineDashMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ PolylineDashMaterialProperty.prototype.getType = function (time) { return "PolylineDash"; @@ -114,8 +114,8 @@ PolylineDashMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ PolylineDashMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { @@ -153,7 +153,7 @@ PolylineDashMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ PolylineDashMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/PolylineGeometryUpdater.js b/packages/engine/Source/DataSources/PolylineGeometryUpdater.js index 924efbf2a0bf..6ad349c9d862 100644 --- a/packages/engine/Source/DataSources/PolylineGeometryUpdater.js +++ b/packages/engine/Source/DataSources/PolylineGeometryUpdater.js @@ -108,7 +108,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { /** * Gets the unique ID associated with this updater * @memberof PolylineGeometryUpdater.prototype - * @type {String} + * @type {string} * @readonly */ id: { @@ -132,7 +132,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { * Gets a value indicating if the geometry has a fill component. * @memberof PolylineGeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ fillEnabled: { @@ -144,7 +144,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { * Gets a value indicating if fill visibility varies with simulation time. * @memberof PolylineGeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ hasConstantFill: { @@ -184,7 +184,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { * Gets a value indicating if the geometry has an outline component. * @memberof PolylineGeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ outlineEnabled: { @@ -194,7 +194,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { * Gets a value indicating if outline visibility varies with simulation time. * @memberof PolylineGeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ hasConstantOutline: { @@ -253,7 +253,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { * returned by GeometryUpdater#createDynamicUpdater. * @memberof PolylineGeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isDynamic: { @@ -266,7 +266,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { * This property is only valid for static geometry. * @memberof PolylineGeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isClosed: { @@ -277,7 +277,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { * of this updater change. * @memberof PolylineGeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ geometryChanged: { @@ -304,7 +304,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { * Returns false if polylines on terrain is not supported. * @memberof PolylineGeometryUpdater.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ clampToGround: { @@ -315,7 +315,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { /** * Gets the zindex - * @type {Number} + * @type {number} * @memberof PolylineGeometryUpdater.prototype * @readonly */ @@ -330,7 +330,7 @@ Object.defineProperties(PolylineGeometryUpdater.prototype, { * Checks if the geometry is outlined at the provided time. * * @param {JulianDate} time The time for which to retrieve visibility. - * @returns {Boolean} true if geometry is outlined at the provided time, false otherwise. + * @returns {boolean} true if geometry is outlined at the provided time, false otherwise. */ PolylineGeometryUpdater.prototype.isOutlineVisible = function (time) { return false; @@ -340,7 +340,7 @@ PolylineGeometryUpdater.prototype.isOutlineVisible = function (time) { * Checks if the geometry is filled at the provided time. * * @param {JulianDate} time The time for which to retrieve visibility. - * @returns {Boolean} true if geometry is filled at the provided time, false otherwise. + * @returns {boolean} true if geometry is filled at the provided time, false otherwise. */ PolylineGeometryUpdater.prototype.isFilled = function (time) { const entity = this._entity; @@ -460,7 +460,7 @@ PolylineGeometryUpdater.prototype.createOutlineGeometryInstance = function ( /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ PolylineGeometryUpdater.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/PolylineGlowMaterialProperty.js b/packages/engine/Source/DataSources/PolylineGlowMaterialProperty.js index 4bfde8b82e58..11ac0f10a9e8 100644 --- a/packages/engine/Source/DataSources/PolylineGlowMaterialProperty.js +++ b/packages/engine/Source/DataSources/PolylineGlowMaterialProperty.js @@ -14,10 +14,10 @@ const defaultTaperPower = 1.0; * @alias PolylineGlowMaterialProperty * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Property|Color} [options.color=Color.WHITE] A Property specifying the {@link Color} of the line. - * @param {Property|Number} [options.glowPower=0.25] A numeric Property specifying the strength of the glow, as a percentage of the total line width. - * @param {Property|Number} [options.taperPower=1.0] A numeric Property specifying the strength of the tapering effect, as a percentage of the total line length. If 1.0 or higher, no taper effect is used. + * @param {Property|number} [options.glowPower=0.25] A numeric Property specifying the strength of the glow, as a percentage of the total line width. + * @param {Property|number} [options.taperPower=1.0] A numeric Property specifying the strength of the tapering effect, as a percentage of the total line length. If 1.0 or higher, no taper effect is used. */ function PolylineGlowMaterialProperty(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -40,7 +40,7 @@ Object.defineProperties(PolylineGlowMaterialProperty.prototype, { * Gets a value indicating if this property is constant. A property is considered * constant if getValue always returns the same result for the current definition. * @memberof PolylineGlowMaterialProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -89,7 +89,7 @@ Object.defineProperties(PolylineGlowMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ PolylineGlowMaterialProperty.prototype.getType = function (time) { return "PolylineGlow"; @@ -99,8 +99,8 @@ PolylineGlowMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ PolylineGlowMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { @@ -132,7 +132,7 @@ PolylineGlowMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ PolylineGlowMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/PolylineGraphics.js b/packages/engine/Source/DataSources/PolylineGraphics.js index 90566a523341..68c00789e036 100644 --- a/packages/engine/Source/DataSources/PolylineGraphics.js +++ b/packages/engine/Source/DataSources/PolylineGraphics.js @@ -6,12 +6,12 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} PolylineGraphics.ConstructorOptions + * @typedef {object} PolylineGraphics.ConstructorOptions * * Initialization options for the PolylineGraphics constructor * * @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the polyline. - * @property {Property | Array} [positions] A Property specifying the array of {@link Cartesian3} positions that define the line strip. + * @property {Property | Cartesian3[]} [positions] A Property specifying the array of {@link Cartesian3} positions that define the line strip. * @property {Property | number} [width=1.0] A numeric Property specifying the width in pixels. * @property {Property | number} [granularity=Cesium.Math.RADIANS_PER_DEGREE] A numeric Property specifying the angular distance between each latitude and longitude if arcType is not ArcType.NONE. * @property {MaterialProperty | Color} [material=Color.WHITE] A Property specifying the material used to draw the polyline. diff --git a/packages/engine/Source/DataSources/PolylineOutlineMaterialProperty.js b/packages/engine/Source/DataSources/PolylineOutlineMaterialProperty.js index 69334d6f358e..27851e59ba78 100644 --- a/packages/engine/Source/DataSources/PolylineOutlineMaterialProperty.js +++ b/packages/engine/Source/DataSources/PolylineOutlineMaterialProperty.js @@ -14,10 +14,10 @@ const defaultOutlineWidth = 1.0; * @alias PolylineOutlineMaterialProperty * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Property|Color} [options.color=Color.WHITE] A Property specifying the {@link Color} of the line. * @param {Property|Color} [options.outlineColor=Color.BLACK] A Property specifying the {@link Color} of the outline. - * @param {Property|Number} [options.outlineWidth=1.0] A numeric Property specifying the width of the outline, in pixels. + * @param {Property|number} [options.outlineWidth=1.0] A numeric Property specifying the width of the outline, in pixels. */ function PolylineOutlineMaterialProperty(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -41,7 +41,7 @@ Object.defineProperties(PolylineOutlineMaterialProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof PolylineOutlineMaterialProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -96,7 +96,7 @@ Object.defineProperties(PolylineOutlineMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ PolylineOutlineMaterialProperty.prototype.getType = function (time) { return "PolylineOutline"; @@ -106,8 +106,8 @@ PolylineOutlineMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ PolylineOutlineMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { @@ -138,7 +138,7 @@ PolylineOutlineMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ PolylineOutlineMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/PolylineVisualizer.js b/packages/engine/Source/DataSources/PolylineVisualizer.js index f3d969009b7b..a30fb2fad7be 100644 --- a/packages/engine/Source/DataSources/PolylineVisualizer.js +++ b/packages/engine/Source/DataSources/PolylineVisualizer.js @@ -197,7 +197,7 @@ function PolylineVisualizer( * Entity counterpart at the given time. * * @param {JulianDate} time The time to update to. - * @returns {Boolean} True if the visualizer successfully updated to the provided time, + * @returns {boolean} True if the visualizer successfully updated to the provided time, * false if the visualizer is waiting for asynchronous primitives to be created. */ PolylineVisualizer.prototype.update = function (time) { @@ -329,7 +329,7 @@ PolylineVisualizer.prototype.getBoundingSphere = function (entity, result) { /** * Returns true if this object was destroyed; otherwise, false. * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ PolylineVisualizer.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/DataSources/PolylineVolumeGraphics.js b/packages/engine/Source/DataSources/PolylineVolumeGraphics.js index 6bd22468dca0..19ff7e271c99 100644 --- a/packages/engine/Source/DataSources/PolylineVolumeGraphics.js +++ b/packages/engine/Source/DataSources/PolylineVolumeGraphics.js @@ -6,13 +6,13 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} PolylineVolumeGraphics.ConstructorOptions + * @typedef {object} PolylineVolumeGraphics.ConstructorOptions * * Initialization options for the PolylineVolumeGraphics constructor * * @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the volume. - * @property {Property | Array} [positions] A Property specifying the array of {@link Cartesian3} positions which define the line strip. - * @property {Property | Array} [shape] A Property specifying the array of {@link Cartesian2} positions which define the shape to be extruded. + * @property {Property | Cartesian3[]} [positions] A Property specifying the array of {@link Cartesian3} positions which define the line strip. + * @property {Property | Cartesian2[]} [shape] A Property specifying the array of {@link Cartesian2} positions which define the shape to be extruded. * @property {Property | CornerType} [cornerType=CornerType.ROUNDED] A {@link CornerType} Property specifying the style of the corners. * @property {Property | number} [granularity=Cesium.Math.RADIANS_PER_DEGREE] A numeric Property specifying the angular distance between each latitude and longitude point. * @property {Property | boolean} [fill=true] A boolean Property specifying whether the volume is filled with the provided material. diff --git a/packages/engine/Source/DataSources/PositionProperty.js b/packages/engine/Source/DataSources/PositionProperty.js index 93f28de8b6bf..88b0e2371a64 100644 --- a/packages/engine/Source/DataSources/PositionProperty.js +++ b/packages/engine/Source/DataSources/PositionProperty.js @@ -29,7 +29,7 @@ Object.defineProperties(PositionProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof PositionProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -85,7 +85,7 @@ PositionProperty.prototype.getValueInReferenceFrame = * @function * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ PositionProperty.prototype.equals = DeveloperError.throwInstantiationError; diff --git a/packages/engine/Source/DataSources/PositionPropertyArray.js b/packages/engine/Source/DataSources/PositionPropertyArray.js index fb58d11d3576..ac8853533a67 100644 --- a/packages/engine/Source/DataSources/PositionPropertyArray.js +++ b/packages/engine/Source/DataSources/PositionPropertyArray.js @@ -30,7 +30,7 @@ Object.defineProperties(PositionPropertyArray.prototype, { * is considered constant if all property items in the array are constant. * @memberof PositionPropertyArray.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -170,7 +170,7 @@ PositionPropertyArray.prototype.setValue = function (value) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ PositionPropertyArray.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/Property.js b/packages/engine/Source/DataSources/Property.js index facdbf6957b5..5bb13ab71b49 100644 --- a/packages/engine/Source/DataSources/Property.js +++ b/packages/engine/Source/DataSources/Property.js @@ -28,7 +28,7 @@ Object.defineProperties(Property.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof Property.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -53,8 +53,8 @@ Object.defineProperties(Property.prototype, { * @function * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ Property.prototype.getValue = DeveloperError.throwInstantiationError; @@ -64,7 +64,7 @@ Property.prototype.getValue = DeveloperError.throwInstantiationError; * @function * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ Property.prototype.equals = DeveloperError.throwInstantiationError; diff --git a/packages/engine/Source/DataSources/PropertyArray.js b/packages/engine/Source/DataSources/PropertyArray.js index 0e083bf0a180..305e3c0c9401 100644 --- a/packages/engine/Source/DataSources/PropertyArray.js +++ b/packages/engine/Source/DataSources/PropertyArray.js @@ -26,7 +26,7 @@ Object.defineProperties(PropertyArray.prototype, { * is considered constant if all property items in the array are constant. * @memberof PropertyArray.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -131,7 +131,7 @@ PropertyArray.prototype.setValue = function (value) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ PropertyArray.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/PropertyBag.js b/packages/engine/Source/DataSources/PropertyBag.js index b6e27371551c..a5b0220f400b 100644 --- a/packages/engine/Source/DataSources/PropertyBag.js +++ b/packages/engine/Source/DataSources/PropertyBag.js @@ -13,7 +13,7 @@ import Property from "./Property.js"; * @implements Record * @constructor * - * @param {Object} [value] An object, containing key-value mapping of property names to properties. + * @param {object} [value] An object, containing key-value mapping of property names to properties. * @param {Function} [createPropertyCallback] A function that will be called when the value of any of the properties in value are not a Property. */ function PropertyBag(value, createPropertyCallback) { @@ -41,7 +41,7 @@ Object.defineProperties(PropertyBag.prototype, { * is considered constant if all property items in this object are constant. * @memberof PropertyBag.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -74,9 +74,9 @@ Object.defineProperties(PropertyBag.prototype, { /** * Determines if this object has defined a property with the given name. * - * @param {String} propertyName The name of the property to check for. + * @param {string} propertyName The name of the property to check for. * - * @returns {Boolean} True if this object has defined a property with the given name, false otherwise. + * @returns {boolean} True if this object has defined a property with the given name, false otherwise. */ PropertyBag.prototype.hasProperty = function (propertyName) { return this._propertyNames.indexOf(propertyName) !== -1; @@ -89,7 +89,7 @@ function createConstantProperty(value) { /** * Adds a property to this object. * - * @param {String} propertyName The name of the property to add. + * @param {string} propertyName The name of the property to add. * @param {*} [value] The value of the new property, if provided. * @param {Function} [createPropertyCallback] A function that will be called when the value of this new property is set to a value that is not a Property. * @@ -134,7 +134,7 @@ PropertyBag.prototype.addProperty = function ( /** * Removed a property previously added with addProperty. * - * @param {String} propertyName The name of the property to remove. + * @param {string} propertyName The name of the property to remove. * * @exception {DeveloperError} "propertyName" is not a registered property. */ @@ -162,9 +162,9 @@ PropertyBag.prototype.removeProperty = function (propertyName) { * result will be an object, mapping property names to those values. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. * Note that any properties in result which are not part of this PropertyBag will be left as-is. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ PropertyBag.prototype.getValue = function (time, result) { //>>includeStart('debug', pragmas.debug); @@ -193,7 +193,7 @@ PropertyBag.prototype.getValue = function (time, result) { * Assigns each unassigned property on this object to the value * of the same property on the provided source object. * - * @param {Object} source The object to be merged into this object. + * @param {object} source The object to be merged into this object. * @param {Function} [createPropertyCallback] A function that will be called when the value of any of the properties in value are not a Property. */ PropertyBag.prototype.merge = function (source, createPropertyCallback) { @@ -263,7 +263,7 @@ function propertiesEqual(a, b) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ PropertyBag.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/RectangleGraphics.js b/packages/engine/Source/DataSources/RectangleGraphics.js index 4c8f30aa5b10..020f96e56d14 100644 --- a/packages/engine/Source/DataSources/RectangleGraphics.js +++ b/packages/engine/Source/DataSources/RectangleGraphics.js @@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} RectangleGraphics.ConstructorOptions + * @typedef {object} RectangleGraphics.ConstructorOptions * * Initialization options for the RectangleGraphics constructor * diff --git a/packages/engine/Source/DataSources/ReferenceProperty.js b/packages/engine/Source/DataSources/ReferenceProperty.js index 6d427d786f3a..88218e81d0db 100644 --- a/packages/engine/Source/DataSources/ReferenceProperty.js +++ b/packages/engine/Source/DataSources/ReferenceProperty.js @@ -51,8 +51,8 @@ function resolve(that) { * @constructor * * @param {EntityCollection} targetCollection The entity collection which will be used to resolve the reference. - * @param {String} targetId The id of the entity which is being referenced. - * @param {String[]} targetPropertyNames The names of the property on the target entity which we will use. + * @param {string} targetId The id of the entity which is being referenced. + * @param {string[]} targetPropertyNames The names of the property on the target entity which we will use. * * @example * const collection = new Cesium.EntityCollection(); @@ -122,7 +122,7 @@ Object.defineProperties(ReferenceProperty.prototype, { /** * Gets a value indicating if this property is constant. * @memberof ReferenceProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -158,7 +158,7 @@ Object.defineProperties(ReferenceProperty.prototype, { /** * Gets the id of the entity being referenced. * @memberof ReferenceProperty.prototype - * @type {String} + * @type {string} * @readonly */ targetId: { @@ -180,7 +180,7 @@ Object.defineProperties(ReferenceProperty.prototype, { /** * Gets the array of property names used to retrieve the referenced property. * @memberof ReferenceProperty.prototype - * @type {String[]} + * @type {} * @readonly */ targetPropertyNames: { @@ -209,7 +209,7 @@ Object.defineProperties(ReferenceProperty.prototype, { * or any sub-properties contains a # . or \ they must be escaped. * * @param {EntityCollection} targetCollection - * @param {String} referenceString + * @param {string} referenceString * @returns {ReferenceProperty} A new instance of ReferenceProperty. * * @exception {DeveloperError} invalid referenceString. @@ -258,8 +258,8 @@ ReferenceProperty.fromString = function (targetCollection, referenceString) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ ReferenceProperty.prototype.getValue = function (time, result) { const target = resolve(this); @@ -291,7 +291,7 @@ ReferenceProperty.prototype.getValueInReferenceFrame = function ( * This method is only valid if the property being referenced is a {@link MaterialProperty}. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ ReferenceProperty.prototype.getType = function (time) { const target = resolve(this); @@ -303,7 +303,7 @@ ReferenceProperty.prototype.getType = function (time) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ ReferenceProperty.prototype.equals = function (other) { if (this === other) { diff --git a/packages/engine/Source/DataSources/Rotation.js b/packages/engine/Source/DataSources/Rotation.js index 6ed6a6a19bd4..5f60a4a92fe8 100644 --- a/packages/engine/Source/DataSources/Rotation.js +++ b/packages/engine/Source/DataSources/Rotation.js @@ -32,7 +32,7 @@ import CesiumMath from "../Core/Math.js"; const Rotation = { /** * The number of elements used to pack the object into an array. - * @type {Number} + * @type {number} */ packedLength: 1, @@ -40,10 +40,10 @@ const Rotation = { * Stores the provided instance into the provided array. * * @param {Rotation} value The value to pack. - * @param {Number[]} array The array to pack into. - * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements. + * @param {number[]} array The array to pack into. + * @param {number} [startingIndex=0] The index into the array at which to start packing the elements. * - * @returns {Number[]} The array that was packed into + * @returns {number[]} The array that was packed into */ pack: function (value, array, startingIndex) { //>>includeStart('debug', pragmas.debug); @@ -65,8 +65,8 @@ const Rotation = { /** * Retrieves an instance from a packed array. * - * @param {Number[]} array The packed array. - * @param {Number} [startingIndex=0] The starting index of the element to be unpacked. + * @param {number[]} array The packed array. + * @param {number} [startingIndex=0] The starting index of the element to be unpacked. * @param {Rotation} [result] The object into which to store the result. * @returns {Rotation} The modified result parameter or a new Rotation instance if one was not provided. */ @@ -84,10 +84,10 @@ const Rotation = { /** * Converts a packed array into a form suitable for interpolation. * - * @param {Number[]} packedArray The packed array. - * @param {Number} [startingIndex=0] The index of the first element to be converted. - * @param {Number} [lastIndex=packedArray.length] The index of the last element to be converted. - * @param {Number[]} [result] The object into which to store the result. + * @param {number[]} packedArray The packed array. + * @param {number} [startingIndex=0] The index of the first element to be converted. + * @param {number} [lastIndex=packedArray.length] The index of the last element to be converted. + * @param {number[]} [result] The object into which to store the result. */ convertPackedArrayForInterpolation: function ( packedArray, @@ -123,10 +123,10 @@ const Rotation = { /** * Retrieves an instance from a packed array converted with {@link Rotation.convertPackedArrayForInterpolation}. * - * @param {Number[]} array The array previously packed for interpolation. - * @param {Number[]} sourceArray The original packed array. - * @param {Number} [firstIndex=0] The firstIndex used to convert the array. - * @param {Number} [lastIndex=packedArray.length] The lastIndex used to convert the array. + * @param {number[]} array The array previously packed for interpolation. + * @param {number[]} sourceArray The original packed array. + * @param {number} [firstIndex=0] The firstIndex used to convert the array. + * @param {number} [lastIndex=packedArray.length] The lastIndex used to convert the array. * @param {Rotation} [result] The object into which to store the result. * @returns {Rotation} The modified result parameter or a new Rotation instance if one was not provided. */ diff --git a/packages/engine/Source/DataSources/SampledPositionProperty.js b/packages/engine/Source/DataSources/SampledPositionProperty.js index 58e9e48a49b8..001fba3465bc 100644 --- a/packages/engine/Source/DataSources/SampledPositionProperty.js +++ b/packages/engine/Source/DataSources/SampledPositionProperty.js @@ -16,7 +16,7 @@ import SampledProperty from "./SampledProperty.js"; * @constructor * * @param {ReferenceFrame} [referenceFrame=ReferenceFrame.FIXED] The reference frame in which the position is defined. - * @param {Number} [numberOfDerivatives=0] The number of derivatives that accompany each position; i.e. velocity, acceleration, etc... + * @param {number} [numberOfDerivatives=0] The number of derivatives that accompany each position; i.e. velocity, acceleration, etc... */ function SampledPositionProperty(referenceFrame, numberOfDerivatives) { numberOfDerivatives = defaultValue(numberOfDerivatives, 0); @@ -45,7 +45,7 @@ Object.defineProperties(SampledPositionProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof SampledPositionProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -82,7 +82,7 @@ Object.defineProperties(SampledPositionProperty.prototype, { * Gets the degree of interpolation to perform when retrieving a value. Call setInterpolationOptions to set this. * @memberof SampledPositionProperty.prototype * - * @type {Number} + * @type {number} * @default 1 * @readonly */ @@ -108,7 +108,7 @@ Object.defineProperties(SampledPositionProperty.prototype, { * The number of derivatives contained by this property; i.e. 0 for just position, 1 for velocity, etc. * @memberof SampledPositionProperty.prototype * - * @type {Number} + * @type {number} * @default 0 */ numberOfDerivatives: { @@ -135,7 +135,7 @@ Object.defineProperties(SampledPositionProperty.prototype, { * Gets or sets the amount of time to extrapolate forward before * the property becomes undefined. A value of 0 will extrapolate forever. * @memberof SampledPositionProperty.prototype - * @type {Number} + * @type {number} * @default 0 */ forwardExtrapolationDuration: { @@ -165,7 +165,7 @@ Object.defineProperties(SampledPositionProperty.prototype, { * Gets or sets the amount of time to extrapolate backward * before the property becomes undefined. A value of 0 will extrapolate forever. * @memberof SampledPositionProperty.prototype - * @type {Number} + * @type {number} * @default 0 */ backwardExtrapolationDuration: { @@ -223,9 +223,9 @@ SampledPositionProperty.prototype.getValueInReferenceFrame = function ( /** * Sets the algorithm and degree to use when interpolating a position. * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {InterpolationAlgorithm} [options.interpolationAlgorithm] The new interpolation algorithm. If undefined, the existing property will be unchanged. - * @param {Number} [options.interpolationDegree] The new interpolation degree. If undefined, the existing property will be unchanged. + * @param {number} [options.interpolationDegree] The new interpolation degree. If undefined, the existing property will be unchanged. */ SampledPositionProperty.prototype.setInterpolationOptions = function (options) { this._property.setInterpolationOptions(options); @@ -278,7 +278,7 @@ SampledPositionProperty.prototype.addSamples = function ( * Adds samples as a single packed array where each new sample is represented as a date, * followed by the packed representation of the corresponding value and derivatives. * - * @param {Number[]} packedSamples The array of packed samples. + * @param {number[]} packedSamples The array of packed samples. * @param {JulianDate} [epoch] If any of the dates in packedSamples are numbers, they are considered an offset from this epoch, in seconds. */ SampledPositionProperty.prototype.addSamplesPackedArray = function ( @@ -292,7 +292,7 @@ SampledPositionProperty.prototype.addSamplesPackedArray = function ( * Removes a sample at the given time, if present. * * @param {JulianDate} time The sample time. - * @returns {Boolean} true if a sample at time was removed, false otherwise. + * @returns {boolean} true if a sample at time was removed, false otherwise. */ SampledPositionProperty.prototype.removeSample = function (time) { return this._property.removeSample(time); @@ -312,7 +312,7 @@ SampledPositionProperty.prototype.removeSamples = function (timeInterval) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ SampledPositionProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/SampledProperty.js b/packages/engine/Source/DataSources/SampledProperty.js index 1f2604348c78..39248a3a39e3 100644 --- a/packages/engine/Source/DataSources/SampledProperty.js +++ b/packages/engine/Source/DataSources/SampledProperty.js @@ -118,7 +118,7 @@ function mergeNewSamples(epoch, times, values, newData, packedLength) { * @alias SampledProperty * @constructor * - * @param {Number|Packable} type The type of property. + * @param {number|Packable} type The type of property. * @param {Packable[]} [derivativeTypes] When supplied, indicates that samples will contain derivative information of the specified types. * * @@ -221,7 +221,7 @@ Object.defineProperties(SampledProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof SampledProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -266,7 +266,7 @@ Object.defineProperties(SampledProperty.prototype, { /** * Gets the degree of interpolation to perform when retrieving a value. * @memberof SampledProperty.prototype - * @type {Number} + * @type {number} * @default 1 */ interpolationDegree: { @@ -307,7 +307,7 @@ Object.defineProperties(SampledProperty.prototype, { * Gets or sets the amount of time to extrapolate forward before * the property becomes undefined. A value of 0 will extrapolate forever. * @memberof SampledProperty.prototype - * @type {Number} + * @type {number} * @default 0 */ forwardExtrapolationDuration: { @@ -343,7 +343,7 @@ Object.defineProperties(SampledProperty.prototype, { * Gets or sets the amount of time to extrapolate backward * before the property becomes undefined. A value of 0 will extrapolate forever. * @memberof SampledProperty.prototype - * @type {Number} + * @type {number} * @default 0 */ backwardExtrapolationDuration: { @@ -363,8 +363,8 @@ Object.defineProperties(SampledProperty.prototype, { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ SampledProperty.prototype.getValue = function (time, result) { //>>includeStart('debug', pragmas.debug); @@ -535,9 +535,9 @@ SampledProperty.prototype.getValue = function (time, result) { /** * Sets the algorithm and degree to use when interpolating a value. * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {InterpolationAlgorithm} [options.interpolationAlgorithm] The new interpolation algorithm. If undefined, the existing property will be unchanged. - * @param {Number} [options.interpolationDegree] The new interpolation degree. If undefined, the existing property will be unchanged. + * @param {number} [options.interpolationDegree] The new interpolation degree. If undefined, the existing property will be unchanged. */ SampledProperty.prototype.setInterpolationOptions = function (options) { if (!defined(options)) { @@ -676,7 +676,7 @@ SampledProperty.prototype.addSamples = function ( * Adds samples as a single packed array where each new sample is represented as a date, * followed by the packed representation of the corresponding value and derivatives. * - * @param {Number[]} packedSamples The array of packed samples. + * @param {number[]} packedSamples The array of packed samples. * @param {JulianDate} [epoch] If any of the dates in packedSamples are numbers, they are considered an offset from this epoch, in seconds. */ SampledProperty.prototype.addSamplesPackedArray = function ( @@ -702,7 +702,7 @@ SampledProperty.prototype.addSamplesPackedArray = function ( * Removes a sample at the given time, if present. * * @param {JulianDate} time The sample time. - * @returns {Boolean} true if a sample at time was removed, false otherwise. + * @returns {boolean} true if a sample at time was removed, false otherwise. */ SampledProperty.prototype.removeSample = function (time) { //>>includeStart('debug', pragmas.debug); @@ -760,7 +760,7 @@ SampledProperty.prototype.removeSamples = function (timeInterval) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ SampledProperty.prototype.equals = function (other) { if (this === other) { diff --git a/packages/engine/Source/DataSources/StripeMaterialProperty.js b/packages/engine/Source/DataSources/StripeMaterialProperty.js index 54d29125de10..c778483802a2 100644 --- a/packages/engine/Source/DataSources/StripeMaterialProperty.js +++ b/packages/engine/Source/DataSources/StripeMaterialProperty.js @@ -17,12 +17,12 @@ const defaultRepeat = 1; * @alias StripeMaterialProperty * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Property|StripeOrientation} [options.orientation=StripeOrientation.HORIZONTAL] A Property specifying the {@link StripeOrientation}. * @param {Property|Color} [options.evenColor=Color.WHITE] A Property specifying the first {@link Color}. * @param {Property|Color} [options.oddColor=Color.BLACK] A Property specifying the second {@link Color}. - * @param {Property|Number} [options.offset=0] A numeric Property specifying how far into the pattern to start the material. - * @param {Property|Number} [options.repeat=1] A numeric Property specifying how many times the stripes repeat. + * @param {Property|number} [options.offset=0] A numeric Property specifying how far into the pattern to start the material. + * @param {Property|number} [options.repeat=1] A numeric Property specifying how many times the stripes repeat. */ function StripeMaterialProperty(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -52,7 +52,7 @@ Object.defineProperties(StripeMaterialProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof StripeMaterialProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -129,7 +129,7 @@ Object.defineProperties(StripeMaterialProperty.prototype, { * Gets the {@link Material} type at the provided time. * * @param {JulianDate} time The time for which to retrieve the type. - * @returns {String} The type of material. + * @returns {string} The type of material. */ StripeMaterialProperty.prototype.getType = function (time) { return "Stripe"; @@ -139,8 +139,8 @@ StripeMaterialProperty.prototype.getType = function (time) { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ StripeMaterialProperty.prototype.getValue = function (time, result) { if (!defined(result)) { @@ -171,7 +171,7 @@ StripeMaterialProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ StripeMaterialProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/StripeOrientation.js b/packages/engine/Source/DataSources/StripeOrientation.js index 8b0588f4daed..5ad1b6369921 100644 --- a/packages/engine/Source/DataSources/StripeOrientation.js +++ b/packages/engine/Source/DataSources/StripeOrientation.js @@ -1,18 +1,18 @@ /** * Defined the orientation of stripes in {@link StripeMaterialProperty}. * - * @enum {Number} + * @enum {number} */ const StripeOrientation = { /** * Horizontal orientation. - * @type {Number} + * @type {number} */ HORIZONTAL: 0, /** * Vertical orientation. - * @type {Number} + * @type {number} */ VERTICAL: 1, }; diff --git a/packages/engine/Source/DataSources/TerrainOffsetProperty.js b/packages/engine/Source/DataSources/TerrainOffsetProperty.js index 85c107207793..17eab9c26406 100644 --- a/packages/engine/Source/DataSources/TerrainOffsetProperty.js +++ b/packages/engine/Source/DataSources/TerrainOffsetProperty.js @@ -84,7 +84,7 @@ Object.defineProperties(TerrainOffsetProperty.prototype, { * Gets a value indicating if this property is constant. * @memberof TerrainOffsetProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { diff --git a/packages/engine/Source/DataSources/TimeIntervalCollectionPositionProperty.js b/packages/engine/Source/DataSources/TimeIntervalCollectionPositionProperty.js index 1f41507af83f..9fd6a16a7a4a 100644 --- a/packages/engine/Source/DataSources/TimeIntervalCollectionPositionProperty.js +++ b/packages/engine/Source/DataSources/TimeIntervalCollectionPositionProperty.js @@ -31,7 +31,7 @@ Object.defineProperties(TimeIntervalCollectionPositionProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof TimeIntervalCollectionPositionProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -82,7 +82,7 @@ Object.defineProperties(TimeIntervalCollectionPositionProperty.prototype, { * Gets the value of the property at the provided time in the fixed frame. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. * @returns {Cartesian3 | undefined} The modified result parameter or a new instance if the result parameter was not supplied. */ TimeIntervalCollectionPositionProperty.prototype.getValue = function ( @@ -132,7 +132,7 @@ TimeIntervalCollectionPositionProperty.prototype.getValueInReferenceFrame = func * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ TimeIntervalCollectionPositionProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/TimeIntervalCollectionProperty.js b/packages/engine/Source/DataSources/TimeIntervalCollectionProperty.js index 06851a541d06..3c7f5a4b8f82 100644 --- a/packages/engine/Source/DataSources/TimeIntervalCollectionProperty.js +++ b/packages/engine/Source/DataSources/TimeIntervalCollectionProperty.js @@ -55,7 +55,7 @@ Object.defineProperties(TimeIntervalCollectionProperty.prototype, { * constant if getValue always returns the same result for the current definition. * @memberof TimeIntervalCollectionProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -95,8 +95,8 @@ Object.defineProperties(TimeIntervalCollectionProperty.prototype, { * Gets the value of the property at the provided time. * * @param {JulianDate} time The time for which to retrieve the value. - * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned. - * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied. + * @param {object} [result] The object to store the value into, if omitted, a new instance is created and returned. + * @returns {object} The modified result parameter or a new instance if the result parameter was not supplied. */ TimeIntervalCollectionProperty.prototype.getValue = function (time, result) { //>>includeStart('debug', pragmas.debug); @@ -117,7 +117,7 @@ TimeIntervalCollectionProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ TimeIntervalCollectionProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/VelocityOrientationProperty.js b/packages/engine/Source/DataSources/VelocityOrientationProperty.js index 1486c214c968..f6b2788542ba 100644 --- a/packages/engine/Source/DataSources/VelocityOrientationProperty.js +++ b/packages/engine/Source/DataSources/VelocityOrientationProperty.js @@ -47,7 +47,7 @@ Object.defineProperties(VelocityOrientationProperty.prototype, { * Gets a value indicating if this property is constant. * @memberof VelocityOrientationProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -137,7 +137,7 @@ VelocityOrientationProperty.prototype.getValue = function (time, result) { * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ VelocityOrientationProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/VelocityVectorProperty.js b/packages/engine/Source/DataSources/VelocityVectorProperty.js index ea547f9a2ef6..0184422ffd05 100644 --- a/packages/engine/Source/DataSources/VelocityVectorProperty.js +++ b/packages/engine/Source/DataSources/VelocityVectorProperty.js @@ -14,7 +14,7 @@ import Property from "./Property.js"; * @constructor * * @param {PositionProperty} [position] The position property used to compute the velocity. - * @param {Boolean} [normalize=true] Whether to normalize the computed velocity vector. + * @param {boolean} [normalize=true] Whether to normalize the computed velocity vector. * * @example * //Create an entity with a billboard rotated to match its velocity. @@ -42,7 +42,7 @@ Object.defineProperties(VelocityVectorProperty.prototype, { * Gets a value indicating if this property is constant. * @memberof VelocityVectorProperty.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ isConstant: { @@ -99,7 +99,7 @@ Object.defineProperties(VelocityVectorProperty.prototype, { * will be normalized or not. * @memberof VelocityVectorProperty.prototype * - * @type {Boolean} + * @type {boolean} */ normalize: { get: function () { @@ -204,7 +204,7 @@ VelocityVectorProperty.prototype._getValue = function ( * true if they are equal, false otherwise. * * @param {Property} [other] The other property. - * @returns {Boolean} true if left and right are equal, false otherwise. + * @returns {boolean} true if left and right are equal, false otherwise. */ VelocityVectorProperty.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/DataSources/Visualizer.js b/packages/engine/Source/DataSources/Visualizer.js index 5a64cf18c856..fc9331513f97 100644 --- a/packages/engine/Source/DataSources/Visualizer.js +++ b/packages/engine/Source/DataSources/Visualizer.js @@ -26,7 +26,7 @@ function Visualizer() { * * @param {JulianDate} time The time. * - * @returns {Boolean} True if the display was updated to the provided time, + * @returns {boolean} True if the display was updated to the provided time, * false if the visualizer is waiting for an asynchronous operation to * complete before data can be updated. */ @@ -49,7 +49,7 @@ Visualizer.prototype.getBoundingSphere = DeveloperError.throwInstantiationError; * Returns true if this object was destroyed; otherwise, false. * @function * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. */ Visualizer.prototype.isDestroyed = DeveloperError.throwInstantiationError; diff --git a/packages/engine/Source/DataSources/WallGraphics.js b/packages/engine/Source/DataSources/WallGraphics.js index 6e94982e4c70..05653c9225bf 100644 --- a/packages/engine/Source/DataSources/WallGraphics.js +++ b/packages/engine/Source/DataSources/WallGraphics.js @@ -6,14 +6,14 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor import createPropertyDescriptor from "./createPropertyDescriptor.js"; /** - * @typedef {Object} WallGraphics.ConstructorOptions + * @typedef {object} WallGraphics.ConstructorOptions * * Initialization options for the WallGraphics constructor * * @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the wall. - * @property {Property | Array} [positions] A Property specifying the array of {@link Cartesian3} positions which define the top of the wall. - * @property {Property | Array} [minimumHeights] A Property specifying an array of heights to be used for the bottom of the wall instead of the globe surface. - * @property {Property | Array} [maximumHeights] A Property specifying an array of heights to be used for the top of the wall instead of the height of each position. + * @property {Property | Cartesian3[]} [positions] A Property specifying the array of {@link Cartesian3} positions which define the top of the wall. + * @property {Property | number[]} [minimumHeights] A Property specifying an array of heights to be used for the bottom of the wall instead of the globe surface. + * @property {Property | number[]} [maximumHeights] A Property specifying an array of heights to be used for the top of the wall instead of the height of each position. * @property {Property | number} [granularity=Cesium.Math.RADIANS_PER_DEGREE] A numeric Property specifying the angular distance between each latitude and longitude point. * @property {Property | boolean} [fill=true] A boolean Property specifying whether the wall is filled with the provided material. * @property {MaterialProperty | Color} [material=Color.WHITE] A Property specifying the material used to fill the wall. diff --git a/packages/engine/Source/DataSources/exportKml.js b/packages/engine/Source/DataSources/exportKml.js index 2484f0c7dd49..9cfb3fa10a29 100644 --- a/packages/engine/Source/DataSources/exportKml.js +++ b/packages/engine/Source/DataSources/exportKml.js @@ -224,14 +224,14 @@ IdManager.prototype.get = function (id) { /** * @typedef exportKmlResultKml - * @type {Object} - * @property {String} kml The generated KML. - * @property {Object.} externalFiles An object dictionary of external files + * @type {object} + * @property {string} kml The generated KML. + * @property {Object} externalFiles An object dictionary of external files */ /** * @typedef exportKmlResultKmz - * @type {Object} + * @type {object} * @property {Blob} kmz The generated kmz file. */ @@ -247,14 +247,14 @@ IdManager.prototype.get = function (id) { * * @function exportKml * - * @param {Object} options An object with the following properties: + * @param {object} options An object with the following properties: * @param {EntityCollection} options.entities The EntityCollection to export as KML. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for the output file. * @param {exportKmlModelCallback} [options.modelCallback] A callback that will be called with a {@link ModelGraphics} instance and should return the URI to use in the KML. Required if a model exists in the entity collection. * @param {JulianDate} [options.time=entities.computeAvailability().start] The time value to use to get properties that are not time varying in KML. * @param {TimeInterval} [options.defaultAvailability=entities.computeAvailability()] The interval that will be sampled if an entity doesn't have an availability. - * @param {Number} [options.sampleDuration=60] The number of seconds to sample properties that are varying in KML. - * @param {Boolean} [options.kmz=false] If true KML and external files will be compressed into a kmz file. + * @param {number} [options.sampleDuration=60] The number of seconds to sample properties that are varying in KML. + * @param {boolean} [options.kmz=false] If true KML and external files will be compressed into a kmz file. * * @returns {Promise} A promise that resolved to an object containing the KML string and a dictionary of external file blobs, or a kmz file as a blob if options.kmz is true. * @demo {@link https://sandcastle.cesium.com/index.html?src=Export%20KML.html|Cesium Sandcastle KML Export Demo} @@ -1513,7 +1513,7 @@ function colorToString(color) { * * @param {ModelGraphics} model The ModelGraphics instance for an Entity. * @param {JulianDate} time The time that any properties should use to get the value. - * @param {Object} externalFiles An object that maps a filename to a Blob or a Promise that resolves to a Blob. - * @returns {String} The URL to use for the href in the KML document. + * @param {object} externalFiles An object that maps a filename to a Blob or a Promise that resolves to a Blob. + * @returns {string} The URL to use for the href in the KML document. */ export default exportKml; diff --git a/packages/engine/Source/Renderer/Buffer.js b/packages/engine/Source/Renderer/Buffer.js index 8b323f3fb5f4..641e8cc5c967 100644 --- a/packages/engine/Source/Renderer/Buffer.js +++ b/packages/engine/Source/Renderer/Buffer.js @@ -78,10 +78,10 @@ function Buffer(options) { * A vertex array defines the actual makeup of a vertex, e.g., positions, normals, texture coordinates, * etc., by interpreting the raw data in one or more vertex buffers. * - * @param {Object} options An object containing the following properties: + * @param {object} options An object containing the following properties: * @param {Context} options.context The context in which to create the buffer * @param {ArrayBufferView} [options.typedArray] A typed array containing the data to copy to the buffer. - * @param {Number} [options.sizeInBytes] A Number defining the size of the buffer in bytes. Required if options.typedArray is not given. + * @param {number} [options.sizeInBytes] A Number defining the size of the buffer in bytes. Required if options.typedArray is not given. * @param {BufferUsage} options.usage Specifies the expected usage pattern of the buffer. On some GL implementations, this can significantly affect performance. See {@link BufferUsage}. * @returns {VertexBuffer} The vertex buffer, ready to be attached to a vertex array. * @@ -133,10 +133,10 @@ Buffer.createVertexBuffer = function (options) { * Context.draw can render using the entire index buffer or a subset * of the index buffer defined by an offset and count. * - * @param {Object} options An object containing the following properties: + * @param {object} options An object containing the following properties: * @param {Context} options.context The context in which to create the buffer * @param {ArrayBufferView} [options.typedArray] A typed array containing the data to copy to the buffer. - * @param {Number} [options.sizeInBytes] A Number defining the size of the buffer in bytes. Required if options.typedArray is not given. + * @param {number} [options.sizeInBytes] A Number defining the size of the buffer in bytes. Required if options.typedArray is not given. * @param {BufferUsage} options.usage Specifies the expected usage pattern of the buffer. On some GL implementations, this can significantly affect performance. See {@link BufferUsage}. * @param {IndexDatatype} options.indexDatatype The datatype of indices in the buffer. * @returns {IndexBuffer} The index buffer, ready to be attached to a vertex array. diff --git a/packages/engine/Source/Renderer/ClearCommand.js b/packages/engine/Source/Renderer/ClearCommand.js index b2b23f86c905..696db4f2934f 100644 --- a/packages/engine/Source/Renderer/ClearCommand.js +++ b/packages/engine/Source/Renderer/ClearCommand.js @@ -22,7 +22,7 @@ function ClearCommand(options) { /** * The value to clear the depth buffer to. When undefined, the depth buffer is not cleared. * - * @type {Number} + * @type {number} * * @default undefined */ @@ -31,7 +31,7 @@ function ClearCommand(options) { /** * The value to clear the stencil buffer to. When undefined, the stencil buffer is not cleared. * - * @type {Number} + * @type {number} * * @default undefined */ @@ -63,7 +63,7 @@ function ClearCommand(options) { * reference to the command, and can be used to selectively execute commands * with {@link Scene#debugCommandFilter}. * - * @type {Object} + * @type {object} * * @default undefined * diff --git a/packages/engine/Source/Renderer/ComputeCommand.js b/packages/engine/Source/Renderer/ComputeCommand.js index abb9c71a9a5f..0979b648c908 100644 --- a/packages/engine/Source/Renderer/ComputeCommand.js +++ b/packages/engine/Source/Renderer/ComputeCommand.js @@ -38,7 +38,7 @@ function ComputeCommand(options) { * An object with functions whose names match the uniforms in the shader program * and return values to set those uniforms. * - * @type {Object} + * @type {object} * @default undefined */ this.uniformMap = options.uniformMap; @@ -81,7 +81,7 @@ function ComputeCommand(options) { * Whether the renderer resources will persist beyond this call. If not, they * will be destroyed after completion. * - * @type {Boolean} + * @type {boolean} * @default false */ this.persists = defaultValue(options.persists, false); @@ -100,7 +100,7 @@ function ComputeCommand(options) { * reference to the command, and can be used to selectively execute commands * with {@link Scene#debugCommandFilter}. * - * @type {Object} + * @type {object} * @default undefined * * @see Scene#debugCommandFilter diff --git a/packages/engine/Source/Renderer/Context.js b/packages/engine/Source/Renderer/Context.js index fea81d75c608..1d66504f495a 100644 --- a/packages/engine/Source/Renderer/Context.js +++ b/packages/engine/Source/Renderer/Context.js @@ -379,7 +379,7 @@ function Context(canvas, options) { * be stored globally, except they're tied to a particular context, and to manage * their lifetime. * - * @type {Object} + * @type {object} */ this.cache = {}; @@ -387,7 +387,7 @@ function Context(canvas, options) { } /** - * @typedef {Object} ContextOptions + * @typedef {object} ContextOptions * * Options to control the setting up of a WebGL Context. *

@@ -397,8 +397,8 @@ function Context(canvas, options) { * especially for horizon views. *

* - * @property {Boolean} [requestWebgl1=false] If true and the browser supports it, use a WebGL 1 rendering context - * @property {Boolean} [allowTextureFilterAnisotropic=true] If true, use anisotropic filtering during texture sampling + * @property {boolean} [requestWebgl1=false] If true and the browser supports it, use a WebGL 1 rendering context + * @property {boolean} [allowTextureFilterAnisotropic=true] If true, use anisotropic filtering during texture sampling * @property {WebGLOptions} [webgl] WebGL options to be passed on to canvas.getContext * @property {Function} [getWebGLStub] A function to create a WebGL stub for testing */ @@ -407,7 +407,7 @@ function Context(canvas, options) { * @private * @param {HTMLCanvasElement} canvas The canvas element to which the context will be associated * @param {WebGLOptions} webglOptions WebGL options to be passed on to HTMLCanvasElement.getContext() - * @param {Boolean} requestWebgl1 Whether to request a WebGLRenderingContext or a WebGL2RenderingContext. + * @param {boolean} requestWebgl1 Whether to request a WebGLRenderingContext or a WebGL2RenderingContext. * @returns {WebGLRenderingContext|WebGL2RenderingContext} */ function getWebGLContext(canvas, webglOptions, requestWebgl1) { @@ -436,7 +436,7 @@ function getWebGLContext(canvas, webglOptions, requestWebgl1) { } /** - * @typedef {Object} WebGLOptions + * @typedef {object} WebGLOptions * * WebGL options to be passed on to HTMLCanvasElement.getContext(). * See {@link https://registry.khronos.org/webgl/specs/latest/1.0/#5.2|WebGLContextAttributes} @@ -449,14 +449,14 @@ function getWebGLContext(canvas, webglOptions, requestWebgl1) { * alpha to true. *

* - * @property {Boolean} [alpha=false] - * @property {Boolean} [depth=true] - * @property {Boolean} [stencil=false] - * @property {Boolean} [antialias=true] - * @property {Boolean} [premultipliedAlpha=true] - * @property {Boolean} [preserveDrawingBuffer=false] + * @property {boolean} [alpha=false] + * @property {boolean} [depth=true] + * @property {boolean} [stencil=false] + * @property {boolean} [antialias=true] + * @property {boolean} [premultipliedAlpha=true] + * @property {boolean} [preserveDrawingBuffer=false] * @property {("default"|"low-power"|"high-performance")} [powerPreference="high-performance"] - * @property {Boolean} [failIfMajorPerformanceCaveat=false] + * @property {boolean} [failIfMajorPerformanceCaveat=false] */ function errorToString(gl, error) { @@ -608,7 +608,7 @@ Object.defineProperties(Context.prototype, { /** * The number of stencil bits per pixel in the default bound framebuffer. The minimum is eight bits. * @memberof Context.prototype - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with STENCIL_BITS. */ stencilBits: { @@ -621,7 +621,7 @@ Object.defineProperties(Context.prototype, { * true if the WebGL context supports stencil buffers. * Stencil buffers are not supported by all systems. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} */ stencilBuffer: { get: function () { @@ -633,7 +633,7 @@ Object.defineProperties(Context.prototype, { * true if the WebGL context supports antialiasing. By default * antialiasing is requested, but it is not supported by all systems. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} */ antialias: { get: function () { @@ -645,7 +645,7 @@ Object.defineProperties(Context.prototype, { * true if the WebGL context supports multisample antialiasing. Requires * WebGL2. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} */ msaa: { get: function () { @@ -659,7 +659,7 @@ Object.defineProperties(Context.prototype, { * functions from GLSL. A shader using these functions still needs to explicitly enable the * extension with #extension GL_OES_standard_derivatives : enable. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link http://www.khronos.org/registry/gles/extensions/OES/OES_standard_derivatives.txt|OES_standard_derivatives} */ standardDerivatives: { @@ -672,7 +672,7 @@ Object.defineProperties(Context.prototype, { * true if the EXT_float_blend extension is supported. This * extension enables blending with 32-bit float values. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/EXT_float_blend/} */ floatBlend: { @@ -686,7 +686,7 @@ Object.defineProperties(Context.prototype, { * extension extends blending capabilities by adding two new blend equations: * the minimum or maximum color components of the source and destination colors. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/EXT_blend_minmax/} */ blendMinmax: { @@ -700,7 +700,7 @@ Object.defineProperties(Context.prototype, { * extension allows the use of unsigned int indices, which can improve performance by * eliminating batch breaking caused by unsigned short indices. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link http://www.khronos.org/registry/webgl/extensions/OES_element_index_uint/|OES_element_index_uint} */ elementIndexUint: { @@ -713,7 +713,7 @@ Object.defineProperties(Context.prototype, { * true if WEBGL_depth_texture is supported. This extension provides * access to depth textures that, for example, can be attached to framebuffers for shadow mapping. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/|WEBGL_depth_texture} */ depthTexture: { @@ -726,7 +726,7 @@ Object.defineProperties(Context.prototype, { * true if OES_texture_float is supported. This extension provides * access to floating point textures that, for example, can be attached to framebuffers for high dynamic range. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/OES_texture_float/} */ floatingPointTexture: { @@ -739,7 +739,7 @@ Object.defineProperties(Context.prototype, { * true if OES_texture_half_float is supported. This extension provides * access to floating point textures that, for example, can be attached to framebuffers for high dynamic range. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/OES_texture_half_float/} */ halfFloatingPointTexture: { @@ -752,7 +752,7 @@ Object.defineProperties(Context.prototype, { * true if OES_texture_float_linear is supported. This extension provides * access to linear sampling methods for minification and magnification filters of floating-point textures. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/OES_texture_float_linear/} */ textureFloatLinear: { @@ -765,7 +765,7 @@ Object.defineProperties(Context.prototype, { * true if OES_texture_half_float_linear is supported. This extension provides * access to linear sampling methods for minification and magnification filters of half floating-point textures. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/OES_texture_half_float_linear/} */ textureHalfFloatLinear: { @@ -781,7 +781,7 @@ Object.defineProperties(Context.prototype, { * true if EXT_texture_filter_anisotropic is supported. This extension provides * access to anisotropic filtering for textured surfaces at an oblique angle from the viewer. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/EXT_texture_filter_anisotropic/} */ textureFilterAnisotropic: { @@ -794,7 +794,7 @@ Object.defineProperties(Context.prototype, { * true if WEBGL_compressed_texture_s3tc is supported. This extension provides * access to DXT compressed textures. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/WEBGL_compressed_texture_s3tc/} */ s3tc: { @@ -807,7 +807,7 @@ Object.defineProperties(Context.prototype, { * true if WEBGL_compressed_texture_pvrtc is supported. This extension provides * access to PVR compressed textures. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/WEBGL_compressed_texture_pvrtc/} */ pvrtc: { @@ -820,7 +820,7 @@ Object.defineProperties(Context.prototype, { * true if WEBGL_compressed_texture_astc is supported. This extension provides * access to ASTC compressed textures. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/WEBGL_compressed_texture_astc/} */ astc: { @@ -833,7 +833,7 @@ Object.defineProperties(Context.prototype, { * true if WEBGL_compressed_texture_etc is supported. This extension provides * access to ETC compressed textures. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/WEBGL_compressed_texture_etc/} */ etc: { @@ -846,7 +846,7 @@ Object.defineProperties(Context.prototype, { * true if WEBGL_compressed_texture_etc1 is supported. This extension provides * access to ETC1 compressed textures. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/WEBGL_compressed_texture_etc1/} */ etc1: { @@ -859,7 +859,7 @@ Object.defineProperties(Context.prototype, { * true if EXT_texture_compression_bptc is supported. This extension provides * access to BC7 compressed textures. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/EXT_texture_compression_bptc/} */ bc7: { @@ -871,7 +871,7 @@ Object.defineProperties(Context.prototype, { /** * true if S3TC, PVRTC, ASTC, ETC, ETC1, or BC7 compression is supported. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} */ supportsBasis: { get: function () { @@ -891,7 +891,7 @@ Object.defineProperties(Context.prototype, { * extension can improve performance by reducing the overhead of switching vertex arrays. * When enabled, this extension is automatically used by {@link VertexArray}. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link http://www.khronos.org/registry/webgl/extensions/OES_vertex_array_object/|OES_vertex_array_object} */ vertexArrayObject: { @@ -906,7 +906,7 @@ Object.defineProperties(Context.prototype, { * from GLSL fragment shaders. A shader using these functions still needs to explicitly enable the * extension with #extension GL_EXT_frag_depth : enable. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link http://www.khronos.org/registry/webgl/extensions/EXT_frag_depth/|EXT_frag_depth} */ fragmentDepth: { @@ -919,7 +919,7 @@ Object.defineProperties(Context.prototype, { * true if the ANGLE_instanced_arrays extension is supported. This * extension provides access to instanced rendering. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/ANGLE_instanced_arrays} */ instancedArrays: { @@ -932,7 +932,7 @@ Object.defineProperties(Context.prototype, { * true if the EXT_color_buffer_float extension is supported. This * extension makes the gl.RGBA32F format color renderable. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/WEBGL_color_buffer_float/} * @see {@link https://www.khronos.org/registry/webgl/extensions/EXT_color_buffer_float/} */ @@ -946,7 +946,7 @@ Object.defineProperties(Context.prototype, { * true if the EXT_color_buffer_half_float extension is supported. This * extension makes the format gl.RGBA16F format color renderable. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link https://www.khronos.org/registry/webgl/extensions/EXT_color_buffer_half_float/} * @see {@link https://www.khronos.org/registry/webgl/extensions/EXT_color_buffer_float/} */ @@ -966,7 +966,7 @@ Object.defineProperties(Context.prototype, { * A shader using this feature needs to explicitly enable the extension with * #extension GL_EXT_draw_buffers : enable. * @memberof Context.prototype - * @type {Boolean} + * @type {boolean} * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_draw_buffers/|WEBGL_draw_buffers} */ drawBuffers: { @@ -1106,7 +1106,7 @@ Object.defineProperties(Context.prototype, { /** * The drawingBufferHeight of the underlying GL context. * @memberof Context.prototype - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/registry/webgl/specs/1.0/#DOM-WebGLRenderingContext-drawingBufferHeight|drawingBufferHeight} */ drawingBufferHeight: { @@ -1118,7 +1118,7 @@ Object.defineProperties(Context.prototype, { /** * The drawingBufferWidth of the underlying GL context. * @memberof Context.prototype - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/registry/webgl/specs/1.0/#DOM-WebGLRenderingContext-drawingBufferWidth|drawingBufferWidth} */ drawingBufferWidth: { @@ -1132,7 +1132,7 @@ Object.defineProperties(Context.prototype, { * {@link Framebuffer}, it is used to represent the default framebuffer in calls to * {@link Texture.fromFramebuffer}. * @memberof Context.prototype - * @type {Object} + * @type {object} */ defaultFramebuffer: { get: function () { @@ -1536,7 +1536,7 @@ Context.prototype.createViewportQuadCommand = function ( * Gets the object associated with a pick color. * * @param {Color} pickColor The pick color. - * @returns {Object} The object associated with the pick color, or undefined if no object is associated with that color. + * @returns {object} The object associated with the pick color, or undefined if no object is associated with that color. * * @example * const object = context.getObjectByPickColor(pickColor); @@ -1578,8 +1578,8 @@ PickId.prototype.destroy = function () { * The ID has an RGBA color value unique to this context. You must call destroy() * on the pick ID when destroying the input object. * - * @param {Object} object The object to associate with the pick ID. - * @returns {Object} A PickId object with a color property. + * @param {object} object The object to associate with the pick ID. + * @returns {object} A PickId object with a color property. * * @exception {RuntimeError} Out of unique Pick IDs. * diff --git a/packages/engine/Source/Renderer/ContextLimits.js b/packages/engine/Source/Renderer/ContextLimits.js index 287f44e494b2..6bdb837cf60e 100644 --- a/packages/engine/Source/Renderer/ContextLimits.js +++ b/packages/engine/Source/Renderer/ContextLimits.js @@ -32,7 +32,7 @@ Object.defineProperties(ContextLimits, { * shader with this WebGL implementation. The minimum is eight. If both shaders access the * same texture unit, this counts as two texture units. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_COMBINED_TEXTURE_IMAGE_UNITS. */ maximumCombinedTextureImageUnits: { @@ -45,7 +45,7 @@ Object.defineProperties(ContextLimits, { * The approximate maximum cube mape width and height supported by this WebGL implementation. * The minimum is 16, but most desktop and laptop implementations will support much larger sizes like 8,192. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_CUBE_MAP_TEXTURE_SIZE. */ maximumCubeMapSize: { @@ -58,7 +58,7 @@ Object.defineProperties(ContextLimits, { * The maximum number of vec4, ivec4, and bvec4 * uniforms that can be used by a fragment shader with this WebGL implementation. The minimum is 16. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_FRAGMENT_UNIFORM_VECTORS. */ maximumFragmentUniformVectors: { @@ -70,7 +70,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum number of texture units that can be used from the fragment shader with this WebGL implementation. The minimum is eight. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_TEXTURE_IMAGE_UNITS. */ maximumTextureImageUnits: { @@ -83,7 +83,7 @@ Object.defineProperties(ContextLimits, { * The maximum renderbuffer width and height supported by this WebGL implementation. * The minimum is 16, but most desktop and laptop implementations will support much larger sizes like 8,192. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_RENDERBUFFER_SIZE. */ maximumRenderbufferSize: { @@ -96,7 +96,7 @@ Object.defineProperties(ContextLimits, { * The approximate maximum texture width and height supported by this WebGL implementation. * The minimum is 64, but most desktop and laptop implementations will support much larger sizes like 8,192. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_TEXTURE_SIZE. */ maximumTextureSize: { @@ -109,7 +109,7 @@ Object.defineProperties(ContextLimits, { * The maximum number of vec4 varying variables supported by this WebGL implementation. * The minimum is eight. Matrices and arrays count as multiple vec4s. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_VARYING_VECTORS. */ maximumVaryingVectors: { @@ -121,7 +121,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum number of vec4 vertex attributes supported by this WebGL implementation. The minimum is eight. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_VERTEX_ATTRIBS. */ maximumVertexAttributes: { @@ -134,7 +134,7 @@ Object.defineProperties(ContextLimits, { * The maximum number of texture units that can be used from the vertex shader with this WebGL implementation. * The minimum is zero, which means the GL does not support vertex texture fetch. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_VERTEX_TEXTURE_IMAGE_UNITS. */ maximumVertexTextureImageUnits: { @@ -147,7 +147,7 @@ Object.defineProperties(ContextLimits, { * The maximum number of vec4, ivec4, and bvec4 * uniforms that can be used by a vertex shader with this WebGL implementation. The minimum is 16. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_VERTEX_UNIFORM_VECTORS. */ maximumVertexUniformVectors: { @@ -159,7 +159,7 @@ Object.defineProperties(ContextLimits, { /** * The minimum aliased line width, in pixels, supported by this WebGL implementation. It will be at most one. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with ALIASED_LINE_WIDTH_RANGE. */ minimumAliasedLineWidth: { @@ -171,7 +171,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum aliased line width, in pixels, supported by this WebGL implementation. It will be at least one. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with ALIASED_LINE_WIDTH_RANGE. */ maximumAliasedLineWidth: { @@ -183,7 +183,7 @@ Object.defineProperties(ContextLimits, { /** * The minimum aliased point size, in pixels, supported by this WebGL implementation. It will be at most one. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with ALIASED_POINT_SIZE_RANGE. */ minimumAliasedPointSize: { @@ -195,7 +195,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum aliased point size, in pixels, supported by this WebGL implementation. It will be at least one. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with ALIASED_POINT_SIZE_RANGE. */ maximumAliasedPointSize: { @@ -207,7 +207,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum supported width of the viewport. It will be at least as large as the visible width of the associated canvas. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_VIEWPORT_DIMS. */ maximumViewportWidth: { @@ -219,7 +219,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum supported height of the viewport. It will be at least as large as the visible height of the associated canvas. * @memberof ContextLimits - * @type {Number} + * @type {number} * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with MAX_VIEWPORT_DIMS. */ maximumViewportHeight: { @@ -231,7 +231,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum degree of anisotropy for texture filtering * @memberof ContextLimits - * @type {Number} + * @type {number} */ maximumTextureFilterAnisotropy: { get: function () { @@ -242,7 +242,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum number of simultaneous outputs that may be written in a fragment shader. * @memberof ContextLimits - * @type {Number} + * @type {number} */ maximumDrawBuffers: { get: function () { @@ -253,7 +253,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum number of color attachments supported. * @memberof ContextLimits - * @type {Number} + * @type {number} */ maximumColorAttachments: { get: function () { @@ -264,7 +264,7 @@ Object.defineProperties(ContextLimits, { /** * The maximum number of samples supported for multisampling. * @memberof ContextLimits - * @type {Number} + * @type {number} */ maximumSamples: { get: function () { @@ -275,7 +275,7 @@ Object.defineProperties(ContextLimits, { /** * High precision float supported (highp) in fragment shaders. * @memberof ContextLimits - * @type {Boolean} + * @type {boolean} */ highpFloatSupported: { get: function () { @@ -286,7 +286,7 @@ Object.defineProperties(ContextLimits, { /** * High precision int supported (highp) in fragment shaders. * @memberof ContextLimits - * @type {Boolean} + * @type {boolean} */ highpIntSupported: { get: function () { diff --git a/packages/engine/Source/Renderer/CubeMapFace.js b/packages/engine/Source/Renderer/CubeMapFace.js index c3730d5bc23b..9f161b848764 100644 --- a/packages/engine/Source/Renderer/CubeMapFace.js +++ b/packages/engine/Source/Renderer/CubeMapFace.js @@ -54,12 +54,12 @@ Object.defineProperties(CubeMapFace.prototype, { /** * Copies texels from the source to the cubemap's face. - * @param {Object} options Object with the following properties: - * @param {Object} options.source The source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, {@link HTMLVideoElement}, + * @param {object} options Object with the following properties: + * @param {object} options.source The source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, {@link HTMLVideoElement}, * or an object with a width, height, and arrayBufferView properties. - * @param {Number} [options.xOffset=0] An offset in the x direction in the cubemap where copying begins. - * @param {Number} [options.yOffset=0] An offset in the y direction in the cubemap where copying begins. - * @param {Boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the texture will be ignored. + * @param {number} [options.xOffset=0] An offset in the x direction in the cubemap where copying begins. + * @param {number} [options.yOffset=0] An offset in the y direction in the cubemap where copying begins. + * @param {boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the texture will be ignored. * @exception {DeveloperError} xOffset must be greater than or equal to zero. * @exception {DeveloperError} yOffset must be greater than or equal to zero. * @exception {DeveloperError} xOffset + source.width must be less than or equal to width. @@ -268,12 +268,12 @@ CubeMapFace.prototype.copyFrom = function (options) { /** * Copies texels from the framebuffer to the cubemap's face. * - * @param {Number} [xOffset=0] An offset in the x direction in the cubemap where copying begins. - * @param {Number} [yOffset=0] An offset in the y direction in the cubemap where copying begins. - * @param {Number} [framebufferXOffset=0] An offset in the x direction in the framebuffer where copying begins from. - * @param {Number} [framebufferYOffset=0] An offset in the y direction in the framebuffer where copying begins from. - * @param {Number} [width=CubeMap's width] The width of the subimage to copy. - * @param {Number} [height=CubeMap's height] The height of the subimage to copy. + * @param {number} [xOffset=0] An offset in the x direction in the cubemap where copying begins. + * @param {number} [yOffset=0] An offset in the y direction in the cubemap where copying begins. + * @param {number} [framebufferXOffset=0] An offset in the x direction in the framebuffer where copying begins from. + * @param {number} [framebufferYOffset=0] An offset in the y direction in the framebuffer where copying begins from. + * @param {number} [width=CubeMap's width] The width of the subimage to copy. + * @param {number} [height=CubeMap's height] The height of the subimage to copy. * * @exception {DeveloperError} Cannot call copyFromFramebuffer when the texture pixel data type is FLOAT. * @exception {DeveloperError} Cannot call copyFromFramebuffer when the texture pixel data type is HALF_FLOAT. diff --git a/packages/engine/Source/Renderer/DrawCommand.js b/packages/engine/Source/Renderer/DrawCommand.js index 0ecb8b3b5836..14d75d5c7ee5 100644 --- a/packages/engine/Source/Renderer/DrawCommand.js +++ b/packages/engine/Source/Renderer/DrawCommand.js @@ -93,7 +93,7 @@ Object.defineProperties(DrawCommand.prototype, { *

* * @memberof DrawCommand.prototype - * @type {Object} + * @type {object} * @default undefined * * @see DrawCommand#debugShowBoundingVolume @@ -137,7 +137,7 @@ Object.defineProperties(DrawCommand.prototype, { * If the command was already culled, set this to false for a performance improvement. * * @memberof DrawCommand.prototype - * @type {Boolean} + * @type {boolean} * @default true */ cull: { @@ -157,7 +157,7 @@ Object.defineProperties(DrawCommand.prototype, { * {@link DrawCommand#cull} must also be true in order for the command to be culled. * * @memberof DrawCommand.prototype - * @type {Boolean} + * @type {boolean} * @default true */ occlude: { @@ -236,7 +236,7 @@ Object.defineProperties(DrawCommand.prototype, { * The number of vertices to draw in the vertex array. * * @memberof DrawCommand.prototype - * @type {Number} + * @type {number} * @default undefined */ count: { @@ -255,7 +255,7 @@ Object.defineProperties(DrawCommand.prototype, { * The offset to start drawing in the vertex array. * * @memberof DrawCommand.prototype - * @type {Number} + * @type {number} * @default 0 */ offset: { @@ -274,7 +274,7 @@ Object.defineProperties(DrawCommand.prototype, { * The number of instances to draw. * * @memberof DrawCommand.prototype - * @type {Number} + * @type {number} * @default 0 */ instanceCount: { @@ -312,7 +312,7 @@ Object.defineProperties(DrawCommand.prototype, { * Whether this command should cast shadows when shadowing is enabled. * * @memberof DrawCommand.prototype - * @type {Boolean} + * @type {boolean} * @default false */ castShadows: { @@ -331,7 +331,7 @@ Object.defineProperties(DrawCommand.prototype, { * Whether this command should receive shadows when shadowing is enabled. * * @memberof DrawCommand.prototype - * @type {Boolean} + * @type {boolean} * @default false */ receiveShadows: { @@ -351,7 +351,7 @@ Object.defineProperties(DrawCommand.prototype, { * and return values to set those uniforms. * * @memberof DrawCommand.prototype - * @type {Object} + * @type {object} * @default undefined */ uniformMap: { @@ -428,7 +428,7 @@ Object.defineProperties(DrawCommand.prototype, { * to the eye containing the bounding volume. Defaults to false. * * @memberof DrawCommand.prototype - * @type {Boolean} + * @type {boolean} * @default false */ executeInClosestFrustum: { @@ -450,7 +450,7 @@ Object.defineProperties(DrawCommand.prototype, { * with {@link Scene#debugCommandFilter}. * * @memberof DrawCommand.prototype - * @type {Object} + * @type {object} * @default undefined * * @see Scene#debugCommandFilter @@ -474,7 +474,7 @@ Object.defineProperties(DrawCommand.prototype, { *

* * @memberof DrawCommand.prototype - * @type {Boolean} + * @type {boolean} * @default false * * @see DrawCommand#boundingVolume @@ -511,7 +511,7 @@ Object.defineProperties(DrawCommand.prototype, { * during the pick pass. * * @memberof DrawCommand.prototype - * @type {String} + * @type {string} * @default undefined */ pickId: { @@ -529,7 +529,7 @@ Object.defineProperties(DrawCommand.prototype, { * Whether this command should be executed in the pick pass only. * * @memberof DrawCommand.prototype - * @type {Boolean} + * @type {boolean} * @default false */ pickOnly: { @@ -547,7 +547,7 @@ Object.defineProperties(DrawCommand.prototype, { * Whether this command should be derived to draw depth for classification of translucent primitives. * * @memberof DrawCommand.prototype - * @type {Boolean} + * @type {boolean} * @default false */ depthForTranslucentClassification: { diff --git a/packages/engine/Source/Renderer/Framebuffer.js b/packages/engine/Source/Renderer/Framebuffer.js index 61a1ef71fcf6..ad0caf4688b0 100644 --- a/packages/engine/Source/Renderer/Framebuffer.js +++ b/packages/engine/Source/Renderer/Framebuffer.js @@ -33,7 +33,7 @@ function attachRenderbuffer(framebuffer, attachment, renderbuffer) { * Framebuffers are used for render-to-texture effects; they allow us to render to * textures in one pass, and read from it in a later pass. * - * @param {Object} options The initial framebuffer attachments as shown in the example below. context is required. The possible properties are colorTextures, colorRenderbuffers, depthTexture, depthRenderbuffer, stencilRenderbuffer, depthStencilTexture, depthStencilRenderbuffer, and destroyAttachments. + * @param {object} options The initial framebuffer attachments as shown in the example below. context is required. The possible properties are colorTextures, colorRenderbuffers, depthTexture, depthRenderbuffer, stencilRenderbuffer, depthStencilTexture, depthStencilRenderbuffer, and destroyAttachments. * * @exception {DeveloperError} Cannot have both color texture and color renderbuffer attachments. * @exception {DeveloperError} Cannot have both a depth texture and depth renderbuffer attachment. @@ -101,7 +101,7 @@ function Framebuffer(options) { * {@link Framebuffer#destroy} is called or when a new attachment is assigned * to an attachment point. * - * @type {Boolean} + * @type {boolean} * @default true * * @see Framebuffer#destroy @@ -292,7 +292,7 @@ Object.defineProperties(Framebuffer.prototype, { * The status of the framebuffer. If the status is not WebGLConstants.FRAMEBUFFER_COMPLETE, * a {@link DeveloperError} will be thrown when attempting to render to the framebuffer. * @memberof Framebuffer.prototype - * @type {Number} + * @type {number} */ status: { get: function () { @@ -338,7 +338,7 @@ Object.defineProperties(Framebuffer.prototype, { * depth and depth-stencil textures, and depth and depth-stencil renderbuffers. When * rendering to a framebuffer, a depth attachment is required for the depth test to have effect. * @memberof Framebuffer.prototype - * @type {Boolean} + * @type {boolean} */ hasDepthAttachment: { get: function () { diff --git a/packages/engine/Source/Renderer/FramebufferManager.js b/packages/engine/Source/Renderer/FramebufferManager.js index 83d4a5d2b48f..5594895fa3db 100644 --- a/packages/engine/Source/Renderer/FramebufferManager.js +++ b/packages/engine/Source/Renderer/FramebufferManager.js @@ -13,15 +13,15 @@ import PixelFormat from "../Core/PixelFormat.js"; /** * Creates a wrapper object around a framebuffer and its resources. * - * @param {Object} options Object with the following properties: - * @param {Number} [options.numSamples=1] The multisampling rate of the render targets. Requires a WebGL2 context. - * @param {Number} [options.colorAttachmentsLength=1] The number of color attachments this FramebufferManager will create. - * @param {Boolean} [options.color=true] Whether the FramebufferManager will use color attachments. - * @param {Boolean} [options.depth=false] Whether the FramebufferManager will use depth attachments. - * @param {Boolean} [options.depthStencil=false] Whether the FramebufferManager will use depth-stencil attachments. - * @param {Boolean} [options.supportsDepthTexture=false] Whether the FramebufferManager will create a depth texture when the extension is supported. - * @param {Boolean} [options.createColorAttachments=true] Whether the FramebufferManager will construct its own color attachments. - * @param {Boolean} [options.createDepthAttachments=true] Whether the FramebufferManager will construct its own depth attachments. + * @param {object} options Object with the following properties: + * @param {number} [options.numSamples=1] The multisampling rate of the render targets. Requires a WebGL2 context. + * @param {number} [options.colorAttachmentsLength=1] The number of color attachments this FramebufferManager will create. + * @param {boolean} [options.color=true] Whether the FramebufferManager will use color attachments. + * @param {boolean} [options.depth=false] Whether the FramebufferManager will use depth attachments. + * @param {boolean} [options.depthStencil=false] Whether the FramebufferManager will use depth-stencil attachments. + * @param {boolean} [options.supportsDepthTexture=false] Whether the FramebufferManager will create a depth texture when the extension is supported. + * @param {boolean} [options.createColorAttachments=true] Whether the FramebufferManager will construct its own color attachments. + * @param {boolean} [options.createDepthAttachments=true] Whether the FramebufferManager will construct its own depth attachments. * @param {PixelDatatype} [options.pixelDatatype=undefined] The default pixel datatype to use when creating color attachments. * @param {PixelFormat} [options.pixelFormat=undefined] The default pixel format to use when creating color attachments. * diff --git a/packages/engine/Source/Renderer/MultisampleFramebuffer.js b/packages/engine/Source/Renderer/MultisampleFramebuffer.js index 9327cc49cc5e..183e1bf20a74 100644 --- a/packages/engine/Source/Renderer/MultisampleFramebuffer.js +++ b/packages/engine/Source/Renderer/MultisampleFramebuffer.js @@ -12,7 +12,7 @@ import Framebuffer from "./Framebuffer.js"; * second is bound to DRAW_FRAMEBUFFER during the blit, and has texture attachments * to store the copied pixels. * - * @param {Object} options The initial framebuffer attachments. context, width, and height are required. The possible properties are colorTextures, colorRenderbuffers, depthStencilTexture, depthStencilRenderbuffer, and destroyAttachments. + * @param {object} options The initial framebuffer attachments. context, width, and height are required. The possible properties are colorTextures, colorRenderbuffers, depthStencilTexture, depthStencilRenderbuffer, and destroyAttachments. * * @exception {DeveloperError} Both color renderbuffer and texture attachments must be provided. * @exception {DeveloperError} Both depth-stencil renderbuffer and texture attachments must be provided. diff --git a/packages/engine/Source/Renderer/PassState.js b/packages/engine/Source/Renderer/PassState.js index f634256ce14e..a0ec7e603412 100644 --- a/packages/engine/Source/Renderer/PassState.js +++ b/packages/engine/Source/Renderer/PassState.js @@ -30,7 +30,7 @@ function PassState(context) { * When this is undefined, the {@link DrawCommand}'s property is used. *

* - * @type {Boolean} + * @type {boolean} * @default undefined */ this.blendingEnabled = undefined; @@ -42,7 +42,7 @@ function PassState(context) { * When this is undefined, the {@link DrawCommand}'s property is used. *

* - * @type {Object} + * @type {object} * @default undefined */ this.scissorTest = undefined; diff --git a/packages/engine/Source/Renderer/PixelDatatype.js b/packages/engine/Source/Renderer/PixelDatatype.js index 4452a63fc8fd..e04330d36f9e 100644 --- a/packages/engine/Source/Renderer/PixelDatatype.js +++ b/packages/engine/Source/Renderer/PixelDatatype.js @@ -3,7 +3,7 @@ import WebGLConstants from "../Core/WebGLConstants.js"; /** * The data type of a pixel. * - * @enum {Number} + * @enum {number} * @see PostProcessStage */ const PixelDatatype = { diff --git a/packages/engine/Source/Renderer/RenderState.js b/packages/engine/Source/Renderer/RenderState.js index eabd07fa3936..e83838745c35 100644 --- a/packages/engine/Source/Renderer/RenderState.js +++ b/packages/engine/Source/Renderer/RenderState.js @@ -372,7 +372,7 @@ let renderStateCache = {}; * state for a {@link DrawCommand} or {@link ClearCommand}. All inputs states are optional. Omitted states * use the defaults shown in the example below. * - * @param {Object} [renderState] The states defining the render state as shown in the example below. + * @param {object} [renderState] The states defining the render state as shown in the example below. * * @exception {RuntimeError} renderState.lineWidth is out of range. * @exception {DeveloperError} Invalid renderState.frontFace. diff --git a/packages/engine/Source/Renderer/ShaderBuilder.js b/packages/engine/Source/Renderer/ShaderBuilder.js index ddf650988a7a..f6cc1b3c643d 100644 --- a/packages/engine/Source/Renderer/ShaderBuilder.js +++ b/packages/engine/Source/Renderer/ShaderBuilder.js @@ -92,7 +92,7 @@ Object.defineProperties(ShaderBuilder.prototype, { * the vertex shader. * * @memberof ShaderBuilder.prototype - * @type {Object.} + * @type {Object} * @readonly * @private */ @@ -107,8 +107,8 @@ Object.defineProperties(ShaderBuilder.prototype, { * Add a #define macro to one or both of the shaders. These lines * will appear at the top of the final shader source. * - * @param {String} identifier An identifier for the macro. Identifiers must use uppercase letters with underscores to be consistent with Cesium's style guide. - * @param {String} [value] The value of the macro. If undefined, the define will not include a value. The value will be converted to GLSL code via toString() + * @param {string} identifier An identifier for the macro. Identifiers must use uppercase letters with underscores to be consistent with Cesium's style guide. + * @param {string} [value] The value of the macro. If undefined, the define will not include a value. The value will be converted to GLSL code via toString() * @param {ShaderDestination} [destination=ShaderDestination.BOTH] Whether the define appears in the vertex shader, the fragment shader, or both. * * @example @@ -141,8 +141,8 @@ ShaderBuilder.prototype.addDefine = function (identifier, value, destination) { /** * Add a new dynamically-generated struct to the shader - * @param {String} structId A unique ID to identify this struct in {@link ShaderBuilder#addStructField} - * @param {String} structName The name of the struct as it will appear in the shader. + * @param {string} structId A unique ID to identify this struct in {@link ShaderBuilder#addStructField} + * @param {string} structName The name of the struct as it will appear in the shader. * @param {ShaderDestination} destination Whether the struct will appear in the vertex shader, the fragment shader, or both. * * @example @@ -174,9 +174,9 @@ ShaderBuilder.prototype.addStruct = function ( /** * Add a field to a dynamically-generated struct. - * @param {String} structId The ID of the struct. This must be created first with {@link ShaderBuilder#addStruct} - * @param {String} type The GLSL type of the field - * @param {String} identifier The identifier of the field. + * @param {string} structId The ID of the struct. This must be created first with {@link ShaderBuilder#addStruct} + * @param {string} type The GLSL type of the field + * @param {string} identifier The identifier of the field. * * @example * // generates the following struct in the fragment shader @@ -200,8 +200,8 @@ ShaderBuilder.prototype.addStructField = function (structId, type, identifier) { /** * Add a new dynamically-generated function to the shader. - * @param {String} functionName The name of the function. This will be used to identify the function in {@link ShaderBuilder#addFunctionLines}. - * @param {String} signature The full signature of the function as it will appear in the shader. Do not include the curly braces. + * @param {string} functionName The name of the function. This will be used to identify the function in {@link ShaderBuilder#addFunctionLines}. + * @param {string} signature The full signature of the function as it will appear in the shader. Do not include the curly braces. * @param {ShaderDestination} destination Whether the struct will appear in the vertex shader, the fragment shader, or both. * @example * // generates the following function in the vertex shader @@ -233,8 +233,8 @@ ShaderBuilder.prototype.addFunction = function ( /** * Add lines to a dynamically-generated function - * @param {String} functionName The name of the function. This must be created beforehand using {@link ShaderBuilder#addFunction} - * @param {String|String[]} lines One or more lines of GLSL code to add to the function body. Do not include any preceding or ending whitespace, but do include the semicolon for each line. + * @param {string} functionName The name of the function. This must be created beforehand using {@link ShaderBuilder#addFunction} + * @param {string|string[]} lines One or more lines of GLSL code to add to the function body. Do not include any preceding or ending whitespace, but do include the semicolon for each line. * * @example * // generates the following function in the vertex shader @@ -265,8 +265,8 @@ ShaderBuilder.prototype.addFunctionLines = function (functionName, lines) { * Add a uniform declaration to one or both of the shaders. These lines * will appear grouped near the top of the final shader source. * - * @param {String} type The GLSL type of the uniform. - * @param {String} identifier An identifier for the uniform. Identifiers must begin with u_ to be consistent with Cesium's style guide. + * @param {string} type The GLSL type of the uniform. + * @param {string} identifier An identifier for the uniform. Identifiers must begin with u_ to be consistent with Cesium's style guide. * @param {ShaderDestination} [destination=ShaderDestination.BOTH] Whether the uniform appears in the vertex shader, the fragment shader, or both. * * @example @@ -302,9 +302,9 @@ ShaderBuilder.prototype.addUniform = function (type, identifier, destination) { * {@link ShaderBuilder#addAttribute} *

* - * @param {String} type The GLSL type of the attribute - * @param {String} identifier An identifier for the attribute. Identifiers must begin with a_ to be consistent with Cesium's style guide. - * @return {Number} The integer location of the attribute. This location can be used when creating attributes for a {@link VertexArray}. This will always be 0. + * @param {string} type The GLSL type of the attribute + * @param {string} identifier An identifier for the attribute. Identifiers must begin with a_ to be consistent with Cesium's style guide. + * @return {number} The integer location of the attribute. This location can be used when creating attributes for a {@link VertexArray}. This will always be 0. * * @example * // creates the line "in vec3 a_position;" @@ -338,9 +338,9 @@ ShaderBuilder.prototype.setPositionAttribute = function (type, identifier) { * reserved for the position attribute. See {@link ShaderBuilder#setPositionAttribute} *

* - * @param {String} type The GLSL type of the attribute - * @param {String} identifier An identifier for the attribute. Identifiers must begin with a_ to be consistent with Cesium's style guide. - * @return {Number} The integer location of the attribute. This location can be used when creating attributes for a {@link VertexArray} + * @param {string} type The GLSL type of the attribute + * @param {string} identifier An identifier for the attribute. Identifiers must begin with a_ to be consistent with Cesium's style guide. + * @return {number} The integer location of the attribute. This location can be used when creating attributes for a {@link VertexArray} * * @example * // creates the line "in vec2 a_texCoord0;" in the vertex shader @@ -367,8 +367,8 @@ ShaderBuilder.prototype.addAttribute = function (type, identifier) { /** * Add a varying declaration to both the vertex and fragment shaders. * - * @param {String} type The GLSL type of the varying - * @param {String} identifier An identifier for the varying. Identifiers must begin with v_ to be consistent with Cesium's style guide. + * @param {string} type The GLSL type of the varying + * @param {string} identifier An identifier for the varying. Identifiers must begin with v_ to be consistent with Cesium's style guide. * * @example * // creates the line "in vec3 v_color;" in the vertex shader @@ -389,7 +389,7 @@ ShaderBuilder.prototype.addVarying = function (type, identifier) { /** * Appends lines of GLSL code to the vertex shader * - * @param {String|String[]} lines One or more lines to add to the end of the vertex shader source + * @param {string|string[]} lines One or more lines to add to the end of the vertex shader source * * @example * shaderBuilder.addVertexLines([ @@ -421,7 +421,7 @@ ShaderBuilder.prototype.addVertexLines = function (lines) { /** * Appends lines of GLSL code to the fragment shader * - * @param {String[]} lines The lines to add to the end of the fragment shader source + * @param {string[]} lines The lines to add to the end of the fragment shader source * * @example * shaderBuilder.addFragmentLines([ diff --git a/packages/engine/Source/Renderer/ShaderCache.js b/packages/engine/Source/Renderer/ShaderCache.js index b7addaf09d69..95268dd6b8b3 100644 --- a/packages/engine/Source/Renderer/ShaderCache.js +++ b/packages/engine/Source/Renderer/ShaderCache.js @@ -29,11 +29,11 @@ Object.defineProperties(ShaderCache.prototype, { * replace an existing reference to a shader program, which is passed as the first argument. *

* - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {ShaderProgram} [options.shaderProgram] The shader program that is being reassigned. - * @param {String|ShaderSource} options.vertexShaderSource The GLSL source for the vertex shader. - * @param {String|ShaderSource} options.fragmentShaderSource The GLSL source for the fragment shader. - * @param {Object} options.attributeLocations Indices for the attribute inputs to the vertex shader. + * @param {string|ShaderSource} options.vertexShaderSource The GLSL source for the vertex shader. + * @param {string|ShaderSource} options.fragmentShaderSource The GLSL source for the fragment shader. + * @param {object} options.attributeLocations Indices for the attribute inputs to the vertex shader. * @returns {ShaderProgram} The cached or newly created shader program. * @@ -65,10 +65,10 @@ function toSortedJson(dictionary) { * Returns a shader program from the cache, or creates and caches a new shader program, * given the GLSL vertex and fragment shader source and attribute locations. * - * @param {Object} options Object with the following properties: - * @param {String|ShaderSource} options.vertexShaderSource The GLSL source for the vertex shader. - * @param {String|ShaderSource} options.fragmentShaderSource The GLSL source for the fragment shader. - * @param {Object} options.attributeLocations Indices for the attribute inputs to the vertex shader. + * @param {object} options Object with the following properties: + * @param {string|ShaderSource} options.vertexShaderSource The GLSL source for the vertex shader. + * @param {string|ShaderSource} options.fragmentShaderSource The GLSL source for the fragment shader. + * @param {object} options.attributeLocations Indices for the attribute inputs to the vertex shader. * * @returns {ShaderProgram} The cached or newly created shader program. */ diff --git a/packages/engine/Source/Renderer/ShaderDestination.js b/packages/engine/Source/Renderer/ShaderDestination.js index bcc4b2385791..eb3a9af3c318 100644 --- a/packages/engine/Source/Renderer/ShaderDestination.js +++ b/packages/engine/Source/Renderer/ShaderDestination.js @@ -16,7 +16,7 @@ const ShaderDestination = { * Check if a variable should be included in the vertex shader. * * @param {ShaderDestination} destination The ShaderDestination to check - * @return {Boolean} true if the variable appears in the vertex shader, or false otherwise + * @return {boolean} true if the variable appears in the vertex shader, or false otherwise * @private */ ShaderDestination.includesVertexShader = function (destination) { @@ -34,7 +34,7 @@ ShaderDestination.includesVertexShader = function (destination) { * Check if a variable should be included in the vertex shader. * * @param {ShaderDestination} destination The ShaderDestination to check - * @return {Boolean} true if the variable appears in the vertex shader, or false otherwise + * @return {boolean} true if the variable appears in the vertex shader, or false otherwise * @private */ ShaderDestination.includesFragmentShader = function (destination) { diff --git a/packages/engine/Source/Renderer/ShaderFunction.js b/packages/engine/Source/Renderer/ShaderFunction.js index 4f84cf513886..3da6656486ee 100644 --- a/packages/engine/Source/Renderer/ShaderFunction.js +++ b/packages/engine/Source/Renderer/ShaderFunction.js @@ -7,7 +7,7 @@ import DeveloperError from "../Core/DeveloperError.js"; * @constructor * * @see {@link ShaderBuilder} - * @param {String} signature The full signature of the function as it will appear in the shader. Do not include the curly braces. + * @param {string} signature The full signature of the function as it will appear in the shader. Do not include the curly braces. * @example * // generate the following function * // @@ -31,7 +31,7 @@ function ShaderFunction(signature) { /** * Adds one or more lines to the body of the function - * @param {String|String[]} lines One or more lines of GLSL code to add to the function body. Do not include any preceding or ending whitespace, but do include the semicolon for each line. + * @param {string|string[]} lines One or more lines of GLSL code to add to the function body. Do not include any preceding or ending whitespace, but do include the semicolon for each line. */ ShaderFunction.prototype.addLines = function (lines) { //>>includeStart('debug', pragmas.debug); @@ -57,7 +57,7 @@ ShaderFunction.prototype.addLines = function (lines) { /** * Generate lines of GLSL code for use with {@link ShaderBuilder} - * @return {String[]} + * @return {string[]} */ ShaderFunction.prototype.generateGlslLines = function () { return [].concat(this.signature, "{", this.body, "}"); diff --git a/packages/engine/Source/Renderer/ShaderSource.js b/packages/engine/Source/Renderer/ShaderSource.js index 493aa622920f..66d253e19ef5 100644 --- a/packages/engine/Source/Renderer/ShaderSource.js +++ b/packages/engine/Source/Renderer/ShaderSource.js @@ -304,11 +304,11 @@ function combineShader(shaderSource, isFragmentShader, context) { /** * An object containing various inputs that will be combined to form a final GLSL shader string. * - * @param {Object} [options] Object with the following properties: - * @param {String[]} [options.sources] An array of strings to combine containing GLSL code for the shader. - * @param {String[]} [options.defines] An array of strings containing GLSL identifiers to #define. - * @param {String} [options.pickColorQualifier] The GLSL qualifier, uniform or in, for the input czm_pickColor. When defined, a pick fragment shader is generated. - * @param {Boolean} [options.includeBuiltIns=true] If true, referenced built-in functions will be included with the combined shader. Set to false if this shader will become a source in another shader, to avoid duplicating functions. + * @param {object} [options] Object with the following properties: + * @param {string[]} [options.sources] An array of strings to combine containing GLSL code for the shader. + * @param {string[]} [options.defines] An array of strings containing GLSL identifiers to #define. + * @param {string} [options.pickColorQualifier] The GLSL qualifier, uniform or in, for the input czm_pickColor. When defined, a pick fragment shader is generated. + * @param {boolean} [options.includeBuiltIns=true] If true, referenced built-in functions will be included with the combined shader. Set to false if this shader will become a source in another shader, to avoid duplicating functions. * * @exception {DeveloperError} options.pickColorQualifier must be 'uniform' or 'in'. * @@ -368,7 +368,7 @@ ShaderSource.replaceMain = function (source, renamedMain) { * {@link ShaderSource#createCombinedFragmentShader} are both expensive to * compute, create a simpler string key for lookups in the {@link ShaderCache}. * - * @returns {String} A key for identifying this shader + * @returns {string} A key for identifying this shader * * @private */ @@ -388,7 +388,7 @@ ShaderSource.prototype.getCacheKey = function () { * * @param {Context} context The current rendering context * - * @returns {String} The combined shader string. + * @returns {string} The combined shader string. */ ShaderSource.prototype.createCombinedVertexShader = function (context) { return combineShader(this, false, context); @@ -399,7 +399,7 @@ ShaderSource.prototype.createCombinedVertexShader = function (context) { * * @param {Context} context The current rendering context * - * @returns {String} The combined shader string. + * @returns {string} The combined shader string. */ ShaderSource.prototype.createCombinedFragmentShader = function (context) { return combineShader(this, true, context); diff --git a/packages/engine/Source/Renderer/ShaderStruct.js b/packages/engine/Source/Renderer/ShaderStruct.js index 9b2a2c7c1faa..c65c4983cd26 100644 --- a/packages/engine/Source/Renderer/ShaderStruct.js +++ b/packages/engine/Source/Renderer/ShaderStruct.js @@ -5,7 +5,7 @@ * @constructor * * @see {@link ShaderBuilder} - * @param {String} name The name of the struct as it will appear in the shader. + * @param {string} name The name of the struct as it will appear in the shader. * @example * // Generate the struct: * // @@ -30,8 +30,8 @@ function ShaderStruct(name) { /** * Add a field to the struct - * @param {String} type The type of the struct field - * @param {String} identifier The identifier of the struct field + * @param {string} type The type of the struct field + * @param {string} identifier The identifier of the struct field */ ShaderStruct.prototype.addField = function (type, identifier) { const field = ` ${type} ${identifier};`; @@ -40,7 +40,7 @@ ShaderStruct.prototype.addField = function (type, identifier) { /** * Generate a list of lines of GLSL code for use with {@link ShaderBuilder} - * @return {String[]} The generated GLSL code. + * @return {string[]} The generated GLSL code. */ ShaderStruct.prototype.generateGlslLines = function () { let fields = this.fields; diff --git a/packages/engine/Source/Renderer/Texture.js b/packages/engine/Source/Renderer/Texture.js index e75a25274caa..1f157e74ce1c 100644 --- a/packages/engine/Source/Renderer/Texture.js +++ b/packages/engine/Source/Renderer/Texture.js @@ -411,13 +411,13 @@ Texture.create = function (options) { * Creates a texture, and copies a subimage of the framebuffer to it. When called without arguments, * the texture is the same width and height as the framebuffer and contains its contents. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Context} options.context The context in which the Texture gets created. * @param {PixelFormat} [options.pixelFormat=PixelFormat.RGB] The texture's internal pixel format. - * @param {Number} [options.framebufferXOffset=0] An offset in the x direction in the framebuffer where copying begins from. - * @param {Number} [options.framebufferYOffset=0] An offset in the y direction in the framebuffer where copying begins from. - * @param {Number} [options.width=canvas.clientWidth] The width of the texture in texels. - * @param {Number} [options.height=canvas.clientHeight] The height of the texture in texels. + * @param {number} [options.framebufferXOffset=0] An offset in the x direction in the framebuffer where copying begins from. + * @param {number} [options.framebufferYOffset=0] An offset in the y direction in the framebuffer where copying begins from. + * @param {number} [options.width=canvas.clientWidth] The width of the texture in texels. + * @param {number} [options.height=canvas.clientHeight] The height of the texture in texels. * @param {Framebuffer} [options.framebuffer=defaultFramebuffer] The framebuffer from which to create the texture. If this * parameter is not specified, the default framebuffer is used. * @returns {Texture} A texture with contents from the framebuffer. @@ -515,7 +515,7 @@ Object.defineProperties(Texture.prototype, { /** * A unique id for the texture * @memberof Texture.prototype - * @type {String} + * @type {string} * @readonly * @private */ @@ -531,7 +531,7 @@ Object.defineProperties(Texture.prototype, { * coordinates in both directions, uses linear filtering for both magnification and minification, * and uses a maximum anisotropy of 1.0. * @memberof Texture.prototype - * @type {Object} + * @type {object} */ sampler: { get: function () { @@ -648,12 +648,12 @@ Object.defineProperties(Texture.prototype, { /** * Copy new image data into this texture, from a source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, or {@link HTMLVideoElement}. * or an object with width, height, and arrayBufferView properties. - * @param {Object} options Object with the following properties: - * @param {Object} options.source The source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, or {@link HTMLVideoElement}, + * @param {object} options Object with the following properties: + * @param {object} options.source The source {@link ImageData}, {@link HTMLImageElement}, {@link HTMLCanvasElement}, or {@link HTMLVideoElement}, * or an object with width, height, and arrayBufferView properties. - * @param {Number} [options.xOffset=0] The offset in the x direction within the texture to copy into. - * @param {Number} [options.yOffset=0] The offset in the y direction within the texture to copy into. - * @param {Boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the texture will be ignored. + * @param {number} [options.xOffset=0] The offset in the x direction within the texture to copy into. + * @param {number} [options.yOffset=0] The offset in the y direction within the texture to copy into. + * @param {boolean} [options.skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the texture will be ignored. * * @exception {DeveloperError} Cannot call copyFrom when the texture pixel format is DEPTH_COMPONENT or DEPTH_STENCIL. * @exception {DeveloperError} Cannot call copyFrom with a compressed texture pixel format. @@ -872,12 +872,12 @@ Texture.prototype.copyFrom = function (options) { }; /** - * @param {Number} [xOffset=0] The offset in the x direction within the texture to copy into. - * @param {Number} [yOffset=0] The offset in the y direction within the texture to copy into. - * @param {Number} [framebufferXOffset=0] optional - * @param {Number} [framebufferYOffset=0] optional - * @param {Number} [width=width] optional - * @param {Number} [height=height] optional + * @param {number} [xOffset=0] The offset in the x direction within the texture to copy into. + * @param {number} [yOffset=0] The offset in the y direction within the texture to copy into. + * @param {number} [framebufferXOffset=0] optional + * @param {number} [framebufferYOffset=0] optional + * @param {number} [width=width] optional + * @param {number} [height=height] optional * * @exception {DeveloperError} Cannot call copyFromFramebuffer when the texture pixel format is DEPTH_COMPONENT or DEPTH_STENCIL. * @exception {DeveloperError} Cannot call copyFromFramebuffer when the texture pixel data type is FLOAT. diff --git a/packages/engine/Source/Renderer/TextureMagnificationFilter.js b/packages/engine/Source/Renderer/TextureMagnificationFilter.js index d432fe405703..3dfc3589def4 100644 --- a/packages/engine/Source/Renderer/TextureMagnificationFilter.js +++ b/packages/engine/Source/Renderer/TextureMagnificationFilter.js @@ -3,7 +3,7 @@ import WebGLConstants from "../Core/WebGLConstants.js"; /** * Enumerates all possible filters used when magnifying WebGL textures. * - * @enum {Number} + * @enum {number} * * @see TextureMinificationFilter */ @@ -11,14 +11,14 @@ const TextureMagnificationFilter = { /** * Samples the texture by returning the closest pixel. * - * @type {Number} + * @type {number} * @constant */ NEAREST: WebGLConstants.NEAREST, /** * Samples the texture through bi-linear interpolation of the four nearest pixels. This produces smoother results than NEAREST filtering. * - * @type {Number} + * @type {number} * @constant */ LINEAR: WebGLConstants.LINEAR, @@ -27,7 +27,7 @@ const TextureMagnificationFilter = { /** * Validates the given textureMinificationFilter with respect to the possible enum values. * @param textureMagnificationFilter - * @returns {Boolean} true if textureMagnificationFilter is valid. + * @returns {boolean} true if textureMagnificationFilter is valid. * * @private */ diff --git a/packages/engine/Source/Renderer/TextureMinificationFilter.js b/packages/engine/Source/Renderer/TextureMinificationFilter.js index ddab3b091f17..9c881d206668 100644 --- a/packages/engine/Source/Renderer/TextureMinificationFilter.js +++ b/packages/engine/Source/Renderer/TextureMinificationFilter.js @@ -3,7 +3,7 @@ import WebGLConstants from "../Core/WebGLConstants.js"; /** * Enumerates all possible filters used when minifying WebGL textures. * - * @enum {Number} + * @enum {number} * * @see TextureMagnificationFilter */ @@ -11,14 +11,14 @@ const TextureMinificationFilter = { /** * Samples the texture by returning the closest pixel. * - * @type {Number} + * @type {number} * @constant */ NEAREST: WebGLConstants.NEAREST, /** * Samples the texture through bi-linear interpolation of the four nearest pixels. This produces smoother results than NEAREST filtering. * - * @type {Number} + * @type {number} * @constant */ LINEAR: WebGLConstants.LINEAR, @@ -28,7 +28,7 @@ const TextureMinificationFilter = { * Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture. *

* - * @type {Number} + * @type {number} * @constant */ NEAREST_MIPMAP_NEAREST: WebGLConstants.NEAREST_MIPMAP_NEAREST, @@ -38,7 +38,7 @@ const TextureMinificationFilter = { * Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture. *

* - * @type {Number} + * @type {number} * @constant */ LINEAR_MIPMAP_NEAREST: WebGLConstants.LINEAR_MIPMAP_NEAREST, @@ -51,7 +51,7 @@ const TextureMinificationFilter = { * Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture. *

* - * @type {Number} + * @type {number} * @constant */ NEAREST_MIPMAP_LINEAR: WebGLConstants.NEAREST_MIPMAP_LINEAR, @@ -63,7 +63,7 @@ const TextureMinificationFilter = { *

* Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture. *

- * @type {Number} + * @type {number} * @constant */ LINEAR_MIPMAP_LINEAR: WebGLConstants.LINEAR_MIPMAP_LINEAR, @@ -75,7 +75,7 @@ const TextureMinificationFilter = { * @private * * @param textureMinificationFilter - * @returns {Boolean} true if textureMinificationFilter is valid. + * @returns {boolean} true if textureMinificationFilter is valid. */ TextureMinificationFilter.validate = function (textureMinificationFilter) { return ( diff --git a/packages/engine/Source/Renderer/UniformState.js b/packages/engine/Source/Renderer/UniformState.js index ea292e6cece7..75e55c25da01 100644 --- a/packages/engine/Source/Renderer/UniformState.js +++ b/packages/engine/Source/Renderer/UniformState.js @@ -27,7 +27,7 @@ function UniformState() { */ this.globeDepthTexture = undefined; /** - * @type {Number} + * @type {number} */ this.gamma = undefined; @@ -640,7 +640,7 @@ Object.defineProperties(UniformState.prototype, { * The far plane's distance from the near plane, plus 1.0. * * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ farDepthFromNearPlusOne: { get: function () { @@ -652,7 +652,7 @@ Object.defineProperties(UniformState.prototype, { * The log2 of {@link UniformState#farDepthFromNearPlusOne}. * * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ log2FarDepthFromNearPlusOne: { get: function () { @@ -664,7 +664,7 @@ Object.defineProperties(UniformState.prototype, { * 1.0 divided by {@link UniformState#log2FarDepthFromNearPlusOne}. * * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ oneOverLog2FarDepthFromNearPlusOne: { get: function () { @@ -675,7 +675,7 @@ Object.defineProperties(UniformState.prototype, { /** * The height in meters of the eye (camera) above or below the ellipsoid. * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ eyeHeight: { get: function () { @@ -846,7 +846,7 @@ Object.defineProperties(UniformState.prototype, { * Gets the scaling factor for transforming from the canvas * pixel space to canvas coordinate space. * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ pixelRatio: { get: function () { @@ -857,7 +857,7 @@ Object.defineProperties(UniformState.prototype, { /** * A scalar used to mix a color with the fog color based on the distance to the camera. * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ fogDensity: { get: function () { @@ -868,7 +868,7 @@ Object.defineProperties(UniformState.prototype, { /** * A scalar that represents the geometric tolerance per meter * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ geometricToleranceOverMeter: { get: function () { @@ -955,7 +955,7 @@ Object.defineProperties(UniformState.prototype, { /** * The maximum level-of-detail of the specular environment map atlas of the scene. * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ specularEnvironmentMapsMaximumLOD: { get: function () { @@ -966,7 +966,7 @@ Object.defineProperties(UniformState.prototype, { /** * The splitter position to use when rendering with a splitter. This will be in pixel coordinates relative to the canvas. * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ splitPosition: { get: function () { @@ -980,7 +980,7 @@ Object.defineProperties(UniformState.prototype, { * be applied. When less than zero, the depth test should never be applied. * * @memberof UniformState.prototype - * @type {Number} + * @type {number} */ minimumDisableDepthTestDistance: { get: function () { @@ -1004,7 +1004,7 @@ Object.defineProperties(UniformState.prototype, { * Whether or not the current projection is orthographic in 3D. * * @memberOf UniformState.prototype - * @type {Boolean} + * @type {boolean} */ orthographicIn3D: { get: function () { @@ -1135,7 +1135,7 @@ function setSunAndMoonDirections(uniformState, frameState) { * by the {@link Scene} when rendering to ensure that automatic GLSL uniforms * are set to the right value. * - * @param {Object} camera The camera to synchronize with. + * @param {object} camera The camera to synchronize with. */ UniformState.prototype.updateCamera = function (camera) { setView(this, camera.viewMatrix); @@ -1156,7 +1156,7 @@ UniformState.prototype.updateCamera = function (camera) { * by the {@link Scene} when rendering to ensure that automatic GLSL uniforms * are set to the right value. * - * @param {Object} frustum The frustum to synchronize with. + * @param {object} frustum The frustum to synchronize with. */ UniformState.prototype.updateFrustum = function (frustum) { setProjection(this, frustum.projectionMatrix); diff --git a/packages/engine/Source/Renderer/VertexArray.js b/packages/engine/Source/Renderer/VertexArray.js index 3241144a490f..ed35bd1b76c2 100644 --- a/packages/engine/Source/Renderer/VertexArray.js +++ b/packages/engine/Source/Renderer/VertexArray.js @@ -178,7 +178,7 @@ function bind(gl, attributes, indexBuffer) { * Creates a vertex array, which defines the attributes making up a vertex, and contains an optional index buffer * to select vertices for rendering. Attributes are defined using object literals as shown in Example 1 below. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Context} options.context The context in which the VertexArray gets created. * @param {Object[]} options.attributes An array of attributes. * @param {IndexBuffer} [options.indexBuffer] An optional index buffer. @@ -531,7 +531,7 @@ function interleaveAttributes(attributes) { *
* If options is not specified or the geometry contains no data, the returned vertex array is empty. * - * @param {Object} options An object defining the geometry, attribute indices, buffer usage, and vertex layout used to create the vertex array. + * @param {object} options An object defining the geometry, attribute indices, buffer usage, and vertex layout used to create the vertex array. * * @exception {RuntimeError} Each attribute list must have the same number of vertices. * @exception {DeveloperError} The geometry must have zero or one index lists. diff --git a/packages/engine/Source/Renderer/createUniform.js b/packages/engine/Source/Renderer/createUniform.js index 55f43cd1ff1b..ccf68c1981f1 100644 --- a/packages/engine/Source/Renderer/createUniform.js +++ b/packages/engine/Source/Renderer/createUniform.js @@ -57,7 +57,7 @@ function createUniform(gl, activeUniform, uniformName, location) { */ function UniformFloat(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -84,7 +84,7 @@ UniformFloat.prototype.set = function () { */ function UniformFloatVec2(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -112,7 +112,7 @@ UniformFloatVec2.prototype.set = function () { */ function UniformFloatVec3(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -152,7 +152,7 @@ UniformFloatVec3.prototype.set = function () { */ function UniformFloatVec4(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -192,7 +192,7 @@ UniformFloatVec4.prototype.set = function () { */ function UniformSampler(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -227,7 +227,7 @@ UniformSampler.prototype._setSampler = function (textureUnitIndex) { */ function UniformInt(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -253,7 +253,7 @@ UniformInt.prototype.set = function () { */ function UniformIntVec2(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -280,7 +280,7 @@ UniformIntVec2.prototype.set = function () { */ function UniformIntVec3(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -307,7 +307,7 @@ UniformIntVec3.prototype.set = function () { */ function UniformIntVec4(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -336,7 +336,7 @@ const scratchUniformArray = new Float32Array(4); */ function UniformMat2(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -366,7 +366,7 @@ const scratchMat3Array = new Float32Array(9); */ function UniformMat3(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -396,7 +396,7 @@ const scratchMat4Array = new Float32Array(16); */ function UniformMat4(gl, activeUniform, uniformName, location) { /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; diff --git a/packages/engine/Source/Renderer/createUniformArray.js b/packages/engine/Source/Renderer/createUniformArray.js index 8028c8370895..0c9268a1d7b5 100644 --- a/packages/engine/Source/Renderer/createUniformArray.js +++ b/packages/engine/Source/Renderer/createUniformArray.js @@ -74,7 +74,7 @@ function UniformArrayFloat(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -116,7 +116,7 @@ function UniformArrayFloatVec2(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -160,7 +160,7 @@ function UniformArrayFloatVec3(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -222,7 +222,7 @@ function UniformArrayFloatVec4(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -289,7 +289,7 @@ function UniformArraySampler(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -339,7 +339,7 @@ function UniformArrayInt(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -381,7 +381,7 @@ function UniformArrayIntVec2(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -425,7 +425,7 @@ function UniformArrayIntVec3(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -469,7 +469,7 @@ function UniformArrayIntVec4(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -513,7 +513,7 @@ function UniformArrayMat2(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -557,7 +557,7 @@ function UniformArrayMat3(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; @@ -601,7 +601,7 @@ function UniformArrayMat4(gl, activeUniform, uniformName, locations) { const length = locations.length; /** - * @type {String} + * @type {string} * @readonly */ this.name = uniformName; diff --git a/packages/engine/Source/Renderer/freezeRenderState.js b/packages/engine/Source/Renderer/freezeRenderState.js index 02c31607405a..253be6539ffe 100644 --- a/packages/engine/Source/Renderer/freezeRenderState.js +++ b/packages/engine/Source/Renderer/freezeRenderState.js @@ -4,8 +4,8 @@ * * @private * - * @param {Object} renderState - * @returns {Object} Returns frozen renderState. + * @param {object} renderState + * @returns {object} Returns frozen renderState. * */ function freezeRenderState(renderState) { diff --git a/packages/engine/Source/Renderer/loadCubeMap.js b/packages/engine/Source/Renderer/loadCubeMap.js index 018bf9c96270..992d4fc80972 100644 --- a/packages/engine/Source/Renderer/loadCubeMap.js +++ b/packages/engine/Source/Renderer/loadCubeMap.js @@ -11,9 +11,9 @@ import CubeMap from "./CubeMap.js"; * @function loadCubeMap * * @param {Context} context The context to use to create the cube map. - * @param {Object} urls The source URL of each image. See the example below. - * @param {Boolean} [skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the images will be ignored. - * @returns {Promise.} a promise that will resolve to the requested {@link CubeMap} when loaded. + * @param {object} urls The source URL of each image. See the example below. + * @param {boolean} [skipColorSpaceConversion=false] If true, any custom gamma or color profiles in the images will be ignored. + * @returns {Promise} a promise that will resolve to the requested {@link CubeMap} when loaded. * * @exception {DeveloperError} context is required. * @exception {DeveloperError} urls is required and must have positiveX, negativeX, positiveY, negativeY, positiveZ, and negativeZ properties. diff --git a/packages/engine/Source/Scene/AlphaMode.js b/packages/engine/Source/Scene/AlphaMode.js index 959ab42abd98..56f3bce645d8 100644 --- a/packages/engine/Source/Scene/AlphaMode.js +++ b/packages/engine/Source/Scene/AlphaMode.js @@ -1,14 +1,14 @@ /** * The alpha rendering mode of the material. * - * @enum {String} + * @enum {string} * @private */ const AlphaMode = { /** * The alpha value is ignored and the rendered output is fully opaque. * - * @type {String} + * @type {string} * @constant */ OPAQUE: "OPAQUE", @@ -16,7 +16,7 @@ const AlphaMode = { /** * The rendered output is either fully opaque or fully transparent depending on the alpha value and the specified alpha cutoff value. * - * @type {String} + * @type {string} * @constant */ MASK: "MASK", @@ -24,7 +24,7 @@ const AlphaMode = { /** * The rendered output is composited onto the destination with alpha blending. * - * @type {String} + * @type {string} * @constant */ BLEND: "BLEND", diff --git a/packages/engine/Source/Scene/Appearance.js b/packages/engine/Source/Scene/Appearance.js index 07f4aa3680e3..597e89308fd9 100644 --- a/packages/engine/Source/Scene/Appearance.js +++ b/packages/engine/Source/Scene/Appearance.js @@ -13,13 +13,13 @@ import CullFace from "./CullFace.js"; * @alias Appearance * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link Appearance#renderState} has alpha blending enabled. - * @param {Boolean} [options.closed=false] When true, the geometry is expected to be closed so {@link Appearance#renderState} has backface culling enabled. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link Appearance#renderState} has alpha blending enabled. + * @param {boolean} [options.closed=false] When true, the geometry is expected to be closed so {@link Appearance#renderState} has backface culling enabled. * @param {Material} [options.material=Material.ColorType] The material used to determine the fragment color. - * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. - * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. - * @param {Object} [options.renderState] Optional render state to override the default render state. + * @param {string} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. + * @param {string} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. + * @param {object} [options.renderState] Optional render state to override the default render state. * * @see MaterialAppearance * @see EllipsoidSurfaceAppearance @@ -46,7 +46,7 @@ function Appearance(options) { /** * When true, the geometry is expected to appear translucent. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -64,7 +64,7 @@ Object.defineProperties(Appearance.prototype, { * * @memberof Appearance.prototype * - * @type {String} + * @type {string} * @readonly */ vertexShaderSource: { @@ -80,7 +80,7 @@ Object.defineProperties(Appearance.prototype, { * * @memberof Appearance.prototype * - * @type {String} + * @type {string} * @readonly */ fragmentShaderSource: { @@ -94,7 +94,7 @@ Object.defineProperties(Appearance.prototype, { * * @memberof Appearance.prototype * - * @type {Object} + * @type {object} * @readonly */ renderState: { @@ -108,7 +108,7 @@ Object.defineProperties(Appearance.prototype, { * * @memberof Appearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -124,7 +124,7 @@ Object.defineProperties(Appearance.prototype, { * Procedurally creates the full GLSL fragment shader source for this appearance * taking into account {@link Appearance#fragmentShaderSource} and {@link Appearance#material}. * - * @returns {String} The full GLSL fragment shader source. + * @returns {string} The full GLSL fragment shader source. */ Appearance.prototype.getFragmentShaderSource = function () { const parts = []; @@ -145,7 +145,7 @@ Appearance.prototype.getFragmentShaderSource = function () { /** * Determines if the geometry is translucent based on {@link Appearance#translucent} and {@link Material#isTranslucent}. * - * @returns {Boolean} true if the appearance is translucent. + * @returns {boolean} true if the appearance is translucent. */ Appearance.prototype.isTranslucent = function () { return ( @@ -159,7 +159,7 @@ Appearance.prototype.isTranslucent = function () { * it can contain a subset of render state properties identical to the render state * created in the context. * - * @returns {Object} The render state. + * @returns {object} The render state. */ Appearance.prototype.getRenderState = function () { const translucent = this.isTranslucent(); diff --git a/packages/engine/Source/Scene/ArcGisMapServerImageryProvider.js b/packages/engine/Source/Scene/ArcGisMapServerImageryProvider.js index 3c9af4d7afcf..8646d48e7a40 100644 --- a/packages/engine/Source/Scene/ArcGisMapServerImageryProvider.js +++ b/packages/engine/Source/Scene/ArcGisMapServerImageryProvider.js @@ -20,12 +20,12 @@ import ImageryLayerFeatureInfo from "./ImageryLayerFeatureInfo.js"; import ImageryProvider from "./ImageryProvider.js"; /** - * @typedef {Object} ArcGisMapServerImageryProvider.ConstructorOptions + * @typedef {object} ArcGisMapServerImageryProvider.ConstructorOptions * * Initialization options for the ArcGisMapServerImageryProvider constructor * - * @property {Resource|String} url The URL of the ArcGIS MapServer service. - * @property {String} [token] The ArcGIS token used to authenticate with the ArcGIS MapServer service. + * @property {Resource|string} url The URL of the ArcGIS MapServer service. + * @property {string} [token] The ArcGIS token used to authenticate with the ArcGIS MapServer service. * @property {TileDiscardPolicy} [tileDiscardPolicy] The policy that determines if a tile * is invalid and should be discarded. If this value is not specified, a default * {@link DiscardMissingTileImagePolicy} is used for tiled map servers, and a @@ -37,11 +37,11 @@ import ImageryProvider from "./ImageryProvider.js"; * these defaults should be correct tile discarding for a standard ArcGIS Server. To ensure * that no tiles are discarded, construct and pass a {@link NeverTileDiscardPolicy} for this * parameter. - * @property {Boolean} [usePreCachedTilesIfAvailable=true] If true, the server's pre-cached + * @property {boolean} [usePreCachedTilesIfAvailable=true] If true, the server's pre-cached * tiles are used if they are available. If false, any pre-cached tiles are ignored and the * 'export' service is used. - * @property {String} [layers] A comma-separated list of the layers to show, or undefined if all layers should be shown. - * @property {Boolean} [enablePickFeatures=true] If true, {@link ArcGisMapServerImageryProvider#pickFeatures} will invoke + * @property {string} [layers] A comma-separated list of the layers to show, or undefined if all layers should be shown. + * @property {boolean} [enablePickFeatures=true] If true, {@link ArcGisMapServerImageryProvider#pickFeatures} will invoke * the Identify service on the MapServer and return the features included in the response. If false, * {@link ArcGisMapServerImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable features) * without communicating with the server. Set this property to false if you don't want this provider's features to @@ -53,10 +53,10 @@ import ImageryProvider from "./ImageryProvider.js"; * @property {Ellipsoid} [ellipsoid] The ellipsoid. If the tilingScheme is specified and used, * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither * parameter is specified, the WGS84 ellipsoid is used. - * @property {Credit|String} [credit] A credit for the data source, which is displayed on the canvas. This parameter is ignored when accessing a tiled server. - * @property {Number} [tileWidth=256] The width of each tile in pixels. This parameter is ignored when accessing a tiled server. - * @property {Number} [tileHeight=256] The height of each tile in pixels. This parameter is ignored when accessing a tiled server. - * @property {Number} [maximumLevel] The maximum tile level to request, or undefined if there is no maximum. This parameter is ignored when accessing + * @property {Credit|string} [credit] A credit for the data source, which is displayed on the canvas. This parameter is ignored when accessing a tiled server. + * @property {number} [tileWidth=256] The width of each tile in pixels. This parameter is ignored when accessing a tiled server. + * @property {number} [tileHeight=256] The height of each tile in pixels. This parameter is ignored when accessing a tiled server. + * @property {number} [maximumLevel] The maximum tile level to request, or undefined if there is no maximum. This parameter is ignored when accessing * a tiled server. */ @@ -100,7 +100,7 @@ function ArcGisMapServerImageryProvider(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; @@ -109,7 +109,7 @@ function ArcGisMapServerImageryProvider(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; @@ -118,7 +118,7 @@ function ArcGisMapServerImageryProvider(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; @@ -127,7 +127,7 @@ function ArcGisMapServerImageryProvider(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; @@ -136,7 +136,7 @@ function ArcGisMapServerImageryProvider(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; @@ -144,7 +144,7 @@ function ArcGisMapServerImageryProvider(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; @@ -153,7 +153,7 @@ function ArcGisMapServerImageryProvider(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; @@ -161,7 +161,7 @@ function ArcGisMapServerImageryProvider(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; @@ -219,7 +219,7 @@ function ArcGisMapServerImageryProvider(options) { * invoke the "identify" operation on the ArcGIS server and return the features included in the response. If false, * {@link ArcGisMapServerImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable features) * without communicating with the server. - * @type {Boolean} + * @type {boolean} * @default true */ this.enablePickFeatures = defaultValue(options.enablePickFeatures, true); @@ -448,7 +448,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { /** * Gets the URL of the ArcGIS MapServer. * @memberof ArcGisMapServerImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -460,7 +460,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { /** * Gets the ArcGIS token used to authenticate with the ArcGis MapServer service. * @memberof ArcGisMapServerImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ token: { @@ -485,7 +485,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link ArcGisMapServerImageryProvider#ready} returns true. * @memberof ArcGisMapServerImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -506,7 +506,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link ArcGisMapServerImageryProvider#ready} returns true. * @memberof ArcGisMapServerImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -527,7 +527,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link ArcGisMapServerImageryProvider#ready} returns true. * @memberof ArcGisMapServerImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -548,7 +548,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { * Gets the minimum level-of-detail that can be requested. This function should * not be called before {@link ArcGisMapServerImageryProvider#ready} returns true. * @memberof ArcGisMapServerImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -647,7 +647,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof ArcGisMapServerImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -659,7 +659,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof ArcGisMapServerImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -688,7 +688,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { * not have pre-cached tiles. * @memberof ArcGisMapServerImageryProvider.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * @default true */ @@ -706,7 +706,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { * and texture upload time are reduced. * @memberof ArcGisMapServerImageryProvider.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * @default true */ @@ -720,7 +720,7 @@ Object.defineProperties(ArcGisMapServerImageryProvider.prototype, { * Gets the comma-separated list of layer IDs to show. * @memberof ArcGisMapServerImageryProvider.prototype * - * @type {String} + * @type {string} */ layers: { get: function () { @@ -732,9 +732,9 @@ Object.defineProperties(ArcGisMapServerImageryProvider.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} getTileCredits must not be called before the imagery provider is ready. @@ -751,11 +751,11 @@ ArcGisMapServerImageryProvider.prototype.getTileCredits = function ( * Requests the image for a given tile. This function should * not be called before {@link ArcGisMapServerImageryProvider#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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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} requestImage must not be called before the imagery provider is ready. @@ -785,12 +785,12 @@ ArcGisMapServerImageryProvider.prototype.requestImage = function ( * Asynchronously determines what features, if any, are located at a given longitude and latitude within * a tile. This function should not be called before {@link ImageryProvider#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} longitude The longitude at which to pick features. - * @param {Number} latitude The latitude at which to pick features. - * @return {Promise.|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|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. * diff --git a/packages/engine/Source/Scene/AttributeType.js b/packages/engine/Source/Scene/AttributeType.js index 0cb63d6f8c9f..5ba4d4f2e5c7 100644 --- a/packages/engine/Source/Scene/AttributeType.js +++ b/packages/engine/Source/Scene/AttributeType.js @@ -10,7 +10,7 @@ import Matrix4 from "../Core/Matrix4.js"; /** * An enum describing the attribute type for glTF and 3D Tiles. * - * @enum {String} + * @enum {string} * * @private */ @@ -18,7 +18,7 @@ const AttributeType = { /** * The attribute is a single component. * - * @type {String} + * @type {string} * @constant */ SCALAR: "SCALAR", @@ -26,7 +26,7 @@ const AttributeType = { /** * The attribute is a two-component vector. * - * @type {String} + * @type {string} * @constant */ VEC2: "VEC2", @@ -34,7 +34,7 @@ const AttributeType = { /** * The attribute is a three-component vector. * - * @type {String} + * @type {string} * @constant */ VEC3: "VEC3", @@ -42,7 +42,7 @@ const AttributeType = { /** * The attribute is a four-component vector. * - * @type {String} + * @type {string} * @constant */ VEC4: "VEC4", @@ -50,7 +50,7 @@ const AttributeType = { /** * The attribute is a 2x2 matrix. * - * @type {String} + * @type {string} * @constant */ MAT2: "MAT2", @@ -58,7 +58,7 @@ const AttributeType = { /** * The attribute is a 3x3 matrix. * - * @type {String} + * @type {string} * @constant */ MAT3: "MAT3", @@ -66,7 +66,7 @@ const AttributeType = { /** * The attribute is a 4x4 matrix. * - * @type {String} + * @type {string} * @constant */ MAT4: "MAT4", @@ -107,7 +107,7 @@ AttributeType.getMathType = function (attributeType) { * Gets the number of components per attribute. * * @param {AttributeType} attributeType The attribute type. - * @returns {Number} The number of components. + * @returns {number} The number of components. * * @private */ @@ -138,7 +138,7 @@ AttributeType.getNumberOfComponents = function (attributeType) { * types require one, but matrices require multiple attribute locations. * * @param {AttributeType} attributeType The attribute type. - * @returns {Number} The number of attribute locations needed in the shader + * @returns {number} The number of attribute locations needed in the shader * * @private */ @@ -166,7 +166,7 @@ AttributeType.getAttributeLocationCount = function (attributeType) { * Gets the GLSL type for the attribute type. * * @param {AttributeType} attributeType The attribute type. - * @returns {String} The GLSL type for the attribute type. + * @returns {string} The GLSL type for the attribute type. * * @private */ diff --git a/packages/engine/Source/Scene/AutoExposure.js b/packages/engine/Source/Scene/AutoExposure.js index 7c0968b99e2a..7d7e08f3d606 100644 --- a/packages/engine/Source/Scene/AutoExposure.js +++ b/packages/engine/Source/Scene/AutoExposure.js @@ -39,7 +39,7 @@ function AutoExposure() { /** * Whether or not to execute this post-process stage when ready. * - * @type {Boolean} + * @type {boolean} */ this.enabled = true; this._enabled = true; @@ -47,7 +47,7 @@ function AutoExposure() { /** * The minimum value used to clamp the luminance. * - * @type {Number} + * @type {number} * @default 0.1 */ this.minimumLuminance = 0.1; @@ -55,7 +55,7 @@ function AutoExposure() { /** * The maximum value used to clamp the luminance. * - * @type {Number} + * @type {number} * @default 10.0 */ this.maximumLuminance = 10.0; @@ -68,7 +68,7 @@ Object.defineProperties(AutoExposure.prototype, { * to load. * * @memberof AutoExposure.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -80,7 +80,7 @@ Object.defineProperties(AutoExposure.prototype, { * The unique name of this post-process stage for reference by other stages. * * @memberof AutoExposure.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -358,7 +358,7 @@ AutoExposure.prototype.execute = function (context, colorTexture) { * isDestroyed 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. * * @see AutoExposure#destroy */ diff --git a/packages/engine/Source/Scene/Axis.js b/packages/engine/Source/Scene/Axis.js index 2ea92c1bd995..04b763122aff 100644 --- a/packages/engine/Source/Scene/Axis.js +++ b/packages/engine/Source/Scene/Axis.js @@ -6,13 +6,13 @@ import Matrix4 from "../Core/Matrix4.js"; /** * An enum describing the x, y, and z axes and helper conversion functions. * - * @enum {Number} + * @enum {number} */ const Axis = { /** * Denotes the x-axis. * - * @type {Number} + * @type {number} * @constant */ X: 0, @@ -20,7 +20,7 @@ const Axis = { /** * Denotes the y-axis. * - * @type {Number} + * @type {number} * @constant */ Y: 1, @@ -28,7 +28,7 @@ const Axis = { /** * Denotes the z-axis. * - * @type {Number} + * @type {number} * @constant */ Z: 2, @@ -97,8 +97,8 @@ Axis.Y_UP_TO_X_UP = Matrix4.fromRotationTranslation( /** * Gets the axis by name * - * @param {String} name The name of the axis. - * @returns {Number} The axis enum. + * @param {string} name The name of the axis. + * @returns {number} The axis enum. */ Axis.fromName = function (name) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Scene/B3dmParser.js b/packages/engine/Source/Scene/B3dmParser.js index 84cde3f39c52..6d06e6161538 100644 --- a/packages/engine/Source/Scene/B3dmParser.js +++ b/packages/engine/Source/Scene/B3dmParser.js @@ -21,8 +21,8 @@ const sizeOfUint32 = Uint32Array.BYTES_PER_ELEMENT; * @private * * @param {ArrayBuffer} arrayBuffer The array buffer containing the b3dm. - * @param {Number} [byteOffset=0] The byte offset of the beginning of the b3dm in the array buffer. - * @returns {Object} Returns an object with the batch length, feature table (binary and json), batch table (binary and json) and glTF parts of the b3dm. + * @param {number} [byteOffset=0] The byte offset of the beginning of the b3dm in the array buffer. + * @returns {object} Returns an object with the batch length, feature table (binary and json), batch table (binary and json) and glTF parts of the b3dm. */ B3dmParser.parse = function (arrayBuffer, byteOffset) { const byteStart = defaultValue(byteOffset, 0); diff --git a/packages/engine/Source/Scene/BatchTable.js b/packages/engine/Source/Scene/BatchTable.js index 3efa78ae3c15..a24e541c86e8 100644 --- a/packages/engine/Source/Scene/BatchTable.js +++ b/packages/engine/Source/Scene/BatchTable.js @@ -22,7 +22,7 @@ import Texture from "../Renderer/Texture.js"; * @param {Context} context The context in which the batch table is created. * @param {Object[]} attributes An array of objects describing a per instance attribute. Each object contains a datatype, components per attributes, whether it is normalized and a function name * to retrieve the value in the vertex shader. - * @param {Number} numberOfInstances The number of instances in a batch table. + * @param {number} numberOfInstances The number of instances in a batch table. * * @example * // create the batch table @@ -142,7 +142,7 @@ Object.defineProperties(BatchTable.prototype, { /** * The number of instances. * @memberOf BatchTable.prototype - * @type {Number} + * @type {number} * @readonly */ numberOfInstances: { @@ -247,10 +247,10 @@ const scratchGetAttributeCartesian4 = new Cartesian4(); /** * Gets the value of an attribute in the table. * - * @param {Number} instanceIndex The index of the instance. - * @param {Number} attributeIndex The index of the attribute. + * @param {number} instanceIndex The index of the instance. + * @param {number} attributeIndex The index of the attribute. * @param {undefined|Cartesian2|Cartesian3|Cartesian4} [result] The object onto which to store the result. The type is dependent on the attribute's number of components. - * @returns {Number|Cartesian2|Cartesian3|Cartesian4} The attribute value stored for the instance. + * @returns {number|Cartesian2|Cartesian3|Cartesian4} The attribute value stored for the instance. * * @exception {DeveloperError} instanceIndex is out of range. * @exception {DeveloperError} attributeIndex is out of range. @@ -315,9 +315,9 @@ const setAttributeScratchCartesian4 = new Cartesian4(); /** * Sets the value of an attribute in the table. * - * @param {Number} instanceIndex The index of the instance. - * @param {Number} attributeIndex The index of the attribute. - * @param {Number|Cartesian2|Cartesian3|Cartesian4} value The value to be stored in the table. The type of value will depend on the number of components of the attribute. + * @param {number} instanceIndex The index of the instance. + * @param {number} attributeIndex The index of the attribute. + * @param {number|Cartesian2|Cartesian3|Cartesian4} value The value to be stored in the table. The type of value will depend on the number of components of the attribute. * * @exception {DeveloperError} instanceIndex is out of range. * @exception {DeveloperError} attributeIndex is out of range. @@ -593,7 +593,7 @@ BatchTable.prototype.getVertexShaderCallback = function () { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see BatchTable#destroy */ @@ -622,15 +622,15 @@ BatchTable.prototype.destroy = function () { * A callback for updating uniform maps. * @callback BatchTable.updateUniformMapCallback * - * @param {Object} uniformMap The uniform map. - * @returns {Object} The new uniform map with properties for retrieving values from the batch table. + * @param {object} uniformMap The uniform map. + * @returns {object} The new uniform map with properties for retrieving values from the batch table. */ /** * A callback for updating a vertex shader source. * @callback BatchTable.updateVertexShaderSourceCallback * - * @param {String} vertexShaderSource The vertex shader source. - * @returns {String} The new vertex shader source with the functions for retrieving batch table values injected. + * @param {string} vertexShaderSource The vertex shader source. + * @returns {string} The new vertex shader source with the functions for retrieving batch table values injected. */ export default BatchTable; diff --git a/packages/engine/Source/Scene/BatchTableHierarchy.js b/packages/engine/Source/Scene/BatchTableHierarchy.js index 802ee6b5a954..4c1b2c4f1d90 100644 --- a/packages/engine/Source/Scene/BatchTableHierarchy.js +++ b/packages/engine/Source/Scene/BatchTableHierarchy.js @@ -12,8 +12,8 @@ import RuntimeError from "../Core/RuntimeError.js"; /** * Object for handling the 3DTILES_batch_table_hierarchy extension * - * @param {Object} options Object with the following properties: - * @param {Object} options.extension The 3DTILES_batch_table_hierarchy extension object. + * @param {object} options Object with the following properties: + * @param {object} options.extension The 3DTILES_batch_table_hierarchy extension object. * @param {Uint8Array} [options.binaryBody] The binary body of the batch table * * @alias BatchTableHierarchy @@ -56,7 +56,7 @@ Object.defineProperties(BatchTableHierarchy.prototype, { * 3DTILES_batch_table_hierarchy extension. * * @param {BatchTableHierarchy} hierarchy The hierarchy instance - * @param {Object} hierarchyJson The JSON of the extension + * @param {object} hierarchyJson The JSON of the extension * @param {Uint8Array} [binaryBody] The binary body of the batch table for accessing binary properties * @private */ @@ -365,9 +365,9 @@ function traverseHierarchy(hierarchy, instanceIndex, endConditionCallback) { /** * Returns whether the feature has this property. * - * @param {Number} batchId the batch ID of the feature - * @param {String} propertyId The case-sensitive ID of the property. - * @returns {Boolean} Whether the feature has this property. + * @param {number} batchId the batch ID of the feature + * @param {string} propertyId The case-sensitive ID of the property. + * @returns {boolean} Whether the feature has this property. * @private */ BatchTableHierarchy.prototype.hasProperty = function (batchId, propertyId) { @@ -387,8 +387,8 @@ BatchTableHierarchy.prototype.hasProperty = function (batchId, propertyId) { /** * Returns whether any feature has this property. * - * @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 */ BatchTableHierarchy.prototype.propertyExists = function (propertyId) { @@ -406,10 +406,10 @@ BatchTableHierarchy.prototype.propertyExists = function (propertyId) { /** * Returns an array of property IDs. * - * @param {Number} batchId the batch ID of the feature - * @param {Number} index The index of the entity. - * @param {String[]} [results] An array into which to store the results. - * @returns {String[]} The property IDs. + * @param {number} batchId the batch ID of the feature + * @param {number} index The index of the entity. + * @param {string[]} [results] An array into which to store the results. + * @returns {string[]} The property IDs. * @private */ BatchTableHierarchy.prototype.getPropertyIds = function (batchId, results) { @@ -434,8 +434,8 @@ BatchTableHierarchy.prototype.getPropertyIds = function (batchId, results) { /** * Returns a copy of the value of the property with the given ID. * - * @param {Number} batchId the batch ID of the feature - * @param {String} propertyId The case-sensitive ID of the property. + * @param {number} batchId the batch ID of the feature + * @param {string} propertyId The case-sensitive ID of the property. * @returns {*} The value of the property or undefined if the feature does not have this property. * @private */ @@ -467,10 +467,10 @@ function getBinaryProperty(binaryProperty, index) { * Sets the value of the property with the given ID. Only properties of the * instance may be set; parent properties may not be set. * - * @param {Number} batchId The batchId of the feature - * @param {String} propertyId The case-sensitive ID of the property. + * @param {number} batchId The batchId of the feature + * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * * @exception {DeveloperError} when setting an inherited property * @private @@ -520,9 +520,9 @@ function setBinaryProperty(binaryProperty, index, value) { /** * Check if a feature belongs to a class with the given name * - * @param {Number} batchId The batch ID of the feature - * @param {String} className The name of the class - * @return {Boolean} true if the feature belongs to the class given by className, or false otherwise + * @param {number} batchId The batch ID of the feature + * @param {string} className The name of the class + * @return {boolean} true if the feature belongs to the class given by className, or false otherwise * @private */ BatchTableHierarchy.prototype.isClass = function (batchId, className) { @@ -544,8 +544,8 @@ BatchTableHierarchy.prototype.isClass = function (batchId, className) { /** * Get the name of the class a given feature belongs to * - * @param {Number} batchId The batch ID of the feature - * @return {String} The name of the class this feature belongs to + * @param {number} batchId The batch ID of the feature + * @return {string} The name of the class this feature belongs to */ BatchTableHierarchy.prototype.getClassName = function (batchId) { const classId = this._classIds[batchId]; diff --git a/packages/engine/Source/Scene/BatchTexture.js b/packages/engine/Source/Scene/BatchTexture.js index 4350c295137b..7b43f8cee30d 100644 --- a/packages/engine/Source/Scene/BatchTexture.js +++ b/packages/engine/Source/Scene/BatchTexture.js @@ -16,10 +16,10 @@ import Texture from "../Renderer/Texture.js"; * An object that manages color, show/hide and picking textures for a batch * table or feature table. * - * @param {Object} options Object with the following properties: - * @param {Number} featuresLength The number of features in the batch table or feature table + * @param {object} options Object with the following properties: + * @param {number} featuresLength The number of features in the batch table or feature table * @param {Cesium3DTileContent|ModelFeatureTable} owner The owner of this batch texture. For 3D Tiles, this will be a {@link Cesium3DTileContent}. For glTF models, this will be a {@link ModelFeatureTable}. - * @param {Object} [statistics] The statistics object to update with information about the batch texture. + * @param {object} [statistics] The statistics object to update with information about the batch texture. * @param {Function} [colorChangedCallback] A callback function that is called whenever the color of a feature changes. * * @alias BatchTexture @@ -81,7 +81,7 @@ Object.defineProperties(BatchTexture.prototype, { * Number of features that are translucent * * @memberof BatchTexture.prototype - * @type {Number} + * @type {number} * @readonly * @private */ @@ -95,7 +95,7 @@ Object.defineProperties(BatchTexture.prototype, { * Total size of all GPU resources used by this batch texture. * * @memberof BatchTexture.prototype - * @type {Number} + * @type {number} * @readonly * @private */ @@ -228,8 +228,8 @@ function checkBatchId(batchId, featuresLength) { /** * Set whether a feature is visible. * - * @param {Number} batchId the ID of the feature - * @param {Boolean} show true if the feature should be shown, false otherwise + * @param {number} batchId the ID of the feature + * @param {boolean} show true if the feature should be shown, false otherwise * @private */ BatchTexture.prototype.setShow = function (batchId, show) { @@ -263,7 +263,7 @@ BatchTexture.prototype.setShow = function (batchId, show) { /** * Set the show for all features at once. * - * @param {Boolean} show true if the feature should be shown, false otherwise + * @param {boolean} show true if the feature should be shown, false otherwise * @private */ BatchTexture.prototype.setAllShow = function (show) { @@ -280,8 +280,8 @@ BatchTexture.prototype.setAllShow = function (show) { /** * Check the current show value for a feature * - * @param {Number} batchId the ID of the feature - * @return {Boolean} true if the feature is shown, or false otherwise + * @param {number} batchId the ID of the feature + * @return {boolean} true if the feature is shown, or false otherwise * @private */ BatchTexture.prototype.getShow = function (batchId) { @@ -303,7 +303,7 @@ const scratchColorBytes = new Array(4); /** * Set the styling color of a feature * - * @param {Number} batchId the ID of the feature + * @param {number} batchId the ID of the feature * @param {Color} color the color to assign to this feature. * * @private @@ -386,7 +386,7 @@ BatchTexture.prototype.setAllColor = function (color) { /** * Get the current color of a feature * - * @param {Number} batchId The ID of the feature + * @param {number} batchId The ID of the feature * @param {Color} result A color object where the result will be stored. * @return {Color} The color assigned to the selected feature * @@ -421,7 +421,7 @@ BatchTexture.prototype.getColor = function (batchId, result) { * Get the pick color of a feature. This feature is an RGBA encoding of the * pick ID. * - * @param {Number} batchId The ID of the feature + * @param {number} batchId The ID of the feature * @return {PickId} The picking color assigned to this feature * * @private @@ -532,7 +532,7 @@ BatchTexture.prototype.update = function (tileset, frameState) { * isDestroyed 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. * * @see BatchTexture#destroy * @private diff --git a/packages/engine/Source/Scene/Billboard.js b/packages/engine/Source/Scene/Billboard.js index 3d3300139366..4035cda8d008 100644 --- a/packages/engine/Source/Scene/Billboard.js +++ b/packages/engine/Source/Scene/Billboard.js @@ -250,7 +250,7 @@ Object.defineProperties(Billboard.prototype, { * Determines if this billboard will be shown. Use this to hide or show a billboard, instead * of removing it and re-adding it to the collection. * @memberof Billboard.prototype - * @type {Boolean} + * @type {boolean} * @default true */ show: { @@ -606,7 +606,7 @@ Object.defineProperties(Billboard.prototype, { * and 2.0. * * @memberof Billboard.prototype - * @type {Number} + * @type {number} */ scale: { get: function () { @@ -671,7 +671,7 @@ Object.defineProperties(Billboard.prototype, { /** * Gets or sets the rotation angle in radians. * @memberof Billboard.prototype - * @type {Number} + * @type {number} */ rotation: { get: function () { @@ -730,7 +730,7 @@ Object.defineProperties(Billboard.prototype, { /** * Gets or sets a width for the billboard. If undefined, the image width will be used. * @memberof Billboard.prototype - * @type {Number} + * @type {number} */ width: { get: function () { @@ -752,7 +752,7 @@ Object.defineProperties(Billboard.prototype, { /** * Gets or sets a height for the billboard. If undefined, the image height will be used. * @memberof Billboard.prototype - * @type {Number} + * @type {number} */ height: { get: function () { @@ -775,7 +775,7 @@ Object.defineProperties(Billboard.prototype, { * Gets or sets if the billboard size is in meters or pixels. true to size the billboard in meters; * otherwise, the size is in pixels. * @memberof Billboard.prototype - * @type {Boolean} + * @type {boolean} * @default false */ sizeInMeters: { @@ -830,7 +830,7 @@ Object.defineProperties(Billboard.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 Billboard.prototype - * @type {Number} + * @type {number} */ disableDepthTestDistance: { get: function () { @@ -857,7 +857,7 @@ Object.defineProperties(Billboard.prototype, { /** * Gets or sets the user-defined object returned when the billboard is picked. * @memberof Billboard.prototype - * @type {Object} + * @type {object} */ id: { get: function () { @@ -908,7 +908,7 @@ Object.defineProperties(Billboard.prototype, { *

* * @memberof Billboard.prototype - * @type {String} + * @type {string} * @example * // load an image from a URL * b.image = 'some/image/url.png'; @@ -947,7 +947,7 @@ Object.defineProperties(Billboard.prototype, { * * @memberof Billboard.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -980,7 +980,7 @@ Object.defineProperties(Billboard.prototype, { /** * Determines whether or not this billboard will be shown or hidden because it was clustered. * @memberof Billboard.prototype - * @type {Boolean} + * @type {boolean} * @private */ clusterShow: { @@ -1023,7 +1023,7 @@ Object.defineProperties(Billboard.prototype, { /** * The outline width of this Billboard in pixels. Effective only for SDF billboards like Label glyphs. * @memberof Billboard.prototype - * @type {Number} + * @type {number} * @private */ outlineWidth: { @@ -1208,8 +1208,8 @@ Billboard.prototype._loadImage = function () { * To load an image from a URL, setting the {@link Billboard#image} property is more convenient. *

* - * @param {String} id The id of the image. This can be any string that uniquely identifies the image. - * @param {HTMLImageElement|HTMLCanvasElement|String|Resource|Billboard.CreateImageCallback} image The image to load. This parameter + * @param {string} id The id of the image. This can be any string that uniquely identifies the image. + * @param {HTMLImageElement|HTMLCanvasElement|string|Resource|Billboard.CreateImageCallback} image The image to load. This parameter * can either be a loaded Image or Canvas, a URL which will be loaded as an Image automatically, * or a function which will be called to create the image if it hasn't been loaded already. * @example @@ -1256,7 +1256,7 @@ Billboard.prototype.setImage = function (id, image) { * Uses a sub-region of the image with the given id as the image for this billboard, * measured in pixels from the bottom-left. * - * @param {String} id The id of the image to use. + * @param {string} id The id of the image to use. * @param {BoundingRectangle} subRegion The sub-region of the image. * * @exception {RuntimeError} image with id must be in the atlas @@ -1489,7 +1489,7 @@ Billboard.getScreenSpaceBoundingBox = function ( * are equal. Billboards in different collections can be equal. * * @param {Billboard} other The billboard to compare for equality. - * @returns {Boolean} true if the billboards are equal; otherwise, false. + * @returns {boolean} true if the billboards are equal; otherwise, false. */ Billboard.prototype.equals = function (other) { return ( @@ -1546,7 +1546,7 @@ Billboard.prototype._destroy = function () { /** * A function that creates an image. * @callback Billboard.CreateImageCallback - * @param {String} id The identifier of the image to load. + * @param {string} id The identifier of the image to load. * @returns {HTMLImageElement|HTMLCanvasElement|Promise} The image, or a promise that will resolve to an image. */ export default Billboard; diff --git a/packages/engine/Source/Scene/BillboardCollection.js b/packages/engine/Source/Scene/BillboardCollection.js index d5b2bf1b2e92..c0116eaabc6b 100644 --- a/packages/engine/Source/Scene/BillboardCollection.js +++ b/packages/engine/Source/Scene/BillboardCollection.js @@ -105,14 +105,14 @@ const attributeLocationsInstanced = { * @alias BillboardCollection * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms each billboard from model to world coordinates. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. * @param {Scene} [options.scene] Must be passed in for billboards that use the height reference property or will be depth tested against the globe. * @param {BlendOption} [options.blendOption=BlendOption.OPAQUE_AND_TRANSLUCENT] The billboard blending option. The default * is used for rendering both opaque and translucent billboards. However, if either all of the billboards are completely opaque or all are completely translucent, * setting the technique to BlendOption.OPAQUE or BlendOption.TRANSLUCENT can improve performance by up to 2x. - * @param {Boolean} [options.show=true] Determines if the billboards in the collection will be shown. + * @param {boolean} [options.show=true] Determines if the billboards in the collection will be shown. * * @performance For best performance, prefer a few collections, each with many billboards, to * many collections with only a few billboards each. Organize collections so that billboards @@ -205,7 +205,7 @@ function BillboardCollection(options) { /** * Determines if billboards in this collection will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -253,7 +253,7 @@ function BillboardCollection(options) { * Draws the bounding sphere for each draw command in the primitive. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -268,7 +268,7 @@ function BillboardCollection(options) { * Draws the texture atlas for this BillboardCollection as a fullscreen quad. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -348,7 +348,7 @@ Object.defineProperties(BillboardCollection.prototype, { * {@link BillboardCollection#get} to iterate over all the billboards * in the collection. * @memberof BillboardCollection.prototype - * @type {Number} + * @type {number} */ length: { get: function () { @@ -387,7 +387,7 @@ Object.defineProperties(BillboardCollection.prototype, { * and explicitly destroy the atlas to avoid attempting to destroy it multiple times. * * @memberof BillboardCollection.prototype - * @type {Boolean} + * @type {boolean} * @private * * @example @@ -426,7 +426,7 @@ function destroyBillboards(billboards) { * Creates and adds a billboard with the specified initial properties to the collection. * The added billboard is returned so it can be modified or removed from the collection later. * - * @param {Object}[options] A template describing the billboard's properties as shown in Example 1. + * @param {object}[options] A template describing the billboard's properties as shown in Example 1. * @returns {Billboard} The billboard that was added to the collection. * * @performance Calling add is expected constant time. However, the collection's vertex buffer @@ -485,7 +485,7 @@ BillboardCollection.prototype.add = function (options) { * Removes a billboard from the collection. * * @param {Billboard} billboard The billboard to remove. - * @returns {Boolean} true if the billboard was removed; false if the billboard was not found in the collection. + * @returns {boolean} true if the billboard was removed; false if the billboard was not found in the collection. * * @performance Calling remove is expected constant time. However, the collection's vertex buffer * is rewritten - an O(n) operation that also incurs CPU to GPU overhead. For @@ -577,7 +577,7 @@ BillboardCollection.prototype._updateBillboard = function ( * Check whether this collection contains a given billboard. * * @param {Billboard} [billboard] The billboard to check for. - * @returns {Boolean} true if this collection contains the billboard, false otherwise. + * @returns {boolean} true if this collection contains the billboard, false otherwise. * * @see BillboardCollection#get */ @@ -592,7 +592,7 @@ BillboardCollection.prototype.contains = function (billboard) { * {@link BillboardCollection#length} to iterate over all the billboards * in the collection. * - * @param {Number} index The zero-based index of the billboard. + * @param {number} index The zero-based index of the billboard. * @returns {Billboard} The billboard at the specified index. * * @performance Expected constant time. If billboards were removed from the collection and @@ -2373,7 +2373,7 @@ BillboardCollection.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see BillboardCollection#destroy */ diff --git a/packages/engine/Source/Scene/BingMapsImageryProvider.js b/packages/engine/Source/Scene/BingMapsImageryProvider.js index 39870e4814f1..4fa70ef672c5 100644 --- a/packages/engine/Source/Scene/BingMapsImageryProvider.js +++ b/packages/engine/Source/Scene/BingMapsImageryProvider.js @@ -16,17 +16,17 @@ import DiscardEmptyTilePolicy from "./DiscardEmptyTileImagePolicy.js"; import ImageryProvider from "./ImageryProvider.js"; /** - * @typedef {Object} BingMapsImageryProvider.ConstructorOptions + * @typedef {object} BingMapsImageryProvider.ConstructorOptions * * Initialization options for the BingMapsImageryProvider constructor * - * @property {Resource|String} url The url of the Bing Maps server hosting the imagery. - * @property {String} key The Bing Maps key for your application, which can be + * @property {Resource|string} url The url of the Bing Maps server hosting the imagery. + * @property {string} key The Bing Maps key for your application, which can be * created at {@link https://www.bingmapsportal.com/}. - * @property {String} [tileProtocol] The protocol to use when loading tiles, e.g. 'http' or 'https'. + * @property {string} [tileProtocol] The protocol to use when loading tiles, e.g. 'http' or 'https'. * By default, tiles are loaded using the same protocol as the page. * @property {BingMapsStyle} [mapStyle=BingMapsStyle.AERIAL] The type of Bing Maps imagery to load. - * @property {String} [culture=''] The culture to use when requesting Bing Maps imagery. Not + * @property {string} [culture=''] The culture to use when requesting Bing Maps imagery. Not * all cultures are supported. See {@link http://msdn.microsoft.com/en-us/library/hh441729.aspx} * for information on the supported cultures. * @property {Ellipsoid} [ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used. @@ -81,7 +81,7 @@ function BingMapsImageryProvider(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; @@ -90,7 +90,7 @@ function BingMapsImageryProvider(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; @@ -99,7 +99,7 @@ function BingMapsImageryProvider(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; @@ -108,7 +108,7 @@ function BingMapsImageryProvider(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; @@ -117,7 +117,7 @@ function BingMapsImageryProvider(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; @@ -125,7 +125,7 @@ function BingMapsImageryProvider(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; @@ -134,7 +134,7 @@ function BingMapsImageryProvider(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; @@ -142,7 +142,7 @@ function BingMapsImageryProvider(options) { /** * The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color. * - * @type {Number|undefined} + * @type {number|undefined} * @default 1.0 */ this.defaultGamma = 1.0; @@ -315,7 +315,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { /** * Gets the name of the BingMaps server url hosting the imagery. * @memberof BingMapsImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -339,7 +339,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { /** * Gets the Bing Maps key. * @memberof BingMapsImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ key: { @@ -365,7 +365,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { * all cultures are supported. See {@link http://msdn.microsoft.com/en-us/library/hh441729.aspx} * for information on the supported cultures. * @memberof BingMapsImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ culture: { @@ -378,7 +378,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link BingMapsImageryProvider#ready} returns true. * @memberof BingMapsImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -399,7 +399,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link BingMapsImageryProvider#ready} returns true. * @memberof BingMapsImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -420,7 +420,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link BingMapsImageryProvider#ready} returns true. * @memberof BingMapsImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -441,7 +441,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { * Gets the minimum level-of-detail that can be requested. This function should * not be called before {@link BingMapsImageryProvider#ready} returns true. * @memberof BingMapsImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -540,7 +540,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof BingMapsImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -552,7 +552,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof BingMapsImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -581,7 +581,7 @@ Object.defineProperties(BingMapsImageryProvider.prototype, { * as if their alpha is 1.0 everywhere. Setting this property to false reduces memory usage * and texture upload time. * @memberof BingMapsImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -596,9 +596,9 @@ const rectangleScratch = new Rectangle(); /** * 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} getTileCredits must not be called before the imagery provider is ready. @@ -631,11 +631,11 @@ BingMapsImageryProvider.prototype.getTileCredits = function (x, y, level) { * Requests the image for a given tile. This function should * not be called before {@link BingMapsImageryProvider#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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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} requestImage must not be called before the imagery provider is ready. @@ -678,11 +678,11 @@ BingMapsImageryProvider.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. */ BingMapsImageryProvider.prototype.pickFeatures = function ( @@ -699,9 +699,9 @@ BingMapsImageryProvider.prototype.pickFeatures = function ( * Converts a tiles (x, y, level) position into a quadkey used to request an image * from a Bing Maps server. * - * @param {Number} x The tile's x coordinate. - * @param {Number} y The tile's y coordinate. - * @param {Number} level The tile's zoom level. + * @param {number} x The tile's x coordinate. + * @param {number} y The tile's y coordinate. + * @param {number} level The tile's zoom level. * * @see {@link http://msdn.microsoft.com/en-us/library/bb259689.aspx|Bing Maps Tile System} * @see BingMapsImageryProvider#quadKeyToTileXY @@ -729,7 +729,7 @@ BingMapsImageryProvider.tileXYToQuadKey = function (x, y, level) { * Converts a tile's quadkey used to request an image from a Bing Maps server into the * (x, y, level) position. * - * @param {String} quadkey The tile's quad key + * @param {string} quadkey The tile's quad key * * @see {@link http://msdn.microsoft.com/en-us/library/bb259689.aspx|Bing Maps Tile System} * @see BingMapsImageryProvider#tileXYToQuadKey @@ -763,7 +763,7 @@ Object.defineProperties(BingMapsImageryProvider, { /** * Gets or sets the URL to the Bing logo for display in the credit. * @memberof BingMapsImageryProvider - * @type {String} + * @type {string} */ logoUrl: { get: function () { diff --git a/packages/engine/Source/Scene/BingMapsStyle.js b/packages/engine/Source/Scene/BingMapsStyle.js index ab9d5cd14cac..a41f5d8f8a25 100644 --- a/packages/engine/Source/Scene/BingMapsStyle.js +++ b/packages/engine/Source/Scene/BingMapsStyle.js @@ -1,7 +1,7 @@ /** * The types of imagery provided by Bing Maps. * - * @enum {Number} + * @enum {number} * * @see BingMapsImageryProvider */ @@ -9,7 +9,7 @@ const BingMapsStyle = { /** * Aerial imagery. * - * @type {String} + * @type {string} * @constant */ AERIAL: "Aerial", @@ -17,7 +17,7 @@ const BingMapsStyle = { /** * Aerial imagery with a road overlay. * - * @type {String} + * @type {string} * @constant * @deprecated See https://github.com/CesiumGS/cesium/issues/7128. * Use `BingMapsStyle.AERIAL_WITH_LABELS_ON_DEMAND` instead @@ -27,7 +27,7 @@ const BingMapsStyle = { /** * Aerial imagery with a road overlay. * - * @type {String} + * @type {string} * @constant */ AERIAL_WITH_LABELS_ON_DEMAND: "AerialWithLabelsOnDemand", @@ -35,7 +35,7 @@ const BingMapsStyle = { /** * Roads without additional imagery. * - * @type {String} + * @type {string} * @constant * @deprecated See https://github.com/CesiumGS/cesium/issues/7128. * Use `BingMapsStyle.ROAD_ON_DEMAND` instead @@ -45,7 +45,7 @@ const BingMapsStyle = { /** * Roads without additional imagery. * - * @type {String} + * @type {string} * @constant */ ROAD_ON_DEMAND: "RoadOnDemand", @@ -53,7 +53,7 @@ const BingMapsStyle = { /** * A dark version of the road maps. * - * @type {String} + * @type {string} * @constant */ CANVAS_DARK: "CanvasDark", @@ -61,7 +61,7 @@ const BingMapsStyle = { /** * A lighter version of the road maps. * - * @type {String} + * @type {string} * @constant */ CANVAS_LIGHT: "CanvasLight", @@ -69,7 +69,7 @@ const BingMapsStyle = { /** * A grayscale version of the road maps. * - * @type {String} + * @type {string} * @constant */ CANVAS_GRAY: "CanvasGray", @@ -77,7 +77,7 @@ const BingMapsStyle = { /** * Ordnance Survey imagery. This imagery is visible only for the London, UK area. * - * @type {String} + * @type {string} * @constant */ ORDNANCE_SURVEY: "OrdnanceSurvey", @@ -85,7 +85,7 @@ const BingMapsStyle = { /** * Collins Bart imagery. * - * @type {String} + * @type {string} * @constant */ COLLINS_BART: "CollinsBart", diff --git a/packages/engine/Source/Scene/BlendEquation.js b/packages/engine/Source/Scene/BlendEquation.js index d007e3433f48..c36e9653d6c5 100644 --- a/packages/engine/Source/Scene/BlendEquation.js +++ b/packages/engine/Source/Scene/BlendEquation.js @@ -3,13 +3,13 @@ import WebGLConstants from "../Core/WebGLConstants.js"; /** * Determines how two pixels' values are combined. * - * @enum {Number} + * @enum {number} */ const BlendEquation = { /** * Pixel values are added componentwise. This is used in additive blending for translucency. * - * @type {Number} + * @type {number} * @constant */ ADD: WebGLConstants.FUNC_ADD, @@ -17,7 +17,7 @@ const BlendEquation = { /** * Pixel values are subtracted componentwise (source - destination). This is used in alpha blending for translucency. * - * @type {Number} + * @type {number} * @constant */ SUBTRACT: WebGLConstants.FUNC_SUBTRACT, @@ -25,7 +25,7 @@ const BlendEquation = { /** * Pixel values are subtracted componentwise (destination - source). * - * @type {Number} + * @type {number} * @constant */ REVERSE_SUBTRACT: WebGLConstants.FUNC_REVERSE_SUBTRACT, @@ -35,7 +35,7 @@ const BlendEquation = { * * This equation operates on each pixel color component. * - * @type {Number} + * @type {number} * @constant */ MIN: WebGLConstants.MIN, @@ -45,7 +45,7 @@ const BlendEquation = { * * This equation operates on each pixel color component. * - * @type {Number} + * @type {number} * @constant */ MAX: WebGLConstants.MAX, diff --git a/packages/engine/Source/Scene/BlendFunction.js b/packages/engine/Source/Scene/BlendFunction.js index 3c3a624fdfe4..c8be135e246e 100644 --- a/packages/engine/Source/Scene/BlendFunction.js +++ b/packages/engine/Source/Scene/BlendFunction.js @@ -3,13 +3,13 @@ import WebGLConstants from "../Core/WebGLConstants.js"; /** * Determines how blending factors are computed. * - * @enum {Number} + * @enum {number} */ const BlendFunction = { /** * The blend factor is zero. * - * @type {Number} + * @type {number} * @constant */ ZERO: WebGLConstants.ZERO, @@ -17,7 +17,7 @@ const BlendFunction = { /** * The blend factor is one. * - * @type {Number} + * @type {number} * @constant */ ONE: WebGLConstants.ONE, @@ -25,7 +25,7 @@ const BlendFunction = { /** * The blend factor is the source color. * - * @type {Number} + * @type {number} * @constant */ SOURCE_COLOR: WebGLConstants.SRC_COLOR, @@ -33,7 +33,7 @@ const BlendFunction = { /** * The blend factor is one minus the source color. * - * @type {Number} + * @type {number} * @constant */ ONE_MINUS_SOURCE_COLOR: WebGLConstants.ONE_MINUS_SRC_COLOR, @@ -41,7 +41,7 @@ const BlendFunction = { /** * The blend factor is the destination color. * - * @type {Number} + * @type {number} * @constant */ DESTINATION_COLOR: WebGLConstants.DST_COLOR, @@ -49,7 +49,7 @@ const BlendFunction = { /** * The blend factor is one minus the destination color. * - * @type {Number} + * @type {number} * @constant */ ONE_MINUS_DESTINATION_COLOR: WebGLConstants.ONE_MINUS_DST_COLOR, @@ -57,7 +57,7 @@ const BlendFunction = { /** * The blend factor is the source alpha. * - * @type {Number} + * @type {number} * @constant */ SOURCE_ALPHA: WebGLConstants.SRC_ALPHA, @@ -65,7 +65,7 @@ const BlendFunction = { /** * The blend factor is one minus the source alpha. * - * @type {Number} + * @type {number} * @constant */ ONE_MINUS_SOURCE_ALPHA: WebGLConstants.ONE_MINUS_SRC_ALPHA, @@ -73,7 +73,7 @@ const BlendFunction = { /** * The blend factor is the destination alpha. * - * @type {Number} + * @type {number} * @constant */ DESTINATION_ALPHA: WebGLConstants.DST_ALPHA, @@ -81,7 +81,7 @@ const BlendFunction = { /** * The blend factor is one minus the destination alpha. * - * @type {Number} + * @type {number} * @constant */ ONE_MINUS_DESTINATION_ALPHA: WebGLConstants.ONE_MINUS_DST_ALPHA, @@ -89,7 +89,7 @@ const BlendFunction = { /** * The blend factor is the constant color. * - * @type {Number} + * @type {number} * @constant */ CONSTANT_COLOR: WebGLConstants.CONSTANT_COLOR, @@ -97,7 +97,7 @@ const BlendFunction = { /** * The blend factor is one minus the constant color. * - * @type {Number} + * @type {number} * @constant */ ONE_MINUS_CONSTANT_COLOR: WebGLConstants.ONE_MINUS_CONSTANT_COLOR, @@ -105,7 +105,7 @@ const BlendFunction = { /** * The blend factor is the constant alpha. * - * @type {Number} + * @type {number} * @constant */ CONSTANT_ALPHA: WebGLConstants.CONSTANT_ALPHA, @@ -113,7 +113,7 @@ const BlendFunction = { /** * The blend factor is one minus the constant alpha. * - * @type {Number} + * @type {number} * @constant */ ONE_MINUS_CONSTANT_ALPHA: WebGLConstants.ONE_MINUS_CONSTANT_ALPHA, @@ -121,7 +121,7 @@ const BlendFunction = { /** * The blend factor is the saturated source alpha. * - * @type {Number} + * @type {number} * @constant */ SOURCE_ALPHA_SATURATE: WebGLConstants.SRC_ALPHA_SATURATE, diff --git a/packages/engine/Source/Scene/BlendOption.js b/packages/engine/Source/Scene/BlendOption.js index 8228ed0c02a6..bd40f1f0b540 100644 --- a/packages/engine/Source/Scene/BlendOption.js +++ b/packages/engine/Source/Scene/BlendOption.js @@ -1,26 +1,26 @@ /** * Determines how opaque and translucent parts of billboards, points, and labels are blended with the scene. * - * @enum {Number} + * @enum {number} */ const BlendOption = { /** * The billboards, points, or labels in the collection are completely opaque. - * @type {Number} + * @type {number} * @constant */ OPAQUE: 0, /** * The billboards, points, or labels in the collection are completely translucent. - * @type {Number} + * @type {number} * @constant */ TRANSLUCENT: 1, /** * The billboards, points, or labels in the collection are both opaque and translucent. - * @type {Number} + * @type {number} * @constant */ OPAQUE_AND_TRANSLUCENT: 2, diff --git a/packages/engine/Source/Scene/BlendingState.js b/packages/engine/Source/Scene/BlendingState.js index 82f0a228a136..856f4d497ff1 100644 --- a/packages/engine/Source/Scene/BlendingState.js +++ b/packages/engine/Source/Scene/BlendingState.js @@ -15,7 +15,7 @@ const BlendingState = { /** * Blending is disabled. * - * @type {Object} + * @type {object} * @constant */ DISABLED: Object.freeze({ @@ -25,7 +25,7 @@ const BlendingState = { /** * Blending is enabled using alpha blending, source(source.alpha) + destination(1 - source.alpha). * - * @type {Object} + * @type {object} * @constant */ ALPHA_BLEND: Object.freeze({ @@ -41,7 +41,7 @@ const BlendingState = { /** * Blending is enabled using alpha blending with premultiplied alpha, source + destination(1 - source.alpha). * - * @type {Object} + * @type {object} * @constant */ PRE_MULTIPLIED_ALPHA_BLEND: Object.freeze({ @@ -57,7 +57,7 @@ const BlendingState = { /** * Blending is enabled using additive blending, source(source.alpha) + destination. * - * @type {Object} + * @type {object} * @constant */ ADDITIVE_BLEND: Object.freeze({ diff --git a/packages/engine/Source/Scene/BufferLoader.js b/packages/engine/Source/Scene/BufferLoader.js index f04cd75ad194..43562c0b93cd 100644 --- a/packages/engine/Source/Scene/BufferLoader.js +++ b/packages/engine/Source/Scene/BufferLoader.js @@ -14,10 +14,10 @@ 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 {Uint8Array} [options.typedArray] The typed array containing the embedded buffer contents. Mutually exclusive with options.resource. * @param {Resource} [options.resource] The {@link Resource} pointing to the external buffer. Mutually exclusive with options.typedArray. - * @param {String} [options.cacheKey] The cache key of the resource. + * @param {string} [options.cacheKey] The cache key of the resource. * * @exception {DeveloperError} One of options.typedArray and options.resource must be defined. * @@ -55,7 +55,7 @@ Object.defineProperties(BufferLoader.prototype, { * * @memberof BufferLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly */ promise: { @@ -68,7 +68,7 @@ Object.defineProperties(BufferLoader.prototype, { * * @memberof BufferLoader.prototype * - * @type {String} + * @type {string} * @readonly */ cacheKey: { @@ -93,7 +93,7 @@ Object.defineProperties(BufferLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ BufferLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/Camera.js b/packages/engine/Source/Scene/Camera.js index c1765f2eb307..caab469d1b39 100644 --- a/packages/engine/Source/Scene/Camera.js +++ b/packages/engine/Source/Scene/Camera.js @@ -30,7 +30,7 @@ import MapMode2D from "./MapMode2D.js"; import SceneMode from "./SceneMode.js"; /** - * @typedef {Object} DirectionUp + * @typedef {object} DirectionUp * * An orientation given by a pair of unit vectors * @@ -38,7 +38,7 @@ import SceneMode from "./SceneMode.js"; * @property {Cartesian3} up The unit "up" vector **/ /** - * @typedef {Object} HeadingPitchRollValues + * @typedef {object} HeadingPitchRollValues * * An orientation given by numeric heading, pitch, and roll * @@ -170,28 +170,28 @@ function Camera(scene) { /** * The default amount to move the camera when an argument is not * provided to the move methods. - * @type {Number} + * @type {number} * @default 100000.0; */ this.defaultMoveAmount = 100000.0; /** * The default amount to rotate the camera when an argument is not * provided to the look methods. - * @type {Number} + * @type {number} * @default Math.PI / 60.0 */ this.defaultLookAmount = Math.PI / 60.0; /** * The default amount to rotate the camera when an argument is not * provided to the rotate methods. - * @type {Number} + * @type {number} * @default Math.PI / 3600.0 */ this.defaultRotateAmount = Math.PI / 3600.0; /** * The default amount to move the camera when an argument is not * provided to the zoom methods. - * @type {Number} + * @type {number} * @default 100000.0; */ this.defaultZoomAmount = 100000.0; @@ -204,7 +204,7 @@ function Camera(scene) { /** * The factor multiplied by the the map size used to determine where to clamp the camera position * when zooming out from the surface. The default is 1.5. Only valid for 2D and the map is rotatable. - * @type {Number} + * @type {number} * @default 1.5 */ this.maximumZoomFactor = 1.5; @@ -297,7 +297,7 @@ Camera.DEFAULT_VIEW_RECTANGLE = Rectangle.fromDegrees( * A scalar to multiply to the camera position and add it back after setting the camera to view the rectangle. * A value of zero means the camera will view the entire {@link Camera#DEFAULT_VIEW_RECTANGLE}, a value greater than zero * will move it further away from the extent, and a value less than zero will move it close to the extent. - * @type Number + * @type {number} */ Camera.DEFAULT_VIEW_FACTOR = 0.5; @@ -360,7 +360,7 @@ function updateCameraDeltas(camera) { /** * Checks if there's a camera flight with preload for this camera. * - * @returns {Boolean} Whether or not this camera has a current flight with a valid preloadFlightCamera in scene. + * @returns {boolean} Whether or not this camera has a current flight with a valid preloadFlightCamera in scene. * * @private * @@ -955,7 +955,7 @@ Object.defineProperties(Camera.prototype, { * Gets the camera heading in radians. * @memberof Camera.prototype * - * @type {Number} + * @type {number} * @readonly */ heading: { @@ -986,7 +986,7 @@ Object.defineProperties(Camera.prototype, { * Gets the camera pitch in radians. * @memberof Camera.prototype * - * @type {Number} + * @type {number} * @readonly */ pitch: { @@ -1017,7 +1017,7 @@ Object.defineProperties(Camera.prototype, { * Gets the camera roll in radians. * @memberof Camera.prototype * - * @type {Number} + * @type {number} * @readonly */ roll: { @@ -1399,13 +1399,13 @@ const scratchHpr = new HeadingPitchRoll(); /** * Sets the camera position, orientation and transform. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3|Rectangle} [options.destination] The final position of the camera in WGS84 (world) coordinates or a rectangle that would be visible from a top-down view. * @param {HeadingPitchRollValues|DirectionUp} [options.orientation] An object that contains either direction and up properties or heading, pitch and roll properties. By default, the direction will point * towards the center of the frame in 3D and in the negative z direction in Columbus view. The up direction will point towards local north in 3D and in the positive * y direction in Columbus view. Orientation is not used in 2D when in infinite scrolling mode. * @param {Matrix4} [options.endTransform] Transform matrix representing the reference frame of the camera. - * @param {Boolean} [options.convert] Whether to convert the destination from world coordinates to scene coordinates (only relevant when not using 3D). Defaults to true. + * @param {boolean} [options.convert] Whether to convert the destination from world coordinates to scene coordinates (only relevant when not using 3D). Defaults to true. * * @example * // 1. Set position with a top-down view @@ -1504,7 +1504,7 @@ const pitchScratch = new Cartesian3(); * the default view for the 3D scene. The home view for 2D and columbus view shows the * entire map. * - * @param {Number} [duration] The duration of the flight in seconds. If omitted, Cesium attempts to calculate an ideal duration based on the distance to be traveled by the flight. See {@link Camera#flyTo} + * @param {number} [duration] The duration of the flight in seconds. If omitted, Cesium attempts to calculate an ideal duration based on the distance to be traveled by the flight. See {@link Camera#flyTo} */ Camera.prototype.flyHome = function (duration) { const mode = this._mode; @@ -1725,7 +1725,7 @@ const moveScratch = new Cartesian3(); * Translates the camera's position by amount along direction. * * @param {Cartesian3} direction The direction to move. - * @param {Number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. + * @param {number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. * * @see Camera#moveBackward * @see Camera#moveForward @@ -1755,7 +1755,7 @@ Camera.prototype.move = function (direction, amount) { * Translates the camera's position by amount along the camera's view vector. * When in 2D mode, this will zoom in the camera instead of translating the camera's position. * - * @param {Number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. + * @param {number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. * * @see Camera#moveBackward */ @@ -1776,7 +1776,7 @@ Camera.prototype.moveForward = function (amount) { * of the camera's view vector. * When in 2D mode, this will zoom out the camera instead of translating the camera's position. * - * @param {Number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. + * @param {number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. * * @see Camera#moveForward */ @@ -1795,7 +1795,7 @@ Camera.prototype.moveBackward = function (amount) { /** * Translates the camera's position by amount along the camera's up vector. * - * @param {Number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. + * @param {number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. * * @see Camera#moveDown */ @@ -1808,7 +1808,7 @@ Camera.prototype.moveUp = function (amount) { * Translates the camera's position by amount along the opposite direction * of the camera's up vector. * - * @param {Number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. + * @param {number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. * * @see Camera#moveUp */ @@ -1820,7 +1820,7 @@ Camera.prototype.moveDown = function (amount) { /** * Translates the camera's position by amount along the camera's right vector. * - * @param {Number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. + * @param {number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. * * @see Camera#moveLeft */ @@ -1833,7 +1833,7 @@ Camera.prototype.moveRight = function (amount) { * Translates the camera's position by amount along the opposite direction * of the camera's right vector. * - * @param {Number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. + * @param {number} [amount] The amount, in meters, to move. Defaults to defaultMoveAmount. * * @see Camera#moveRight */ @@ -1846,7 +1846,7 @@ Camera.prototype.moveLeft = function (amount) { * Rotates the camera around its up vector by amount, in radians, in the opposite direction * of its right vector if not in 2D mode. * - * @param {Number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. + * @param {number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. * * @see Camera#lookRight */ @@ -1863,7 +1863,7 @@ Camera.prototype.lookLeft = function (amount) { * Rotates the camera around its up vector by amount, in radians, in the direction * of its right vector if not in 2D mode. * - * @param {Number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. + * @param {number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. * * @see Camera#lookLeft */ @@ -1880,7 +1880,7 @@ Camera.prototype.lookRight = function (amount) { * Rotates the camera around its right vector by amount, in radians, in the direction * of its up vector if not in 2D mode. * - * @param {Number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. + * @param {number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. * * @see Camera#lookDown */ @@ -1897,7 +1897,7 @@ Camera.prototype.lookUp = function (amount) { * Rotates the camera around its right vector by amount, in radians, in the opposite direction * of its up vector if not in 2D mode. * - * @param {Number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. + * @param {number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. * * @see Camera#lookUp */ @@ -1916,7 +1916,7 @@ const lookScratchMatrix = new Matrix3(); * Rotate each of the camera's orientation vectors around axis by angle * * @param {Cartesian3} axis The axis to rotate around. - * @param {Number} [angle] The angle, in radians, to rotate by. Defaults to defaultLookAmount. + * @param {number} [angle] The angle, in radians, to rotate by. Defaults to defaultLookAmount. * * @see Camera#lookUp * @see Camera#lookDown @@ -1950,7 +1950,7 @@ Camera.prototype.look = function (axis, angle) { /** * Rotate the camera counter-clockwise around its direction vector by amount, in radians. * - * @param {Number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. + * @param {number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. * * @see Camera#twistRight */ @@ -1962,7 +1962,7 @@ Camera.prototype.twistLeft = function (amount) { /** * Rotate the camera clockwise around its direction vector by amount, in radians. * - * @param {Number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. + * @param {number} [amount] The amount, in radians, to rotate by. Defaults to defaultLookAmount. * * @see Camera#twistLeft */ @@ -1978,7 +1978,7 @@ const rotateScratchMatrix = new Matrix3(); * of the camera's position to the center of the camera's reference frame remains the same. * * @param {Cartesian3} axis The axis to rotate around given in world coordinates. - * @param {Number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. + * @param {number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. * * @see Camera#rotateUp * @see Camera#rotateDown @@ -2011,7 +2011,7 @@ Camera.prototype.rotate = function (axis, angle) { /** * Rotates the camera around the center of the camera's reference frame by angle downwards. * - * @param {Number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. + * @param {number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. * * @see Camera#rotateUp * @see Camera#rotate @@ -2024,7 +2024,7 @@ Camera.prototype.rotateDown = function (angle) { /** * Rotates the camera around the center of the camera's reference frame by angle upwards. * - * @param {Number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. + * @param {number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. * * @see Camera#rotateDown * @see Camera#rotate @@ -2097,7 +2097,7 @@ function rotateVertical(camera, angle) { /** * Rotates the camera around the center of the camera's reference frame by angle to the right. * - * @param {Number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. + * @param {number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. * * @see Camera#rotateLeft * @see Camera#rotate @@ -2110,7 +2110,7 @@ Camera.prototype.rotateRight = function (angle) { /** * Rotates the camera around the center of the camera's reference frame by angle to the left. * - * @param {Number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. + * @param {number} [angle] The angle, in radians, to rotate by. Defaults to defaultRotateAmount. * * @see Camera#rotateRight * @see Camera#rotate @@ -2208,7 +2208,7 @@ function zoom3D(camera, amount) { /** * Zooms amount along the camera's view vector. * - * @param {Number} [amount] The amount to move. Defaults to defaultZoomAmount. + * @param {number} [amount] The amount to move. Defaults to defaultZoomAmount. * * @see Camera#zoomOut */ @@ -2225,7 +2225,7 @@ Camera.prototype.zoomIn = function (amount) { * Zooms amount along the opposite direction of * the camera's view vector. * - * @param {Number} [amount] The amount to move. Defaults to defaultZoomAmount. + * @param {number} [amount] The amount to move. Defaults to defaultZoomAmount. * * @see Camera#zoomIn */ @@ -2242,7 +2242,7 @@ Camera.prototype.zoomOut = function (amount) { * Gets the magnitude of the camera position. In 3D, this is the vector magnitude. In 2D and * Columbus view, this is the distance to the map. * - * @returns {Number} The magnitude of the position. + * @returns {number} The magnitude of the position. */ Camera.prototype.getMagnitude = function () { if (this._mode === SceneMode.SCENE3D) { @@ -3026,7 +3026,7 @@ const scratchProj = new Cartesian3(); * Return the distance from the camera to the front of the bounding sphere. * * @param {BoundingSphere} boundingSphere The bounding sphere in world coordinates. - * @returns {Number} The distance to the bounding sphere. + * @returns {number} The distance to the bounding sphere. */ Camera.prototype.distanceToBoundingSphere = function (boundingSphere) { //>>includeStart('debug', pragmas.debug); @@ -3054,9 +3054,9 @@ const scratchPixelSize = new Cartesian2(); * Return the pixel size in meters. * * @param {BoundingSphere} boundingSphere The bounding sphere in world coordinates. - * @param {Number} drawingBufferWidth The drawing buffer width. - * @param {Number} drawingBufferHeight The drawing buffer height. - * @returns {Number} The pixel size in meters. + * @param {number} drawingBufferWidth The drawing buffer width. + * @param {number} drawingBufferHeight The drawing buffer height. + * @returns {number} The pixel size in meters. */ Camera.prototype.getPixelSize = function ( boundingSphere, @@ -3194,8 +3194,8 @@ function createAnimationCV(camera, duration) { /** * Create an animation to move the map into view. This method is only valid for 2D and Columbus modes. * - * @param {Number} duration The duration, in seconds, of the animation. - * @returns {Object} The animation or undefined if the scene mode is 3D or the map is already ion view. + * @param {number} duration The duration, in seconds, of the animation. + * @returns {object} The animation or undefined if the scene mode is 3D or the map is already ion view. * * @private */ @@ -3273,20 +3273,20 @@ Camera.prototype.completeFlight = function () { /** * Flies the camera from its current position to a new position. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3|Rectangle} options.destination The final position of the camera in WGS84 (world) coordinates or a rectangle that would be visible from a top-down view. - * @param {Object} [options.orientation] An object that contains either direction and up properties or heading, pitch and roll properties. By default, the direction will point + * @param {object} [options.orientation] An object that contains either direction and up properties or heading, pitch and roll properties. By default, the direction will point * towards the center of the frame in 3D and in the negative z direction in Columbus view. The up direction will point towards local north in 3D and in the positive * y direction in Columbus view. Orientation is not used in 2D when in infinite scrolling mode. - * @param {Number} [options.duration] The duration of the flight in seconds. If omitted, Cesium attempts to calculate an ideal duration based on the distance to be traveled by the flight. + * @param {number} [options.duration] The duration of the flight in seconds. If omitted, Cesium attempts to calculate an ideal duration based on the distance to be traveled by the flight. * @param {Camera.FlightCompleteCallback} [options.complete] The function to execute when the flight is complete. * @param {Camera.FlightCancelledCallback} [options.cancel] The function to execute if the flight is cancelled. * @param {Matrix4} [options.endTransform] Transform matrix representing the reference frame the camera will be in when the flight is completed. - * @param {Number} [options.maximumHeight] The maximum height at the peak of the flight. - * @param {Number} [options.pitchAdjustHeight] If camera flyes higher than that value, adjust pitch duiring the flight to look down, and keep Earth in viewport. - * @param {Number} [options.flyOverLongitude] There are always two ways between 2 points on globe. This option force camera to choose fight direction to fly over that longitude. - * @param {Number} [options.flyOverLongitudeWeight] Fly over the lon specifyed via flyOverLongitude only if that way is not longer than short way times flyOverLongitudeWeight. - * @param {Boolean} [options.convert] Whether to convert the destination from world coordinates to scene coordinates (only relevant when not using 3D). Defaults to true. + * @param {number} [options.maximumHeight] The maximum height at the peak of the flight. + * @param {number} [options.pitchAdjustHeight] If camera flyes higher than that value, adjust pitch duiring the flight to look down, and keep Earth in viewport. + * @param {number} [options.flyOverLongitude] There are always two ways between 2 points on globe. This option force camera to choose fight direction to fly over that longitude. + * @param {number} [options.flyOverLongitudeWeight] Fly over the lon specifyed via flyOverLongitude only if that way is not longer than short way times flyOverLongitudeWeight. + * @param {boolean} [options.convert] Whether to convert the destination from world coordinates to scene coordinates (only relevant when not using 3D). Defaults to true. * @param {EasingFunction.Callback} [options.easingFunction] Controls how the time is interpolated over the duration of the flight. * * @exception {DeveloperError} If either direction or up is given, then both are required. @@ -3545,16 +3545,16 @@ const scratchFlyToBoundingSphereMatrix3 = new Matrix3(); * target will be the range. The heading will be aligned to local north.

* * @param {BoundingSphere} boundingSphere The bounding sphere to view, in world coordinates. - * @param {Object} [options] Object with the following properties: - * @param {Number} [options.duration] The duration of the flight in seconds. If omitted, Cesium attempts to calculate an ideal duration based on the distance to be traveled by the flight. + * @param {object} [options] Object with the following properties: + * @param {number} [options.duration] The duration of the flight in seconds. If omitted, Cesium attempts to calculate an ideal duration based on the distance to be traveled by the flight. * @param {HeadingPitchRange} [options.offset] The offset from the target in the local east-north-up reference frame centered at the target. * @param {Camera.FlightCompleteCallback} [options.complete] The function to execute when the flight is complete. * @param {Camera.FlightCancelledCallback} [options.cancel] The function to execute if the flight is cancelled. * @param {Matrix4} [options.endTransform] Transform matrix representing the reference frame the camera will be in when the flight is completed. - * @param {Number} [options.maximumHeight] The maximum height at the peak of the flight. - * @param {Number} [options.pitchAdjustHeight] If camera flyes higher than that value, adjust pitch duiring the flight to look down, and keep Earth in viewport. - * @param {Number} [options.flyOverLongitude] There are always two ways between 2 points on globe. This option force camera to choose fight direction to fly over that longitude. - * @param {Number} [options.flyOverLongitudeWeight] Fly over the lon specifyed via flyOverLongitude only if that way is not longer than short way times flyOverLongitudeWeight. + * @param {number} [options.maximumHeight] The maximum height at the peak of the flight. + * @param {number} [options.pitchAdjustHeight] If camera flyes higher than that value, adjust pitch duiring the flight to look down, and keep Earth in viewport. + * @param {number} [options.flyOverLongitude] There are always two ways between 2 points on globe. This option force camera to choose fight direction to fly over that longitude. + * @param {number} [options.flyOverLongitudeWeight] Fly over the lon specifyed via flyOverLongitude only if that way is not longer than short way times flyOverLongitudeWeight. * @param {EasingFunction.Callback} [options.easingFunction] Controls how the time is interpolated over the duration of the flight. */ Camera.prototype.flyToBoundingSphere = function (boundingSphere, options) { diff --git a/packages/engine/Source/Scene/CameraEventAggregator.js b/packages/engine/Source/Scene/CameraEventAggregator.js index 19bff9d4e0b9..79be40dff2bb 100644 --- a/packages/engine/Source/Scene/CameraEventAggregator.js +++ b/packages/engine/Source/Scene/CameraEventAggregator.js @@ -133,6 +133,9 @@ function listenToPinch(aggregator, modifier, canvas) { function listenToWheel(aggregator, modifier) { const key = getKey(CameraEventType.WHEEL, modifier); + const pressTime = aggregator._pressTime; + const releaseTime = aggregator._releaseTime; + const update = aggregator._update; update[key] = true; @@ -141,21 +144,29 @@ function listenToWheel(aggregator, modifier) { movement = aggregator._movement[key] = {}; } + let lastMovement = aggregator._lastMovement[key]; + if (!defined(lastMovement)) { + lastMovement = aggregator._lastMovement[key] = { + startPosition: new Cartesian2(), + endPosition: new Cartesian2(), + valid: false, + }; + } + movement.startPosition = new Cartesian2(); + Cartesian2.clone(Cartesian2.ZERO, movement.startPosition); movement.endPosition = new Cartesian2(); aggregator._eventHandler.setInputAction( function (delta) { // TODO: magic numbers const arcLength = 15.0 * CesiumMath.toRadians(delta); - if (!update[key]) { - movement.endPosition.y = movement.endPosition.y + arcLength; - } else { - Cartesian2.clone(Cartesian2.ZERO, movement.startPosition); - movement.endPosition.x = 0.0; - movement.endPosition.y = arcLength; - update[key] = false; - } + pressTime[key] = releaseTime[key] = new Date(); + movement.endPosition.x = 0.0; + movement.endPosition.y = arcLength; + Cartesian2.clone(movement.endPosition, lastMovement.endPosition); + lastMovement.valid = true; + update[key] = false; }, ScreenSpaceEventType.WHEEL, modifier @@ -358,7 +369,7 @@ Object.defineProperties(CameraEventAggregator.prototype, { /** * Gets whether any mouse button is down, a touch has started, or the wheel has been moved. * @memberof CameraEventAggregator.prototype - * @type {Boolean} + * @type {boolean} */ anyButtonDown: { get: function () { @@ -381,7 +392,7 @@ Object.defineProperties(CameraEventAggregator.prototype, { * * @param {CameraEventType} type The camera event type. * @param {KeyboardEventModifier} [modifier] The keyboard modifier. - * @returns {Boolean} Returns true if a mouse button down or touch has started and has been moved; otherwise, false + * @returns {boolean} Returns true if a mouse button down or touch has started and has been moved; otherwise, false */ CameraEventAggregator.prototype.isMoving = function (type, modifier) { //>>includeStart('debug', pragmas.debug); @@ -399,7 +410,7 @@ CameraEventAggregator.prototype.isMoving = function (type, modifier) { * * @param {CameraEventType} type The camera event type. * @param {KeyboardEventModifier} [modifier] The keyboard modifier. - * @returns {Object} An object with two {@link Cartesian2} properties: startPosition and endPosition. + * @returns {object} An object with two {@link Cartesian2} properties: startPosition and endPosition. */ CameraEventAggregator.prototype.getMovement = function (type, modifier) { //>>includeStart('debug', pragmas.debug); @@ -418,7 +429,7 @@ CameraEventAggregator.prototype.getMovement = function (type, modifier) { * * @param {CameraEventType} type The camera event type. * @param {KeyboardEventModifier} [modifier] The keyboard modifier. - * @returns {Object|undefined} An object with two {@link Cartesian2} properties: startPosition and endPosition or undefined. + * @returns {object|undefined} An object with two {@link Cartesian2} properties: startPosition and endPosition or undefined. */ CameraEventAggregator.prototype.getLastMovement = function (type, modifier) { //>>includeStart('debug', pragmas.debug); @@ -441,7 +452,7 @@ CameraEventAggregator.prototype.getLastMovement = function (type, modifier) { * * @param {CameraEventType} type The camera event type. * @param {KeyboardEventModifier} [modifier] The keyboard modifier. - * @returns {Boolean} Whether the mouse button is down or a touch has started. + * @returns {boolean} Whether the mouse button is down or a touch has started. */ CameraEventAggregator.prototype.isButtonDown = function (type, modifier) { //>>includeStart('debug', pragmas.debug); @@ -535,7 +546,7 @@ CameraEventAggregator.prototype.reset = function () { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see CameraEventAggregator#destroy */ diff --git a/packages/engine/Source/Scene/CameraEventType.js b/packages/engine/Source/Scene/CameraEventType.js index 8dcbe541fb51..730575545013 100644 --- a/packages/engine/Source/Scene/CameraEventType.js +++ b/packages/engine/Source/Scene/CameraEventType.js @@ -1,13 +1,13 @@ /** * Enumerates the available input for interacting with the camera. * - * @enum {Number} + * @enum {number} */ const CameraEventType = { /** * A left mouse button press followed by moving the mouse and releasing the button. * - * @type {Number} + * @type {number} * @constant */ LEFT_DRAG: 0, @@ -15,7 +15,7 @@ const CameraEventType = { /** * A right mouse button press followed by moving the mouse and releasing the button. * - * @type {Number} + * @type {number} * @constant */ RIGHT_DRAG: 1, @@ -23,7 +23,7 @@ const CameraEventType = { /** * A middle mouse button press followed by moving the mouse and releasing the button. * - * @type {Number} + * @type {number} * @constant */ MIDDLE_DRAG: 2, @@ -31,7 +31,7 @@ const CameraEventType = { /** * Scrolling the middle mouse button. * - * @type {Number} + * @type {number} * @constant */ WHEEL: 3, @@ -39,7 +39,7 @@ const CameraEventType = { /** * A two-finger touch on a touch surface. * - * @type {Number} + * @type {number} * @constant */ PINCH: 4, diff --git a/packages/engine/Source/Scene/Cesium3DContentGroup.js b/packages/engine/Source/Scene/Cesium3DContentGroup.js index 1694a948b7a3..bacacd718626 100644 --- a/packages/engine/Source/Scene/Cesium3DContentGroup.js +++ b/packages/engine/Source/Scene/Cesium3DContentGroup.js @@ -7,7 +7,7 @@ import defaultValue from "../Core/defaultValue.js"; * content.group.metadata much like tile metadata is accessed as * tile.metadata. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {GroupMetadata} options.metadata The metadata associated with this group. * * @alias Cesium3DContentGroup diff --git a/packages/engine/Source/Scene/Cesium3DTile.js b/packages/engine/Source/Scene/Cesium3DTile.js index 4495909c9411..efc574291377 100644 --- a/packages/engine/Source/Scene/Cesium3DTile.js +++ b/packages/engine/Source/Scene/Cesium3DTile.js @@ -138,7 +138,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { * The error, in meters, introduced if this tile is rendered and its children are not. * This is used to compute screen space error, i.e., the error measured in pixels. * - * @type {Number} + * @type {number} * @readonly */ this.geometricError = header.geometricError; @@ -264,7 +264,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { /** * When true, the tile has no content. * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -277,7 +277,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { * This is false until the tile's content is loaded. *

* - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -290,7 +290,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { * This is false until the tile's implicit content is loaded. *

* - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -305,7 +305,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { * This is false until the tile's content is loaded. *

* - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -319,7 +319,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { * * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_multiple_contents|3DTILES_multiple_contents extension} * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -362,7 +362,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { /** * The time in seconds after the tile's content is ready when the content expires and new content is requested. * - * @type {Number} + * @type {number} */ this.expireDuration = expireDuration; @@ -376,7 +376,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { /** * The time when a style was last applied to this tile. * - * @type {Number} + * @type {number} * * @private */ @@ -395,7 +395,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { * Tracks if the tile's relationship with a ClippingPlaneCollection has changed with regards * to the ClippingPlaneCollection's state. * - * @type {Boolean} + * @type {boolean} * * @private */ @@ -405,7 +405,7 @@ function Cesium3DTile(tileset, baseResource, header, parent) { * Tracks if the tile's request should be deferred until all non-deferred * tiles load. * - * @type {Boolean} + * @type {boolean} * * @private */ @@ -621,7 +621,7 @@ Object.defineProperties(Cesium3DTile.prototype, { * * @memberof Cesium3DTile.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -644,7 +644,7 @@ Object.defineProperties(Cesium3DTile.prototype, { * * @memberof Cesium3DTile.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -661,7 +661,7 @@ Object.defineProperties(Cesium3DTile.prototype, { * * @memberof Cesium3DTile.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -678,7 +678,7 @@ Object.defineProperties(Cesium3DTile.prototype, { * * @memberof Cesium3DTile.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -695,7 +695,7 @@ Object.defineProperties(Cesium3DTile.prototype, { * * @memberof Cesium3DTile.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -714,7 +714,7 @@ Object.defineProperties(Cesium3DTile.prototype, { * The promise remains undefined until the tile's content is requested. *

* - * @type {Promise.} + * @type {Promise} * @readonly * * @private @@ -731,7 +731,7 @@ Object.defineProperties(Cesium3DTile.prototype, { * The promise remains undefined until the tile's content is requested. *

* - * @type {Promise.} + * @type {Promise} * @readonly * * @private @@ -1049,7 +1049,7 @@ function createPriorityFunction(tile) { * The request may not be made if the Cesium Request Scheduler can't prioritize it. *

* - * @return {Number} The number of requests that were attempted but not scheduled. + * @return {number} The number of requests that were attempted but not scheduled. * @private */ Cesium3DTile.prototype.requestContent = function () { @@ -1449,8 +1449,8 @@ function getContentBoundingVolume(tile, frameState) { * Determines whether the tile's bounding volume intersects the culling volume. * * @param {FrameState} frameState The frame state. - * @param {Number} parentVisibilityPlaneMask The parent's plane mask to speed up the visibility check. - * @returns {Number} A plane mask as described above in {@link CullingVolume#computeVisibilityWithPlaneMask}. + * @param {number} parentVisibilityPlaneMask The parent's plane mask to speed up the visibility check. + * @returns {number} A plane mask as described above in {@link CullingVolume#computeVisibilityWithPlaneMask}. * * @private */ @@ -1527,7 +1527,7 @@ Cesium3DTile.prototype.contentVisibility = function (frameState) { * Computes the (potentially approximate) distance from the closest point of the tile's bounding volume to the camera. * * @param {FrameState} frameState The frame state. - * @returns {Number} The distance, in meters, or zero if the camera is inside the bounding volume. + * @returns {number} The distance, in meters, or zero if the camera is inside the bounding volume. * * @private */ @@ -1542,7 +1542,7 @@ const scratchToTileCenter = new Cartesian3(); * Computes the distance from the center of the tile's bounding volume to the camera's plane defined by its position and view direction. * * @param {FrameState} frameState The frame state. - * @returns {Number} The distance, in meters. + * @returns {number} The distance, in meters. * * @private */ @@ -1561,7 +1561,7 @@ Cesium3DTile.prototype.distanceToTileCenter = function (frameState) { * Checks if the camera is inside the viewer request volume. * * @param {FrameState} frameState The frame state. - * @returns {Boolean} Whether the camera is inside the volume. + * @returns {boolean} Whether the camera is inside the volume. * * @private */ @@ -1687,7 +1687,7 @@ function createSphere(sphere, transform, result) { /** * Create a bounding volume from the tile's bounding volume header. * - * @param {Object} boundingVolumeHeader The tile's bounding volume header. + * @param {object} boundingVolumeHeader The tile's bounding volume header. * @param {Matrix4} transform The transform to apply to the bounding volume. * @param {TileBoundingVolume} [result] The object onto which to store the result. * diff --git a/packages/engine/Source/Scene/Cesium3DTileBatchTable.js b/packages/engine/Source/Scene/Cesium3DTileBatchTable.js index 4430c4c0c353..a892b0f94945 100644 --- a/packages/engine/Source/Scene/Cesium3DTileBatchTable.js +++ b/packages/engine/Source/Scene/Cesium3DTileBatchTable.js @@ -88,7 +88,7 @@ Object.defineProperties(Cesium3DTileBatchTable.prototype, { * buffers and any binary properties. JSON data is not counted. * * @memberof Cesium3DTileBatchTable.prototype - * @type {Number} + * @type {number} * @readonly * @private */ diff --git a/packages/engine/Source/Scene/Cesium3DTileColorBlendMode.js b/packages/engine/Source/Scene/Cesium3DTileColorBlendMode.js index 3970583d5870..8ae81db8e3de 100644 --- a/packages/engine/Source/Scene/Cesium3DTileColorBlendMode.js +++ b/packages/engine/Source/Scene/Cesium3DTileColorBlendMode.js @@ -22,13 +22,13 @@ * } * * - * @enum {Number} + * @enum {number} */ const Cesium3DTileColorBlendMode = { /** * Multiplies the source color by the feature color. * - * @type {Number} + * @type {number} * @constant */ HIGHLIGHT: 0, @@ -36,7 +36,7 @@ const Cesium3DTileColorBlendMode = { /** * Replaces the source color with the feature color. * - * @type {Number} + * @type {number} * @constant */ REPLACE: 1, @@ -44,7 +44,7 @@ const Cesium3DTileColorBlendMode = { /** * Blends the source color and feature color together. * - * @type {Number} + * @type {number} * @constant */ MIX: 2, diff --git a/packages/engine/Source/Scene/Cesium3DTileContent.js b/packages/engine/Source/Scene/Cesium3DTileContent.js index 3ec029bfc8cf..c5464c418e0b 100644 --- a/packages/engine/Source/Scene/Cesium3DTileContent.js +++ b/packages/engine/Source/Scene/Cesium3DTileContent.js @@ -22,7 +22,7 @@ function Cesium3DTileContent() { * not part of the public Cesium API. *

* - * @type {Boolean} + * @type {boolean} * * @private */ @@ -35,7 +35,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, { * * @memberof Cesium3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly */ featuresLength: { @@ -56,7 +56,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, { * * @memberof Cesium3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly */ pointsLength: { @@ -71,7 +71,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, { * * @memberof Cesium3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly */ trianglesLength: { @@ -86,7 +86,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, { * * @memberof Cesium3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly */ geometryByteLength: { @@ -101,7 +101,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, { * * @memberof Cesium3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly */ texturesByteLength: { @@ -118,7 +118,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, { * * @memberof Cesium3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly */ batchTableByteLength: { @@ -150,7 +150,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, { * * @memberof Cesium3DTileContent.prototype * - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -194,7 +194,7 @@ Object.defineProperties(Cesium3DTileContent.prototype, { * Gets the url of the tile's content. * @memberof Cesium3DTileContent.prototype * - * @type {String} + * @type {string} * @readonly */ url: { @@ -274,9 +274,9 @@ Object.defineProperties(Cesium3DTileContent.prototype, { /** * Returns whether the feature has this property. * - * @param {Number} batchId The batchId for the feature. - * @param {String} name The case-sensitive name of the property. - * @returns {Boolean} true if the feature has this property; otherwise, false. + * @param {number} batchId The batchId for the feature. + * @param {string} name The case-sensitive name of the property. + * @returns {boolean} true if the feature has this property; otherwise, false. */ Cesium3DTileContent.prototype.hasProperty = function (batchId, name) { DeveloperError.throwInstantiationError(); @@ -292,7 +292,7 @@ Cesium3DTileContent.prototype.hasProperty = function (batchId, name) { * * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/TileFormats/BatchTable}. * - * @param {Number} batchId The batchId for the feature. + * @param {number} batchId The batchId for the feature. * @returns {Cesium3DTileFeature} The corresponding {@link Cesium3DTileFeature} object. * * @exception {DeveloperError} batchId must be between zero and {@link Cesium3DTileContent#featuresLength} - 1. @@ -308,7 +308,7 @@ Cesium3DTileContent.prototype.getFeature = function (batchId) { * not part of the public Cesium API. *

* - * @param {Boolean} enabled Whether to enable or disable debug settings. + * @param {boolean} enabled Whether to enable or disable debug settings. * @returns {Cesium3DTileFeature} The corresponding {@link Cesium3DTileFeature} object. * @private @@ -360,7 +360,7 @@ Cesium3DTileContent.prototype.update = function (tileset, frameState) { * not part of the public Cesium API. *

* - * @returns {Boolean} true if this object was destroyed; otherwise, false. + * @returns {boolean} true if this object was destroyed; otherwise, false. * * @see Cesium3DTileContent#destroy * diff --git a/packages/engine/Source/Scene/Cesium3DTileContentType.js b/packages/engine/Source/Scene/Cesium3DTileContentType.js index 39caeef85792..8167d13e7583 100644 --- a/packages/engine/Source/Scene/Cesium3DTileContentType.js +++ b/packages/engine/Source/Scene/Cesium3DTileContentType.js @@ -4,7 +4,7 @@ * unless otherwise noted. For JSON files, the enum value is a unique name * for internal use. * - * @enum {String} + * @enum {string} * @see Cesium3DTileContent * * @private @@ -14,7 +14,7 @@ const Cesium3DTileContentType = { * A Batched 3D Model. This is a binary format with * magic number b3dm * - * @type {String} + * @type {string} * @constant * @private */ @@ -23,7 +23,7 @@ const Cesium3DTileContentType = { * An Instanced 3D Model. This is a binary format with magic number * i3dm * - * @type {String} + * @type {string} * @constant * @private */ @@ -32,7 +32,7 @@ const Cesium3DTileContentType = { * A Composite model. This is a binary format with magic number * cmpt * - * @type {String} + * @type {string} * @constant * @private */ @@ -41,7 +41,7 @@ const Cesium3DTileContentType = { * A Point Cloud model. This is a binary format with magic number * pnts * - * @type {String} + * @type {string} * @constant * @private */ @@ -50,7 +50,7 @@ const Cesium3DTileContentType = { * Vector tiles. This is a binary format with magic number * vctr * - * @type {String} + * @type {string} * @constant * @private */ @@ -59,7 +59,7 @@ const Cesium3DTileContentType = { * Geometry tiles. This is a binary format with magic number * geom * - * @type {String} + * @type {string} * @constant * @private */ @@ -68,7 +68,7 @@ const Cesium3DTileContentType = { * A glTF model in JSON + external BIN form. This is treated * as a JSON format. * - * @type {String} + * @type {string} * @constant * @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. @@ -79,7 +79,7 @@ const Cesium3DTileContentType = { * changed from glTF to glb to distinguish it from * the JSON glTF format. * - * @type {String} + * @type {string} * @constant * @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. @@ -89,7 +89,7 @@ const Cesium3DTileContentType = { * For implicit tiling, availability bitstreams are stored in binary subtree files. * The magic number is subt * - * @type {String} + * @type {string} * @constant * @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. @@ -98,7 +98,7 @@ const Cesium3DTileContentType = { /** * For implicit tiling. Subtrees can also be represented as JSON files. * - * @type {String} + * @type {string} * @constant * @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. @@ -108,7 +108,7 @@ const Cesium3DTileContentType = { * Contents can reference another tileset.json to use * as an external tileset. This is a JSON-based format. * - * @type {String} + * @type {string} * @constant * @private */ @@ -117,7 +117,7 @@ const Cesium3DTileContentType = { * Multiple contents are handled separately from the other content types * due to differences in request scheduling. * - * @type {String} + * @type {string} * @constant * @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. @@ -126,7 +126,7 @@ const Cesium3DTileContentType = { /** * GeoJSON content for MAXAR_content_geojson extension. * - * @type {String} + * @type {string} * @constant * @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. @@ -135,7 +135,7 @@ const Cesium3DTileContentType = { /** * Binary voxel content for 3DTILES_content_voxels extension. * - * @type {String} + * @type {string} * @constant * @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. @@ -144,7 +144,7 @@ const Cesium3DTileContentType = { /** * Binary voxel content for 3DTILES_content_voxels extension. * - * @type {String} + * @type {string} * @constant * @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. @@ -156,7 +156,7 @@ const Cesium3DTileContentType = { * Check if a content is one of the supported binary formats. Otherwise, * the caller can assume a JSON format. * @param {Cesium3DTileContentType} contentType The content type of the content payload. - * @return {Boolean} true if the content type is a binary format, or false if the content type is a JSON format. + * @return {boolean} true if the content type is a binary format, or false if the content type is a JSON format. * @private */ Cesium3DTileContentType.isBinaryFormat = function (contentType) { diff --git a/packages/engine/Source/Scene/Cesium3DTileFeature.js b/packages/engine/Source/Scene/Cesium3DTileFeature.js index a19347705e36..49d3dd06e1c8 100644 --- a/packages/engine/Source/Scene/Cesium3DTileFeature.js +++ b/packages/engine/Source/Scene/Cesium3DTileFeature.js @@ -49,7 +49,7 @@ Object.defineProperties(Cesium3DTileFeature.prototype, { * * @memberof Cesium3DTileFeature.prototype * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -160,7 +160,7 @@ Object.defineProperties(Cesium3DTileFeature.prototype, { * * @memberof Cesium3DTileFeature.prototype * - * @type {Number} + * @type {number} * * @readonly * @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. @@ -187,8 +187,8 @@ Object.defineProperties(Cesium3DTileFeature.prototype, { * * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy} * - * @param {String} name The case-sensitive name of the property. - * @returns {Boolean} Whether the feature contains this property. + * @param {string} name The case-sensitive name of the property. + * @returns {boolean} Whether the feature contains this property. */ Cesium3DTileFeature.prototype.hasProperty = function (name) { return this._content.batchTable.hasProperty(this._batchId, name); @@ -200,8 +200,8 @@ Cesium3DTileFeature.prototype.hasProperty = function (name) { * * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy} * - * @param {String[]} [results] An array into which to store the results. - * @returns {String[]} The IDs of the feature's properties. + * @param {string[]} [results] An array into which to store the results. + * @returns {string[]} The IDs of the feature's properties. */ Cesium3DTileFeature.prototype.getPropertyIds = function (results) { return this._content.batchTable.getPropertyIds(this._batchId, results); @@ -213,7 +213,7 @@ Cesium3DTileFeature.prototype.getPropertyIds = function (results) { * * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy} * - * @param {String} name The case-sensitive name of the property. + * @param {string} name The case-sensitive name of the property. * @returns {*} The value of the property or undefined if the feature does not have this property. * * @example @@ -259,8 +259,8 @@ Cesium3DTileFeature.prototype.getProperty = function (name) { *

* * @param {Cesium3DTileContent} content The content for accessing the metadata - * @param {Number} batchId The batch ID (or feature ID) of the feature to get a property for - * @param {String} name The semantic or property ID of the feature. Semantics are checked before property IDs in each granularity of metadata. + * @param {number} batchId The batch ID (or feature ID) of the feature to get a property for + * @param {string} name The semantic or property ID of the feature. Semantics are checked before property IDs in each granularity of metadata. * @return {*} The value of the property or undefined if the feature does not have this property. * * @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. @@ -353,7 +353,7 @@ Cesium3DTileFeature.getPropertyInherited = function (content, batchId, name) { * tileset. Within each granularity, semantics are resolved first, then other * properties. *

- * @param {String} name The case-sensitive name of the property. + * @param {string} name The case-sensitive name of the property. * @returns {*} The value of the property or undefined if the feature does not have this property. * @private */ @@ -371,7 +371,7 @@ Cesium3DTileFeature.prototype.getPropertyInherited = function (name) { * If a property with the given name doesn't exist, it is created. *

* - * @param {String} name The case-sensitive name of the property. + * @param {string} name The case-sensitive name of the property. * @param {*} value The value of the property that will be copied. * * @exception {DeveloperError} Inherited batch table hierarchy property is read only. @@ -404,8 +404,8 @@ Cesium3DTileFeature.prototype.setProperty = function (name, value) { * This function returns false if no batch table hierarchy is present. *

* - * @param {String} className The name to check against. - * @returns {Boolean} Whether the feature's class name equals className + * @param {string} className The name to check against. + * @returns {boolean} Whether the feature's class name equals className * * @private */ @@ -419,8 +419,8 @@ Cesium3DTileFeature.prototype.isExactClass = function (className) { * This function returns false if no batch table hierarchy is present. *

* - * @param {String} className The name to check against. - * @returns {Boolean} Whether the feature's class or inherited classes are named className + * @param {string} className The name to check against. + * @returns {boolean} Whether the feature's class or inherited classes are named className * * @private */ @@ -434,7 +434,7 @@ Cesium3DTileFeature.prototype.isClass = function (className) { * This function returns undefined if no batch table hierarchy is present. *

* - * @returns {String} The feature's class name. + * @returns {string} The feature's class name. * * @private */ diff --git a/packages/engine/Source/Scene/Cesium3DTileOptimizationHint.js b/packages/engine/Source/Scene/Cesium3DTileOptimizationHint.js index bef800f818c7..11e484eefe2b 100644 --- a/packages/engine/Source/Scene/Cesium3DTileOptimizationHint.js +++ b/packages/engine/Source/Scene/Cesium3DTileOptimizationHint.js @@ -1,7 +1,7 @@ /** * Hint defining optimization support for a 3D tile * - * @enum {Number} + * @enum {number} * * @private */ diff --git a/packages/engine/Source/Scene/Cesium3DTileOptimizations.js b/packages/engine/Source/Scene/Cesium3DTileOptimizations.js index 79281e3788c5..9e836942f74c 100644 --- a/packages/engine/Source/Scene/Cesium3DTileOptimizations.js +++ b/packages/engine/Source/Scene/Cesium3DTileOptimizations.js @@ -25,7 +25,7 @@ const scratchAxis = new Cartesian3(); * partially outside of the parent bounds. * * @param {Cesium3DTile} tile The tile to check. - * @returns {Boolean} Whether the childrenWithinParent optimization is supported. + * @returns {boolean} Whether the childrenWithinParent optimization is supported. */ Cesium3DTileOptimizations.checkChildrenWithinParent = function (tile) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Scene/Cesium3DTilePassState.js b/packages/engine/Source/Scene/Cesium3DTilePassState.js index ac53e44fad48..d86c774faf51 100644 --- a/packages/engine/Source/Scene/Cesium3DTilePassState.js +++ b/packages/engine/Source/Scene/Cesium3DTilePassState.js @@ -43,7 +43,7 @@ function Cesium3DTilePassState(options) { /** * A read-only property that indicates whether the pass is ready, i.e. all tiles needed by the pass are loaded. * - * @type {Boolean} + * @type {boolean} * @readonly * @default false */ diff --git a/packages/engine/Source/Scene/Cesium3DTilePointFeature.js b/packages/engine/Source/Scene/Cesium3DTilePointFeature.js index 77028911b3c2..01158482ac53 100644 --- a/packages/engine/Source/Scene/Cesium3DTilePointFeature.js +++ b/packages/engine/Source/Scene/Cesium3DTilePointFeature.js @@ -80,7 +80,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -123,7 +123,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {Number} + * @type {number} */ pointSize: { get: function () { @@ -163,7 +163,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {Number} + * @type {number} */ pointOutlineWidth: { get: function () { @@ -222,7 +222,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {Number} + * @type {number} */ labelOutlineWidth: { get: function () { @@ -241,7 +241,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {String} + * @type {string} */ font: { get: function () { @@ -276,7 +276,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {String} + * @type {string} */ labelText: { get: function () { @@ -336,7 +336,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {Boolean} + * @type {boolean} */ backgroundEnabled: { get: function () { @@ -404,7 +404,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {Number} + * @type {number} */ heightOffset: { get: function () { @@ -437,7 +437,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {Boolean} + * @type {boolean} */ anchorLineEnabled: { get: function () { @@ -475,7 +475,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {String} + * @type {string} */ image: { get: function () { @@ -495,7 +495,7 @@ Object.defineProperties(Cesium3DTilePointFeature.prototype, { * * @memberof Cesium3DTilePointFeature.prototype * - * @type {Number} + * @type {number} */ disableDepthTestDistance: { get: function () { @@ -719,8 +719,8 @@ function setBillboardImage(feature) { * * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy} * - * @param {String} name The case-sensitive name of the property. - * @returns {Boolean} Whether the feature contains this property. + * @param {string} name The case-sensitive name of the property. + * @returns {boolean} Whether the feature contains this property. */ Cesium3DTilePointFeature.prototype.hasProperty = function (name) { return this._content.batchTable.hasProperty(this._batchId, name); @@ -732,8 +732,8 @@ Cesium3DTilePointFeature.prototype.hasProperty = function (name) { * * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy} * - * @param {String[]} [results] An array into which to store the results. - * @returns {String[]} The IDs of the feature's properties. + * @param {string[]} [results] An array into which to store the results. + * @returns {string[]} The IDs of the feature's properties. */ Cesium3DTilePointFeature.prototype.getPropertyIds = function (results) { return this._content.batchTable.getPropertyIds(this._batchId, results); @@ -745,7 +745,7 @@ Cesium3DTilePointFeature.prototype.getPropertyIds = function (results) { * * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_batch_table_hierarchy} * - * @param {String} name The case-sensitive name of the property. + * @param {string} name The case-sensitive name of the property. * @returns {*} The value of the property or undefined if the feature does not have this property. * * @example @@ -772,7 +772,7 @@ Cesium3DTilePointFeature.prototype.getProperty = function (name) { * tileset. Within each granularity, semantics are resolved first, then other * properties. *

- * @param {String} name The case-sensitive name of the property. + * @param {string} name The case-sensitive name of the property. * @returns {*} The value of the property or undefined if the feature does not have this property. * @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. @@ -791,7 +791,7 @@ Cesium3DTilePointFeature.prototype.getPropertyInherited = function (name) { * If a property with the given name doesn't exist, it is created. *

* - * @param {String} name The case-sensitive name of the property. + * @param {string} name The case-sensitive name of the property. * @param {*} value The value of the property that will be copied. * * @exception {DeveloperError} Inherited batch table hierarchy property is read only. @@ -824,8 +824,8 @@ Cesium3DTilePointFeature.prototype.setProperty = function (name, value) { * This function returns false if no batch table hierarchy is present. *

* - * @param {String} className The name to check against. - * @returns {Boolean} Whether the feature's class name equals className + * @param {string} className The name to check against. + * @returns {boolean} Whether the feature's class name equals className * * @private */ @@ -839,8 +839,8 @@ Cesium3DTilePointFeature.prototype.isExactClass = function (className) { * This function returns false if no batch table hierarchy is present. *

* - * @param {String} className The name to check against. - * @returns {Boolean} Whether the feature's class or inherited classes are named className + * @param {string} className The name to check against. + * @returns {boolean} Whether the feature's class or inherited classes are named className * * @private */ @@ -854,7 +854,7 @@ Cesium3DTilePointFeature.prototype.isClass = function (className) { * This function returns undefined if no batch table hierarchy is present. *

* - * @returns {String} The feature's class name. + * @returns {string} The feature's class name. * * @private */ diff --git a/packages/engine/Source/Scene/Cesium3DTileRefine.js b/packages/engine/Source/Scene/Cesium3DTileRefine.js index 01d0e8d2c252..4b998df48e68 100644 --- a/packages/engine/Source/Scene/Cesium3DTileRefine.js +++ b/packages/engine/Source/Scene/Cesium3DTileRefine.js @@ -5,7 +5,7 @@ * in the 3D Tiles spec. *

* - * @enum {Number} + * @enum {number} * * @private */ @@ -13,7 +13,7 @@ const Cesium3DTileRefine = { /** * Render this tile and, if it doesn't meet the screen space error, also refine to its children. * - * @type {Number} + * @type {number} * @constant */ ADD: 0, @@ -21,7 +21,7 @@ const Cesium3DTileRefine = { /** * Render this tile or, if it doesn't meet the screen space error, refine to its descendants instead. * - * @type {Number} + * @type {number} * @constant */ REPLACE: 1, diff --git a/packages/engine/Source/Scene/Cesium3DTileStyle.js b/packages/engine/Source/Scene/Cesium3DTileStyle.js index e4b73ca6f977..b5cd56c60d37 100644 --- a/packages/engine/Source/Scene/Cesium3DTileStyle.js +++ b/packages/engine/Source/Scene/Cesium3DTileStyle.js @@ -16,7 +16,7 @@ import Expression from "./Expression.js"; * @alias Cesium3DTileStyle * @constructor * - * @param {Object} [style] An object defining a style. + * @param {object} [style] An object defining a style. * * @example * tileset.style = new Cesium.Cesium3DTileStyle({ @@ -166,7 +166,7 @@ Object.defineProperties(Cesium3DTileStyle.prototype, { * * @memberof Cesium3DTileStyle.prototype * - * @type {Object} + * @type {object} * @readonly * * @default {} @@ -1313,9 +1313,9 @@ Object.defineProperties(Cesium3DTileStyle.prototype, { /** * Asynchronously creates a Cesium3DTileStyle from a url. * - * @param {Resource|String} url The url of the style to be loaded. + * @param {Resource|string} url The url of the style to be loaded. * - * @returns {Promise.} A promise which resolves to the created style + * @returns {Promise} A promise which resolves to the created style * * @private */ @@ -1335,11 +1335,11 @@ Cesium3DTileStyle.fromUrl = function (url) { /** * Gets the color shader function for this style. * - * @param {String} functionSignature Signature of the generated function. - * @param {Object} variableSubstitutionMap Maps variable names to shader variable names. - * @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent. + * @param {string} functionSignature Signature of the generated function. + * @param {object} variableSubstitutionMap Maps variable names to shader variable names. + * @param {object} shaderState Stores information about the generated shader function, including whether it is translucent. * - * @returns {String} The shader function. + * @returns {string} The shader function. * * @private */ @@ -1373,11 +1373,11 @@ Cesium3DTileStyle.prototype.getColorShaderFunction = function ( /** * Gets the show shader function for this style. * - * @param {String} functionSignature Signature of the generated function. - * @param {Object} variableSubstitutionMap Maps variable names to shader variable names. - * @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent. + * @param {string} functionSignature Signature of the generated function. + * @param {object} variableSubstitutionMap Maps variable names to shader variable names. + * @param {object} shaderState Stores information about the generated shader function, including whether it is translucent. * - * @returns {String} The shader function. + * @returns {string} The shader function. * * @private */ @@ -1409,11 +1409,11 @@ Cesium3DTileStyle.prototype.getShowShaderFunction = function ( /** * Gets the pointSize shader function for this style. * - * @param {String} functionSignature Signature of the generated function. - * @param {Object} variableSubstitutionMap Maps variable names to shader variable names. - * @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent. + * @param {string} functionSignature Signature of the generated function. + * @param {object} variableSubstitutionMap Maps variable names to shader variable names. + * @param {object} shaderState Stores information about the generated shader function, including whether it is translucent. * - * @returns {String} The shader function. + * @returns {string} The shader function. * * @private */ @@ -1445,7 +1445,7 @@ Cesium3DTileStyle.prototype.getPointSizeShaderFunction = function ( /** * Gets the variables used by the style. * - * @returns {String[]} The variables used by the style. + * @returns {string[]} The variables used by the style. * * @private */ diff --git a/packages/engine/Source/Scene/Cesium3DTilesVoxelProvider.js b/packages/engine/Source/Scene/Cesium3DTilesVoxelProvider.js index 90477276db8d..69a729ff49cd 100644 --- a/packages/engine/Source/Scene/Cesium3DTilesVoxelProvider.js +++ b/packages/engine/Source/Scene/Cesium3DTilesVoxelProvider.js @@ -33,8 +33,8 @@ import VoxelShapeType from "./VoxelShapeType.js"; * @constructor * @augments VoxelProvider * - * @param {Object} options Object with the following properties: - * @param {Resource|String|Promise|Promise} options.url The URL to a tileset JSON file. + * @param {object} options Object with the following properties: + * @param {Resource|string|Promise|Promise} options.url The URL to a tileset JSON file. * * @see VoxelProvider * @see VoxelPrimitive diff --git a/packages/engine/Source/Scene/Cesium3DTileset.js b/packages/engine/Source/Scene/Cesium3DTileset.js index 1c2a9327103b..c4b67cc0a688 100644 --- a/packages/engine/Source/Scene/Cesium3DTileset.js +++ b/packages/engine/Source/Scene/Cesium3DTileset.js @@ -60,66 +60,66 @@ import TileOrientedBoundingBox from "./TileOrientedBoundingBox.js"; * @alias Cesium3DTileset * @constructor * - * @param {Object} options Object with the following properties: - * @param {Resource|String|Promise|Promise} options.url The url to a tileset JSON file. - * @param {Boolean} [options.show=true] Determines if the tileset will be shown. + * @param {object} options Object with the following properties: + * @param {Resource|string|Promise|Promise} options.url The url to a tileset JSON file. + * @param {boolean} [options.show=true] Determines if the tileset will be shown. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] A 4x4 transformation matrix that transforms the tileset's root tile. * @param {Axis} [options.modelUpAxis=Axis.Y] Which axis is considered up when loading models for tile contents. * @param {Axis} [options.modelForwardAxis=Axis.X] Which axis is considered forward when loading models for tile contents. * @param {ShadowMode} [options.shadows=ShadowMode.ENABLED] Determines whether the tileset casts or receives shadows from light sources. - * @param {Number} [options.maximumScreenSpaceError=16] The maximum screen space error used to drive level of detail refinement. - * @param {Number} [options.maximumMemoryUsage=512] The maximum amount of memory in MB that can be used by the tileset. - * @param {Boolean} [options.cullWithChildrenBounds=true] Optimization option. Whether to cull tiles using the union of their children bounding volumes. - * @param {Boolean} [options.cullRequestsWhileMoving=true] Optimization option. Don't request tiles that will likely be unused when they come back because of the camera's movement. This optimization only applies to stationary tilesets. - * @param {Number} [options.cullRequestsWhileMovingMultiplier=60.0] Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling. - * @param {Boolean} [options.preloadWhenHidden=false] Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them. - * @param {Boolean} [options.preloadFlightDestinations=true] Optimization option. Preload tiles at the camera's flight destination while the camera is in flight. - * @param {Boolean} [options.preferLeaves=false] Optimization option. Prefer loading of leaves first. - * @param {Boolean} [options.dynamicScreenSpaceError=false] Optimization option. Reduce the screen space error for tiles that are further away from the camera. - * @param {Number} [options.dynamicScreenSpaceErrorDensity=0.00278] Density used to adjust the dynamic screen space error, similar to fog density. - * @param {Number} [options.dynamicScreenSpaceErrorFactor=4.0] A factor used to increase the computed dynamic screen space error. - * @param {Number} [options.dynamicScreenSpaceErrorHeightFalloff=0.25] A ratio of the tileset's height at which the density starts to falloff. - * @param {Number} [options.progressiveResolutionHeightFraction=0.3] Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of progressiveResolutionHeightFraction*screenHeight will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load. - * @param {Boolean} [options.foveatedScreenSpaceError=true] Optimization option. Prioritize loading tiles in the center of the screen by temporarily raising the screen space error for tiles around the edge of the screen. Screen space error returns to normal once all the tiles in the center of the screen as determined by the {@link Cesium3DTileset#foveatedConeSize} are loaded. - * @param {Number} [options.foveatedConeSize=0.1] Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the cone size that determines which tiles are deferred. Tiles that are inside this cone are loaded immediately. Tiles outside the cone are potentially deferred based on how far outside the cone they are and their screen space error. This is controlled by {@link Cesium3DTileset#foveatedInterpolationCallback} and {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation}. Setting this to 0.0 means the cone will be the line formed by the camera position and its view direction. Setting this to 1.0 means the cone encompasses the entire field of view of the camera, disabling the effect. - * @param {Number} [options.foveatedMinimumScreenSpaceErrorRelaxation=0.0] Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the starting screen space error relaxation for tiles outside the foveated cone. The screen space error will be raised starting with tileset value up to {@link Cesium3DTileset#maximumScreenSpaceError} based on the provided {@link Cesium3DTileset#foveatedInterpolationCallback}. + * @param {number} [options.maximumScreenSpaceError=16] The maximum screen space error used to drive level of detail refinement. + * @param {number} [options.maximumMemoryUsage=512] The maximum amount of memory in MB that can be used by the tileset. + * @param {boolean} [options.cullWithChildrenBounds=true] Optimization option. Whether to cull tiles using the union of their children bounding volumes. + * @param {boolean} [options.cullRequestsWhileMoving=true] Optimization option. Don't request tiles that will likely be unused when they come back because of the camera's movement. This optimization only applies to stationary tilesets. + * @param {number} [options.cullRequestsWhileMovingMultiplier=60.0] Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling. + * @param {boolean} [options.preloadWhenHidden=false] Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them. + * @param {boolean} [options.preloadFlightDestinations=true] Optimization option. Preload tiles at the camera's flight destination while the camera is in flight. + * @param {boolean} [options.preferLeaves=false] Optimization option. Prefer loading of leaves first. + * @param {boolean} [options.dynamicScreenSpaceError=false] Optimization option. Reduce the screen space error for tiles that are further away from the camera. + * @param {number} [options.dynamicScreenSpaceErrorDensity=0.00278] Density used to adjust the dynamic screen space error, similar to fog density. + * @param {number} [options.dynamicScreenSpaceErrorFactor=4.0] A factor used to increase the computed dynamic screen space error. + * @param {number} [options.dynamicScreenSpaceErrorHeightFalloff=0.25] A ratio of the tileset's height at which the density starts to falloff. + * @param {number} [options.progressiveResolutionHeightFraction=0.3] Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of progressiveResolutionHeightFraction*screenHeight will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load. + * @param {boolean} [options.foveatedScreenSpaceError=true] Optimization option. Prioritize loading tiles in the center of the screen by temporarily raising the screen space error for tiles around the edge of the screen. Screen space error returns to normal once all the tiles in the center of the screen as determined by the {@link Cesium3DTileset#foveatedConeSize} are loaded. + * @param {number} [options.foveatedConeSize=0.1] Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the cone size that determines which tiles are deferred. Tiles that are inside this cone are loaded immediately. Tiles outside the cone are potentially deferred based on how far outside the cone they are and their screen space error. This is controlled by {@link Cesium3DTileset#foveatedInterpolationCallback} and {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation}. Setting this to 0.0 means the cone will be the line formed by the camera position and its view direction. Setting this to 1.0 means the cone encompasses the entire field of view of the camera, disabling the effect. + * @param {number} [options.foveatedMinimumScreenSpaceErrorRelaxation=0.0] Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control the starting screen space error relaxation for tiles outside the foveated cone. The screen space error will be raised starting with tileset value up to {@link Cesium3DTileset#maximumScreenSpaceError} based on the provided {@link Cesium3DTileset#foveatedInterpolationCallback}. * @param {Cesium3DTileset.foveatedInterpolationCallback} [options.foveatedInterpolationCallback=Math.lerp] Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control how much to raise the screen space error for tiles outside the foveated cone, interpolating between {@link Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation} and {@link Cesium3DTileset#maximumScreenSpaceError} - * @param {Number} [options.foveatedTimeDelay=0.2] Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control how long in seconds to wait after the camera stops moving before deferred tiles start loading in. This time delay prevents requesting tiles around the edges of the screen when the camera is moving. Setting this to 0.0 will immediately request all tiles in any given view. - * @param {Boolean} [options.skipLevelOfDetail=false] Optimization option. Determines if level of detail skipping should be applied during the traversal. - * @param {Number} [options.baseScreenSpaceError=1024] When skipLevelOfDetail is true, the screen space error that must be reached before skipping levels of detail. - * @param {Number} [options.skipScreenSpaceErrorFactor=16] When skipLevelOfDetail is true, a multiplier defining the minimum screen space error to skip. Used in conjunction with skipLevels to determine which tiles to load. - * @param {Number} [options.skipLevels=1] When skipLevelOfDetail is true, a constant defining the minimum number of levels to skip when loading tiles. When it is 0, no levels are skipped. Used in conjunction with skipScreenSpaceErrorFactor to determine which tiles to load. - * @param {Boolean} [options.immediatelyLoadDesiredLevelOfDetail=false] When skipLevelOfDetail is true, only tiles that meet the maximum screen space error will ever be downloaded. Skipping factors are ignored and just the desired tiles are loaded. - * @param {Boolean} [options.loadSiblings=false] When skipLevelOfDetail is true, determines whether siblings of visible tiles are always downloaded during traversal. + * @param {number} [options.foveatedTimeDelay=0.2] Optimization option. Used when {@link Cesium3DTileset#foveatedScreenSpaceError} is true to control how long in seconds to wait after the camera stops moving before deferred tiles start loading in. This time delay prevents requesting tiles around the edges of the screen when the camera is moving. Setting this to 0.0 will immediately request all tiles in any given view. + * @param {boolean} [options.skipLevelOfDetail=false] Optimization option. Determines if level of detail skipping should be applied during the traversal. + * @param {number} [options.baseScreenSpaceError=1024] When skipLevelOfDetail is true, the screen space error that must be reached before skipping levels of detail. + * @param {number} [options.skipScreenSpaceErrorFactor=16] When skipLevelOfDetail is true, a multiplier defining the minimum screen space error to skip. Used in conjunction with skipLevels to determine which tiles to load. + * @param {number} [options.skipLevels=1] When skipLevelOfDetail is true, a constant defining the minimum number of levels to skip when loading tiles. When it is 0, no levels are skipped. Used in conjunction with skipScreenSpaceErrorFactor to determine which tiles to load. + * @param {boolean} [options.immediatelyLoadDesiredLevelOfDetail=false] When skipLevelOfDetail is true, only tiles that meet the maximum screen space error will ever be downloaded. Skipping factors are ignored and just the desired tiles are loaded. + * @param {boolean} [options.loadSiblings=false] When skipLevelOfDetail is true, determines whether siblings of visible tiles are always downloaded during traversal. * @param {ClippingPlaneCollection} [options.clippingPlanes] The {@link ClippingPlaneCollection} used to selectively disable rendering the tileset. * @param {ClassificationType} [options.classificationType] Determines whether terrain, 3D Tiles or both will be classified by this tileset. See {@link Cesium3DTileset#classificationType} for details about restrictions and limitations. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid determining the size and shape of the globe. - * @param {Object} [options.pointCloudShading] Options for constructing a {@link PointCloudShading} object to control point attenuation based on geometric error and lighting. + * @param {object} [options.pointCloudShading] Options for constructing a {@link PointCloudShading} object to control point attenuation based on geometric error and lighting. * @param {Cartesian3} [options.lightColor] The light color when shading models. When undefined the scene's light color is used instead. * @param {ImageBasedLighting} [options.imageBasedLighting] The properties for managing image-based lighting for this tileset. - * @param {Boolean} [options.backFaceCulling=true] Whether to cull back-facing geometry. When true, back face culling is determined by the glTF material's doubleSided property; when false, back face culling is disabled. - * @param {Boolean} [options.enableShowOutline=true] Whether to enable outlines for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set to false to avoid the additional processing of geometry at load time. When false, the showOutlines and outlineColor options are ignored. - * @param {Boolean} [options.showOutline=true] Whether to display the outline for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. When true, outlines are displayed. When false, outlines are not displayed. + * @param {boolean} [options.backFaceCulling=true] Whether to cull back-facing geometry. When true, back face culling is determined by the glTF material's doubleSided property; when false, back face culling is disabled. + * @param {boolean} [options.enableShowOutline=true] Whether to enable outlines for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set to false to avoid the additional processing of geometry at load time. When false, the showOutlines and outlineColor options are ignored. + * @param {boolean} [options.showOutline=true] Whether to display the outline for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. When true, outlines are displayed. When false, outlines are not displayed. * @param {Color} [options.outlineColor=Color.BLACK] The color to use when rendering outlines. - * @param {Boolean} [options.vectorClassificationOnly=false] Indicates that only the tileset's vector tiles should be used for classification. - * @param {Boolean} [options.vectorKeepDecodedPositions=false] Whether vector tiles should keep decoded positions in memory. This is used with {@link Cesium3DTileFeature.getPolylinePositions}. - * @param {String|Number} [options.featureIdLabel="featureId_0"] Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. - * @param {String|Number} [options.instanceFeatureIdLabel="instanceFeatureId_0"] Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. - * @param {Boolean} [options.showCreditsOnScreen=false] Whether to display the credits of this tileset on screen. + * @param {boolean} [options.vectorClassificationOnly=false] Indicates that only the tileset's vector tiles should be used for classification. + * @param {boolean} [options.vectorKeepDecodedPositions=false] Whether vector tiles should keep decoded positions in memory. This is used with {@link Cesium3DTileFeature.getPolylinePositions}. + * @param {string|number} [options.featureIdLabel="featureId_0"] Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. + * @param {string|number} [options.instanceFeatureIdLabel="instanceFeatureId_0"] Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. + * @param {boolean} [options.showCreditsOnScreen=false] Whether to display the credits of this tileset on screen. * @param {SplitDirection} [options.splitDirection=SplitDirection.NONE] The {@link SplitDirection} split to apply to this tileset. - * @param {Boolean} [options.projectTo2D=false] Whether to accurately project the tileset to 2D. If this is true, the tileset will be projected accurately to 2D, but it will use more memory to do so. If this is false, the tileset will use less memory and will still render in 2D / CV mode, but its projected positions may be inaccurate. This cannot be set after the tileset has loaded. - * @param {String} [options.debugHeatmapTilePropertyName] The tile variable to colorize as a heatmap. All rendered tiles will be colorized relative to each other's specified variable value. - * @param {Boolean} [options.debugFreezeFrame=false] For debugging only. Determines if only the tiles from last frame should be used for rendering. - * @param {Boolean} [options.debugColorizeTiles=false] For debugging only. When true, assigns a random color to each tile. - * @param {Boolean} [options.enableDebugWireframe] For debugging only. This must be true for debugWireframe to work in WebGL1. This cannot be set after the tileset has loaded. - * @param {Boolean} [options.debugWireframe=false] For debugging only. When true, render's each tile's content as a wireframe. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. When true, renders the bounding volume for each tile. - * @param {Boolean} [options.debugShowContentBoundingVolume=false] For debugging only. When true, renders the bounding volume for each tile's content. - * @param {Boolean} [options.debugShowViewerRequestVolume=false] For debugging only. When true, renders the viewer request volume for each tile. - * @param {Boolean} [options.debugShowGeometricError=false] For debugging only. When true, draws labels to indicate the geometric error of each tile. - * @param {Boolean} [options.debugShowRenderingStatistics=false] For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile. - * @param {Boolean} [options.debugShowMemoryUsage=false] For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile. - * @param {Boolean} [options.debugShowUrl=false] For debugging only. When true, draws labels to indicate the url of each tile. + * @param {boolean} [options.projectTo2D=false] Whether to accurately project the tileset to 2D. If this is true, the tileset will be projected accurately to 2D, but it will use more memory to do so. If this is false, the tileset will use less memory and will still render in 2D / CV mode, but its projected positions may be inaccurate. This cannot be set after the tileset has loaded. + * @param {string} [options.debugHeatmapTilePropertyName] The tile variable to colorize as a heatmap. All rendered tiles will be colorized relative to each other's specified variable value. + * @param {boolean} [options.debugFreezeFrame=false] For debugging only. Determines if only the tiles from last frame should be used for rendering. + * @param {boolean} [options.debugColorizeTiles=false] For debugging only. When true, assigns a random color to each tile. + * @param {boolean} [options.enableDebugWireframe] For debugging only. This must be true for debugWireframe to work in WebGL1. This cannot be set after the tileset has loaded. + * @param {boolean} [options.debugWireframe=false] For debugging only. When true, render's each tile's content as a wireframe. + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. When true, renders the bounding volume for each tile. + * @param {boolean} [options.debugShowContentBoundingVolume=false] For debugging only. When true, renders the bounding volume for each tile's content. + * @param {boolean} [options.debugShowViewerRequestVolume=false] For debugging only. When true, renders the viewer request volume for each tile. + * @param {boolean} [options.debugShowGeometricError=false] For debugging only. When true, draws labels to indicate the geometric error of each tile. + * @param {boolean} [options.debugShowRenderingStatistics=false] For debugging only. When true, draws labels to indicate the number of commands, points, triangles and features for each tile. + * @param {boolean} [options.debugShowMemoryUsage=false] For debugging only. When true, draws labels to indicate the texture and geometry memory in megabytes used by each tile. + * @param {boolean} [options.debugShowUrl=false] For debugging only. When true, draws labels to indicate the url of each tile. * * @exception {DeveloperError} The tileset must be 3D Tiles version 0.0 or 1.0. * @@ -242,7 +242,7 @@ function Cesium3DTileset(options) { /** * Optimization option. Don't request tiles that will likely be unused when they come back because of the camera's movement. This optimization only applies to stationary tilesets. * - * @type {Boolean} + * @type {boolean} * @default true */ this.cullRequestsWhileMoving = defaultValue( @@ -254,7 +254,7 @@ function Cesium3DTileset(options) { /** * Optimization option. Multiplier used in culling requests while moving. Larger is more aggressive culling, smaller less aggressive culling. * - * @type {Number} + * @type {number} * @default 60.0 */ this.cullRequestsWhileMovingMultiplier = defaultValue( @@ -265,7 +265,7 @@ function Cesium3DTileset(options) { /** * Optimization option. If between (0.0, 0.5], tiles at or above the screen space error for the reduced screen resolution of progressiveResolutionHeightFraction*screenHeight will be prioritized first. This can help get a quick layer of tiles down while full resolution tiles continue to load. * - * @type {Number} + * @type {number} * @default 0.3 */ this.progressiveResolutionHeightFraction = CesiumMath.clamp( @@ -277,7 +277,7 @@ function Cesium3DTileset(options) { /** * Optimization option. Prefer loading of leaves first. * - * @type {Boolean} + * @type {boolean} * @default false */ this.preferLeaves = defaultValue(options.preferLeaves, false); @@ -308,7 +308,7 @@ function Cesium3DTileset(options) { /** * Preload tiles when tileset.show is false. Loads tiles as if the tileset is visible but does not render them. * - * @type {Boolean} + * @type {boolean} * @default false */ this.preloadWhenHidden = defaultValue(options.preloadWhenHidden, false); @@ -316,7 +316,7 @@ function Cesium3DTileset(options) { /** * Optimization option. Fetch tiles at the camera's flight destination while the camera is in flight. * - * @type {Boolean} + * @type {boolean} * @default true */ this.preloadFlightDestinations = defaultValue( @@ -332,7 +332,7 @@ function Cesium3DTileset(options) { * The algorithm is biased towards "street views" where the camera is close to the ground plane of the tileset and looking * at the horizon. In addition results are more accurate for tightly fitting bounding volumes like box and region. * - * @type {Boolean} + * @type {boolean} * @default false */ this.dynamicScreenSpaceError = defaultValue( @@ -345,7 +345,7 @@ function Cesium3DTileset(options) { * screen space error for tiles around the edge of the screen. Screen space error returns to normal once all * the tiles in the center of the screen as determined by the {@link Cesium3DTileset#foveatedConeSize} are loaded. * - * @type {Boolean} + * @type {boolean} * @default true */ this.foveatedScreenSpaceError = defaultValue( @@ -375,7 +375,7 @@ function Cesium3DTileset(options) { * This time delay prevents requesting tiles around the edges of the screen when the camera is moving. * Setting this to 0.0 will immediately request all tiles in any given view. * - * @type {Number} + * @type {number} * @default 0.2 */ this.foveatedTimeDelay = defaultValue(options.foveatedTimeDelay, 0.2); @@ -395,7 +395,7 @@ function Cesium3DTileset(options) { * It is analogous to moving fog closer to the camera. *

* - * @type {Number} + * @type {number} * @default 0.00278 */ this.dynamicScreenSpaceErrorDensity = 0.00278; @@ -404,7 +404,7 @@ function Cesium3DTileset(options) { * A factor used to increase the screen space error of tiles for dynamic screen space error. As this value increases less tiles * are requested for rendering and tiles in the distance will have lower detail. If set to zero, the feature will be disabled. * - * @type {Number} + * @type {number} * @default 4.0 */ this.dynamicScreenSpaceErrorFactor = 4.0; @@ -417,7 +417,7 @@ function Cesium3DTileset(options) { * Valid values are between 0.0 and 1.0. *

* - * @type {Number} + * @type {number} * @default 0.25 */ this.dynamicScreenSpaceErrorHeightFalloff = 0.25; @@ -441,7 +441,7 @@ function Cesium3DTileset(options) { /** * Determines if the tileset will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -460,7 +460,7 @@ function Cesium3DTileset(options) { * A value of 0.0 results in the source color while a value of 1.0 results in the feature color, with any value in-between * resulting in a mix of the source color and feature color. * - * @type {Number} + * @type {number} * @default 0.5 */ this.colorBlendAmount = 0.5; @@ -650,7 +650,7 @@ function Cesium3DTileset(options) { * using this optimization. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.skipLevelOfDetail = defaultValue(options.skipLevelOfDetail, false); @@ -663,7 +663,7 @@ function Cesium3DTileset(options) { * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true. *

* - * @type {Number} + * @type {number} * @default 1024 */ this.baseScreenSpaceError = defaultValue(options.baseScreenSpaceError, 1024); @@ -676,7 +676,7 @@ function Cesium3DTileset(options) { * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true. *

* - * @type {Number} + * @type {number} * @default 16 */ this.skipScreenSpaceErrorFactor = defaultValue( @@ -691,7 +691,7 @@ function Cesium3DTileset(options) { * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true. *

* - * @type {Number} + * @type {number} * @default 1 */ this.skipLevels = defaultValue(options.skipLevels, 1); @@ -703,7 +703,7 @@ function Cesium3DTileset(options) { * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.immediatelyLoadDesiredLevelOfDetail = defaultValue( @@ -718,7 +718,7 @@ function Cesium3DTileset(options) { * Only used when {@link Cesium3DTileset#skipLevelOfDetail} is true. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.loadSiblings = defaultValue(options.loadSiblings, false); @@ -751,7 +751,7 @@ function Cesium3DTileset(options) { * Whether to cull back-facing geometry. When true, back face culling is determined * by the glTF material's doubleSided property; when false, back face culling is disabled. * - * @type {Boolean} + * @type {boolean} * @default true */ this.backFaceCulling = defaultValue(options.backFaceCulling, true); @@ -763,7 +763,7 @@ function Cesium3DTileset(options) { * {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. * When true, outlines are displayed. When false, outlines are not displayed. * - * @type {Boolean} + * @type {boolean} * @default true */ this.showOutline = defaultValue(options.showOutline, true); @@ -797,7 +797,7 @@ function Cesium3DTileset(options) { * out and see what was rendered. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugFreezeFrame = defaultValue(options.debugFreezeFrame, false); @@ -810,7 +810,7 @@ function Cesium3DTileset(options) { * from parent tiles may be interleaved with features from child tiles. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugColorizeTiles = defaultValue(options.debugColorizeTiles, false); @@ -826,7 +826,7 @@ function Cesium3DTileset(options) { * When true, renders each tile's content as a wireframe. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugWireframe = defaultValue(options.debugWireframe, false); @@ -847,7 +847,7 @@ function Cesium3DTileset(options) { * screen space error and are still refining to their descendants are yellow. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugShowBoundingVolume = defaultValue( @@ -862,7 +862,7 @@ function Cesium3DTileset(options) { * blue if the tile has a content bounding volume; otherwise it is red. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugShowContentBoundingVolume = defaultValue( @@ -876,7 +876,7 @@ function Cesium3DTileset(options) { * When true, renders the viewer request volume for each tile. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugShowViewerRequestVolume = defaultValue( @@ -895,7 +895,7 @@ function Cesium3DTileset(options) { * When true, draws labels to indicate the geometric error of each tile. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugShowGeometricError = defaultValue( @@ -909,7 +909,7 @@ function Cesium3DTileset(options) { * When true, draws labels to indicate the number of commands, points, triangles and features of each tile. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugShowRenderingStatistics = defaultValue( @@ -923,7 +923,7 @@ function Cesium3DTileset(options) { * When true, draws labels to indicate the geometry and texture memory usage of each tile. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugShowMemoryUsage = defaultValue(options.debugShowMemoryUsage, false); @@ -934,7 +934,7 @@ function Cesium3DTileset(options) { * When true, draws labels to indicate the url of each tile. *

* - * @type {Boolean} + * @type {boolean} * @default false */ this.debugShowUrl = defaultValue(options.debugShowUrl, false); @@ -1102,7 +1102,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Object} + * @type {object} * @readonly * * @exception {DeveloperError} The tileset is not loaded. Use Cesium3DTileset.readyPromise or wait for Cesium3DTileset.ready to be true. @@ -1126,7 +1126,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Object} + * @type {object} * @readonly * * @exception {DeveloperError} The tileset is not loaded. Use Cesium3DTileset.readyPromise or wait for Cesium3DTileset.ready to be true. @@ -1170,7 +1170,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Object} + * @type {object} * @readonly * * @exception {DeveloperError} The tileset is not loaded. Use Cesium3DTileset.readyPromise or wait for Cesium3DTileset.ready to be true. @@ -1202,7 +1202,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -1221,7 +1221,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Promise.} + * @type {Promise} * @readonly * * @example @@ -1247,7 +1247,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -1279,7 +1279,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {String} + * @type {string} * @readonly * @deprecated */ @@ -1445,7 +1445,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Number} + * @type {number} * @default 16 * * @exception {DeveloperError} maximumScreenSpaceError must be greater than or equal to zero. @@ -1488,7 +1488,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Number} + * @type {number} * @default 512 * * @exception {DeveloperError} maximumMemoryUsage must be greater than or equal to zero. @@ -1617,7 +1617,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Number} + * @type {number} * @readonly */ timeSinceLoad: { @@ -1632,7 +1632,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Number} + * @type {number} * @readonly * * @see Cesium3DTileset#maximumMemoryUsage @@ -1748,7 +1748,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Number} + * @type {number} * @default 0.3 */ foveatedConeSize: { @@ -1771,7 +1771,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Number} + * @type {number} * @default 0.0 */ foveatedMinimumScreenSpaceErrorRelaxation: { @@ -1858,7 +1858,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @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. * - * @type {Boolean} + * @type {boolean} * @default false */ vectorClassificationOnly: { @@ -1875,7 +1875,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @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. * - * @type {Boolean} + * @type {boolean} * @default false */ vectorKeepDecodedPositions: { @@ -1889,7 +1889,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {Boolean} + * @type {boolean} * @default false */ showCreditsOnScreen: { @@ -1920,7 +1920,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {String} + * @type {string} * @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. */ featureIdLabel: { @@ -1952,7 +1952,7 @@ Object.defineProperties(Cesium3DTileset.prototype, { * * @memberof Cesium3DTileset.prototype * - * @type {String} + * @type {string} * @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. */ instanceFeatureIdLabel: { @@ -1977,8 +1977,8 @@ Object.defineProperties(Cesium3DTileset.prototype, { /** * Provides a hook to override the method used to request the tileset json * useful when fetching tilesets from remote servers - * @param {Resource|String} tilesetUrl The url of the json file to be fetched - * @returns {Promise.} A promise that resolves with the fetched json data + * @param {Resource|string} tilesetUrl The url of the json file to be fetched + * @returns {Promise} A promise that resolves with the fetched json data */ Cesium3DTileset.loadJson = function (tilesetUrl) { const resource = Resource.createIfNeeded(tilesetUrl); @@ -2077,7 +2077,7 @@ Cesium3DTileset.prototype.loadTileset = function ( * * @param {Cesium3DTileset} tileset The tileset * @param {Resource} baseResource The base resource for the tileset - * @param {Object} tileHeader The JSON header for the tile + * @param {object} tileHeader The JSON header for the tile * @param {Cesium3DTile} [parentTile] The parent tile of the new tile * @returns {Cesium3DTile} The newly created tile * @@ -2142,8 +2142,8 @@ function makeTile(tileset, baseResource, tileHeader, parentTile) { * instance. This is asynchronous since metadata schemas may be external. * * @param {Cesium3DTileset} tileset The tileset - * @param {Object} tilesetJson The tileset JSON - * @return {Promise} A promise that resolves to tilesetJson for chaining. + * @param {object} tilesetJson The tileset JSON + * @return {Promise} A promise that resolves to tilesetJson for chaining. * @private */ function processMetadataExtension(tileset, tilesetJson) { @@ -3040,9 +3040,9 @@ Cesium3DTileset.prototype.updateForPass = function ( /** * true if the tileset JSON file lists the extension in extensionsUsed; otherwise, false. - * @param {String} extensionName The name of the extension to check. + * @param {string} extensionName The name of the extension to check. * - * @returns {Boolean} true if the tileset JSON file lists the extension in extensionsUsed; otherwise, false. + * @returns {boolean} true if the tileset JSON file lists the extension in extensionsUsed; otherwise, false. */ Cesium3DTileset.prototype.hasExtension = function (extensionName) { if (!defined(this._extensionsUsed)) { @@ -3058,7 +3058,7 @@ Cesium3DTileset.prototype.hasExtension = function (extensionName) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see Cesium3DTileset#destroy */ @@ -3134,7 +3134,7 @@ Cesium3DTileset.supportedExtensions = { * Checks to see if a given extension is supported by Cesium3DTileset. If * the extension is not supported by Cesium3DTileset, it throws a RuntimeError. * - * @param {Object} extensionsRequired The extensions we wish to check + * @param {object} extensionsRequired The extensions we wish to check * * @private */ @@ -3155,9 +3155,9 @@ Cesium3DTileset.checkSupportedExtensions = function (extensionsRequired) { * @callback Cesium3DTileset.foveatedInterpolationCallback * @default Math.lerp * - * @param {Number} p The start value to interpolate. - * @param {Number} q The end value to interpolate. - * @param {Number} time The time of interpolation generally in the range [0.0, 1.0]. - * @returns {Number} The interpolated value. + * @param {number} p The start value to interpolate. + * @param {number} q The end value to interpolate. + * @param {number} time The time of interpolation generally in the range [0.0, 1.0]. + * @returns {number} The interpolated value. */ export default Cesium3DTileset; diff --git a/packages/engine/Source/Scene/Cesium3DTilesetHeatmap.js b/packages/engine/Source/Scene/Cesium3DTilesetHeatmap.js index 5d4f068e54f6..ec01db34d542 100644 --- a/packages/engine/Source/Scene/Cesium3DTilesetHeatmap.js +++ b/packages/engine/Source/Scene/Cesium3DTilesetHeatmap.js @@ -15,7 +15,7 @@ function Cesium3DTilesetHeatmap(tilePropertyName) { * The tile variable to track for heatmap colorization. * Tile's will be colorized relative to the other visible tile's values for this variable. * - * @type {String} + * @type {string} */ this.tilePropertyName = tilePropertyName; @@ -50,9 +50,9 @@ function getHeatmapValue(tileValue, tilePropertyName) { /** * Sets the reference minimum and maximum for the variable name. Converted to numbers before they are stored. * - * @param {Object} minimum The minimum reference value. - * @param {Object} maximum The maximum reference value. - * @param {String} tilePropertyName The tile variable that will use these reference values when it is colorized. + * @param {object} minimum The minimum reference value. + * @param {object} maximum The maximum reference value. + * @param {string} tilePropertyName The tile variable that will use these reference values when it is colorized. */ Cesium3DTilesetHeatmap.prototype.setReferenceMinimumMaximum = function ( minimum, diff --git a/packages/engine/Source/Scene/Cesium3DTilesetMetadata.js b/packages/engine/Source/Scene/Cesium3DTilesetMetadata.js index 1b8dfd462b00..8c2df573bfb2 100644 --- a/packages/engine/Source/Scene/Cesium3DTilesetMetadata.js +++ b/packages/engine/Source/Scene/Cesium3DTilesetMetadata.js @@ -14,8 +14,8 @@ import TilesetMetadata from "./TilesetMetadata.js"; * the schema ({@link MetadataSchema}), tileset metadata ({@link TilesetMetadata}), group metadata (dictionary of {@link GroupMetadata}), and metadata statistics (dictionary) *

* - * @param {Object} options Object with the following properties: - * @param {Object} options.metadataJson Either the tileset JSON (3D Tiles 1.1) or the 3DTILES_metadata extension object that contains the tileset metadata. + * @param {object} options Object with the following properties: + * @param {object} options.metadataJson Either the tileset JSON (3D Tiles 1.1) or the 3DTILES_metadata extension object that contains the tileset metadata. * @param {MetadataSchema} options.schema The parsed schema. * * @alias Cesium3DTilesetMetadata @@ -125,7 +125,7 @@ Object.defineProperties(Cesium3DTilesetMetadata.prototype, { * Only populated if using the legacy schema. * * @memberof Cesium3DTilesetMetadata.prototype - * @type {String[]} + * @type {} * @readonly * @private */ @@ -157,7 +157,7 @@ Object.defineProperties(Cesium3DTilesetMetadata.prototype, { *

* * @memberof Cesium3DTilesetMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -185,7 +185,7 @@ Object.defineProperties(Cesium3DTilesetMetadata.prototype, { * An object containing extensions. * * @memberof Cesium3DTilesetMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ diff --git a/packages/engine/Source/Scene/CircleEmitter.js b/packages/engine/Source/Scene/CircleEmitter.js index a1e10a255d94..4fe04e5201bb 100644 --- a/packages/engine/Source/Scene/CircleEmitter.js +++ b/packages/engine/Source/Scene/CircleEmitter.js @@ -10,7 +10,7 @@ import CesiumMath from "../Core/Math.js"; * @alias CircleEmitter * @constructor * - * @param {Number} [radius=1.0] The radius of the circle in meters. + * @param {number} [radius=1.0] The radius of the circle in meters. */ function CircleEmitter(radius) { radius = defaultValue(radius, 1.0); @@ -26,7 +26,7 @@ Object.defineProperties(CircleEmitter.prototype, { /** * The radius of the circle in meters. * @memberof CircleEmitter.prototype - * @type {Number} + * @type {number} * @default 1.0 */ radius: { diff --git a/packages/engine/Source/Scene/ClassificationPrimitive.js b/packages/engine/Source/Scene/ClassificationPrimitive.js index d0412080fabe..b9d1c608bce7 100644 --- a/packages/engine/Source/Scene/ClassificationPrimitive.js +++ b/packages/engine/Source/Scene/ClassificationPrimitive.js @@ -49,19 +49,19 @@ import StencilOperation from "./StencilOperation.js"; * @alias ClassificationPrimitive * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Array|GeometryInstance} [options.geometryInstances] The geometry instances to render. This can either be a single instance or an array of length one. * @param {Appearance} [options.appearance] The appearance used to render the primitive. Defaults to PerInstanceColorAppearance when GeometryInstances have a color attribute. - * @param {Boolean} [options.show=true] Determines if this primitive will be shown. - * @param {Boolean} [options.vertexCacheOptimize=false] When true, geometry vertices are optimized for the pre and post-vertex-shader caches. - * @param {Boolean} [options.interleave=false] When true, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time. - * @param {Boolean} [options.compressVertices=true] When true, the geometry vertices are compressed, which will save memory. - * @param {Boolean} [options.releaseGeometryInstances=true] When true, the primitive does not keep a reference to the input geometryInstances to save memory. - * @param {Boolean} [options.allowPicking=true] When true, each geometry instance will only be pickable with {@link Scene#pick}. When false, GPU memory is saved. - * @param {Boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready. If false initializeTerrainHeights() must be called first. + * @param {boolean} [options.show=true] Determines if this primitive will be shown. + * @param {boolean} [options.vertexCacheOptimize=false] When true, geometry vertices are optimized for the pre and post-vertex-shader caches. + * @param {boolean} [options.interleave=false] When true, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time. + * @param {boolean} [options.compressVertices=true] When true, the geometry vertices are compressed, which will save memory. + * @param {boolean} [options.releaseGeometryInstances=true] When true, the primitive does not keep a reference to the input geometryInstances to save memory. + * @param {boolean} [options.allowPicking=true] When true, each geometry instance will only be pickable with {@link Scene#pick}. When false, GPU memory is saved. + * @param {boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready. If false initializeTerrainHeights() must be called first. * @param {ClassificationType} [options.classificationType=ClassificationType.BOTH] Determines whether terrain, 3D Tiles or both will be classified. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. - * @param {Boolean} [options.debugShowShadowVolume=false] For debugging only. Determines if the shadow volume for each geometry in the primitive is drawn. Must be true on + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. + * @param {boolean} [options.debugShowShadowVolume=false] For debugging only. Determines if the shadow volume for each geometry in the primitive is drawn. Must be true on * creation for the volumes to be created before the geometry is released or options.releaseGeometryInstance must be false. * * @see Primitive @@ -96,7 +96,7 @@ function ClassificationPrimitive(options) { * Determines if the primitive will be shown. This affects all geometry * instances in the primitive. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -118,7 +118,7 @@ function ClassificationPrimitive(options) { * Draws the bounding sphere for each draw command in the primitive. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -132,7 +132,7 @@ function ClassificationPrimitive(options) { * Draws the shadow volume for each geometry in the primitive. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -228,7 +228,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { * * @memberof ClassificationPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -244,7 +244,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { * * @memberof ClassificationPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -260,7 +260,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { * * @memberof ClassificationPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -276,7 +276,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { * * @memberof ClassificationPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -292,7 +292,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { * * @memberof ClassificationPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -308,7 +308,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { * * @memberof ClassificationPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -326,7 +326,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { * * @memberof ClassificationPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -338,7 +338,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { /** * Gets a promise that resolves when the primitive is ready to render. * @memberof ClassificationPrimitive.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -352,7 +352,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { * This is because texture coordinates on ClassificationPrimitives are computed differently, * and are used for culling when multiple GeometryInstances are batched in one ClassificationPrimitive. * @memberof ClassificationPrimitive.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @private */ @@ -369,7 +369,7 @@ Object.defineProperties(ClassificationPrimitive.prototype, { * Determines if ClassificationPrimitive rendering is supported. * * @param {Scene} scene The scene. - * @returns {Boolean} true if ClassificationPrimitives are supported; otherwise, returns false + * @returns {boolean} true if ClassificationPrimitives are supported; otherwise, returns false */ ClassificationPrimitive.isSupported = function (scene) { return scene.context.stencilBuffer; @@ -1361,7 +1361,7 @@ ClassificationPrimitive.prototype.update = function (frameState) { * Returns the modifiable per-instance attributes for a {@link GeometryInstance}. * * @param {*} id The id of the {@link GeometryInstance}. - * @returns {Object} The typed array in the attribute's format or undefined if the is no instance with id. + * @returns {object} The typed array in the attribute's format or undefined if the is no instance with id. * * @exception {DeveloperError} must call update before calling getGeometryInstanceAttributes. * @@ -1390,7 +1390,7 @@ ClassificationPrimitive.prototype.getGeometryInstanceAttributes = function ( * isDestroyed 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. * * @see ClassificationPrimitive#destroy */ diff --git a/packages/engine/Source/Scene/ClassificationType.js b/packages/engine/Source/Scene/ClassificationType.js index 5992c7cb2371..55fb1fe18206 100644 --- a/packages/engine/Source/Scene/ClassificationType.js +++ b/packages/engine/Source/Scene/ClassificationType.js @@ -1,27 +1,27 @@ /** * Whether a classification affects terrain, 3D Tiles or both. * - * @enum {Number} + * @enum {number} */ const ClassificationType = { /** * Only terrain will be classified. * - * @type {Number} + * @type {number} * @constant */ TERRAIN: 0, /** * Only 3D Tiles will be classified. * - * @type {Number} + * @type {number} * @constant */ CESIUM_3D_TILE: 1, /** * Both terrain and 3D Tiles will be classified. * - * @type {Number} + * @type {number} * @constant */ BOTH: 2, diff --git a/packages/engine/Source/Scene/ClippingPlane.js b/packages/engine/Source/Scene/ClippingPlane.js index d1e65e60cab8..603ba0309a02 100644 --- a/packages/engine/Source/Scene/ClippingPlane.js +++ b/packages/engine/Source/Scene/ClippingPlane.js @@ -10,7 +10,7 @@ import defined from "../Core/defined.js"; * @constructor * * @param {Cartesian3} normal The plane's normal (normalized). - * @param {Number} distance The shortest distance from the origin to the plane. The sign of + * @param {number} distance The shortest distance from the origin to the plane. The sign of * distance determines which side of the plane the origin * is on. If distance is positive, the origin is in the half-space * in the direction of the normal; if negative, the origin is in the half-space @@ -36,7 +36,7 @@ Object.defineProperties(ClippingPlane.prototype, { * in the direction of the normal; if negative, the origin is in the half-space * opposite to the normal; if zero, the plane passes through the origin. * - * @type {Number} + * @type {number} * @memberof ClippingPlane.prototype */ distance: { diff --git a/packages/engine/Source/Scene/ClippingPlaneCollection.js b/packages/engine/Source/Scene/ClippingPlaneCollection.js index d16b971fb0af..c9c9d84a3cfa 100644 --- a/packages/engine/Source/Scene/ClippingPlaneCollection.js +++ b/packages/engine/Source/Scene/ClippingPlaneCollection.js @@ -33,13 +33,13 @@ import ClippingPlane from "./ClippingPlane.js"; * @alias ClippingPlaneCollection * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {ClippingPlane[]} [options.planes=[]] An array of {@link ClippingPlane} objects used to selectively disable rendering on the outside of each plane. - * @param {Boolean} [options.enabled=true] Determines whether the clipping planes are active. + * @param {boolean} [options.enabled=true] Determines whether the clipping planes are active. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix specifying an additional transform relative to the clipping planes original coordinate system. - * @param {Boolean} [options.unionClippingRegions=false] If true, a region will be clipped if it is on the outside of any plane in the collection. Otherwise, a region will only be clipped if it is on the outside of every plane. + * @param {boolean} [options.unionClippingRegions=false] If true, a region will be clipped if it is on the outside of any plane in the collection. Otherwise, a region will only be clipped if it is on the outside of every plane. * @param {Color} [options.edgeColor=Color.WHITE] The color applied to highlight the edge along which an object is clipped. - * @param {Number} [options.edgeWidth=0.0] The width, in pixels, of the highlight applied to the edge along which an object is clipped. + * @param {number} [options.edgeWidth=0.0] The width, in pixels, of the highlight applied to the edge along which an object is clipped. * * @demo {@link https://sandcastle.cesium.com/?src=3D%20Tiles%20Clipping%20Planes.html|Clipping 3D Tiles and glTF models.} * @demo {@link https://sandcastle.cesium.com/?src=Terrain%20Clipping%20Planes.html|Clipping the Globe.} @@ -99,7 +99,7 @@ function ClippingPlaneCollection(options) { /** * The width, in pixels, of the highlight applied to the edge along which an object is clipped. * - * @type {Number} + * @type {number} * @default 0.0 */ this.edgeWidth = defaultValue(options.edgeWidth, 0.0); @@ -163,7 +163,7 @@ Object.defineProperties(ClippingPlaneCollection.prototype, { * in the collection. * * @memberof ClippingPlaneCollection.prototype - * @type {Number} + * @type {number} * @readonly */ length: { @@ -178,7 +178,7 @@ Object.defineProperties(ClippingPlaneCollection.prototype, { * outside of every plane. * * @memberof ClippingPlaneCollection.prototype - * @type {Boolean} + * @type {boolean} * @default false */ unionClippingRegions: { @@ -200,7 +200,7 @@ Object.defineProperties(ClippingPlaneCollection.prototype, { * If true, clipping will be enabled. * * @memberof ClippingPlaneCollection.prototype - * @type {Boolean} + * @type {boolean} * @default true */ enabled: { @@ -249,7 +249,7 @@ Object.defineProperties(ClippingPlaneCollection.prototype, { * If this value changes, then shader regeneration is necessary. * * @memberof ClippingPlaneCollection.prototype - * @returns {Number} A Number that describes the ClippingPlaneCollection's state. + * @returns {number} A Number that describes the ClippingPlaneCollection's state. * @readonly * @private */ @@ -303,7 +303,7 @@ ClippingPlaneCollection.prototype.add = function (plane) { * {@link ClippingPlaneCollection#length} to iterate over all the planes * in the collection. * - * @param {Number} index The zero-based index of the plane. + * @param {number} index The zero-based index of the plane. * @returns {ClippingPlane} The ClippingPlane at the specified index. * * @see ClippingPlaneCollection#length @@ -331,7 +331,7 @@ function indexOf(planes, plane) { * Checks whether this collection contains a ClippingPlane equal to the given ClippingPlane. * * @param {ClippingPlane} [clippingPlane] The ClippingPlane to check for. - * @returns {Boolean} true if this collection contains the ClippingPlane, false otherwise. + * @returns {boolean} true if this collection contains the ClippingPlane, false otherwise. * * @see ClippingPlaneCollection#get */ @@ -343,7 +343,7 @@ ClippingPlaneCollection.prototype.contains = function (clippingPlane) { * Removes the first occurrence of the given ClippingPlane from the collection. * * @param {ClippingPlane} clippingPlane - * @returns {Boolean} true if the plane was removed; false if the plane was not found in the collection. + * @returns {boolean} true if the plane was removed; false if the plane was not found in the collection. * * @see ClippingPlaneCollection#add * @see ClippingPlaneCollection#contains @@ -612,7 +612,7 @@ const scratchPlane = new Plane(Cartesian3.UNIT_X, 0.0); * Determines the type intersection with the planes of this ClippingPlaneCollection instance and the specified {@link TileBoundingVolume}. * @private * - * @param {Object} tileBoundingVolume The volume to determine the intersection with the planes. + * @param {object} tileBoundingVolume The volume to determine the intersection with the planes. * @param {Matrix4} [transform] An optional, additional matrix to transform the plane to world coordinates. * @returns {Intersect} {@link Intersect.INSIDE} if the entire volume is on the side of the planes * the normal is pointing and should be entirely rendered, {@link Intersect.OUTSIDE} @@ -661,8 +661,8 @@ ClippingPlaneCollection.prototype.computeIntersectionWithBoundingVolume = functi * Destroys the owner's previous ClippingPlaneCollection if setting is successful. * * @param {ClippingPlaneCollection} [clippingPlaneCollection] A ClippingPlaneCollection (or undefined) being attached to an object - * @param {Object} owner An Object that should receive the new ClippingPlaneCollection - * @param {String} key The Key for the Object to reference the ClippingPlaneCollection + * @param {object} owner An Object that should receive the new ClippingPlaneCollection + * @param {string} key The Key for the Object to reference the ClippingPlaneCollection * @private */ ClippingPlaneCollection.setOwner = function ( @@ -693,7 +693,7 @@ ClippingPlaneCollection.setOwner = function ( * Function for checking if the context will allow clipping planes with floating point textures. * * @param {Context} context The Context that will contain clipped objects and clipping textures. - * @returns {Boolean} true if floating point textures can be used for clipping planes. + * @returns {boolean} true if floating point textures can be used for clipping planes. * @private */ ClippingPlaneCollection.useFloatTexture = function (context) { @@ -739,7 +739,7 @@ ClippingPlaneCollection.getTextureResolution = function ( * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see ClippingPlaneCollection#destroy */ diff --git a/packages/engine/Source/Scene/CloudCollection.js b/packages/engine/Source/Scene/CloudCollection.js index 10b3b20e19e4..43af3d6266a7 100644 --- a/packages/engine/Source/Scene/CloudCollection.js +++ b/packages/engine/Source/Scene/CloudCollection.js @@ -76,12 +76,12 @@ const COLOR_INDEX = CumulusCloud.COLOR_INDEX; * @alias CloudCollection * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.show=true] Whether to display the clouds. - * @param {Number} [options.noiseDetail=16.0] Desired amount of detail in the noise texture. - * @param {Number} [options.noiseOffset=Cartesian3.ZERO] Desired translation of data in noise texture. - * @param {Boolean} [options.debugBillboards=false] For debugging only. Determines if the billboards are rendered with an opaque color. - * @param {Boolean} [options.debugEllipsoids=false] For debugging only. Determines if the clouds will be rendered as opaque ellipsoids. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.show=true] Whether to display the clouds. + * @param {number} [options.noiseDetail=16.0] Desired amount of detail in the noise texture. + * @param {number} [options.noiseOffset=Cartesian3.ZERO] Desired translation of data in noise texture. + * @param {boolean} [options.debugBillboards=false] For debugging only. Determines if the billboards are rendered with an opaque color. + * @param {boolean} [options.debugEllipsoids=false] For debugging only. Determines if the clouds will be rendered as opaque ellipsoids. * @see CloudCollection#add * @see CloudCollection#remove * @see CumulusCloud @@ -139,7 +139,7 @@ function CloudCollection(options) { * * * - * @type {Number} + * @type {number} * * @default 16.0 */ @@ -195,7 +195,7 @@ function CloudCollection(options) { /** * Determines if billboards in this collection will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -208,7 +208,7 @@ function CloudCollection(options) { * Renders the billboards with one opaque color for the sake of debugging. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -222,7 +222,7 @@ function CloudCollection(options) { * If debugBillboards is also true, then the ellipsoids will draw on top of the billboards. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -244,7 +244,7 @@ Object.defineProperties(CloudCollection.prototype, { /** * Returns the number of clouds in this collection. * @memberof CloudCollection.prototype - * @type {Number} + * @type {number} */ length: { get: function () { @@ -267,7 +267,7 @@ function destroyClouds(clouds) { * Creates and adds a cloud with the specified initial properties to the collection. * The added cloud is returned so it can be modified or removed from the collection later. * - * @param {Object}[options] A template describing the cloud's properties as shown in Example 1. + * @param {object}[options] A template describing the cloud's properties as shown in Example 1. * @returns {CumulusCloud} The cloud that was added to the collection. * * @performance Calling add is expected constant time. However, the collection's vertex buffer @@ -321,7 +321,7 @@ CloudCollection.prototype.add = function (options) { * Removes a cloud from the collection. * * @param {CumulusCloud} cloud The cloud to remove. - * @returns {Boolean} true if the cloud was removed; false if the cloud was not found in the collection. + * @returns {boolean} true if the cloud was removed; false if the cloud was not found in the collection. * * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. * @@ -403,7 +403,7 @@ CloudCollection.prototype._updateCloud = function (cloud, propertyChanged) { * Check whether this collection contains a given cloud. * * @param {CumulusCloud} [cloud] The cloud to check for. - * @returns {Boolean} true if this collection contains the cloud, false otherwise. + * @returns {boolean} true if this collection contains the cloud, false otherwise. * * @see CloudCollection#get */ @@ -417,7 +417,7 @@ CloudCollection.prototype.contains = function (cloud) { * it to the left, changing their indices. This function is commonly used with * {@link CloudCollection#length} to iterate over all the clouds in the collection. * - * @param {Number} index The zero-based index of the cloud. + * @param {number} index The zero-based index of the cloud. * @returns {CumulusCloud} The cloud at the specified index. * * @performance Expected constant time. If clouds were removed from the collection and @@ -1013,7 +1013,7 @@ CloudCollection.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see CloudCollection#destroy */ diff --git a/packages/engine/Source/Scene/CloudType.js b/packages/engine/Source/Scene/CloudType.js index 7f0664ff89e8..bb7bbb741b9d 100644 --- a/packages/engine/Source/Scene/CloudType.js +++ b/packages/engine/Source/Scene/CloudType.js @@ -1,14 +1,14 @@ /** * Specifies the type of the cloud that is added to a {@link CloudCollection} in {@link CloudCollection#add}. * - * @enum {Number} + * @enum {number} */ const CloudType = { /** * Cumulus cloud. * - * @type {Number} + * @type {number} * @constant */ CUMULUS: 0, @@ -18,7 +18,7 @@ const CloudType = { * Validates that the provided cloud type is a valid {@link CloudType} * * @param {CloudType} cloudType The cloud type to validate. - * @returns {Boolean} true if the provided cloud type is a valid value; otherwise, false. + * @returns {boolean} true if the provided cloud type is a valid value; otherwise, false. * * @example * if (!Cesium.CloudType.validate(cloudType)) { diff --git a/packages/engine/Source/Scene/ColorBlendMode.js b/packages/engine/Source/Scene/ColorBlendMode.js index 51b3ca1db487..b2f5194da147 100644 --- a/packages/engine/Source/Scene/ColorBlendMode.js +++ b/packages/engine/Source/Scene/ColorBlendMode.js @@ -7,7 +7,7 @@ import CesiumMath from "../Core/Math.js"; * REPLACE replaces the source color with the target color * MIX blends the source color and target color together * - * @enum {Number} + * @enum {number} * * @see Model.colorBlendMode */ diff --git a/packages/engine/Source/Scene/ConditionsExpression.js b/packages/engine/Source/Scene/ConditionsExpression.js index 2fb7ed5957c3..1bed27442ace 100644 --- a/packages/engine/Source/Scene/ConditionsExpression.js +++ b/packages/engine/Source/Scene/ConditionsExpression.js @@ -15,8 +15,8 @@ import Expression from "./Expression.js"; * @alias ConditionsExpression * @constructor * - * @param {Object} [conditionsExpression] The conditions expression defined using the 3D Tiles Styling language. - * @param {Object} [defines] Defines in the style. + * @param {object} [conditionsExpression] The conditions expression defined using the 3D Tiles Styling language. + * @param {object} [defines] Defines in the style. * * @example * const expression = new Cesium.ConditionsExpression({ @@ -42,7 +42,7 @@ Object.defineProperties(ConditionsExpression.prototype, { * * @memberof ConditionsExpression.prototype * - * @type {Object} + * @type {object} * @readonly * * @default undefined @@ -91,8 +91,8 @@ function setRuntime(expression, defines) { * a {@link Color}, the {@link Cartesian4} value is converted to a {@link Color} and then returned. * * @param {Cesium3DTileFeature} feature The feature whose properties may be used as variables in the expression. - * @param {Object} [result] The object onto which to store the result. - * @returns {Boolean|Number|String|RegExp|Cartesian2|Cartesian3|Cartesian4|Color} The result of evaluating the expression. + * @param {object} [result] The object onto which to store the result. + * @returns {boolean|number|string|RegExp|Cartesian2|Cartesian3|Cartesian4|Color} The result of evaluating the expression. */ ConditionsExpression.prototype.evaluate = function (feature, result) { const conditions = this._runtimeConditions; @@ -135,12 +135,12 @@ ConditionsExpression.prototype.evaluateColor = function (feature, result) { * Gets the shader function for this expression. * Returns undefined if the shader function can't be generated from this expression. * - * @param {String} functionSignature Signature of the generated function. - * @param {Object} variableSubstitutionMap Maps variable names to shader variable names. - * @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent. - * @param {String} returnType The return type of the generated function. + * @param {string} functionSignature Signature of the generated function. + * @param {object} variableSubstitutionMap Maps variable names to shader variable names. + * @param {object} shaderState Stores information about the generated shader function, including whether it is translucent. + * @param {string} returnType The return type of the generated function. * - * @returns {String} The shader function. + * @returns {string} The shader function. * * @private */ @@ -188,7 +188,7 @@ ConditionsExpression.prototype.getShaderFunction = function ( /** * Gets the variables used by the expression. * - * @returns {String[]} The variables used by the expression. + * @returns {string[]} The variables used by the expression. * * @private */ diff --git a/packages/engine/Source/Scene/ConeEmitter.js b/packages/engine/Source/Scene/ConeEmitter.js index 66a217f6df22..49371c5e6d6d 100644 --- a/packages/engine/Source/Scene/ConeEmitter.js +++ b/packages/engine/Source/Scene/ConeEmitter.js @@ -12,7 +12,7 @@ const defaultAngle = CesiumMath.toRadians(30.0); * @alias ConeEmitter * @constructor * - * @param {Number} [angle=Cesium.Math.toRadians(30.0)] The angle of the cone in radians. + * @param {number} [angle=Cesium.Math.toRadians(30.0)] The angle of the cone in radians. */ function ConeEmitter(angle) { this._angle = defaultValue(angle, defaultAngle); @@ -22,7 +22,7 @@ Object.defineProperties(ConeEmitter.prototype, { /** * The angle of the cone in radians. * @memberof CircleEmitter.prototype - * @type {Number} + * @type {number} * @default Cesium.Math.toRadians(30.0) */ angle: { diff --git a/packages/engine/Source/Scene/ContentMetadata.js b/packages/engine/Source/Scene/ContentMetadata.js index 7bd110b6ff89..adc66fcd4ca7 100644 --- a/packages/engine/Source/Scene/ContentMetadata.js +++ b/packages/engine/Source/Scene/ContentMetadata.js @@ -9,8 +9,8 @@ import MetadataEntity from "./MetadataEntity.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles *

* - * @param {Object} options Object with the following properties: - * @param {Object} options.content Either the content metadata JSON (3D Tiles 1.1) or the extension JSON attached to the content. + * @param {object} options Object with the following properties: + * @param {object} options.content Either the content metadata JSON (3D Tiles 1.1) or the extension JSON attached to the content. * @param {MetadataClass} options.class The class that the content metadata conforms to. * * @alias ContentMetadata @@ -53,7 +53,7 @@ Object.defineProperties(ContentMetadata.prototype, { * Extra user-defined properties. * * @memberof ContentMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -67,7 +67,7 @@ Object.defineProperties(ContentMetadata.prototype, { * An object containing extensions. * * @memberof ContentMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -81,8 +81,8 @@ Object.defineProperties(ContentMetadata.prototype, { /** * Returns whether the content has this property. * - * @param {String} propertyId The case-sensitive ID of the property. - * @returns {Boolean} Whether the content has this property. + * @param {string} propertyId The case-sensitive ID of the property. + * @returns {boolean} Whether the content has this property. * @private */ ContentMetadata.prototype.hasProperty = function (propertyId) { @@ -92,8 +92,8 @@ ContentMetadata.prototype.hasProperty = function (propertyId) { /** * Returns whether the content has a property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @returns {Boolean} Whether the content has a property with the given semantic. + * @param {string} semantic The case-sensitive semantic of the property. + * @returns {boolean} Whether the content has a property with the given semantic. * @private */ ContentMetadata.prototype.hasPropertyBySemantic = function (semantic) { @@ -107,8 +107,8 @@ ContentMetadata.prototype.hasPropertyBySemantic = function (semantic) { /** * 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 */ ContentMetadata.prototype.getPropertyIds = function (results) { @@ -121,7 +121,7 @@ ContentMetadata.prototype.getPropertyIds = function (results) { * If the property is normalized the normalized value is returned. *

* - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @returns {*} The value of the property or undefined if the content does not have this property. * @private */ @@ -135,9 +135,9 @@ ContentMetadata.prototype.getProperty = function (propertyId) { * If the property is normalized a normalized value must be provided to this function. *

* - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ ContentMetadata.prototype.setProperty = function (propertyId, value) { @@ -152,7 +152,7 @@ ContentMetadata.prototype.setProperty = function (propertyId, value) { /** * Returns a copy of the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @returns {*} The value of the property or undefined if the content does not have this semantic. * @private */ @@ -167,9 +167,9 @@ ContentMetadata.prototype.getPropertyBySemantic = function (semantic) { /** * Sets the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ ContentMetadata.prototype.setPropertyBySemantic = function (semantic, value) { diff --git a/packages/engine/Source/Scene/CreditDisplay.js b/packages/engine/Source/Scene/CreditDisplay.js index 5a7b6ec63504..0649d6552362 100644 --- a/packages/engine/Source/Scene/CreditDisplay.js +++ b/packages/engine/Source/Scene/CreditDisplay.js @@ -280,7 +280,7 @@ function appendCss() { * The credit display is responsible for displaying credits on screen. * * @param {HTMLElement} container The HTML element where credits will be displayed - * @param {String} [delimiter= ' • '] The string to separate text credits + * @param {string} [delimiter= ' • '] The string to separate text credits * @param {HTMLElement} [viewport=document.body] The HTML element that will contain the credits popup * * @alias CreditDisplay @@ -550,7 +550,7 @@ CreditDisplay.prototype.destroy = function () { * Returns true if this object was destroyed; otherwise, false. *

* - * @returns {Boolean} true if this object was destroyed; otherwise, false. + * @returns {boolean} true if this object was destroyed; otherwise, false. */ CreditDisplay.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/CullFace.js b/packages/engine/Source/Scene/CullFace.js index 4503a136274c..414ce811b228 100644 --- a/packages/engine/Source/Scene/CullFace.js +++ b/packages/engine/Source/Scene/CullFace.js @@ -3,13 +3,13 @@ import WebGLConstants from "../Core/WebGLConstants.js"; /** * Determines which triangles, if any, are culled. * - * @enum {Number} + * @enum {number} */ const CullFace = { /** * Front-facing triangles are culled. * - * @type {Number} + * @type {number} * @constant */ FRONT: WebGLConstants.FRONT, @@ -17,7 +17,7 @@ const CullFace = { /** * Back-facing triangles are culled. * - * @type {Number} + * @type {number} * @constant */ BACK: WebGLConstants.BACK, @@ -25,7 +25,7 @@ const CullFace = { /** * Both front-facing and back-facing triangles are culled. * - * @type {Number} + * @type {number} * @constant */ FRONT_AND_BACK: WebGLConstants.FRONT_AND_BACK, diff --git a/packages/engine/Source/Scene/CumulusCloud.js b/packages/engine/Source/Scene/CumulusCloud.js index 11d4cf604598..d66dd964813f 100644 --- a/packages/engine/Source/Scene/CumulusCloud.js +++ b/packages/engine/Source/Scene/CumulusCloud.js @@ -88,7 +88,7 @@ Object.defineProperties(CumulusCloud.prototype, { * Determines if this cumulus cloud will be shown. Use this to hide or show a cloud, instead * of removing it and re-adding it to the collection. * @memberof CumulusCloud.prototype - * @type {Boolean} + * @type {boolean} * @default true */ show: { @@ -293,7 +293,7 @@ Object.defineProperties(CumulusCloud.prototype, { * * * @memberof CumulusCloud.prototype - * @type {Number} + * @type {number} * @default -1.0 */ slice: { @@ -325,7 +325,7 @@ Object.defineProperties(CumulusCloud.prototype, { * * * @memberof CumulusCloud.prototype - * @type {Number} + * @type {number} * @default 1.0 */ brightness: { diff --git a/packages/engine/Source/Scene/DebugAppearance.js b/packages/engine/Source/Scene/DebugAppearance.js index 1f2a8e2a978d..098eea16a602 100644 --- a/packages/engine/Source/Scene/DebugAppearance.js +++ b/packages/engine/Source/Scene/DebugAppearance.js @@ -14,13 +14,13 @@ import Appearance from "./Appearance.js"; * @alias DebugAppearance * @constructor * - * @param {Object} options Object with the following properties: - * @param {String} options.attributeName The name of the attribute to visualize. - * @param {Boolean} [options.perInstanceAttribute=false] Boolean that determines whether this attribute is a per-instance geometry attribute. - * @param {String} [options.glslDatatype='vec3'] The GLSL datatype of the attribute. Supported datatypes are float, vec2, vec3, and vec4. - * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. - * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. - * @param {Object} [options.renderState] Optional render state to override the default render state. + * @param {object} options Object with the following properties: + * @param {string} options.attributeName The name of the attribute to visualize. + * @param {boolean} [options.perInstanceAttribute=false] Boolean that determines whether this attribute is a per-instance geometry attribute. + * @param {string} [options.glslDatatype='vec3'] The GLSL datatype of the attribute. Supported datatypes are float, vec2, vec3, and vec4. + * @param {string} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. + * @param {string} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. + * @param {object} [options.renderState] Optional render state to override the default render state. * * @exception {DeveloperError} options.glslDatatype must be float, vec2, vec3, or vec4. * @@ -122,7 +122,7 @@ function DebugAppearance(options) { /** * When true, the geometry is expected to appear translucent. * - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -149,7 +149,7 @@ Object.defineProperties(DebugAppearance.prototype, { * * @memberof DebugAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ vertexShaderSource: { @@ -165,7 +165,7 @@ Object.defineProperties(DebugAppearance.prototype, { * * @memberof DebugAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ fragmentShaderSource: { @@ -179,7 +179,7 @@ Object.defineProperties(DebugAppearance.prototype, { * * @memberof DebugAppearance.prototype * - * @type {Object} + * @type {object} * @readonly */ renderState: { @@ -193,7 +193,7 @@ Object.defineProperties(DebugAppearance.prototype, { * * @memberof DebugAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -209,7 +209,7 @@ Object.defineProperties(DebugAppearance.prototype, { * * @memberof DebugAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ attributeName: { @@ -223,7 +223,7 @@ Object.defineProperties(DebugAppearance.prototype, { * * @memberof DebugAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ glslDatatype: { @@ -239,7 +239,7 @@ Object.defineProperties(DebugAppearance.prototype, { * * @function * - * @returns {String} The full GLSL fragment shader source. + * @returns {string} The full GLSL fragment shader source. */ DebugAppearance.prototype.getFragmentShaderSource = Appearance.prototype.getFragmentShaderSource; @@ -249,7 +249,7 @@ DebugAppearance.prototype.getFragmentShaderSource = * * @function * - * @returns {Boolean} true if the appearance is translucent. + * @returns {boolean} true if the appearance is translucent. */ DebugAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent; @@ -260,7 +260,7 @@ DebugAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent; * * @function * - * @returns {Object} The render state. + * @returns {object} The render state. */ DebugAppearance.prototype.getRenderState = Appearance.prototype.getRenderState; export default DebugAppearance; diff --git a/packages/engine/Source/Scene/DebugCameraPrimitive.js b/packages/engine/Source/Scene/DebugCameraPrimitive.js index b59abf5bd42d..414882b124a9 100644 --- a/packages/engine/Source/Scene/DebugCameraPrimitive.js +++ b/packages/engine/Source/Scene/DebugCameraPrimitive.js @@ -23,13 +23,13 @@ import Primitive from "./Primitive.js"; * @alias DebugCameraPrimitive * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Camera} options.camera The camera. - * @param {Number[]} [options.frustumSplits] Distances to the near and far planes of the camera frustums. This overrides the camera's frustum near and far values. + * @param {number[]} [options.frustumSplits] Distances to the near and far planes of the camera frustums. This overrides the camera's frustum near and far values. * @param {Color} [options.color=Color.CYAN] The color of the debug outline. - * @param {Boolean} [options.updateOnChange=true] Whether the primitive updates when the underlying camera changes. - * @param {Boolean} [options.show=true] Determines if this primitive will be shown. - * @param {Object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick}. + * @param {boolean} [options.updateOnChange=true] Whether the primitive updates when the underlying camera changes. + * @param {boolean} [options.show=true] Determines if this primitive will be shown. + * @param {object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick}. * * @example * primitives.add(new Cesium.DebugCameraPrimitive({ @@ -54,7 +54,7 @@ function DebugCameraPrimitive(options) { /** * Determines if this primitive will be shown. * - * @type Boolean + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -220,7 +220,7 @@ DebugCameraPrimitive.prototype.update = function (frameState) { * isDestroyed 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. * * @see DebugCameraPrimitive#destroy */ diff --git a/packages/engine/Source/Scene/DebugModelMatrixPrimitive.js b/packages/engine/Source/Scene/DebugModelMatrixPrimitive.js index 0a2f94e9e374..7ab16bb7738c 100644 --- a/packages/engine/Source/Scene/DebugModelMatrixPrimitive.js +++ b/packages/engine/Source/Scene/DebugModelMatrixPrimitive.js @@ -24,12 +24,12 @@ import Primitive from "./Primitive.js"; * @alias DebugModelMatrixPrimitive * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Number} [options.length=10000000.0] The length of the axes in meters. - * @param {Number} [options.width=2.0] The width of the axes in pixels. + * @param {object} [options] Object with the following properties: + * @param {number} [options.length=10000000.0] The length of the axes in meters. + * @param {number} [options.width=2.0] The width of the axes in pixels. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 matrix that defines the reference frame, i.e., origin plus axes, to visualize. - * @param {Boolean} [options.show=true] Determines if this primitive will be shown. - * @param {Object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} + * @param {boolean} [options.show=true] Determines if this primitive will be shown. + * @param {object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} * * @example * primitives.add(new Cesium.DebugModelMatrixPrimitive({ @@ -44,7 +44,7 @@ function DebugModelMatrixPrimitive(options) { /** * The length of the axes in meters. * - * @type {Number} + * @type {number} * @default 10000000.0 */ this.length = defaultValue(options.length, 10000000.0); @@ -53,7 +53,7 @@ function DebugModelMatrixPrimitive(options) { /** * The width of the axes in pixels. * - * @type {Number} + * @type {number} * @default 2.0 */ this.width = defaultValue(options.width, 2.0); @@ -62,7 +62,7 @@ function DebugModelMatrixPrimitive(options) { /** * Determines if this primitive will be shown. * - * @type Boolean + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -191,7 +191,7 @@ DebugModelMatrixPrimitive.prototype.update = function (frameState) { * isDestroyed 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. * * @see DebugModelMatrixPrimitive#destroy */ diff --git a/packages/engine/Source/Scene/DepthFunction.js b/packages/engine/Source/Scene/DepthFunction.js index 0de918ea4fb9..23598bd55876 100644 --- a/packages/engine/Source/Scene/DepthFunction.js +++ b/packages/engine/Source/Scene/DepthFunction.js @@ -3,13 +3,13 @@ import WebGLConstants from "../Core/WebGLConstants.js"; /** * Determines the function used to compare two depths for the depth test. * - * @enum {Number} + * @enum {number} */ const DepthFunction = { /** * The depth test never passes. * - * @type {Number} + * @type {number} * @constant */ NEVER: WebGLConstants.NEVER, @@ -17,7 +17,7 @@ const DepthFunction = { /** * The depth test passes if the incoming depth is less than the stored depth. * - * @type {Number} + * @type {number} * @constant */ LESS: WebGLConstants.LESS, @@ -25,7 +25,7 @@ const DepthFunction = { /** * The depth test passes if the incoming depth is equal to the stored depth. * - * @type {Number} + * @type {number} * @constant */ EQUAL: WebGLConstants.EQUAL, @@ -33,7 +33,7 @@ const DepthFunction = { /** * The depth test passes if the incoming depth is less than or equal to the stored depth. * - * @type {Number} + * @type {number} * @constant */ LESS_OR_EQUAL: WebGLConstants.LEQUAL, @@ -41,7 +41,7 @@ const DepthFunction = { /** * The depth test passes if the incoming depth is greater than the stored depth. * - * @type {Number} + * @type {number} * @constant */ GREATER: WebGLConstants.GREATER, @@ -49,7 +49,7 @@ const DepthFunction = { /** * The depth test passes if the incoming depth is not equal to the stored depth. * - * @type {Number} + * @type {number} * @constant */ NOT_EQUAL: WebGLConstants.NOTEQUAL, @@ -57,7 +57,7 @@ const DepthFunction = { /** * The depth test passes if the incoming depth is greater than or equal to the stored depth. * - * @type {Number} + * @type {number} * @constant */ GREATER_OR_EQUAL: WebGLConstants.GEQUAL, @@ -65,7 +65,7 @@ const DepthFunction = { /** * The depth test always passes. * - * @type {Number} + * @type {number} * @constant */ ALWAYS: WebGLConstants.ALWAYS, diff --git a/packages/engine/Source/Scene/DeviceOrientationCameraController.js b/packages/engine/Source/Scene/DeviceOrientationCameraController.js index efcab6c37a30..986c524300b3 100644 --- a/packages/engine/Source/Scene/DeviceOrientationCameraController.js +++ b/packages/engine/Source/Scene/DeviceOrientationCameraController.js @@ -97,7 +97,7 @@ DeviceOrientationCameraController.prototype.update = function () { * Returns true if this object was destroyed; otherwise, false. *

* - * @returns {Boolean} true if this object was destroyed; otherwise, false. + * @returns {boolean} true if this object was destroyed; otherwise, false. */ DeviceOrientationCameraController.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/DirectionalLight.js b/packages/engine/Source/Scene/DirectionalLight.js index 69b25125515d..bdf90c8d883f 100644 --- a/packages/engine/Source/Scene/DirectionalLight.js +++ b/packages/engine/Source/Scene/DirectionalLight.js @@ -7,10 +7,10 @@ import DeveloperError from "../Core/DeveloperError.js"; /** * A light that gets emitted in a single direction from infinitely far away. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Cartesian3} options.direction The direction in which light gets emitted. * @param {Color} [options.color=Color.WHITE] The color of the light. - * @param {Number} [options.intensity=1.0] The intensity of the light. + * @param {number} [options.intensity=1.0] The intensity of the light. * * @exception {DeveloperError} options.direction cannot be zero-length * @@ -41,7 +41,7 @@ function DirectionalLight(options) { /** * The intensity of the light. - * @type {Number} + * @type {number} * @default 1.0 */ this.intensity = defaultValue(options.intensity, 1.0); diff --git a/packages/engine/Source/Scene/DiscardEmptyTileImagePolicy.js b/packages/engine/Source/Scene/DiscardEmptyTileImagePolicy.js index a841ff516909..1a57765a3aca 100644 --- a/packages/engine/Source/Scene/DiscardEmptyTileImagePolicy.js +++ b/packages/engine/Source/Scene/DiscardEmptyTileImagePolicy.js @@ -14,7 +14,7 @@ function DiscardEmptyTileImagePolicy(options) {} /** * 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. */ DiscardEmptyTileImagePolicy.prototype.isReady = function () { return true; @@ -24,7 +24,7 @@ DiscardEmptyTileImagePolicy.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. */ DiscardEmptyTileImagePolicy.prototype.shouldDiscardImage = function (image) { return DiscardEmptyTileImagePolicy.EMPTY_IMAGE === image; diff --git a/packages/engine/Source/Scene/DiscardMissingTileImagePolicy.js b/packages/engine/Source/Scene/DiscardMissingTileImagePolicy.js index 4651ffb77a00..de950a3b0b1b 100644 --- a/packages/engine/Source/Scene/DiscardMissingTileImagePolicy.js +++ b/packages/engine/Source/Scene/DiscardMissingTileImagePolicy.js @@ -11,11 +11,11 @@ import Resource from "../Core/Resource.js"; * @alias DiscardMissingTileImagePolicy * @constructor * - * @param {Object} options Object with the following properties: - * @param {Resource|String} options.missingImageUrl The URL of the known missing image. + * @param {object} options Object with the following properties: + * @param {Resource|string} options.missingImageUrl The URL of the known missing image. * @param {Cartesian2[]} options.pixelsToCheck An array of {@link Cartesian2} pixel positions to * compare against the missing image. - * @param {Boolean} [options.disableCheckIfAllPixelsAreTransparent=false] If true, the discard check will be disabled + * @param {boolean} [options.disableCheckIfAllPixelsAreTransparent=false] If true, the discard check will be disabled * if all of the pixelsToCheck in the missingImageUrl have an alpha value of 0. If false, the * discard check will proceed no matter the values of the pixelsToCheck. */ @@ -95,7 +95,7 @@ function DiscardMissingTileImagePolicy(options) { /** * 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. */ DiscardMissingTileImagePolicy.prototype.isReady = function () { return this._isReady; @@ -105,7 +105,7 @@ DiscardMissingTileImagePolicy.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. * * @exception {DeveloperError} shouldDiscardImage must not be called before the discard policy is ready. */ diff --git a/packages/engine/Source/Scene/DracoLoader.js b/packages/engine/Source/Scene/DracoLoader.js index 0508a1df235e..82901e159d7a 100644 --- a/packages/engine/Source/Scene/DracoLoader.js +++ b/packages/engine/Source/Scene/DracoLoader.js @@ -54,11 +54,11 @@ DracoLoader.decodePointCloud = function (parameters) { /** * Decodes a buffer view. Returns undefined if the task cannot be scheduled. * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Uint8Array} options.array The typed array containing the buffer view data. - * @param {Object} options.bufferView The glTF buffer view object. - * @param {Object.} options.compressedAttributes The compressed attributes. - * @param {Boolean} options.dequantizeInShader Whether POSITION and NORMAL attributes should be dequantized on the GPU. + * @param {object} options.bufferView The glTF buffer view object. + * @param {Object} options.compressedAttributes The compressed attributes. + * @param {boolean} options.dequantizeInShader Whether POSITION and NORMAL attributes should be dequantized on the GPU. * * @returns {Promise} A promise that resolves to the decoded indices and attributes. * @private diff --git a/packages/engine/Source/Scene/EllipsoidPrimitive.js b/packages/engine/Source/Scene/EllipsoidPrimitive.js index be29bae18217..82530a0463c4 100644 --- a/packages/engine/Source/Scene/EllipsoidPrimitive.js +++ b/packages/engine/Source/Scene/EllipsoidPrimitive.js @@ -35,14 +35,14 @@ const attributeLocations = { * @alias EllipsoidPrimitive * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Cartesian3} [options.center=Cartesian3.ZERO] The center of the ellipsoid in the ellipsoid's model coordinates. * @param {Cartesian3} [options.radii] The radius of the ellipsoid along the x, y, and z axes in the ellipsoid's model coordinates. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms the ellipsoid from model to world coordinates. - * @param {Boolean} [options.show=true] Determines if this primitive will be shown. + * @param {boolean} [options.show=true] Determines if this primitive will be shown. * @param {Material} [options.material=Material.ColorType] The surface appearance of the primitive. - * @param {Object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. + * @param {object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. * * @private */ @@ -108,7 +108,7 @@ function EllipsoidPrimitive(options) { /** * Determines if the ellipsoid primitive will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -143,7 +143,7 @@ function EllipsoidPrimitive(options) { /** * User-defined object returned when the ellipsoid is picked. * - * @type Object + * @type {object} * * @default undefined * @@ -158,7 +158,7 @@ function EllipsoidPrimitive(options) { * Draws the bounding sphere for each draw command in the primitive. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -471,7 +471,7 @@ EllipsoidPrimitive.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see EllipsoidPrimitive#destroy */ diff --git a/packages/engine/Source/Scene/EllipsoidSurfaceAppearance.js b/packages/engine/Source/Scene/EllipsoidSurfaceAppearance.js index 48e7c4cdccb7..30e4aaf91e37 100644 --- a/packages/engine/Source/Scene/EllipsoidSurfaceAppearance.js +++ b/packages/engine/Source/Scene/EllipsoidSurfaceAppearance.js @@ -16,15 +16,15 @@ import Material from "./Material.js"; * @alias EllipsoidSurfaceAppearance * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.flat=false] When true, flat shading is used in the fragment shader, which means lighting is not taking into account. - * @param {Boolean} [options.faceForward=options.aboveGround] When true, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}. - * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link EllipsoidSurfaceAppearance#renderState} has alpha blending enabled. - * @param {Boolean} [options.aboveGround=false] When true, the geometry is expected to be on the ellipsoid's surface - not at a constant height above it - so {@link EllipsoidSurfaceAppearance#renderState} has backface culling enabled. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.flat=false] When true, flat shading is used in the fragment shader, which means lighting is not taking into account. + * @param {boolean} [options.faceForward=options.aboveGround] When true, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}. + * @param {boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link EllipsoidSurfaceAppearance#renderState} has alpha blending enabled. + * @param {boolean} [options.aboveGround=false] When true, the geometry is expected to be on the ellipsoid's surface - not at a constant height above it - so {@link EllipsoidSurfaceAppearance#renderState} has backface culling enabled. * @param {Material} [options.material=Material.ColorType] The material used to determine the fragment color. - * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. - * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. - * @param {Object} [options.renderState] Optional render state to override the default render state. + * @param {string} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. + * @param {string} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. + * @param {object} [options.renderState] Optional render state to override the default render state. * * @see {@link https://github.com/CesiumGS/cesium/wiki/Fabric|Fabric} * @@ -64,7 +64,7 @@ function EllipsoidSurfaceAppearance(options) { /** * When true, the geometry is expected to appear translucent. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -98,7 +98,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, { * * @memberof EllipsoidSurfaceAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ vertexShaderSource: { @@ -115,7 +115,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, { * * @memberof EllipsoidSurfaceAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ fragmentShaderSource: { @@ -134,7 +134,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, { * * @memberof EllipsoidSurfaceAppearance.prototype * - * @type {Object} + * @type {object} * @readonly */ renderState: { @@ -150,7 +150,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, { * * @memberof EllipsoidSurfaceAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -185,7 +185,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, { * * @memberof EllipsoidSurfaceAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -204,7 +204,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, { * * @memberof EllipsoidSurfaceAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -223,7 +223,7 @@ Object.defineProperties(EllipsoidSurfaceAppearance.prototype, { * * @memberof EllipsoidSurfaceAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -253,7 +253,7 @@ EllipsoidSurfaceAppearance.VERTEX_FORMAT = VertexFormat.POSITION_AND_ST; * * @function * - * @returns {String} The full GLSL fragment shader source. + * @returns {string} The full GLSL fragment shader source. */ EllipsoidSurfaceAppearance.prototype.getFragmentShaderSource = Appearance.prototype.getFragmentShaderSource; @@ -263,7 +263,7 @@ EllipsoidSurfaceAppearance.prototype.getFragmentShaderSource = * * @function * - * @returns {Boolean} true if the appearance is translucent. + * @returns {boolean} true if the appearance is translucent. */ EllipsoidSurfaceAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent; @@ -275,7 +275,7 @@ EllipsoidSurfaceAppearance.prototype.isTranslucent = * * @function * - * @returns {Object} The render state. + * @returns {object} The render state. */ EllipsoidSurfaceAppearance.prototype.getRenderState = Appearance.prototype.getRenderState; diff --git a/packages/engine/Source/Scene/Expression.js b/packages/engine/Source/Scene/Expression.js index 1ccd59e45044..2d413de4b39c 100644 --- a/packages/engine/Source/Scene/Expression.js +++ b/packages/engine/Source/Scene/Expression.js @@ -23,8 +23,8 @@ import ExpressionNodeType from "./ExpressionNodeType.js"; * @alias Expression * @constructor * - * @param {String} [expression] The expression defined using the 3D Tiles Styling language. - * @param {Object} [defines] Defines in the style. + * @param {string} [expression] The expression defined using the 3D Tiles Styling language. + * @param {object} [defines] Defines in the style. * * @example * const expression = new Cesium.Expression('(regExp("^Chest").test(${County})) && (${YearBuilt} >= 1970)'); @@ -63,7 +63,7 @@ Object.defineProperties(Expression.prototype, { * * @memberof Expression.prototype * - * @type {String} + * @type {string} * @readonly * * @default undefined @@ -131,8 +131,8 @@ const scratchStorage = { * a {@link Color}, the {@link Cartesian4} value is converted to a {@link Color} and then returned. * * @param {Cesium3DTileFeature} feature The feature whose properties may be used as variables in the expression. - * @param {Object} [result] The object onto which to store the result. - * @returns {Boolean|Number|String|RegExp|Cartesian2|Cartesian3|Cartesian4|Color} The result of evaluating the expression. + * @param {object} [result] The object onto which to store the result. + * @returns {boolean|number|string|RegExp|Cartesian2|Cartesian3|Cartesian4|Color} The result of evaluating the expression. */ Expression.prototype.evaluate = function (feature, result) { scratchStorage.reset(); @@ -170,12 +170,12 @@ Expression.prototype.evaluateColor = function (feature, result) { * Gets the shader function for this expression. * Returns undefined if the shader function can't be generated from this expression. * - * @param {String} functionSignature Signature of the generated function. - * @param {Object} variableSubstitutionMap Maps variable names to shader variable names. - * @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent. - * @param {String} returnType The return type of the generated function. + * @param {string} functionSignature Signature of the generated function. + * @param {object} variableSubstitutionMap Maps variable names to shader variable names. + * @param {object} shaderState Stores information about the generated shader function, including whether it is translucent. + * @param {string} returnType The return type of the generated function. * - * @returns {String} The shader function. + * @returns {string} The shader function. * * @private */ @@ -203,10 +203,10 @@ Expression.prototype.getShaderFunction = function ( * Gets the shader expression for this expression. * Returns undefined if the shader expression can't be generated from this expression. * - * @param {Object} variableSubstitutionMap Maps variable names to shader variable names. - * @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent. + * @param {object} variableSubstitutionMap Maps variable names to shader variable names. + * @param {object} shaderState Stores information about the generated shader function, including whether it is translucent. * - * @returns {String} The shader expression. + * @returns {string} The shader expression. * * @private */ @@ -223,7 +223,7 @@ Expression.prototype.getShaderExpression = function ( /** * Gets the variables used by the expression. * - * @returns {String[]} The variables used by the expression. + * @returns {string[]} The variables used by the expression. * * @private */ diff --git a/packages/engine/Source/Scene/Fog.js b/packages/engine/Source/Scene/Fog.js index 5349f0dd9d79..217ef14afcb2 100644 --- a/packages/engine/Source/Scene/Fog.js +++ b/packages/engine/Source/Scene/Fog.js @@ -13,14 +13,14 @@ import SceneMode from "./SceneMode.js"; function Fog() { /** * true if fog is enabled, false otherwise. - * @type {Boolean} + * @type {boolean} * @default true */ this.enabled = true; /** * true if fog is renderable in shaders, false otherwise. * This allows to benefits from optimized tile loading strategy based on fog density without the actual visual rendering. - * @type {Boolean} + * @type {boolean} * @default true */ this.renderable = true; @@ -30,7 +30,7 @@ function Fog() { * The more dense the fog is, the more aggressively the terrain is culled. For example, if the camera is a height of * 1000.0m above the ellipsoid, increasing the value to 3.0e-3 will cause many tiles close to the viewer be culled. * Decreasing the value will push the fog further from the viewer, but decrease performance as more of the terrain is rendered. - * @type {Number} + * @type {number} * @default 2.0e-4 */ this.density = 2.0e-4; @@ -39,14 +39,14 @@ function Fog() { * the number of terrain tiles requested for rendering. If set to zero, the feature will be disabled. If the value is increased * for mountainous regions, less tiles will need to be requested, but the terrain meshes near the horizon may be a noticeably * lower resolution. If the value is increased in a relatively flat area, there will be little noticeable change on the horizon. - * @type {Number} + * @type {number} * @default 2.0 */ this.screenSpaceErrorFactor = 2.0; /** * The minimum brightness of the fog color from lighting. A value of 0.0 can cause the fog to be completely black. A value of 1.0 will not affect * the brightness at all. - * @type {Number} + * @type {number} * @default 0.03 */ this.minimumBrightness = 0.03; diff --git a/packages/engine/Source/Scene/FrameRateMonitor.js b/packages/engine/Source/Scene/FrameRateMonitor.js index c448aee64368..68169a6c24f6 100644 --- a/packages/engine/Source/Scene/FrameRateMonitor.js +++ b/packages/engine/Source/Scene/FrameRateMonitor.js @@ -15,17 +15,17 @@ import TimeConstants from "../Core/TimeConstants.js"; * @alias FrameRateMonitor * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Scene} options.scene The Scene instance for which to monitor performance. - * @param {Number} [options.samplingWindow=5.0] The length of the sliding window over which to compute the average frame rate, in seconds. - * @param {Number} [options.quietPeriod=2.0] The length of time to wait at startup and each time the page becomes visible (i.e. when the user + * @param {number} [options.samplingWindow=5.0] The length of the sliding window over which to compute the average frame rate, in seconds. + * @param {number} [options.quietPeriod=2.0] The length of time to wait at startup and each time the page becomes visible (i.e. when the user * switches back to the tab) before starting to measure performance, in seconds. - * @param {Number} [options.warmupPeriod=5.0] The length of the warmup period, in seconds. During the warmup period, a separate + * @param {number} [options.warmupPeriod=5.0] The length of the warmup period, in seconds. During the warmup period, a separate * (usually lower) frame rate is required. - * @param {Number} [options.minimumFrameRateDuringWarmup=4] The minimum frames-per-second that are required for acceptable performance during + * @param {number} [options.minimumFrameRateDuringWarmup=4] The minimum frames-per-second that are required for acceptable performance during * the warmup period. If the frame rate averages less than this during any samplingWindow during the warmupPeriod, the * lowFrameRate event will be raised and the page will redirect to the redirectOnLowFrameRateUrl, if any. - * @param {Number} [options.minimumFrameRateAfterWarmup=8] The minimum frames-per-second that are required for acceptable performance after + * @param {number} [options.minimumFrameRateAfterWarmup=8] The minimum frames-per-second that are required for acceptable performance after * the end of the warmup period. If the frame rate averages less than this during any samplingWindow after the warmupPeriod, the * lowFrameRate event will be raised and the page will redirect to the redirectOnLowFrameRateUrl, if any. */ @@ -40,7 +40,7 @@ function FrameRateMonitor(options) { /** * Gets or sets the length of the sliding window over which to compute the average frame rate, in seconds. - * @type {Number} + * @type {number} */ this.samplingWindow = defaultValue( options.samplingWindow, @@ -50,7 +50,7 @@ function FrameRateMonitor(options) { /** * Gets or sets the length of time to wait at startup and each time the page becomes visible (i.e. when the user * switches back to the tab) before starting to measure performance, in seconds. - * @type {Number} + * @type {number} */ this.quietPeriod = defaultValue( options.quietPeriod, @@ -60,7 +60,7 @@ function FrameRateMonitor(options) { /** * Gets or sets the length of the warmup period, in seconds. During the warmup period, a separate * (usually lower) frame rate is required. - * @type {Number} + * @type {number} */ this.warmupPeriod = defaultValue( options.warmupPeriod, @@ -71,7 +71,7 @@ function FrameRateMonitor(options) { * Gets or sets the minimum frames-per-second that are required for acceptable performance during * the warmup period. If the frame rate averages less than this during any samplingWindow during the warmupPeriod, the * lowFrameRate event will be raised and the page will redirect to the redirectOnLowFrameRateUrl, if any. - * @type {Number} + * @type {number} */ this.minimumFrameRateDuringWarmup = defaultValue( options.minimumFrameRateDuringWarmup, @@ -82,7 +82,7 @@ function FrameRateMonitor(options) { * Gets or sets the minimum frames-per-second that are required for acceptable performance after * the end of the warmup period. If the frame rate averages less than this during any samplingWindow after the warmupPeriod, the * lowFrameRate event will be raised and the page will redirect to the redirectOnLowFrameRateUrl, if any. - * @type {Number} + * @type {number} */ this.minimumFrameRateAfterWarmup = defaultValue( options.minimumFrameRateAfterWarmup, @@ -157,7 +157,7 @@ function FrameRateMonitor(options) { * {@link FrameRateMonitor} constructor. * * @memberof FrameRateMonitor - * @type {Object} + * @type {object} */ FrameRateMonitor.defaultSettings = { samplingWindow: 5.0, @@ -235,7 +235,7 @@ Object.defineProperties(FrameRateMonitor.prototype, { * Gets the most recently computed average frames-per-second over the last samplingWindow. * This property may be undefined if the frame rate has not been computed. * @memberof FrameRateMonitor.prototype - * @type {Number} + * @type {number} */ lastFramesPerSecond: { get: function () { @@ -279,7 +279,7 @@ FrameRateMonitor.prototype.unpause = function () { * * @memberof FrameRateMonitor * - * @returns {Boolean} True if this object was destroyed; otherwise, false. + * @returns {boolean} True if this object was destroyed; otherwise, false. * * @see FrameRateMonitor#destroy */ diff --git a/packages/engine/Source/Scene/FrameState.js b/packages/engine/Source/Scene/FrameState.js index 4e6a6a0af101..14b50cefe1d7 100644 --- a/packages/engine/Source/Scene/FrameState.js +++ b/packages/engine/Source/Scene/FrameState.js @@ -60,7 +60,7 @@ function FrameState(context, creditDisplay, jobScheduler) { /** * The maximum level-of-detail of the specular environment atlas used for image-based lighting for PBR models. - * @type {Number} + * @type {number} */ this.specularEnvironmentMapsMaximumLOD = undefined; @@ -76,14 +76,14 @@ function FrameState(context, creditDisplay, jobScheduler) { * The current morph transition time between 2D/Columbus View and 3D, * with 0.0 being 2D or Columbus View and 1.0 being 3D. * - * @type {Number} + * @type {number} */ this.morphTime = SceneMode.getMorphTime(SceneMode.SCENE3D); /** * The current frame number. * - * @type {Number} + * @type {number} * @default 0 */ this.frameNumber = 0; @@ -91,7 +91,7 @@ function FrameState(context, creditDisplay, jobScheduler) { /** * true if a new frame has been issued and the frame number has been updated. * - * @type {Boolean} + * @type {boolean} * @default false */ this.newFrame = false; @@ -130,7 +130,7 @@ function FrameState(context, creditDisplay, jobScheduler) { /** * Whether the camera is underground. * - * @type {Boolean} + * @type {boolean} * @default false */ this.cameraUnderground = false; @@ -163,7 +163,7 @@ function FrameState(context, creditDisplay, jobScheduler) { * The maximum screen-space error used to drive level-of-detail refinement. Higher * values will provide better performance but lower visual quality. * - * @type {Number} + * @type {number} * @default 2 */ this.maximumScreenSpaceError = undefined; @@ -172,19 +172,19 @@ function FrameState(context, creditDisplay, jobScheduler) { * Ratio between a pixel and a density-independent pixel. Provides a standard unit of * measure for real pixel measurements appropriate to a particular device. * - * @type {Number} + * @type {number} * @default 1.0 */ this.pixelRatio = 1.0; /** * @typedef FrameState.Passes - * @type {Object} - * @property {Boolean} render true if the primitive should update for a render pass, false otherwise. - * @property {Boolean} pick true if the primitive should update for a picking pass, false otherwise. - * @property {Boolean} depth true if the primitive should update for a depth only pass, false otherwise. - * @property {Boolean} postProcess true if the primitive should update for a per-feature post-process pass, false otherwise. - * @property {Boolean} offscreen true if the primitive should update for an offscreen pass, false otherwise. + * @type {object} + * @property {boolean} render true if the primitive should update for a render pass, false otherwise. + * @property {boolean} pick true if the primitive should update for a picking pass, false otherwise. + * @property {boolean} depth true if the primitive should update for a depth only pass, false otherwise. + * @property {boolean} postProcess true if the primitive should update for a per-feature post-process pass, false otherwise. + * @property {boolean} offscreen true if the primitive should update for an offscreen pass, false otherwise. */ /** @@ -246,18 +246,18 @@ function FrameState(context, creditDisplay, jobScheduler) { /** * Gets whether or not to optimize for 3D only. * - * @type {Boolean} + * @type {boolean} * @default false */ this.scene3DOnly = false; /** * @typedef FrameState.Fog - * @type {Object} - * @property {Boolean} enabled true if fog is enabled, false otherwise. - * @property {Number} density A positive number used to mix the color and fog color based on camera distance. - * @property {Number} sse A scalar used to modify the screen space error of geometry partially in fog. - * @property {Number} minimumBrightness The minimum brightness of terrain with fog applied. + * @type {object} + * @property {boolean} enabled true if fog is enabled, false otherwise. + * @property {number} density A positive number used to mix the color and fog color based on camera distance. + * @property {number} sse A scalar used to modify the screen space error of geometry partially in fog. + * @property {number} minimumBrightness The minimum brightness of terrain with fog applied. */ /** @@ -276,30 +276,30 @@ function FrameState(context, creditDisplay, jobScheduler) { /** * A scalar used to exaggerate the terrain. - * @type {Number} + * @type {number} * @default 1.0 */ this.terrainExaggeration = 1.0; /** * The height relative to which terrain is exaggerated. - * @type {Number} + * @type {number} * @default 0.0 */ this.terrainExaggerationRelativeHeight = 0.0; /** * @typedef FrameState.ShadowState - * @type {Object} - * @property {Boolean} shadowsEnabled Whether there are any active shadow maps this frame. - * @property {Boolean} lightShadowsEnabled Whether there are any active shadow maps that originate from light sources. Does not include shadow maps that are used for analytical purposes. + * @type {object} + * @property {boolean} shadowsEnabled Whether there are any active shadow maps this frame. + * @property {boolean} lightShadowsEnabled Whether there are any active shadow maps that originate from light sources. Does not include shadow maps that are used for analytical purposes. * @property {ShadowMap[]} shadowMaps All shadow maps that are enabled this frame. * @property {ShadowMap[]} lightShadowMaps Shadow maps that originate from light sources. Does not include shadow maps that are used for analytical purposes. Only these shadow maps will be used to generate receive shadows shaders. - * @property {Number} nearPlane The near plane of the scene's frustum commands. Used for fitting cascaded shadow maps. - * @property {Number} farPlane The far plane of the scene's frustum commands. Used for fitting cascaded shadow maps. - * @property {Number} closestObjectSize The size of the bounding volume that is closest to the camera. This is used to place more shadow detail near the object. - * @property {Number} lastDirtyTime The time when a shadow map was last dirty - * @property {Boolean} outOfView Whether the shadows maps are out of view this frame + * @property {number} nearPlane The near plane of the scene's frustum commands. Used for fitting cascaded shadow maps. + * @property {number} farPlane The far plane of the scene's frustum commands. Used for fitting cascaded shadow maps. + * @property {number} closestObjectSize The size of the bounding volume that is closest to the camera. This is used to place more shadow detail near the object. + * @property {number} lastDirtyTime The time when a shadow map was last dirty + * @property {boolean} outOfView Whether the shadows maps are out of view this frame */ /** @@ -338,14 +338,14 @@ function FrameState(context, creditDisplay, jobScheduler) { /** * The position of the splitter to use when rendering different things on either side of a splitter. * This value should be between 0.0 and 1.0 with 0 being the far left of the viewport and 1 being the far right of the viewport. - * @type {Number} + * @type {number} * @default 0.0 */ this.splitPosition = 0.0; /** * Distances to the near and far planes of the camera frustums - * @type {Number[]} + * @type {number[]} * @default [] */ this.frustumSplits = []; @@ -368,14 +368,14 @@ function FrameState(context, creditDisplay, jobScheduler) { * The distance from the camera at which to disable the depth test of billboards, labels and points * to, for example, prevent clipping against terrain. When set to zero, the depth test should always * be applied. When less than zero, the depth test should never be applied. - * @type {Number} + * @type {number} */ this.minimumDisableDepthTestDistance = undefined; /** * When false, 3D Tiles will render normally. When true, classified 3D Tile geometry will render normally and * unclassified 3D Tile geometry will render with the color multiplied with {@link FrameState#invertClassificationColor}. - * @type {Boolean} + * @type {boolean} * @default false */ this.invertClassification = false; @@ -389,7 +389,7 @@ function FrameState(context, creditDisplay, jobScheduler) { /** * Whether or not the scene uses a logarithmic depth buffer. * - * @type {Boolean} + * @type {boolean} * @default false */ this.useLogDepth = false; @@ -404,7 +404,7 @@ function FrameState(context, creditDisplay, jobScheduler) { /** * The minimum terrain height out of all rendered terrain tiles. Used to improve culling for objects underneath the ellipsoid but above terrain. * - * @type {Number} + * @type {number} * @default 0.0 */ this.minimumTerrainHeight = 0.0; @@ -414,6 +414,6 @@ function FrameState(context, creditDisplay, jobScheduler) { * A function that will be called at the end of the frame. * * @callback FrameState.AfterRenderCallback - * @returns {Boolean} true if another render should be requested in request render mode + * @returns {boolean} true if another render should be requested in request render mode */ export default FrameState; diff --git a/packages/engine/Source/Scene/FrustumCommands.js b/packages/engine/Source/Scene/FrustumCommands.js index 783e468de0a6..1e374378e22a 100644 --- a/packages/engine/Source/Scene/FrustumCommands.js +++ b/packages/engine/Source/Scene/FrustumCommands.js @@ -6,8 +6,8 @@ import Pass from "../Renderer/Pass.js"; * @alias FrustumCommands * @constructor * - * @param {Number} [near=0.0] The lower bound or closest distance from the camera. - * @param {Number} [far=0.0] The upper bound or farthest distance from the camera. + * @param {number} [near=0.0] The lower bound or closest distance from the camera. + * @param {number} [far=0.0] The upper bound or farthest distance from the camera. * * @private */ diff --git a/packages/engine/Source/Scene/GetFeatureInfoFormat.js b/packages/engine/Source/Scene/GetFeatureInfoFormat.js index a390d16f4904..6150c25d6cd3 100644 --- a/packages/engine/Source/Scene/GetFeatureInfoFormat.js +++ b/packages/engine/Source/Scene/GetFeatureInfoFormat.js @@ -10,9 +10,9 @@ import ImageryLayerFeatureInfo from "./ImageryLayerFeatureInfo.js"; * @alias GetFeatureInfoFormat * @constructor * - * @param {String} type The type of response to expect from a GetFeatureInfo request. Valid + * @param {string} type The type of response to expect from a GetFeatureInfo request. Valid * values are 'json', 'xml', 'html', or 'text'. - * @param {String} [format] The info format to request from the WMS server. This is usually a + * @param {string} [format] The info format to request from the WMS server. This is usually a * MIME type such as 'application/json' or text/xml'. If this parameter is not specified, the provider will request 'json' * using 'application/json', 'xml' using 'text/xml', 'html' using 'text/html', and 'text' using 'text/plain'. * @param {Function} [callback] A function to invoke with the GetFeatureInfo response from the WMS server diff --git a/packages/engine/Source/Scene/Globe.js b/packages/engine/Source/Scene/Globe.js index d8f91aae061a..66d1767b17fa 100644 --- a/packages/engine/Source/Scene/Globe.js +++ b/packages/engine/Source/Scene/Globe.js @@ -78,7 +78,7 @@ function Globe(ellipsoid) { /** * Determines if the globe will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = true; @@ -92,7 +92,7 @@ function Globe(ellipsoid) { * The maximum screen-space error used to drive level-of-detail refinement. Higher * values will provide better performance but lower visual quality. * - * @type {Number} + * @type {number} * @default 2 */ this.maximumScreenSpaceError = 2; @@ -103,7 +103,7 @@ function Globe(ellipsoid) { * this frame. A larger number will consume more memory but will show detail faster * when, for example, zooming out and then back in. * - * @type {Number} + * @type {number} * @default 100 */ this.tileCacheSize = 100; @@ -116,7 +116,7 @@ function Globe(ellipsoid) { * 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; @@ -125,7 +125,7 @@ function Globe(ellipsoid) { * 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; @@ -135,7 +135,7 @@ function Globe(ellipsoid) { * 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; @@ -153,7 +153,7 @@ function Globe(ellipsoid) { /** * Enable lighting the globe with the scene's light source. * - * @type {Boolean} + * @type {boolean} * @default false */ this.enableLighting = false; @@ -163,7 +163,7 @@ function Globe(ellipsoid) { * This number is multiplied by the result of czm_getLambertDiffuse in GlobeFS.glsl. * This only takes effect when enableLighting is true. * - * @type {Number} + * @type {number} * @default 0.9 */ this.lambertDiffuseMultiplier = 0.9; @@ -172,7 +172,7 @@ function Globe(ellipsoid) { * Enable dynamic lighting effects on atmosphere and fog. This only takes effect * when enableLighting is true. * - * @type {Boolean} + * @type {boolean} * @default true */ this.dynamicAtmosphereLighting = true; @@ -182,7 +182,7 @@ function Globe(ellipsoid) { * light direction. This only takes effect when enableLighting and * dynamicAtmosphereLighting are true. * - * @type {Boolean} + * @type {boolean} * @default false */ this.dynamicAtmosphereLightingFromSun = false; @@ -190,7 +190,7 @@ function Globe(ellipsoid) { /** * Enable the ground atmosphere, which is drawn over the globe when viewed from a distance between lightingFadeInDistance and lightingFadeOutDistance. * - * @type {Boolean} + * @type {boolean} * @default true */ this.showGroundAtmosphere = true; @@ -198,7 +198,7 @@ function Globe(ellipsoid) { /** * The intensity of the light that is used for computing the ground atmosphere color. * - * @type {Number} + * @type {number} * @default 10.0 */ this.atmosphereLightIntensity = 10.0; @@ -222,7 +222,7 @@ function Globe(ellipsoid) { /** * The Rayleigh scale height used in the atmospheric scattering equations for the ground atmosphere, in meters. * - * @type {Number} + * @type {number} * @default 10000.0 */ this.atmosphereRayleighScaleHeight = 10000.0; @@ -230,7 +230,7 @@ function Globe(ellipsoid) { /** * The Mie scale height used in the atmospheric scattering equations for the ground atmosphere, in meters. * - * @type {Number} + * @type {number} * @default 3200.0 */ this.atmosphereMieScaleHeight = 3200.0; @@ -240,7 +240,7 @@ function Globe(ellipsoid) { *

* Valid values are between -1.0 and 1.0. *

- * @type {Number} + * @type {number} * @default 0.9 */ this.atmosphereMieAnisotropy = 0.9; @@ -249,7 +249,7 @@ function Globe(ellipsoid) { * The distance where everything becomes lit. This only takes effect * when enableLighting or showGroundAtmosphere is true. * - * @type {Number} + * @type {number} * @default 10000000.0 */ this.lightingFadeOutDistance = 1.0e7; @@ -258,7 +258,7 @@ function Globe(ellipsoid) { * The distance where lighting resumes. This only takes effect * when enableLighting or showGroundAtmosphere is true. * - * @type {Number} + * @type {number} * @default 20000000.0 */ this.lightingFadeInDistance = 2.0e7; @@ -268,7 +268,7 @@ function Globe(ellipsoid) { * This only takes effect when showGroundAtmosphere, enableLighting, and * dynamicAtmosphereLighting are true. * - * @type {Number} + * @type {number} * @default 10000000.0 */ this.nightFadeOutDistance = 1.0e7; @@ -278,7 +278,7 @@ function Globe(ellipsoid) { * This only takes effect when showGroundAtmosphere, enableLighting, and * dynamicAtmosphereLighting are true. * - * @type {Number} + * @type {number} * @default 50000000.0 */ this.nightFadeInDistance = 5.0e7; @@ -288,7 +288,7 @@ function Globe(ellipsoid) { * covered by water; otherwise, false. This property is ignored if the * terrainProvider does not provide a water mask. * - * @type {Boolean} + * @type {boolean} * @default true */ this.showWaterEffect = true; @@ -300,7 +300,7 @@ function Globe(ellipsoid) { * testing primitives against terrain is that slight numerical noise or terrain level-of-detail * switched can sometimes make a primitive that should be on the surface disappear underneath it. * - * @type {Boolean} + * @type {boolean} * @default false * */ @@ -319,7 +319,7 @@ function Globe(ellipsoid) { /** * The hue shift to apply to the atmosphere. Defaults to 0.0 (no shift). * A hue shift of 1.0 indicates a complete rotation of the hues available. - * @type {Number} + * @type {number} * @default 0.0 */ this.atmosphereHueShift = 0.0; @@ -327,7 +327,7 @@ function Globe(ellipsoid) { /** * The saturation shift to apply to the atmosphere. Defaults to 0.0 (no shift). * A saturation shift of -1.0 is monochrome. - * @type {Number} + * @type {number} * @default 0.0 */ this.atmosphereSaturationShift = 0.0; @@ -335,7 +335,7 @@ function Globe(ellipsoid) { /** * The brightness shift to apply to the atmosphere. Defaults to 0.0 (no shift). * A brightness shift of -1.0 is complete darkness, which will let space show through. - * @type {Number} + * @type {number} * @default 0.0 */ this.atmosphereBrightnessShift = 0.0; @@ -345,7 +345,7 @@ function Globe(ellipsoid) { * A value of 2.0 scales the terrain by 2x. * A value of 0.0 makes the terrain completely flat. * Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid. - * @type {Number} + * @type {number} * @default 1.0 */ this.terrainExaggeration = 1.0; @@ -355,7 +355,7 @@ function Globe(ellipsoid) { * Terrain that is above this height will scale upwards and terrain that is below this height will scale downwards. * Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid. * If {@link Globe#terrainExaggeration} is 1.0 this value will have no effect. - * @type {Number} + * @type {number} * @default 0.0 */ this.terrainExaggerationRelativeHeight = 0.0; @@ -364,7 +364,7 @@ function Globe(ellipsoid) { * Whether to show terrain skirts. Terrain skirts are geometry extending downwards from a tile's edges used to hide seams between neighboring tiles. * Skirts are always hidden when the camera is underground or translucency is enabled. * - * @type {Boolean} + * @type {boolean} * @default true */ this.showSkirts = true; @@ -372,7 +372,7 @@ function Globe(ellipsoid) { /** * Whether to cull back-facing terrain. Back faces are not culled when the camera is underground or translucency is enabled. * - * @type {Boolean} + * @type {boolean} * @default true */ this.backFaceCulling = true; @@ -384,7 +384,7 @@ function Globe(ellipsoid) { * Determines the darkness of the vertex shadow. * This only takes effect when enableLighting is true. * - * @type {Number} + * @type {number} * @default 0.3 */ this.vertexShadowDarkness = 0.3; @@ -427,7 +427,7 @@ Object.defineProperties(Globe.prototype, { * Returns true when the tile load queue is empty, false otherwise. When the load queue is empty, * all terrain and imagery for the current view have been loaded. * @memberof Globe.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ tilesLoaded: { @@ -493,7 +493,7 @@ Object.defineProperties(Globe.prototype, { * The normal map to use for rendering waves in the ocean. Setting this property will * only have an effect if the configured terrain provider includes a water mask. * @memberof Globe.prototype - * @type {String} + * @type {string} * @default buildModuleUrl('Assets/Textures/waterNormalsSmall.jpg') */ oceanNormalMapUrl: { @@ -699,7 +699,7 @@ const scratchSphereIntersectionResult = { * * @param {Ray} ray The ray to test for intersection. * @param {Scene} scene The scene. - * @param {Boolean} [cullBackFaces=true] Set to true to not pick back faces. + * @param {boolean} [cullBackFaces=true] Set to true to not pick back faces. * @param {Cartesian3} [result] The object onto which to store the result. * @returns {Cartesian3|undefined} The intersection or undefined if none was found. The returned position is in projected coordinates for 2D and Columbus View. * @@ -837,7 +837,7 @@ function tileIfContainsCartographic(tile, cartographic) { * Get the height of the surface at a given cartographic. * * @param {Cartographic} cartographic The cartographic for which to find the height. - * @returns {Number|undefined} The height of the cartographic or undefined if it could not be found. + * @returns {number|undefined} The height of the cartographic or undefined if it could not be found. */ Globe.prototype.getHeight = function (cartographic) { //>>includeStart('debug', pragmas.debug); @@ -1097,7 +1097,7 @@ Globe.prototype.endFrame = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see Globe#destroy */ diff --git a/packages/engine/Source/Scene/GlobeSurfaceTile.js b/packages/engine/Source/Scene/GlobeSurfaceTile.js index 0798fa1845f1..409b44f82f51 100644 --- a/packages/engine/Source/Scene/GlobeSurfaceTile.js +++ b/packages/engine/Source/Scene/GlobeSurfaceTile.js @@ -79,7 +79,7 @@ Object.defineProperties(GlobeSurfaceTile.prototype, { * unloaded while it is needed for rendering, regardless of the value of this * property. * @memberof GlobeSurfaceTile.prototype - * @type {Boolean} + * @type {boolean} */ eligibleForUnloading: { get: function () { diff --git a/packages/engine/Source/Scene/GlobeSurfaceTileProvider.js b/packages/engine/Source/Scene/GlobeSurfaceTileProvider.js index 7a6ba4ec1a38..13f27f3ea9ff 100644 --- a/packages/engine/Source/Scene/GlobeSurfaceTileProvider.js +++ b/packages/engine/Source/Scene/GlobeSurfaceTileProvider.js @@ -232,7 +232,7 @@ Object.defineProperties(GlobeSurfaceTileProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof GlobeSurfaceTileProvider.prototype - * @type {Boolean} + * @type {boolean} */ ready: { get: function () { @@ -565,8 +565,8 @@ GlobeSurfaceTileProvider.prototype.cancelReprojections = function () { * Gets the maximum geometric error allowed in a tile at a given level, in meters. This function should not be * called before {@link GlobeSurfaceTileProvider#ready} returns true. * - * @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. */ GlobeSurfaceTileProvider.prototype.getLevelMaximumGeometricError = function ( level @@ -993,7 +993,7 @@ const tileDirectionScratch = new Cartesian3(); * Determines the priority for loading this tile. Lower priority values load sooner. * @param {QuadtreeTile} tile The tile. * @param {FrameState} frameState The frame state. - * @returns {Number} The load priority value. + * @returns {number} The load priority value. */ GlobeSurfaceTileProvider.prototype.computeTileLoadPriority = function ( tile, @@ -1142,7 +1142,7 @@ function computeOccludeePoint( * @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. */ GlobeSurfaceTileProvider.prototype.computeDistanceToTile = function ( tile, @@ -1357,7 +1357,7 @@ function updateTileBoundingRegion(tile, tileProvider, frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see GlobeSurfaceTileProvider#destroy */ diff --git a/packages/engine/Source/Scene/GlobeTranslucency.js b/packages/engine/Source/Scene/GlobeTranslucency.js index 85a6db5bcbb2..d81eca651829 100644 --- a/packages/engine/Source/Scene/GlobeTranslucency.js +++ b/packages/engine/Source/Scene/GlobeTranslucency.js @@ -34,7 +34,7 @@ Object.defineProperties(GlobeTranslucency.prototype, { * * @memberof GlobeTranslucency.prototype * - * @type {Boolean} + * @type {boolean} * @default false * * @see GlobeTranslucency#frontFaceAlpha @@ -61,7 +61,7 @@ Object.defineProperties(GlobeTranslucency.prototype, { * * @memberof GlobeTranslucency.prototype * - * @type {Number} + * @type {number} * @default 1.0 * * @see GlobeTranslucency#enabled @@ -141,7 +141,7 @@ Object.defineProperties(GlobeTranslucency.prototype, { * * @memberof GlobeTranslucency.prototype * - * @type {Number} + * @type {number} * @default 1.0 * * @see GlobeTranslucency#enabled diff --git a/packages/engine/Source/Scene/GltfBufferViewLoader.js b/packages/engine/Source/Scene/GltfBufferViewLoader.js index e43b2ace1b8b..fcdb3894ecb7 100644 --- a/packages/engine/Source/Scene/GltfBufferViewLoader.js +++ b/packages/engine/Source/Scene/GltfBufferViewLoader.js @@ -16,13 +16,13 @@ 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 {Number} options.bufferViewId The buffer view ID. + * @param {object} options.gltf The glTF JSON. + * @param {number} options.bufferViewId The buffer view 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. - * @param {String} [options.cacheKey] The cache key of the resource. + * @param {string} [options.cacheKey] The cache key of the resource. * * @private */ @@ -101,7 +101,7 @@ Object.defineProperties(GltfBufferViewLoader.prototype, { * * @memberof GltfBufferViewLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * @private */ @@ -115,7 +115,7 @@ Object.defineProperties(GltfBufferViewLoader.prototype, { * * @memberof GltfBufferViewLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -142,7 +142,7 @@ Object.defineProperties(GltfBufferViewLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GltfBufferViewLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/GltfDracoLoader.js b/packages/engine/Source/Scene/GltfDracoLoader.js index 49481b13af00..289ab897d88e 100644 --- a/packages/engine/Source/Scene/GltfDracoLoader.js +++ b/packages/engine/Source/Scene/GltfDracoLoader.js @@ -15,13 +15,13 @@ 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.draco The Draco extension object. + * @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. - * @param {String} [options.cacheKey] The cache key of the resource. + * @param {string} [options.cacheKey] The cache key of the resource. * * @private */ @@ -68,7 +68,7 @@ Object.defineProperties(GltfDracoLoader.prototype, { * * @memberof GltfDracoLoader.prototype * - * @type {Promise.} + * @type {Promise} * @readonly * @private */ @@ -82,7 +82,7 @@ Object.defineProperties(GltfDracoLoader.prototype, { * * @memberof GltfDracoLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -96,7 +96,7 @@ Object.defineProperties(GltfDracoLoader.prototype, { * * @memberof GltfDracoLoader.prototype * - * @type {Object} + * @type {object} * @readonly * @private */ @@ -109,7 +109,7 @@ Object.defineProperties(GltfDracoLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GltfDracoLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/GltfImageLoader.js b/packages/engine/Source/Scene/GltfImageLoader.js index 53e42898325b..fe9e946fae64 100644 --- a/packages/engine/Source/Scene/GltfImageLoader.js +++ b/packages/engine/Source/Scene/GltfImageLoader.js @@ -17,13 +17,13 @@ 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 {Number} options.imageId The image ID. + * @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. - * @param {String} [options.cacheKey] The cache key of the resource. + * @param {string} [options.cacheKey] The cache key of the resource. * * @private */ @@ -73,7 +73,7 @@ Object.defineProperties(GltfImageLoader.prototype, { * * @memberof GltfImageLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * @private */ @@ -87,7 +87,7 @@ Object.defineProperties(GltfImageLoader.prototype, { * * @memberof GltfImageLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -128,7 +128,7 @@ Object.defineProperties(GltfImageLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GltfImageLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/GltfIndexBufferLoader.js b/packages/engine/Source/Scene/GltfIndexBufferLoader.js index b5006e4cbef2..1bcad69367a8 100644 --- a/packages/engine/Source/Scene/GltfIndexBufferLoader.js +++ b/packages/engine/Source/Scene/GltfIndexBufferLoader.js @@ -21,17 +21,17 @@ 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 {Number} options.accessorId The accessor ID corresponding to the index buffer. + * @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 {Object} [options.draco] The Draco extension object. - * @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 the index buffer as a GPU index buffer. - * @param {Boolean} [options.loadTypedArray=false] Load the index buffer as a typed array. + * @param {object} [options.draco] The Draco extension object. + * @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 the index buffer as a GPU index buffer. + * @param {boolean} [options.loadTypedArray=false] Load the index buffer as a typed array. * @private */ function GltfIndexBufferLoader(options) { @@ -93,7 +93,7 @@ Object.defineProperties(GltfIndexBufferLoader.prototype, { * * @memberof GltfIndexBufferLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * @private */ @@ -107,7 +107,7 @@ Object.defineProperties(GltfIndexBufferLoader.prototype, { * * @memberof GltfIndexBufferLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -165,7 +165,7 @@ const scratchIndexBufferJob = new CreateIndexBufferJob(); /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GltfIndexBufferLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/GltfJsonLoader.js b/packages/engine/Source/Scene/GltfJsonLoader.js index fdf7acb60efd..35a73a1f30bd 100644 --- a/packages/engine/Source/Scene/GltfJsonLoader.js +++ b/packages/engine/Source/Scene/GltfJsonLoader.js @@ -25,13 +25,13 @@ 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 {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 {String} [options.cacheKey] The cache key of the resource. + * @param {object} [options.gltfJson] The parsed glTF JSON contents. + * @param {string} [options.cacheKey] The cache key of the resource. * * @private */ @@ -73,7 +73,7 @@ Object.defineProperties(GltfJsonLoader.prototype, { * * @memberof GltfJsonLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * @private */ @@ -87,7 +87,7 @@ Object.defineProperties(GltfJsonLoader.prototype, { * * @memberof GltfJsonLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -101,7 +101,7 @@ Object.defineProperties(GltfJsonLoader.prototype, { * * @memberof GltfJsonLoader.prototype * - * @type {Object} + * @type {object} * @readonly * @private */ @@ -114,7 +114,7 @@ Object.defineProperties(GltfJsonLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GltfJsonLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/GltfLoader.js b/packages/engine/Source/Scene/GltfLoader.js index 20655d764f42..4aaba7c27c19 100644 --- a/packages/engine/Source/Scene/GltfLoader.js +++ b/packages/engine/Source/Scene/GltfLoader.js @@ -59,7 +59,7 @@ const Material = ModelComponents.Material; * States of the glTF loading process. These states also apply to * asynchronous texture loading unless otherwise noted * - * @enum {Number} + * @enum {number} * * @private */ @@ -67,7 +67,7 @@ const GltfLoaderState = { /** * The initial state of the glTF loader before load() is called. * - * @type {Number} + * @type {number} * @constant * * @private @@ -77,7 +77,7 @@ const GltfLoaderState = { * The state of the loader while waiting for the glTF JSON loader promise * to resolve. * - * @type {Number} + * @type {number} * @constant * * @private @@ -87,7 +87,7 @@ const GltfLoaderState = { * The state of the loader once the glTF JSON is loaded but before * process() is called. * - * @type {Number} + * @type {number} * @constant */ LOADED: 2, @@ -95,7 +95,7 @@ const GltfLoaderState = { * The state of the loader while parsing the glTF and creating GPU resources * as needed. * - * @type {Number} + * @type {number} * @constant */ PROCESSING: 3, @@ -107,7 +107,7 @@ const GltfLoaderState = { * This state is not used for asynchronous texture loading. *

* - * @type {Number} + * @type {number} * @constant */ POST_PROCESSING: 4, @@ -116,7 +116,7 @@ const GltfLoaderState = { * enters the processed state (sometimes from a promise chain). The next * call to process() will advance to the ready state. * - * @type {Number} + * @type {number} * @constant */ PROCESSED: 5, @@ -124,21 +124,21 @@ const GltfLoaderState = { * When the loader reaches the ready state, the loaders' promise will be * resolved. * - * @type {Number} + * @type {number} * @constant */ READY: 6, /** * If an error occurs at any point, the loader switches to the failed state. * - * @type {Number} + * @type {number} * @constant */ FAILED: 7, /** * If unload() is called, the loader switches to the unloaded state. * - * @type {Number} + * @type {number} * @constant */ UNLOADED: 8, @@ -154,22 +154,22 @@ const GltfLoaderState = { * @constructor * @augments ResourceLoader * - * @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. This is often the path of the .gltf or .glb file, but may also be the path of the .b3dm, .i3dm, or .cmpt file containing the embedded glb. .cmpt resources should have a URI fragment indicating the index of the inner content to which the glb belongs in order to individually identify the glb in the cache, e.g. http://example.com/tile.cmpt#index=2. * @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, e.g. from a .b3dm, .i3dm, or .cmpt file. - * @param {Object} [options.gltfJson] A parsed glTF JSON file instead of passing it in as a typed array. - * @param {Boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective. - * @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.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the glTF is loaded. + * @param {object} [options.gltfJson] A parsed glTF JSON file instead of passing it in as a typed array. + * @param {boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective. + * @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.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the glTF is loaded. * @param {Axis} [options.upAxis=Axis.Y] The up-axis of the glTF model. * @param {Axis} [options.forwardAxis=Axis.Z] The forward-axis of the glTF model. - * @param {Boolean} [options.loadAttributesAsTypedArray=false] Load all attributes and indices as typed arrays instead of GPU buffers. If the attributes are interleaved in the glTF they will be de-interleaved in the typed array. - * @param {Boolean} [options.loadAttributesFor2D=false] If true, load the positions buffer and any instanced attribute buffers as typed arrays for accurately projecting models to 2D. - * @param {Boolean} [options.loadIndicesForWireframe=false] If true, load the index buffer as both a buffer and typed array. The latter is useful for creating wireframe indices in WebGL1. - * @param {Boolean} [options.loadPrimitiveOutline=true] If true, load outlines from the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time. - * @param {Boolean} [options.loadForClassification=false] If true and if the model has feature IDs, load the feature IDs and indices as typed arrays. This is useful for batching features for classification. - * @param {Boolean} [options.renameBatchIdSemantic=false] If true, rename _BATCHID or BATCHID to _FEATURE_ID_0. This is used for .b3dm models + * @param {boolean} [options.loadAttributesAsTypedArray=false] Load all attributes and indices as typed arrays instead of GPU buffers. If the attributes are interleaved in the glTF they will be de-interleaved in the typed array. + * @param {boolean} [options.loadAttributesFor2D=false] If true, load the positions buffer and any instanced attribute buffers as typed arrays for accurately projecting models to 2D. + * @param {boolean} [options.loadIndicesForWireframe=false] If true, load the index buffer as both a buffer and typed array. The latter is useful for creating wireframe indices in WebGL1. + * @param {boolean} [options.loadPrimitiveOutline=true] If true, load outlines from the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time. + * @param {boolean} [options.loadForClassification=false] If true and if the model has feature IDs, load the feature IDs and indices as typed arrays. This is useful for batching features for classification. + * @param {boolean} [options.renameBatchIdSemantic=false] If true, rename _BATCHID or BATCHID to _FEATURE_ID_0. This is used for .b3dm models * @private */ function GltfLoader(options) { @@ -279,7 +279,7 @@ Object.defineProperties(GltfLoader.prototype, { * * @memberof GltfLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * @private */ @@ -293,7 +293,7 @@ Object.defineProperties(GltfLoader.prototype, { * * @memberof GltfLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -337,7 +337,7 @@ Object.defineProperties(GltfLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GltfLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/GltfLoaderUtil.js b/packages/engine/Source/Scene/GltfLoaderUtil.js index f07e398b758f..1457ac6cd1a8 100644 --- a/packages/engine/Source/Scene/GltfLoaderUtil.js +++ b/packages/engine/Source/Scene/GltfLoaderUtil.js @@ -25,12 +25,12 @@ const GltfLoaderUtil = {}; * WebP images the WebP image ID is returned. *

* - * @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. diff --git a/packages/engine/Source/Scene/GltfPipeline/addBuffer.js b/packages/engine/Source/Scene/GltfPipeline/addBuffer.js index 291bdc0d1c06..b06b5a267055 100644 --- a/packages/engine/Source/Scene/GltfPipeline/addBuffer.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/addDefaults.js b/packages/engine/Source/Scene/GltfPipeline/addDefaults.js index ab35038adfcf..d67b10fd98b4 100644 --- a/packages/engine/Source/Scene/GltfPipeline/addDefaults.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/addExtensionsRequired.js b/packages/engine/Source/Scene/GltfPipeline/addExtensionsRequired.js index c6b82ec7828c..210de9cc9d91 100644 --- a/packages/engine/Source/Scene/GltfPipeline/addExtensionsRequired.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/addExtensionsUsed.js b/packages/engine/Source/Scene/GltfPipeline/addExtensionsUsed.js index 109065d6d5b0..4975ed248bde 100644 --- a/packages/engine/Source/Scene/GltfPipeline/addExtensionsUsed.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/addPipelineExtras.js b/packages/engine/Source/Scene/GltfPipeline/addPipelineExtras.js index b4a81bb67ce1..24242a8739b5 100644 --- a/packages/engine/Source/Scene/GltfPipeline/addPipelineExtras.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/addToArray.js b/packages/engine/Source/Scene/GltfPipeline/addToArray.js index 35a105e92ca1..a9d025a21d86 100644 --- a/packages/engine/Source/Scene/GltfPipeline/addToArray.js +++ b/packages/engine/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 true, if a duplicate element is found its index is returned and element is not added to the array. + * @param {object} element The element to add. + * @param {boolean} [checkDuplicates=false] When true, if a duplicate element is found its index is returned and element is not added to the array. * * @private */ diff --git a/packages/engine/Source/Scene/GltfPipeline/findAccessorMinMax.js b/packages/engine/Source/Scene/GltfPipeline/findAccessorMinMax.js index 54c602a47a78..0a276f4981b7 100644 --- a/packages/engine/Source/Scene/GltfPipeline/findAccessorMinMax.js +++ b/packages/engine/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 diff --git a/packages/engine/Source/Scene/GltfPipeline/forEachTextureInMaterial.js b/packages/engine/Source/Scene/GltfPipeline/forEachTextureInMaterial.js index bd168e7f284d..047d4883de19 100644 --- a/packages/engine/Source/Scene/GltfPipeline/forEachTextureInMaterial.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/getAccessorByteStride.js b/packages/engine/Source/Scene/GltfPipeline/getAccessorByteStride.js index d537bad96e61..f7239c93f6df 100644 --- a/packages/engine/Source/Scene/GltfPipeline/getAccessorByteStride.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/getComponentReader.js b/packages/engine/Source/Scene/GltfPipeline/getComponentReader.js index 36253ea256e3..5e44abfc0860 100644 --- a/packages/engine/Source/Scene/GltfPipeline/getComponentReader.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/moveTechniqueRenderStates.js b/packages/engine/Source/Scene/GltfPipeline/moveTechniqueRenderStates.js index 882b5e1e2054..9d2aa3b59bbb 100644 --- a/packages/engine/Source/Scene/GltfPipeline/moveTechniqueRenderStates.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/moveTechniquesToExtension.js b/packages/engine/Source/Scene/GltfPipeline/moveTechniquesToExtension.js index 2c4a661907ab..98c7a2938da6 100644 --- a/packages/engine/Source/Scene/GltfPipeline/moveTechniquesToExtension.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/numberOfComponentsForType.js b/packages/engine/Source/Scene/GltfPipeline/numberOfComponentsForType.js index 9a413a44d456..ef573b2918fc 100644 --- a/packages/engine/Source/Scene/GltfPipeline/numberOfComponentsForType.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/parseGlb.js b/packages/engine/Source/Scene/GltfPipeline/parseGlb.js index 5c918e9f6892..3ada028bc7d4 100644 --- a/packages/engine/Source/Scene/GltfPipeline/parseGlb.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/readAccessorPacked.js b/packages/engine/Source/Scene/GltfPipeline/readAccessorPacked.js index be3aadd01f9d..60b06b6ce136 100644 --- a/packages/engine/Source/Scene/GltfPipeline/readAccessorPacked.js +++ b/packages/engine/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 diff --git a/packages/engine/Source/Scene/GltfPipeline/removeExtension.js b/packages/engine/Source/Scene/GltfPipeline/removeExtension.js index 49e0e1dda940..6622ea6ab13a 100644 --- a/packages/engine/Source/Scene/GltfPipeline/removeExtension.js +++ b/packages/engine/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. */ diff --git a/packages/engine/Source/Scene/GltfPipeline/removeExtensionsRequired.js b/packages/engine/Source/Scene/GltfPipeline/removeExtensionsRequired.js index eac77f5e92aa..6ca44926bad3 100644 --- a/packages/engine/Source/Scene/GltfPipeline/removeExtensionsRequired.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/removeExtensionsUsed.js b/packages/engine/Source/Scene/GltfPipeline/removeExtensionsUsed.js index 6bf41cf6a4e5..dff9cf8985a4 100644 --- a/packages/engine/Source/Scene/GltfPipeline/removeExtensionsUsed.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/removePipelineExtras.js b/packages/engine/Source/Scene/GltfPipeline/removePipelineExtras.js index 3dece5d8f703..e9162c6f517e 100644 --- a/packages/engine/Source/Scene/GltfPipeline/removePipelineExtras.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/removeUnusedElements.js b/packages/engine/Source/Scene/GltfPipeline/removeUnusedElements.js index 212e1c0d1895..0ab354988a4f 100644 --- a/packages/engine/Source/Scene/GltfPipeline/removeUnusedElements.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/updateAccessorComponentTypes.js b/packages/engine/Source/Scene/GltfPipeline/updateAccessorComponentTypes.js index 936a82e63862..1de3059dfd09 100644 --- a/packages/engine/Source/Scene/GltfPipeline/updateAccessorComponentTypes.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/updateVersion.js b/packages/engine/Source/Scene/GltfPipeline/updateVersion.js index 9171bcffdd7f..0eb8c0c1826e 100644 --- a/packages/engine/Source/Scene/GltfPipeline/updateVersion.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfPipeline/usesExtension.js b/packages/engine/Source/Scene/GltfPipeline/usesExtension.js index 3fb17a4b6781..10815912a821 100644 --- a/packages/engine/Source/Scene/GltfPipeline/usesExtension.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/GltfStructuralMetadataLoader.js b/packages/engine/Source/Scene/GltfStructuralMetadataLoader.js index 032bcdf3f772..4af609227361 100644 --- a/packages/engine/Source/Scene/GltfStructuralMetadataLoader.js +++ b/packages/engine/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 EXT_structural_metadata extension object. If this is undefined, then extensionLegacy must be defined. - * @param {String} [options.extensionLegacy] The legacy EXT_feature_metadata extension for backwards compatibility. + * @param {object} options Object with the following properties: + * @param {object} options.gltf The glTF JSON. + * @param {string} [options.extension] The EXT_structural_metadata extension object. If this is undefined, then extensionLegacy must be defined. + * @param {string} [options.extensionLegacy] The legacy EXT_feature_metadata 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.|undefined} + * @type {Promise|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.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GltfStructuralMetadataLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/GltfTextureLoader.js b/packages/engine/Source/Scene/GltfTextureLoader.js index 4c6139914c95..e99d0d21a9f8 100644 --- a/packages/engine/Source/Scene/GltfTextureLoader.js +++ b/packages/engine/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.|undefined} + * @type {Promise|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.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GltfTextureLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/GltfVertexBufferLoader.js b/packages/engine/Source/Scene/GltfVertexBufferLoader.js index 425d3bad123e..debd8fa50ae2 100644 --- a/packages/engine/Source/Scene/GltfVertexBufferLoader.js +++ b/packages/engine/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.|undefined} + * @type {Promise|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.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GltfVertexBufferLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/GoogleEarthEnterpriseImageryProvider.js b/packages/engine/Source/Scene/GoogleEarthEnterpriseImageryProvider.js index 556b12bbbde6..7f8ba0e311b1 100644 --- a/packages/engine/Source/Scene/GoogleEarthEnterpriseImageryProvider.js +++ b/packages/engine/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.} + * @type {Promise} * @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} getTileCredits 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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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} requestImage 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 ( diff --git a/packages/engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js b/packages/engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js index 7e500951581e..ea93868135db 100644 --- a/packages/engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js +++ b/packages/engine/Source/Scene/GoogleEarthEnterpriseMapsProvider.js @@ -14,12 +14,12 @@ import WebMercatorTilingScheme from "../Core/WebMercatorTilingScheme.js"; import ImageryProvider from "./ImageryProvider.js"; /** - * @typedef {Object} GoogleEarthEnterpriseMapsProvider.ConstructorOptions + * @typedef {object} GoogleEarthEnterpriseMapsProvider.ConstructorOptions * * Initialization options for the GoogleEarthEnterpriseMapsProvider constructor * - * @property {Resource|String} url The url of the Google Earth server hosting the imagery. - * @property {Number} channel The channel (id) to be used when requesting data from the server. + * @property {Resource|string} url The url of the Google Earth server hosting the imagery. + * @property {number} channel The channel (id) to be used when requesting data from the server. * The channel number can be found by looking at the json file located at: * earth.localdomain/default_map/query?request=Json&vars=geeServerDefs The /default_map path may * differ depending on your Google Earth Enterprise server configuration. Look for the "id" that @@ -37,8 +37,8 @@ import ImageryProvider from "./ImageryProvider.js"; * } * ] * } - * @property {String} [path="/default_map"] The path of the Google Earth server hosting the imagery. - * @property {Number} [maximumLevel] The maximum level-of-detail supported by the Google Earth + * @property {string} [path="/default_map"] The path of the Google Earth server hosting the imagery. + * @property {number} [maximumLevel] The maximum level-of-detail supported by the Google Earth * Enterprise server, or undefined if there is no limit. * @property {TileDiscardPolicy} [tileDiscardPolicy] The policy that determines if a tile * is invalid and should be discarded. To ensure that no tiles are discarded, construct and pass @@ -104,7 +104,7 @@ function GoogleEarthEnterpriseMapsProvider(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; @@ -113,7 +113,7 @@ function GoogleEarthEnterpriseMapsProvider(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; @@ -122,7 +122,7 @@ function GoogleEarthEnterpriseMapsProvider(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; @@ -131,7 +131,7 @@ function GoogleEarthEnterpriseMapsProvider(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; @@ -140,7 +140,7 @@ function GoogleEarthEnterpriseMapsProvider(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; @@ -148,7 +148,7 @@ function GoogleEarthEnterpriseMapsProvider(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; @@ -157,7 +157,7 @@ function GoogleEarthEnterpriseMapsProvider(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; @@ -165,7 +165,7 @@ function GoogleEarthEnterpriseMapsProvider(options) { /** * The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color. * - * @type {Number|undefined} + * @type {number|undefined} * @default 1.9 */ this.defaultGamma = 1.9; @@ -342,7 +342,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { /** * Gets the URL of the Google Earth MapServer. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -354,7 +354,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { /** * Gets the url path of the data on the Google Earth server. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {String} + * @type {string} * @readonly */ path: { @@ -378,7 +378,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { /** * Gets the imagery channel (id) currently being used. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {Number} + * @type {number} * @readonly */ channel: { @@ -391,7 +391,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link GoogleEarthEnterpriseMapsProvider#ready} returns true. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -412,7 +412,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link GoogleEarthEnterpriseMapsProvider#ready} returns true. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -433,7 +433,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link GoogleEarthEnterpriseMapsProvider#ready} returns true. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -454,7 +454,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { * Gets the minimum level-of-detail that can be requested. This function should * not be called before {@link GoogleEarthEnterpriseMapsProvider#ready} returns true. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -496,7 +496,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { * Gets the version of the data used by this provider. This function should * not be called before {@link GoogleEarthEnterpriseMapsProvider#ready} returns true. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {Number} + * @type {number} * @readonly */ version: { @@ -517,7 +517,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { * Gets the type of data that is being requested from the provider. This function should * not be called before {@link GoogleEarthEnterpriseMapsProvider#ready} returns true. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {String} + * @type {string} * @readonly */ requestType: { @@ -594,7 +594,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -606,7 +606,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -635,7 +635,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.prototype, { * as if their alpha is 1.0 everywhere. When this property is false, memory usage * and texture upload time are reduced. * @memberof GoogleEarthEnterpriseMapsProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -648,9 +648,9 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider.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} getTileCredits must not be called before the imagery provider is ready. @@ -667,11 +667,11 @@ GoogleEarthEnterpriseMapsProvider.prototype.getTileCredits = function ( * Requests the image for a given tile. This function should * not be called before {@link GoogleEarthEnterpriseMapsProvider#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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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} requestImage must not be called before the imagery provider is ready. @@ -710,11 +710,11 @@ GoogleEarthEnterpriseMapsProvider.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. */ GoogleEarthEnterpriseMapsProvider.prototype.pickFeatures = function ( @@ -733,7 +733,7 @@ Object.defineProperties(GoogleEarthEnterpriseMapsProvider, { /** * Gets or sets the URL to the Google Earth logo for display in the credit. * @memberof GoogleEarthEnterpriseMapsProvider - * @type {String} + * @type {string} */ logoUrl: { get: function () { diff --git a/packages/engine/Source/Scene/GridImageryProvider.js b/packages/engine/Source/Scene/GridImageryProvider.js index ba0470f5019d..6126d547b6e8 100644 --- a/packages/engine/Source/Scene/GridImageryProvider.js +++ b/packages/engine/Source/Scene/GridImageryProvider.js @@ -9,7 +9,7 @@ const defaultGlowColor = new Color(0.0, 1.0, 0.0, 0.05); const defaultBackgroundColor = new Color(0.0, 0.5, 0.0, 0.2); /** - * @typedef {Object} GridImageryProvider.ConstructorOptions + * @typedef {object} GridImageryProvider.ConstructorOptions * * Initialization options for the GridImageryProvider constructor * @@ -17,14 +17,14 @@ const defaultBackgroundColor = new Color(0.0, 0.5, 0.0, 0.2); * @property {Ellipsoid} [ellipsoid] The ellipsoid. If the tilingScheme is specified, * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither * parameter is specified, the WGS84 ellipsoid is used. - * @property {Number} [cells=8] The number of grids cells. + * @property {number} [cells=8] The number of grids cells. * @property {Color} [color=Color(1.0, 1.0, 1.0, 0.4)] The color to draw grid lines. * @property {Color} [glowColor=Color(0.0, 1.0, 0.0, 0.05)] The color to draw glow for grid lines. - * @property {Number} [glowWidth=6] The width of lines used for rendering the line glow effect. + * @property {number} [glowWidth=6] The width of lines used for rendering the line glow effect. * @property {Color} [backgroundColor=Color(0.0, 0.5, 0.0, 0.2)] Background fill color. - * @property {Number} [tileWidth=256] The width of the tile for level-of-detail selection purposes. - * @property {Number} [tileHeight=256] The height of the tile for level-of-detail selection purposes. - * @property {Number} [canvasSize=256] The size of the canvas used for rendering. + * @property {number} [tileWidth=256] The width of the tile for level-of-detail selection purposes. + * @property {number} [tileHeight=256] The height of the tile for level-of-detail selection purposes. + * @property {number} [canvasSize=256] The size of the canvas used for rendering. */ /** @@ -43,7 +43,7 @@ function GridImageryProvider(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; @@ -52,7 +52,7 @@ function GridImageryProvider(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; @@ -61,7 +61,7 @@ function GridImageryProvider(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; @@ -70,7 +70,7 @@ function GridImageryProvider(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; @@ -79,7 +79,7 @@ function GridImageryProvider(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; @@ -87,7 +87,7 @@ function GridImageryProvider(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; @@ -96,7 +96,7 @@ function GridImageryProvider(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; @@ -104,7 +104,7 @@ function GridImageryProvider(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; @@ -168,7 +168,7 @@ Object.defineProperties(GridImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link GridImageryProvider#ready} returns true. * @memberof GridImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -181,7 +181,7 @@ Object.defineProperties(GridImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link GridImageryProvider#ready} returns true. * @memberof GridImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -194,7 +194,7 @@ Object.defineProperties(GridImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link GridImageryProvider#ready} returns true. * @memberof GridImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -207,7 +207,7 @@ Object.defineProperties(GridImageryProvider.prototype, { * Gets the minimum level-of-detail that can be requested. This function should * not be called before {@link GridImageryProvider#ready} returns true. * @memberof GridImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -274,7 +274,7 @@ Object.defineProperties(GridImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof GridImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -286,7 +286,7 @@ Object.defineProperties(GridImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof GridImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -315,7 +315,7 @@ Object.defineProperties(GridImageryProvider.prototype, { * as if their alpha is 1.0 everywhere. When this property is false, memory usage * and texture upload time are reduced. * @memberof GridImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -388,9 +388,9 @@ GridImageryProvider.prototype._createGridCanvas = function () { /** * 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} getTileCredits must not be called before the imagery provider is ready. @@ -403,11 +403,11 @@ GridImageryProvider.prototype.getTileCredits = function (x, y, level) { * Requests the image for a given tile. This function should * not be called before {@link GridImageryProvider#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.} The resolved image as a Canvas DOM object. + * @returns {Promise} The resolved image as a Canvas DOM object. */ GridImageryProvider.prototype.requestImage = function (x, y, level, request) { return Promise.resolve(this._canvas); @@ -417,11 +417,11 @@ GridImageryProvider.prototype.requestImage = function (x, y, level, request) { * 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. */ GridImageryProvider.prototype.pickFeatures = function ( diff --git a/packages/engine/Source/Scene/GroundPolylinePrimitive.js b/packages/engine/Source/Scene/GroundPolylinePrimitive.js index c33e61666170..77afcbe5b629 100644 --- a/packages/engine/Source/Scene/GroundPolylinePrimitive.js +++ b/packages/engine/Source/Scene/GroundPolylinePrimitive.js @@ -36,17 +36,17 @@ import StencilOperation from "./StencilOperation.js"; * @alias GroundPolylinePrimitive * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Array|GeometryInstance} [options.geometryInstances] GeometryInstances containing GroundPolylineGeometry * @param {Appearance} [options.appearance] The Appearance used to render the polyline. Defaults to a white color {@link Material} on a {@link PolylineMaterialAppearance}. - * @param {Boolean} [options.show=true] Determines if this primitive will be shown. - * @param {Boolean} [options.interleave=false] When true, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time. - * @param {Boolean} [options.releaseGeometryInstances=true] When true, the primitive does not keep a reference to the input geometryInstances to save memory. - * @param {Boolean} [options.allowPicking=true] When true, each geometry instance will only be pickable with {@link Scene#pick}. When false, GPU memory is saved. - * @param {Boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready. If false initializeTerrainHeights() must be called first. + * @param {boolean} [options.show=true] Determines if this primitive will be shown. + * @param {boolean} [options.interleave=false] When true, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time. + * @param {boolean} [options.releaseGeometryInstances=true] When true, the primitive does not keep a reference to the input geometryInstances to save memory. + * @param {boolean} [options.allowPicking=true] When true, each geometry instance will only be pickable with {@link Scene#pick}. When false, GPU memory is saved. + * @param {boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready. If false initializeTerrainHeights() must be called first. * @param {ClassificationType} [options.classificationType=ClassificationType.BOTH] Determines whether terrain, 3D Tiles or both will be classified. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. - * @param {Boolean} [options.debugShowShadowVolume=false] For debugging only. Determines if the shadow volume for each geometry in the primitive is drawn. Must be true on creation to have effect. + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. + * @param {boolean} [options.debugShowShadowVolume=false] For debugging only. Determines if the shadow volume for each geometry in the primitive is drawn. Must be true on creation to have effect. * * @example * // 1. Draw a polyline on terrain with a basic color material @@ -132,7 +132,7 @@ function GroundPolylinePrimitive(options) { * Determines if the primitive will be shown. This affects all geometry * instances in the primitive. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -156,7 +156,7 @@ function GroundPolylinePrimitive(options) { * Draws the bounding sphere for each draw command in the primitive. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -238,7 +238,7 @@ Object.defineProperties(GroundPolylinePrimitive.prototype, { * * @memberof GroundPolylinePrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -254,7 +254,7 @@ Object.defineProperties(GroundPolylinePrimitive.prototype, { * * @memberof GroundPolylinePrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -270,7 +270,7 @@ Object.defineProperties(GroundPolylinePrimitive.prototype, { * * @memberof GroundPolylinePrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -286,7 +286,7 @@ Object.defineProperties(GroundPolylinePrimitive.prototype, { * * @memberof GroundPolylinePrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -304,7 +304,7 @@ Object.defineProperties(GroundPolylinePrimitive.prototype, { * * @memberof GroundPolylinePrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -316,7 +316,7 @@ Object.defineProperties(GroundPolylinePrimitive.prototype, { /** * Gets a promise that resolves when the primitive is ready to render. * @memberof GroundPolylinePrimitive.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -333,7 +333,7 @@ Object.defineProperties(GroundPolylinePrimitive.prototype, { * * @memberof GroundPolylinePrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -847,7 +847,7 @@ GroundPolylinePrimitive.prototype.update = function (frameState) { * Returns the modifiable per-instance attributes for a {@link GeometryInstance}. * * @param {*} id The id of the {@link GeometryInstance}. - * @returns {Object} The typed array in the attribute's format or undefined if the is no instance with id. + * @returns {object} The typed array in the attribute's format or undefined if the is no instance with id. * * @exception {DeveloperError} must call update before calling getGeometryInstanceAttributes. * @@ -874,7 +874,7 @@ GroundPolylinePrimitive.prototype.getGeometryInstanceAttributes = function ( * GroundPolylinePrimitives require support for the WEBGL_depth_texture extension. * * @param {Scene} scene The current scene. - * @returns {Boolean} Whether or not the current scene supports GroundPolylinePrimitives. + * @returns {boolean} Whether or not the current scene supports GroundPolylinePrimitives. */ GroundPolylinePrimitive.isSupported = function (scene) { return scene.frameState.context.depthTexture; @@ -887,7 +887,7 @@ GroundPolylinePrimitive.isSupported = function (scene) { * isDestroyed 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. * * @see GroundPolylinePrimitive#destroy */ diff --git a/packages/engine/Source/Scene/GroundPrimitive.js b/packages/engine/Source/Scene/GroundPrimitive.js index 61446947227d..861bd2b44352 100644 --- a/packages/engine/Source/Scene/GroundPrimitive.js +++ b/packages/engine/Source/Scene/GroundPrimitive.js @@ -50,19 +50,19 @@ const GroundPrimitiveUniformMap = { * @alias GroundPrimitive * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Array|GeometryInstance} [options.geometryInstances] The geometry instances to render. * @param {Appearance} [options.appearance] The appearance used to render the primitive. Defaults to a flat PerInstanceColorAppearance when GeometryInstances have a color attribute. - * @param {Boolean} [options.show=true] Determines if this primitive will be shown. - * @param {Boolean} [options.vertexCacheOptimize=false] When true, geometry vertices are optimized for the pre and post-vertex-shader caches. - * @param {Boolean} [options.interleave=false] When true, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time. - * @param {Boolean} [options.compressVertices=true] When true, the geometry vertices are compressed, which will save memory. - * @param {Boolean} [options.releaseGeometryInstances=true] When true, the primitive does not keep a reference to the input geometryInstances to save memory. - * @param {Boolean} [options.allowPicking=true] When true, each geometry instance will only be pickable with {@link Scene#pick}. When false, GPU memory is saved. - * @param {Boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready. If false initializeTerrainHeights() must be called first. + * @param {boolean} [options.show=true] Determines if this primitive will be shown. + * @param {boolean} [options.vertexCacheOptimize=false] When true, geometry vertices are optimized for the pre and post-vertex-shader caches. + * @param {boolean} [options.interleave=false] When true, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time. + * @param {boolean} [options.compressVertices=true] When true, the geometry vertices are compressed, which will save memory. + * @param {boolean} [options.releaseGeometryInstances=true] When true, the primitive does not keep a reference to the input geometryInstances to save memory. + * @param {boolean} [options.allowPicking=true] When true, each geometry instance will only be pickable with {@link Scene#pick}. When false, GPU memory is saved. + * @param {boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready. If false initializeTerrainHeights() must be called first. * @param {ClassificationType} [options.classificationType=ClassificationType.BOTH] Determines whether terrain, 3D Tiles or both will be classified. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. - * @param {Boolean} [options.debugShowShadowVolume=false] For debugging only. Determines if the shadow volume for each geometry in the primitive is drawn. Must be true on + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. + * @param {boolean} [options.debugShowShadowVolume=false] For debugging only. Determines if the shadow volume for each geometry in the primitive is drawn. Must be true on * creation for the volumes to be created before the geometry is released or options.releaseGeometryInstance must be false. * * @example @@ -161,7 +161,7 @@ function GroundPrimitive(options) { * Determines if the primitive will be shown. This affects all geometry * instances in the primitive. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -183,7 +183,7 @@ function GroundPrimitive(options) { * Draws the bounding sphere for each draw command in the primitive. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -198,7 +198,7 @@ function GroundPrimitive(options) { * Draws the shadow volume for each geometry in the primitive. *

* - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -276,7 +276,7 @@ Object.defineProperties(GroundPrimitive.prototype, { * * @memberof GroundPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -292,7 +292,7 @@ Object.defineProperties(GroundPrimitive.prototype, { * * @memberof GroundPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -308,7 +308,7 @@ Object.defineProperties(GroundPrimitive.prototype, { * * @memberof GroundPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -324,7 +324,7 @@ Object.defineProperties(GroundPrimitive.prototype, { * * @memberof GroundPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -340,7 +340,7 @@ Object.defineProperties(GroundPrimitive.prototype, { * * @memberof GroundPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -356,7 +356,7 @@ Object.defineProperties(GroundPrimitive.prototype, { * * @memberof GroundPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -374,7 +374,7 @@ Object.defineProperties(GroundPrimitive.prototype, { * * @memberof GroundPrimitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -386,7 +386,7 @@ Object.defineProperties(GroundPrimitive.prototype, { /** * Gets a promise that resolves when the primitive is ready to render. * @memberof GroundPrimitive.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -401,7 +401,7 @@ Object.defineProperties(GroundPrimitive.prototype, { * * @function * @param {Scene} scene The scene. - * @returns {Boolean} true if GroundPrimitives are supported; otherwise, returns false + * @returns {boolean} true if GroundPrimitives are supported; otherwise, returns false */ GroundPrimitive.isSupported = ClassificationPrimitive.isSupported; @@ -956,7 +956,7 @@ GroundPrimitive.prototype.getBoundingSphere = function (id) { * Returns the modifiable per-instance attributes for a {@link GeometryInstance}. * * @param {*} id The id of the {@link GeometryInstance}. - * @returns {Object} The typed array in the attribute's format or undefined if the is no instance with id. + * @returns {object} The typed array in the attribute's format or undefined if the is no instance with id. * * @exception {DeveloperError} must call update before calling getGeometryInstanceAttributes. * @@ -983,7 +983,7 @@ GroundPrimitive.prototype.getGeometryInstanceAttributes = function (id) { * isDestroyed 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. * * @see GroundPrimitive#destroy */ @@ -1016,7 +1016,7 @@ GroundPrimitive.prototype.destroy = function () { * Exposed for testing. * * @param {Context} context Rendering context - * @returns {Boolean} Whether or not the current context supports materials on GroundPrimitives. + * @returns {boolean} Whether or not the current context supports materials on GroundPrimitives. * @private */ GroundPrimitive._supportsMaterials = function (context) { @@ -1028,7 +1028,7 @@ GroundPrimitive._supportsMaterials = function (context) { * Materials on GroundPrimitives require support for the WEBGL_depth_texture extension. * * @param {Scene} scene The current scene. - * @returns {Boolean} Whether or not the current scene supports materials on GroundPrimitives. + * @returns {boolean} Whether or not the current scene supports materials on GroundPrimitives. */ GroundPrimitive.supportsMaterials = function (scene) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Scene/GroupMetadata.js b/packages/engine/Source/Scene/GroupMetadata.js index d910e919dda6..66b2e3c3d8ff 100644 --- a/packages/engine/Source/Scene/GroupMetadata.js +++ b/packages/engine/Source/Scene/GroupMetadata.js @@ -9,9 +9,9 @@ import MetadataEntity from "./MetadataEntity.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles *

* - * @param {Object} options Object with the following properties: - * @param {String} options.id The ID of the group. - * @param {Object} options.group The group JSON object. + * @param {object} options Object with the following properties: + * @param {string} options.id The ID of the group. + * @param {object} options.group The group JSON object. * @param {MetadataClass} options.class The class that group metadata conforms to. * * @alias GroupMetadata @@ -58,7 +58,7 @@ Object.defineProperties(GroupMetadata.prototype, { * The ID of the group. * * @memberof GroupMetadata.prototype - * @type {String} + * @type {string} * @readonly * @private */ @@ -86,7 +86,7 @@ Object.defineProperties(GroupMetadata.prototype, { * An object containing extensions. * * @memberof GroupMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -100,8 +100,8 @@ Object.defineProperties(GroupMetadata.prototype, { /** * Returns whether the group has this property. * - * @param {String} propertyId The case-sensitive ID of the property. - * @returns {Boolean} Whether the group has this property. + * @param {string} propertyId The case-sensitive ID of the property. + * @returns {boolean} Whether the group has this property. * @private */ GroupMetadata.prototype.hasProperty = function (propertyId) { @@ -111,8 +111,8 @@ GroupMetadata.prototype.hasProperty = function (propertyId) { /** * Returns whether the group has a property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @returns {Boolean} Whether the group has a property with the given semantic. + * @param {string} semantic The case-sensitive semantic of the property. + * @returns {boolean} Whether the group has a property with the given semantic. * @private */ GroupMetadata.prototype.hasPropertyBySemantic = function (semantic) { @@ -126,8 +126,8 @@ GroupMetadata.prototype.hasPropertyBySemantic = function (semantic) { /** * 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 */ GroupMetadata.prototype.getPropertyIds = function (results) { @@ -140,7 +140,7 @@ GroupMetadata.prototype.getPropertyIds = function (results) { * If the property is normalized the normalized value is returned. *

* - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @returns {*} The value of the property or undefined if the group does not have this property. * @private */ @@ -154,9 +154,9 @@ GroupMetadata.prototype.getProperty = function (propertyId) { * If the property is normalized a normalized value must be provided to this function. *

* - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ GroupMetadata.prototype.setProperty = function (propertyId, value) { @@ -171,7 +171,7 @@ GroupMetadata.prototype.setProperty = function (propertyId, value) { /** * Returns a copy of the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @returns {*} The value of the property or undefined if the group does not have this semantic. * @private */ @@ -186,9 +186,9 @@ GroupMetadata.prototype.getPropertyBySemantic = function (semantic) { /** * Sets the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ GroupMetadata.prototype.setPropertyBySemantic = function (semantic, value) { diff --git a/packages/engine/Source/Scene/HeightReference.js b/packages/engine/Source/Scene/HeightReference.js index 45169f0c8067..809fe4c04943 100644 --- a/packages/engine/Source/Scene/HeightReference.js +++ b/packages/engine/Source/Scene/HeightReference.js @@ -1,26 +1,26 @@ /** * Represents the position relative to the terrain. * - * @enum {Number} + * @enum {number} */ const HeightReference = { /** * The position is absolute. - * @type {Number} + * @type {number} * @constant */ NONE: 0, /** * The position is clamped to the terrain. - * @type {Number} + * @type {number} * @constant */ CLAMP_TO_GROUND: 1, /** * The position height is the height above the terrain. - * @type {Number} + * @type {number} * @constant */ RELATIVE_TO_GROUND: 2, diff --git a/packages/engine/Source/Scene/HorizontalOrigin.js b/packages/engine/Source/Scene/HorizontalOrigin.js index 3f7757926559..61eaeb34029b 100644 --- a/packages/engine/Source/Scene/HorizontalOrigin.js +++ b/packages/engine/Source/Scene/HorizontalOrigin.js @@ -8,7 +8,7 @@ *
* * - * @enum {Number} + * @enum {number} * * @see Billboard#horizontalOrigin * @see Label#horizontalOrigin @@ -17,7 +17,7 @@ const HorizontalOrigin = { /** * The origin is at the horizontal center of the object. * - * @type {Number} + * @type {number} * @constant */ CENTER: 0, @@ -25,7 +25,7 @@ const HorizontalOrigin = { /** * The origin is on the left side of the object. * - * @type {Number} + * @type {number} * @constant */ LEFT: 1, @@ -33,7 +33,7 @@ const HorizontalOrigin = { /** * The origin is on the right side of the object. * - * @type {Number} + * @type {number} * @constant */ RIGHT: -1, diff --git a/packages/engine/Source/Scene/I3SDataProvider.js b/packages/engine/Source/Scene/I3SDataProvider.js index ac0fe6cb36dc..ea3cc327d415 100644 --- a/packages/engine/Source/Scene/I3SDataProvider.js +++ b/packages/engine/Source/Scene/I3SDataProvider.js @@ -70,13 +70,13 @@ import Rectangle from "../Core/Rectangle.js"; * @alias I3SDataProvider * @constructor * - * @param {Object} options Object with the following properties: - * @param {Resource|String} options.url The url of the I3S dataset. - * @param {String} [options.name] The name of the I3S dataset. - * @param {Boolean} [options.show=true] Determines if the dataset will be shown. + * @param {object} options Object with the following properties: + * @param {Resource|string} options.url The url of the I3S dataset. + * @param {string} [options.name] The name of the I3S dataset. + * @param {boolean} [options.show=true] Determines if the dataset will be shown. * @param {ArcGISTiledElevationTerrainProvider} [options.geoidTiledTerrainProvider] Tiled elevation provider describing an Earth Gravitational Model. If defined, geometry will be shifted based on the offsets given by this provider. Required to position I3S data sets with gravity-related height at the correct location. - * @param {Boolean} [options.traceFetches=false] Debug option. When true, log a message whenever an I3S tile is fetched. - * @param {Object} [options.cesium3dTilesetOptions] Object containing options to pass to an internally created {@link Cesium3DTileset}. See {@link Cesium3DTileset} for list of valid properties. All options can be used with the exception of url and show which are overridden by values from I3SDataProvider. + * @param {boolean} [options.traceFetches=false] Debug option. When true, log a message whenever an I3S tile is fetched. + * @param {object} [options.cesium3dTilesetOptions] Object containing options to pass to an internally created {@link Cesium3DTileset}. See {@link Cesium3DTileset} for list of valid properties. All options can be used with the exception of url and show which are overridden by values from I3SDataProvider. * * @example * const i3sData = new I3SDataProvider({ @@ -130,7 +130,7 @@ Object.defineProperties(I3SDataProvider.prototype, { /** * Gets a human-readable name for this dataset. * @memberof I3SDataProvider.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -142,7 +142,7 @@ Object.defineProperties(I3SDataProvider.prototype, { /** * Determines if the dataset will be shown. * @memberof I3SDataProvider.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -165,7 +165,7 @@ Object.defineProperties(I3SDataProvider.prototype, { /** * Gets or sets debugging and tracing of I3S fetches. * @memberof I3SDataProvider.prototype - * @type {Boolean} + * @type {boolean} */ traceFetches: { get: function () { @@ -215,7 +215,7 @@ Object.defineProperties(I3SDataProvider.prototype, { /** * Gets the I3S data for this object. * @memberof I3SDataProvider.prototype - * @type {Object} + * @type {object} * @readonly */ data: { @@ -255,7 +255,7 @@ Object.defineProperties(I3SDataProvider.prototype, { /** * Gets the promise that will be resolved when the I3S scene is loaded. * @memberof I3SDataProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -268,7 +268,7 @@ Object.defineProperties(I3SDataProvider.prototype, { * When true, the I3S scene is loaded. * This is set to true right before {@link I3SDataProvider#readyPromise} is resolved. * @memberof I3SDataProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -320,7 +320,7 @@ I3SDataProvider.prototype.destroy = function () { * isDestroyed 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. * * @see I3SDataProvider#destroy */ diff --git a/packages/engine/Source/Scene/I3SFeature.js b/packages/engine/Source/Scene/I3SFeature.js index f2c5b9822a2b..d911a75acaad 100644 --- a/packages/engine/Source/Scene/I3SFeature.js +++ b/packages/engine/Source/Scene/I3SFeature.js @@ -37,7 +37,7 @@ Object.defineProperties(I3SFeature.prototype, { /** * Gets the I3S data for this object. * @memberof I3SFeature.prototype - * @type {Object} + * @type {object} * @readonly */ data: { diff --git a/packages/engine/Source/Scene/I3SField.js b/packages/engine/Source/Scene/I3SField.js index 0123c73febcb..381492a32e88 100644 --- a/packages/engine/Source/Scene/I3SField.js +++ b/packages/engine/Source/Scene/I3SField.js @@ -6,7 +6,7 @@ import defined from "../Core/defined.js"; * @alias I3SField * @internalConstructor * @privateParam {I3SNode} parent The parent of that geometry - * @privateParam {Object} storageInfo The structure containing the storage info of the field + * @privateParam {object} storageInfo The structure containing the storage info of the field */ function I3SField(parent, storageInfo) { this._storageInfo = storageInfo; @@ -38,7 +38,7 @@ Object.defineProperties(I3SField.prototype, { /** * Gets the header for this field. * @memberof I3SField.prototype - * @type {Object} + * @type {object} * @readonly */ header: { @@ -49,7 +49,7 @@ Object.defineProperties(I3SField.prototype, { /** * Gets the values for this field. * @memberof I3SField.prototype - * @type {Object} + * @type {object} * @readonly */ values: { @@ -62,7 +62,7 @@ Object.defineProperties(I3SField.prototype, { /** * Gets the name for the field. * @memberof I3SField.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -94,7 +94,7 @@ function getNumericTypeSize(type) { /** * Loads the content. - * @returns {Promise.} A promise that is resolved when the field data is loaded + * @returns {Promise} A promise that is resolved when the field data is loaded */ I3SField.prototype.load = function () { const that = this; diff --git a/packages/engine/Source/Scene/I3SGeometry.js b/packages/engine/Source/Scene/I3SGeometry.js index 7d97c5c46a69..406fe04ff481 100644 --- a/packages/engine/Source/Scene/I3SGeometry.js +++ b/packages/engine/Source/Scene/I3SGeometry.js @@ -11,7 +11,7 @@ import Matrix3 from "../Core/Matrix3.js"; * @alias I3SGeometry * @internalConstructor * @privateParam {I3SNode} parent The parent of that geometry - * @privateParam {String} uri The uri to load the data from + * @privateParam {string} uri The uri to load the data from */ function I3SGeometry(parent, uri) { const dataProvider = parent._dataProvider; @@ -51,7 +51,7 @@ Object.defineProperties(I3SGeometry.prototype, { /** * Gets the I3S data for this object. * @memberof I3SGeometry.prototype - * @type {Object} + * @type {object} * @readonly */ data: { @@ -62,7 +62,7 @@ Object.defineProperties(I3SGeometry.prototype, { /** * Gets the custom attributes of the geometry. * @memberof I3SGeometry.prototype - * @type {Object} + * @type {object} * @readonly */ customAttributes: { @@ -74,7 +74,7 @@ Object.defineProperties(I3SGeometry.prototype, { /** * Loads the content. - * @returns {Promise.} A promise that is resolved when the geometry data is loaded + * @returns {Promise} A promise that is resolved when the geometry data is loaded * @private */ I3SGeometry.prototype.load = function () { @@ -121,10 +121,10 @@ const scratchV2p = new Cartesian3(); /** * Find a triangle touching the point [px, py, pz], then return the vertex closest to the search point - * @param {Number} px The x component of the point to query - * @param {Number} py The y component of the point to query - * @param {Number} pz The z component of the point to query - * @returns {Object} A structure containing the index of the closest point, + * @param {number} px The x component of the point to query + * @param {number} py The y component of the point to query + * @param {number} pz The z component of the point to query + * @returns {object} A structure containing the index of the closest point, * the squared distance from the queried point to the point that is found, * the distance from the queried point to the point that is found, * the queried position in local space, diff --git a/packages/engine/Source/Scene/I3SLayer.js b/packages/engine/Source/Scene/I3SLayer.js index e6b2f613125d..a894236b8bf5 100644 --- a/packages/engine/Source/Scene/I3SLayer.js +++ b/packages/engine/Source/Scene/I3SLayer.js @@ -12,8 +12,8 @@ import I3SNode from "./I3SNode.js"; * @alias I3SLayer * @internalConstructor * @privateParam {I3SDataProvider} dataProvider The i3s data provider - * @privateParam {Object} layerData The layer data that is loaded from the scene layer - * @privateParam {Number} index The index of the layer to be reflected + * @privateParam {object} layerData The layer data that is loaded from the scene layer + * @privateParam {number} index The index of the layer to be reflected */ function I3SLayer(dataProvider, layerData, index) { this._dataProvider = dataProvider; @@ -95,7 +95,7 @@ Object.defineProperties(I3SLayer.prototype, { /** * Gets the I3S data for this object. * @memberof I3SLayer.prototype - * @type {Object} + * @type {object} * @readonly */ data: { @@ -107,7 +107,7 @@ Object.defineProperties(I3SLayer.prototype, { /** * The version string of the loaded I3S dataset * @memberof I3SLayer.prototype - * @type {String} + * @type {string} * @readonly */ version: { @@ -119,7 +119,7 @@ Object.defineProperties(I3SLayer.prototype, { /** * The major version number of the loaded I3S dataset * @memberof I3SLayer.prototype - * @type {Number} + * @type {number} * @readonly */ majorVersion: { @@ -131,7 +131,7 @@ Object.defineProperties(I3SLayer.prototype, { /** * The minor version number of the loaded I3S dataset * @memberof I3SLayer.prototype - * @type {Number} + * @type {number} * @readonly */ minorVersion: { @@ -143,7 +143,7 @@ Object.defineProperties(I3SLayer.prototype, { /** * When true, when the loaded I3S version is 1.6 or older * @memberof I3SLayer.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ legacyVersion16: { diff --git a/packages/engine/Source/Scene/I3SNode.js b/packages/engine/Source/Scene/I3SNode.js index 8b8536b9a8a0..839b0517a68c 100644 --- a/packages/engine/Source/Scene/I3SNode.js +++ b/packages/engine/Source/Scene/I3SNode.js @@ -157,7 +157,7 @@ Object.defineProperties(I3SNode.prototype, { /** * Gets the I3S data for this object. * @memberof I3SNode.prototype - * @type {Object} + * @type {object} * @readonly */ data: { @@ -217,7 +217,7 @@ I3SNode.prototype.load = function () { /** * Loads the node fields. - * @returns {Promise.} A promise that is resolved when the I3S Node fields are loaded + * @returns {Promise} A promise that is resolved when the I3S Node fields are loaded */ I3SNode.prototype.loadFields = function () { // Check if we must load fields @@ -243,7 +243,7 @@ I3SNode.prototype.loadFields = function () { /** * Returns the fields for a given picked position * @param {Cartesian3} pickedPosition The picked position - * @returns {Object} Object containing field names and their values + * @returns {object} Object containing field names and their values */ I3SNode.prototype.getFieldsForPickedPosition = function (pickedPosition) { const geometry = this.geometryData[0]; @@ -270,8 +270,8 @@ I3SNode.prototype.getFieldsForPickedPosition = function (pickedPosition) { /** * Returns the fields for a given feature - * @param {Number} featureIndex Index of the feature whose attributes we want to get - * @returns {Object} Object containing field names and their values + * @param {number} featureIndex Index of the feature whose attributes we want to get + * @returns {object} Object containing field names and their values */ I3SNode.prototype.getFieldsForFeature = function (featureIndex) { const featureFields = {}; @@ -848,7 +848,7 @@ Object.defineProperties(Cesium3DTile.prototype, { /** * Gets the I3S Node for the tile. * @memberof Cesium3DTile.prototype - * @type {String} + * @type {string} */ i3sNode: { get: function () { diff --git a/packages/engine/Source/Scene/I3dmParser.js b/packages/engine/Source/Scene/I3dmParser.js index 1ce4b993b195..90056bd425dd 100644 --- a/packages/engine/Source/Scene/I3dmParser.js +++ b/packages/engine/Source/Scene/I3dmParser.js @@ -21,8 +21,8 @@ const sizeOfUint32 = Uint32Array.BYTES_PER_ELEMENT; * @private * * @param {ArrayBuffer} arrayBuffer The array buffer containing the i3dm. - * @param {Number} [byteOffset=0] The byte offset of the beginning of the i3dm in the array buffer. - * @returns {Object} Returns an object with the glTF format, feature table (binary and json), batch table (binary and json) and glTF parts of the i3dm. + * @param {number} [byteOffset=0] The byte offset of the beginning of the i3dm in the array buffer. + * @returns {object} Returns an object with the glTF format, feature table (binary and json), batch table (binary and json) and glTF parts of the i3dm. */ I3dmParser.parse = function (arrayBuffer, byteOffset) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Scene/ImageBasedLighting.js b/packages/engine/Source/Scene/ImageBasedLighting.js index 632e1f9dc880..e5822bc5e576 100644 --- a/packages/engine/Source/Scene/ImageBasedLighting.js +++ b/packages/engine/Source/Scene/ImageBasedLighting.js @@ -20,9 +20,9 @@ import OctahedralProjectedCubeMap from "./OctahedralProjectedCubeMap.js"; * @constructor * * @param {Cartesian2} [options.imageBasedLightingFactor=Cartesian2(1.0, 1.0)] Scales diffuse and specular image-based lighting from the earth, sky, atmosphere and star skybox. - * @param {Number} [options.luminanceAtZenith=0.2] The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map. + * @param {number} [options.luminanceAtZenith=0.2] The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map. * @param {Cartesian3[]} [options.sphericalHarmonicCoefficients] The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. - * @param {String} [options.specularEnvironmentMaps] A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps. + * @param {string} [options.specularEnvironmentMaps] A URL to a KTX2 file that contains a cube map of the specular lighting and the convoluted specular mipmaps. */ function ImageBasedLighting(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -164,7 +164,7 @@ Object.defineProperties(ImageBasedLighting.prototype, { * * @memberof ImageBasedLighting.prototype * - * @type {Number} + * @type {number} * @default 0.2 */ luminanceAtZenith: { @@ -217,7 +217,7 @@ Object.defineProperties(ImageBasedLighting.prototype, { * * @memberof ImageBasedLighting.prototype * @demo {@link https://sandcastle.cesium.com/index.html?src=Image-Based Lighting.html|Sandcastle Image Based Lighting Demo} - * @type {String} + * @type {string} * @see ImageBasedLighting#sphericalHarmonicCoefficients */ specularEnvironmentMaps: { @@ -239,7 +239,7 @@ Object.defineProperties(ImageBasedLighting.prototype, { * Whether or not image-based lighting is enabled. * * @memberof ImageBasedLighting.prototype - * @type {Boolean} + * @type {boolean} * * @private */ @@ -257,7 +257,7 @@ Object.defineProperties(ImageBasedLighting.prototype, { * based on the properties and resources have changed. * * @memberof ImageBasedLighting.prototype - * @type {Boolean} + * @type {boolean} * * @private */ @@ -271,7 +271,7 @@ Object.defineProperties(ImageBasedLighting.prototype, { * Whether or not to use the default spherical harmonic coefficients. * * @memberof ImageBasedLighting.prototype - * @type {Boolean} + * @type {boolean} * * @private */ @@ -285,7 +285,7 @@ Object.defineProperties(ImageBasedLighting.prototype, { * Whether or not the image-based lighting settings use spherical harmonic coefficients. * * @memberof ImageBasedLighting.prototype - * @type {Boolean} + * @type {boolean} * * @private */ @@ -316,7 +316,7 @@ Object.defineProperties(ImageBasedLighting.prototype, { * Whether or not to use the default specular environment maps. * * @memberof ImageBasedLighting.prototype - * @type {Boolean} + * @type {boolean} * * @private */ @@ -330,7 +330,7 @@ Object.defineProperties(ImageBasedLighting.prototype, { * Whether or not the image-based lighting settings use specular environment maps. * * @memberof ImageBasedLighting.prototype - * @type {Boolean} + * @type {boolean} * * @private */ @@ -477,7 +477,7 @@ ImageBasedLighting.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see ImageBasedLighting#destroy * @private diff --git a/packages/engine/Source/Scene/ImageryLayer.js b/packages/engine/Source/Scene/ImageryLayer.js index 497e80cba982..960c25de4261 100644 --- a/packages/engine/Source/Scene/ImageryLayer.js +++ b/packages/engine/Source/Scene/ImageryLayer.js @@ -44,28 +44,28 @@ import TileImagery from "./TileImagery.js"; * @constructor * * @param {ImageryProvider} imageryProvider The imagery provider to use. - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Rectangle} [options.rectangle=imageryProvider.rectangle] The rectangle of the layer. This rectangle * can limit the visible portion of the imagery provider. - * @param {Number|Function} [options.alpha=1.0] The alpha blending value of this layer, from 0.0 to 1.0. + * @param {number|Function} [options.alpha=1.0] The alpha blending value of this layer, from 0.0 to 1.0. * This can either be a simple number or a function with the signature * function(frameState, layer, x, y, level). The function is passed the * current frame state, this layer, and the x, y, and level coordinates of the * imagery tile for which the alpha is required, and it is expected to return * the alpha value to use for the tile. - * @param {Number|Function} [options.nightAlpha=1.0] The alpha blending value of this layer on the night side of the globe, from 0.0 to 1.0. + * @param {number|Function} [options.nightAlpha=1.0] The alpha blending value of this layer on the night side of the globe, from 0.0 to 1.0. * This can either be a simple number or a function with the signature * function(frameState, layer, x, y, level). The function is passed the * current frame state, this layer, and the x, y, and level coordinates of the * imagery tile for which the alpha is required, and it is expected to return * the alpha value to use for the tile. This only takes effect when enableLighting is true. - * @param {Number|Function} [options.dayAlpha=1.0] The alpha blending value of this layer on the day side of the globe, from 0.0 to 1.0. + * @param {number|Function} [options.dayAlpha=1.0] The alpha blending value of this layer on the day side of the globe, from 0.0 to 1.0. * This can either be a simple number or a function with the signature * function(frameState, layer, x, y, level). The function is passed the * current frame state, this layer, and the x, y, and level coordinates of the * imagery tile for which the alpha is required, and it is expected to return * the alpha value to use for the tile. This only takes effect when enableLighting is true. - * @param {Number|Function} [options.brightness=1.0] The brightness of this layer. 1.0 uses the unmodified imagery + * @param {number|Function} [options.brightness=1.0] The brightness of this layer. 1.0 uses the unmodified imagery * color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter. * This can either be a simple number or a function with the signature * function(frameState, layer, x, y, level). The function is passed the @@ -73,7 +73,7 @@ import TileImagery from "./TileImagery.js"; * imagery tile for which the brightness is required, and it is expected to return * the brightness value to use for the tile. The function is executed for every * frame and for every tile, so it must be fast. - * @param {Number|Function} [options.contrast=1.0] The contrast of this layer. 1.0 uses the unmodified imagery color. + * @param {number|Function} [options.contrast=1.0] The contrast of this layer. 1.0 uses the unmodified imagery color. * Less than 1.0 reduces the contrast while greater than 1.0 increases it. * This can either be a simple number or a function with the signature * function(frameState, layer, x, y, level). The function is passed the @@ -81,14 +81,14 @@ import TileImagery from "./TileImagery.js"; * imagery tile for which the contrast is required, and it is expected to return * the contrast value to use for the tile. The function is executed for every * frame and for every tile, so it must be fast. - * @param {Number|Function} [options.hue=0.0] The hue of this layer. 0.0 uses the unmodified imagery color. + * @param {number|Function} [options.hue=0.0] The hue of this layer. 0.0 uses the unmodified imagery color. * This can either be a simple number or a function with the signature * function(frameState, layer, x, y, level). The function is passed the * current frame state, this layer, and the x, y, and level coordinates * of the imagery tile for which the hue is required, and it is expected to return * the contrast value to use for the tile. The function is executed for every * frame and for every tile, so it must be fast. - * @param {Number|Function} [options.saturation=1.0] The saturation of this layer. 1.0 uses the unmodified imagery color. + * @param {number|Function} [options.saturation=1.0] The saturation of this layer. 1.0 uses the unmodified imagery color. * Less than 1.0 reduces the saturation while greater than 1.0 increases it. * This can either be a simple number or a function with the signature * function(frameState, layer, x, y, level). The function is passed the @@ -96,7 +96,7 @@ import TileImagery from "./TileImagery.js"; * of the imagery tile for which the saturation is required, and it is expected to return * the contrast value to use for the tile. The function is executed for every * frame and for every tile, so it must be fast. - * @param {Number|Function} [options.gamma=1.0] The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color. + * @param {number|Function} [options.gamma=1.0] The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color. * This can either be a simple number or a function with the signature * function(frameState, layer, x, y, level). The function is passed the * current frame state, this layer, and the x, y, and level coordinates of the @@ -112,18 +112,18 @@ import TileImagery from "./TileImagery.js"; * texture minification filter to apply to this layer. Possible values * are TextureMagnificationFilter.LINEAR and * TextureMagnificationFilter.NEAREST. - * @param {Boolean} [options.show=true] True if the layer is shown; otherwise, false. - * @param {Number} [options.maximumAnisotropy=maximum supported] The maximum anisotropy level to use + * @param {boolean} [options.show=true] True if the layer is shown; otherwise, false. + * @param {number} [options.maximumAnisotropy=maximum supported] The maximum anisotropy level to use * for texture filtering. If this parameter is not specified, the maximum anisotropy supported * by the WebGL stack will be used. Larger values make the imagery look better in horizon * views. - * @param {Number} [options.minimumTerrainLevel] The minimum terrain level-of-detail at which to show this imagery layer, + * @param {number} [options.minimumTerrainLevel] The minimum terrain level-of-detail at which to show this imagery layer, * or undefined to show it at all levels. Level zero is the least-detailed level. - * @param {Number} [options.maximumTerrainLevel] The maximum terrain level-of-detail at which to show this imagery layer, + * @param {number} [options.maximumTerrainLevel] The maximum terrain level-of-detail at which to show this imagery layer, * or undefined to show it at all levels. Level zero is the least-detailed level. * @param {Rectangle} [options.cutoutRectangle] Cartographic rectangle for cutting out a portion of this ImageryLayer. * @param {Color} [options.colorToAlpha] Color to be used as alpha. - * @param {Number} [options.colorToAlphaThreshold=0.004] Threshold for color-to-alpha. + * @param {number} [options.colorToAlphaThreshold=0.004] Threshold for color-to-alpha. */ function ImageryLayer(imageryProvider, options) { this._imageryProvider = imageryProvider; @@ -134,7 +134,7 @@ function ImageryLayer(imageryProvider, options) { * The alpha blending value of this layer, with 0.0 representing fully transparent and * 1.0 representing fully opaque. * - * @type {Number} + * @type {number} * @default 1.0 */ this.alpha = defaultValue( @@ -146,7 +146,7 @@ function ImageryLayer(imageryProvider, options) { * The alpha blending value of this layer on the night side of the globe, with 0.0 representing fully transparent and * 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is true. * - * @type {Number} + * @type {number} * @default 1.0 */ this.nightAlpha = defaultValue( @@ -158,7 +158,7 @@ function ImageryLayer(imageryProvider, options) { * The alpha blending value of this layer on the day side of the globe, with 0.0 representing fully transparent and * 1.0 representing fully opaque. This only takes effect when {@link Globe#enableLighting} is true. * - * @type {Number} + * @type {number} * @default 1.0 */ this.dayAlpha = defaultValue( @@ -170,7 +170,7 @@ function ImageryLayer(imageryProvider, options) { * The brightness of this layer. 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} + * @type {number} * @default {@link ImageryLayer.DEFAULT_BRIGHTNESS} */ this.brightness = defaultValue( @@ -185,7 +185,7 @@ function ImageryLayer(imageryProvider, options) { * The contrast of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces * the contrast while greater than 1.0 increases it. * - * @type {Number} + * @type {number} * @default {@link ImageryLayer.DEFAULT_CONTRAST} */ this.contrast = defaultValue( @@ -196,7 +196,7 @@ function ImageryLayer(imageryProvider, options) { /** * The hue of this layer in radians. 0.0 uses the unmodified imagery color. * - * @type {Number} + * @type {number} * @default {@link ImageryLayer.DEFAULT_HUE} */ this.hue = defaultValue( @@ -208,7 +208,7 @@ function ImageryLayer(imageryProvider, options) { * The saturation of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the * saturation while greater than 1.0 increases it. * - * @type {Number} + * @type {number} * @default {@link ImageryLayer.DEFAULT_SATURATION} */ this.saturation = defaultValue( @@ -222,7 +222,7 @@ function ImageryLayer(imageryProvider, options) { /** * The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color. * - * @type {Number} + * @type {number} * @default {@link ImageryLayer.DEFAULT_GAMMA} */ this.gamma = defaultValue( @@ -282,7 +282,7 @@ function ImageryLayer(imageryProvider, options) { /** * Determines if this layer is shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -327,7 +327,7 @@ function ImageryLayer(imageryProvider, options) { /** * Normalized (0-1) threshold for color-to-alpha. * - * @type {Number} + * @type {number} */ this.colorToAlphaThreshold = defaultValue( options.colorToAlphaThreshold, @@ -365,35 +365,35 @@ Object.defineProperties(ImageryLayer.prototype, { /** * This value is used as the default brightness for the imagery layer if one is not provided during construction * or by the imagery provider. This value does not modify the brightness of the imagery. - * @type {Number} + * @type {number} * @default 1.0 */ ImageryLayer.DEFAULT_BRIGHTNESS = 1.0; /** * This value is used as the default contrast for the imagery layer if one is not provided during construction * or by the imagery provider. This value does not modify the contrast of the imagery. - * @type {Number} + * @type {number} * @default 1.0 */ ImageryLayer.DEFAULT_CONTRAST = 1.0; /** * This value is used as the default hue for the imagery layer if one is not provided during construction * or by the imagery provider. This value does not modify the hue of the imagery. - * @type {Number} + * @type {number} * @default 0.0 */ ImageryLayer.DEFAULT_HUE = 0.0; /** * This value is used as the default saturation for the imagery layer if one is not provided during construction * or by the imagery provider. This value does not modify the saturation of the imagery. - * @type {Number} + * @type {number} * @default 1.0 */ ImageryLayer.DEFAULT_SATURATION = 1.0; /** * This value is used as the default gamma for the imagery layer if one is not provided during construction * or by the imagery provider. This value does not modify the gamma of the imagery. - * @type {Number} + * @type {number} * @default 1.0 */ ImageryLayer.DEFAULT_GAMMA = 1.0; @@ -425,7 +425,7 @@ ImageryLayer.DEFAULT_MAGNIFICATION_FILTER = TextureMagnificationFilter.LINEAR; /** * This value is used as the default threshold for color-to-alpha if one is not provided * during construction or by the imagery provider. - * @type {Number} + * @type {number} * @default 0.004 */ ImageryLayer.DEFAULT_APPLY_COLOR_TO_ALPHA_THRESHOLD = 0.004; @@ -437,7 +437,7 @@ ImageryLayer.DEFAULT_APPLY_COLOR_TO_ALPHA_THRESHOLD = 0.004; * it actually does not, by stretching the texels at the edges over the entire * globe. * - * @returns {Boolean} true if this is the base layer; otherwise, false. + * @returns {boolean} true if this is the base layer; otherwise, false. */ ImageryLayer.prototype.isBaseLayer = function () { return this._isBaseLayer; @@ -449,7 +449,7 @@ ImageryLayer.prototype.isBaseLayer = function () { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see ImageryLayer#destroy */ @@ -486,7 +486,7 @@ const terrainRectangleScratch = new Rectangle(); * Computes the intersection of this layer's rectangle with the imagery provider's availability rectangle, * producing the overall bounds of imagery that can be produced by this layer. * - * @returns {Promise.} A promise to a rectangle which defines the overall bounds of imagery that can be produced by this layer. + * @returns {Promise} A promise to a rectangle which defines the overall bounds of imagery that can be produced by this layer. * * @example * // Zoom to an imagery layer. @@ -512,8 +512,8 @@ ImageryLayer.prototype.getViewableRectangle = function () { * * @param {Tile} tile The terrain tile. * @param {TerrainProvider} terrainProvider The terrain provider associated with the terrain tile. - * @param {Number} insertionPoint The position to insert new skeletons before in the tile's imagery list. - * @returns {Boolean} true if this layer overlaps any portion of the terrain tile; otherwise, false. + * @param {number} insertionPoint The position to insert new skeletons before in the tile's imagery list. + * @returns {boolean} true if this layer overlaps any portion of the terrain tile; otherwise, false. */ ImageryLayer.prototype._createTileImagerySkeletons = function ( tile, @@ -1192,7 +1192,7 @@ ImageryLayer.prototype._finalizeReprojectTexture = function (context, texture) { * * @param {FrameState} frameState The frameState. * @param {Imagery} imagery The imagery instance to reproject. - * @param {Boolean} [needGeographicProjection=true] True to reproject to geographic, or false if Web Mercator is fine. + * @param {boolean} [needGeographicProjection=true] True to reproject to geographic, or false if Web Mercator is fine. */ ImageryLayer.prototype._reprojectTexture = function ( frameState, @@ -1508,9 +1508,9 @@ function reprojectToGeographic(command, context, texture, rectangle) { * Gets the level with the specified world coordinate spacing between texels, or less. * * @param {ImageryLayer} layer The imagery layer to use. - * @param {Number} texelSpacing The texel spacing for which to find a corresponding level. - * @param {Number} latitudeClosestToEquator The latitude closest to the equator that we're concerned with. - * @returns {Number} The level with the specified texel spacing or less. + * @param {number} texelSpacing The texel spacing for which to find a corresponding level. + * @param {number} latitudeClosestToEquator The latitude closest to the equator that we're concerned with. + * @returns {number} The level with the specified texel spacing or less. * @private */ function getLevelWithMaximumTexelSpacing( diff --git a/packages/engine/Source/Scene/ImageryLayerCollection.js b/packages/engine/Source/Scene/ImageryLayerCollection.js index 81c22614c079..a1222d744962 100644 --- a/packages/engine/Source/Scene/ImageryLayerCollection.js +++ b/packages/engine/Source/Scene/ImageryLayerCollection.js @@ -59,7 +59,7 @@ Object.defineProperties(ImageryLayerCollection.prototype, { /** * Gets the number of layers in this collection. * @memberof ImageryLayerCollection.prototype - * @type {Number} + * @type {number} */ length: { get: function () { @@ -72,7 +72,7 @@ Object.defineProperties(ImageryLayerCollection.prototype, { * Adds a layer to the collection. * * @param {ImageryLayer} layer the layer to add. - * @param {Number} [index] the index to add the layer at. If omitted, the layer will + * @param {number} [index] the index to add the layer at. If omitted, the layer will * be added on top of all existing layers. * * @exception {DeveloperError} index, if supplied, must be greater than or equal to zero and less than or equal to the number of the layers. @@ -110,7 +110,7 @@ ImageryLayerCollection.prototype.add = function (layer, index) { * Creates a new layer using the given ImageryProvider and adds it to the collection. * * @param {ImageryProvider} imageryProvider the imagery provider to create a new layer for. - * @param {Number} [index] the index to add the layer at. If omitted, the layer will + * @param {number} [index] the index to add the layer at. If omitted, the layer will * added on top of all existing layers. * @returns {ImageryLayer} The newly created layer. */ @@ -133,8 +133,8 @@ ImageryLayerCollection.prototype.addImageryProvider = function ( * Removes a layer from this collection, if present. * * @param {ImageryLayer} layer The layer to remove. - * @param {Boolean} [destroy=true] whether to destroy the layers in addition to removing them. - * @returns {Boolean} true if the layer was in the collection and was removed, + * @param {boolean} [destroy=true] whether to destroy the layers in addition to removing them. + * @returns {boolean} true if the layer was in the collection and was removed, * false if the layer was not in the collection. */ ImageryLayerCollection.prototype.remove = function (layer, destroy) { @@ -161,7 +161,7 @@ ImageryLayerCollection.prototype.remove = function (layer, destroy) { /** * Removes all layers from this collection. * - * @param {Boolean} [destroy=true] whether to destroy the layers in addition to removing them. + * @param {boolean} [destroy=true] whether to destroy the layers in addition to removing them. */ ImageryLayerCollection.prototype.removeAll = function (destroy) { destroy = defaultValue(destroy, true); @@ -184,7 +184,7 @@ ImageryLayerCollection.prototype.removeAll = function (destroy) { * * @param {ImageryLayer} layer the layer to check for. * - * @returns {Boolean} true if the collection contains the layer, false otherwise. + * @returns {boolean} true if the collection contains the layer, false otherwise. */ ImageryLayerCollection.prototype.contains = function (layer) { return this.indexOf(layer) !== -1; @@ -195,7 +195,7 @@ ImageryLayerCollection.prototype.contains = function (layer) { * * @param {ImageryLayer} layer The layer to find the index of. * - * @returns {Number} The index of the layer in the collection, or -1 if the layer does not exist in the collection. + * @returns {number} The index of the layer in the collection, or -1 if the layer does not exist in the collection. */ ImageryLayerCollection.prototype.indexOf = function (layer) { return this._layers.indexOf(layer); @@ -204,7 +204,7 @@ ImageryLayerCollection.prototype.indexOf = function (layer) { /** * Gets a layer by index from the collection. * - * @param {Number} index the index to retrieve. + * @param {number} index the index to retrieve. * * @returns {ImageryLayer} The imagery layer at the given index. */ @@ -437,7 +437,7 @@ ImageryLayerCollection.prototype.pickImageryLayers = function (ray, scene) { * * @param {Ray} ray The ray to test for intersection. * @param {Scene} scene The scene. - * @return {Promise.|undefined} A promise that resolves to an array of features intersected by the pick ray. + * @return {Promise|undefined} A promise that resolves to an array of features intersected by the pick ray. * If it can be quickly determined that no features are intersected (for example, * because no active imagery providers support {@link ImageryProvider#pickFeatures} * or because the pick ray does not intersect the surface), this function will @@ -552,7 +552,7 @@ ImageryLayerCollection.prototype.cancelReprojections = function () { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see ImageryLayerCollection#destroy */ diff --git a/packages/engine/Source/Scene/ImageryLayerFeatureInfo.js b/packages/engine/Source/Scene/ImageryLayerFeatureInfo.js index 1156bf6df684..0ce99360f846 100644 --- a/packages/engine/Source/Scene/ImageryLayerFeatureInfo.js +++ b/packages/engine/Source/Scene/ImageryLayerFeatureInfo.js @@ -9,14 +9,14 @@ import defined from "../Core/defined.js"; function ImageryLayerFeatureInfo() { /** * Gets or sets the name of the feature. - * @type {String|undefined} + * @type {string|undefined} */ this.name = undefined; /** * Gets or sets an HTML description of the feature. The HTML is not trusted and should * be sanitized before display to the user. - * @type {String|undefined} + * @type {string|undefined} */ this.description = undefined; @@ -30,13 +30,13 @@ function ImageryLayerFeatureInfo() { /** * Gets or sets the raw data describing the feature. The raw data may be in any * number of formats, such as GeoJSON, KML, etc. - * @type {Object|undefined} + * @type {object|undefined} */ this.data = undefined; /** * Gets or sets the image layer of the feature. - * @type {Object|undefined} + * @type {object|undefined} */ this.imageryLayer = undefined; } @@ -47,7 +47,7 @@ function ImageryLayerFeatureInfo() { * 3) the first property containing the word 'name', 4) the first property containing the word 'title'. If * the name cannot be obtained from any of these sources, the existing name will be left unchanged. * - * @param {Object} properties An object literal containing the properties of the feature. + * @param {object} properties An object literal containing the properties of the feature. */ ImageryLayerFeatureInfo.prototype.configureNameFromProperties = function ( properties @@ -83,7 +83,7 @@ ImageryLayerFeatureInfo.prototype.configureNameFromProperties = function ( /** * Configures the description of this feature by creating an HTML table of properties and their values. * - * @param {Object} properties An object literal containing the properties of the feature. + * @param {object} properties An object literal containing the properties of the feature. */ ImageryLayerFeatureInfo.prototype.configureDescriptionFromProperties = function ( properties diff --git a/packages/engine/Source/Scene/ImageryProvider.js b/packages/engine/Source/Scene/ImageryProvider.js index 37a66f8df856..76d6ec9a4bac 100644 --- a/packages/engine/Source/Scene/ImageryProvider.js +++ b/packages/engine/Source/Scene/ImageryProvider.js @@ -47,7 +47,7 @@ function ImageryProvider() { * 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; @@ -56,7 +56,7 @@ function ImageryProvider() { * 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; @@ -65,7 +65,7 @@ function ImageryProvider() { * 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; @@ -74,7 +74,7 @@ function ImageryProvider() { * 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; @@ -83,7 +83,7 @@ function ImageryProvider() { * 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; @@ -91,7 +91,7 @@ function ImageryProvider() { /** * 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; @@ -100,7 +100,7 @@ function ImageryProvider() { * 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; @@ -108,7 +108,7 @@ function ImageryProvider() { /** * 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; @@ -136,7 +136,7 @@ Object.defineProperties(ImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof ImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -146,7 +146,7 @@ Object.defineProperties(ImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof ImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -168,7 +168,7 @@ Object.defineProperties(ImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link ImageryProvider#ready} returns true. * @memberof ImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -179,7 +179,7 @@ Object.defineProperties(ImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link ImageryProvider#ready} returns true. * @memberof ImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -190,7 +190,7 @@ Object.defineProperties(ImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link ImageryProvider#ready} returns true. * @memberof ImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -205,7 +205,7 @@ Object.defineProperties(ImageryProvider.prototype, { * provider with more than a few tiles at the minimum level will lead to * rendering problems. * @memberof ImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -277,7 +277,7 @@ Object.defineProperties(ImageryProvider.prototype, { * as if their alpha is 1.0 everywhere. When this property is false, memory usage * and texture upload time are reduced. * @memberof ImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -288,9 +288,9 @@ Object.defineProperties(ImageryProvider.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} getTileCredits must not be called before the imagery provider is ready. @@ -303,11 +303,11 @@ ImageryProvider.prototype.getTileCredits = function (x, y, level) { * Requests the image for a given tile. This function should * not be called before {@link ImageryProvider#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.|undefined} Returns a promise for the image that will resolve when the image is available, or + * @returns {Promise|undefined} Returns 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} requestImage must not be called before the imagery provider is ready. @@ -323,12 +323,12 @@ ImageryProvider.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.|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|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. @@ -353,8 +353,8 @@ const ktx2Regex = /\.ktx2$/i; * that the request should be retried later. * * @param {ImageryProvider} imageryProvider The imagery provider for the URL. - * @param {Resource|String} url The URL of the image. - * @returns {Promise.|undefined} A promise for the image that will resolve when the image is available, or + * @param {Resource|string} url The URL of the image. + * @returns {Promise|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. */ ImageryProvider.loadImage = function (imageryProvider, url) { diff --git a/packages/engine/Source/Scene/Implicit3DTileContent.js b/packages/engine/Source/Scene/Implicit3DTileContent.js index e8d922ac5b78..fc6bef81a2f1 100644 --- a/packages/engine/Source/Scene/Implicit3DTileContent.js +++ b/packages/engine/Source/Scene/Implicit3DTileContent.js @@ -33,9 +33,9 @@ import parseBoundingVolumeSemantics from "./parseBoundingVolumeSemantics.js"; * @param {Cesium3DTileset} tileset The tileset this content belongs to * @param {Cesium3DTile} tile The tile this content belongs to. * @param {Resource} resource The resource for the tileset - * @param {Object} [json] The JSON object containing the subtree. Mutually exclusive with arrayBuffer. + * @param {object} [json] The JSON object containing the subtree. Mutually exclusive with arrayBuffer. * @param {ArrayBuffer} [arrayBuffer] The array buffer that stores the content payload. Mutually exclusive with json. - * @param {Number} [byteOffset=0] The offset into the array buffer, if one was provided + * @param {number} [byteOffset=0] The offset into the array buffer, if one was provided * * @exception {DeveloperError} One of json and arrayBuffer must be defined. * @@ -189,9 +189,9 @@ Object.defineProperties(Implicit3DTileContent.prototype, { * up a promise chain to expand the immediate subtree. * * @param {Implicit3DTileContent} content The implicit content - * @param {Object} [json] The JSON containing the subtree. Mutually exclusive with arrayBuffer. + * @param {object} [json] The JSON containing the subtree. Mutually exclusive with arrayBuffer. * @param {ArrayBuffer} [arrayBuffer] The ArrayBuffer containing a subtree binary. Mutually exclusive with json. - * @param {Number} [byteOffset=0] The byte offset into the arrayBuffer + * @param {number} [byteOffset=0] The byte offset into the arrayBuffer * @private */ function initialize(content, json, arrayBuffer, byteOffset) { @@ -262,9 +262,9 @@ function expandSubtree(content, subtree) { /** * A pair of (tile, childIndex) used for finding child subtrees. * - * @typedef {Object} ChildSubtreeLocator + * @typedef {object} ChildSubtreeLocator * @property {Cesium3DTile} tile One of the tiles in the bottommost row of the subtree. - * @property {Number} childIndex The morton index of the child tile relative to its parent + * @property {number} childIndex The morton index of the child tile relative to its parent * @private */ @@ -303,7 +303,7 @@ function listChildSubtrees(content, subtree, bottomRow) { * Results of transcodeSubtreeTiles, containing the root tile of the * subtree and the bottom row of nodes for further processing. * - * @typedef {Object} TranscodedSubtree + * @typedef {object} TranscodedSubtree * @property {Cesium3DTile} rootTile The transcoded root tile of the subtree * @property {Array} bottomRow The bottom row of transcoded tiles. This is helpful for processing child subtrees * @private @@ -317,7 +317,7 @@ function listChildSubtrees(content, subtree, bottomRow) { * @param {Implicit3DTileContent} content The implicit content * @param {ImplicitSubtree} subtree The subtree to get availability information * @param {Cesium3DTile} placeholderTile The placeholder tile, used for constructing the subtree root tile - * @param {Number} childIndex The Morton index of the root tile relative to parentOfRootTile + * @param {number} childIndex The Morton index of the root tile relative to parentOfRootTile * @returns {TranscodedSubtree} The newly created subtree of tiles * @private */ @@ -407,9 +407,9 @@ function getGeometricError(tileMetadata, implicitTileset, implicitCoordinates) { * @param {Implicit3DTileContent} implicitContent The implicit content * @param {ImplicitSubtree} subtree The subtree the child tile belongs to * @param {Cesium3DTile} parentTile The parent of the new child tile - * @param {Number} childIndex The morton index of the child tile relative to its parent - * @param {Number} childBitIndex The index of the child tile within the tile's availability information. - * @param {Boolean} [parentIsPlaceholderTile=false] True if parentTile is a placeholder tile. This is true for the root of each subtree. + * @param {number} childIndex The morton index of the child tile relative to its parent + * @param {number} childBitIndex The index of the child tile within the tile's availability information. + * @param {boolean} [parentIsPlaceholderTile=false] True if parentTile is a placeholder tile. This is true for the root of each subtree. * @returns {Cesium3DTile} The new child tile. * @private */ @@ -532,11 +532,11 @@ function deriveChildTile( * Returns true if the minimumHeight/maximumHeight parameter * is defined and the bounding volume is a region or S2 cell. * - * @param {Object} [boundingVolume] The bounding volume - * @param {Object} [tileBounds] The tile bounds - * @param {Number} [tileBounds.minimumHeight] The minimum height - * @param {Number} [tileBounds.maximumHeight] The maximum height - * @returns {Boolean} Whether the bounding volume's heights can be updated + * @param {object} [boundingVolume] The bounding volume + * @param {object} [tileBounds] The tile bounds + * @param {number} [tileBounds.minimumHeight] The minimum height + * @param {number} [tileBounds.maximumHeight] The maximum height + * @returns {boolean} Whether the bounding volume's heights can be updated * @private */ function canUpdateHeights(boundingVolume, tileBounds) { @@ -557,10 +557,10 @@ function canUpdateHeights(boundingVolume, tileBounds) { * minimumHeight/maximumHeight parameter is defined and the * bounding volume is a region or S2 cell. * - * @param {Object} boundingVolume The bounding volume - * @param {Object} [tileBounds] The tile bounds - * @param {Number} [tileBounds.minimumHeight] The new minimum height - * @param {Number} [tileBounds.maximumHeight] The new maximum height + * @param {object} boundingVolume The bounding volume + * @param {object} [tileBounds] The tile bounds + * @param {number} [tileBounds.minimumHeight] The new minimum height + * @param {number} [tileBounds.maximumHeight] The new maximum height * @private */ function updateHeights(boundingVolume, tileBounds) { @@ -591,8 +591,8 @@ function updateHeights(boundingVolume, tileBounds) { * minimumHeight/maximumHeight parameter is defined. * * @param {Array} region A 6-element array describing the bounding region - * @param {Number} [minimumHeight] The new minimum height - * @param {Number} [maximumHeight] The new maximum height + * @param {number} [minimumHeight] The new minimum height + * @param {number} [maximumHeight] The new maximum height * @private */ function updateRegionHeights(region, minimumHeight, maximumHeight) { @@ -612,9 +612,9 @@ function updateRegionHeights(region, minimumHeight, maximumHeight) { * semantics. Heights are only updated if the respective * minimumHeight/maximumHeight parameter is defined. * - * @param {Object} s2CellVolume An object describing the S2 cell - * @param {Number} [minimumHeight] The new minimum height - * @param {Number} [maximumHeight] The new maximum height + * @param {object} s2CellVolume An object describing the S2 cell + * @param {number} [minimumHeight] The new minimum height + * @param {number} [maximumHeight] The new maximum height * @private */ function updateS2CellHeights(s2CellVolume, minimumHeight, maximumHeight) { @@ -652,11 +652,11 @@ function updateS2CellHeights(s2CellVolume, minimumHeight, maximumHeight) { * * @param {ImplicitTileset} implicitTileset The implicit tileset struct which holds the root bounding volume * @param {ImplicitTileCoordinates} implicitCoordinates The coordinates of the child tile - * @param {Number} childIndex The morton index of the child tile relative to its parent - * @param {Boolean} parentIsPlaceholderTile True if parentTile is a placeholder tile. This is true for the root of each subtree. + * @param {number} childIndex The morton index of the child tile relative to its parent + * @param {boolean} parentIsPlaceholderTile True if parentTile is a placeholder tile. This is true for the root of each subtree. * @param {Cesium3DTile} parentTile The parent of the new child tile - * @param {Object} [tileBounds] The tile bounds - * @returns {Object} An object containing the JSON for a bounding volume + * @param {object} [tileBounds] The tile bounds + * @returns {object} An object containing the JSON for a bounding volume * @private */ function getTileBoundingVolume( @@ -712,9 +712,9 @@ function getTileBoundingVolume( * *

* - * @param {Object} tileBoundingVolume An object containing the JSON for the tile's bounding volume - * @param {Object} [contentBounds] The content bounds - * @returns {Object|undefined} An object containing the JSON for a bounding volume, or undefined if there is no bounding volume + * @param {object} tileBoundingVolume An object containing the JSON for the tile's bounding volume + * @param {object} [contentBounds] The content bounds + * @returns {object|undefined} An object containing the JSON for a bounding volume, or undefined if there is no bounding volume * @private */ function getContentBoundingVolume(tileBoundingVolume, contentBounds) { @@ -742,10 +742,10 @@ function getContentBoundingVolume(tileBoundingVolume, contentBounds) { * * @param {ImplicitTileset} implicitTileset The implicit tileset struct which holds the root bounding volume * @param {ImplicitTileCoordinates} implicitCoordinates The coordinates of the child tile - * @param {Number} childIndex The morton index of the child tile relative to its parent - * @param {Boolean} parentIsPlaceholderTile True if parentTile is a placeholder tile. This is true for the root of each subtree. + * @param {number} childIndex The morton index of the child tile relative to its parent + * @param {boolean} parentIsPlaceholderTile True if parentTile is a placeholder tile. This is true for the root of each subtree. * @param {Cesium3DTile} parentTile The parent of the new child tile - * @returns {Object} An object containing the JSON for a bounding volume + * @returns {object} An object containing the JSON for a bounding volume * @private */ function deriveBoundingVolume( @@ -807,14 +807,14 @@ function deriveBoundingVolume( * dimensions, i.e. (x, y), leaving the z axis unchanged. *

* - * @param {Boolean} parentIsPlaceholderTile True if parentTile is a placeholder tile. This is true for the root of each subtree. + * @param {boolean} parentIsPlaceholderTile True if parentTile is a placeholder tile. This is true for the root of each subtree. * @param {Cesium3DTile} parentTile The parent of the new child tile - * @param {Number} childIndex The morton index of the child tile relative to its parent - * @param {Number} level The level of the descendant tile relative to the root implicit tile - * @param {Number} x The x coordinate of the descendant tile - * @param {Number} y The y coordinate of the descendant tile - * @param {Number} [z] The z coordinate of the descendant tile (octree only) - * @returns {Object} An object with the 3DTILES_bounding_volume_S2 extension. + * @param {number} childIndex The morton index of the child tile relative to its parent + * @param {number} level The level of the descendant tile relative to the root implicit tile + * @param {number} x The x coordinate of the descendant tile + * @param {number} y The y coordinate of the descendant tile + * @param {number} [z] The z coordinate of the descendant tile (octree only) + * @returns {object} An object with the 3DTILES_bounding_volume_S2 extension. * @private */ function deriveBoundingVolumeS2( @@ -908,12 +908,12 @@ const scratchHalfAxes = new Matrix3(); * than recursively subdividing to minimize floating point error. *

* - * @param {Number[]} rootBox An array of 12 numbers representing the bounding box of the root tile - * @param {Number} level The level of the descendant tile relative to the root implicit tile - * @param {Number} x The x coordinate of the descendant tile - * @param {Number} y The y coordinate of the descendant tile - * @param {Number} [z] The z coordinate of the descendant tile (octree only) - * @returns {Number[]} An array of 12 numbers representing the bounding box of the descendant tile. + * @param {number[]} rootBox An array of 12 numbers representing the bounding box of the root tile + * @param {number} level The level of the descendant tile relative to the root implicit tile + * @param {number} x The x coordinate of the descendant tile + * @param {number} y The y coordinate of the descendant tile + * @param {number} [z] The z coordinate of the descendant tile (octree only) + * @returns {number[]} An array of 12 numbers representing the bounding box of the descendant tile. * @private */ function deriveBoundingBox(rootBox, level, x, y, z) { @@ -985,12 +985,12 @@ const scratchRectangle = new Rectangle(); * This computes the child volume directly from the root bounding volume rather * than recursively subdividing to minimize floating point error. *

- * @param {Number[]} rootRegion An array of 6 numbers representing the root implicit tile - * @param {Number} level The level of the descendant tile relative to the root implicit tile - * @param {Number} x The x coordinate of the descendant tile - * @param {Number} y The x coordinate of the descendant tile - * @param {Number} [z] The z coordinate of the descendant tile (octree only) - * @returns {Number[]} An array of 6 numbers representing the bounding region of the descendant tile + * @param {number[]} rootRegion An array of 6 numbers representing the root implicit tile + * @param {number} level The level of the descendant tile relative to the root implicit tile + * @param {number} x The x coordinate of the descendant tile + * @param {number} y The x coordinate of the descendant tile + * @param {number} [z] The z coordinate of the descendant tile (octree only) + * @returns {number[]} An array of 6 numbers representing the bounding region of the descendant tile * @private */ function deriveBoundingRegion(rootRegion, level, x, y, z) { @@ -1039,7 +1039,7 @@ function deriveBoundingRegion(rootRegion, level, x, y, z) { * * @param {Implicit3DTileContent} content The content object. * @param {Cesium3DTile} parentTile The parent of the new child subtree. - * @param {Number} childIndex The morton index of the child tile relative to its parent + * @param {number} childIndex The morton index of the child tile relative to its parent * @returns {Cesium3DTile} The new placeholder tile * @private */ @@ -1099,7 +1099,7 @@ function makePlaceholderChildSubtree(content, parentTile, childIndex) { * this file and Cesium3DTile.js * @param {Implicit3DTileContent} content The implicit content * @param {Resource} baseResource The base resource for the tileset - * @param {Object} tileJson The JSON header for the tile + * @param {object} tileJson The JSON header for the tile * @param {Cesium3DTile} parentTile The parent of the new tile * @returns {Cesium3DTile} The newly created tile. * @private diff --git a/packages/engine/Source/Scene/ImplicitAvailabilityBitstream.js b/packages/engine/Source/Scene/ImplicitAvailabilityBitstream.js index bfb9b8524d69..9c664f9a5259 100644 --- a/packages/engine/Source/Scene/ImplicitAvailabilityBitstream.js +++ b/packages/engine/Source/Scene/ImplicitAvailabilityBitstream.js @@ -11,12 +11,12 @@ import RuntimeError from "../Core/RuntimeError.js"; * @alias ImplicitAvailabilityBitstream * @constructor * - * @param {Object} options An object with the following properties: - * @param {Number} options.lengthBits The length of the bitstream in bits - * @param {Boolean} [options.constant] A single boolean value indicating the value of all the bits in the bitstream if they are all the same + * @param {object} options An object with the following properties: + * @param {number} options.lengthBits The length of the bitstream in bits + * @param {boolean} [options.constant] A single boolean value indicating the value of all the bits in the bitstream if they are all the same * @param {Uint8Array} [options.bitstream] An array of bytes storing the bitstream in binary - * @param {Number} [options.availableCount] A number indicating how many 1 bits are found in the bitstream - * @param {Boolean} [options.computeAvailableCountEnabled=false] If true, and options.availableCount is undefined, the availableCount will be computed from the bitstream. + * @param {number} [options.availableCount] A number indicating how many 1 bits are found in the bitstream + * @param {boolean} [options.computeAvailableCountEnabled=false] If true, and options.availableCount is undefined, the availableCount will be computed from the bitstream. * @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. */ @@ -64,7 +64,7 @@ function ImplicitAvailabilityBitstream(options) { * computing availableCount if not precomputed * * @param {Uint8Array} bitstream The bitstream typed array - * @param {Number} lengthBits How many bits are in the bitstream + * @param {number} lengthBits How many bits are in the bitstream * @private */ function count1Bits(bitstream, lengthBits) { @@ -83,7 +83,7 @@ Object.defineProperties(ImplicitAvailabilityBitstream.prototype, { * * @memberof ImplicitAvailabilityBitstream.prototype * - * @type {Number} + * @type {number} * @readonly * @private */ @@ -97,7 +97,7 @@ Object.defineProperties(ImplicitAvailabilityBitstream.prototype, { * * @memberof ImplicitAvailabilityBitstream.prototype * - * @type {Number} + * @type {number} * @readonly * @private */ @@ -112,8 +112,8 @@ Object.defineProperties(ImplicitAvailabilityBitstream.prototype, { * Get a bit from the availability bitstream as a Boolean. If the bitstream * is a constant, the constant value is returned instead. * - * @param {Number} index The integer index of the bit. - * @returns {Boolean} The value of the bit + * @param {number} index The integer index of the bit. + * @returns {boolean} The value of the bit * @private */ ImplicitAvailabilityBitstream.prototype.getBit = function (index) { diff --git a/packages/engine/Source/Scene/ImplicitMetadataView.js b/packages/engine/Source/Scene/ImplicitMetadataView.js index 7856b29af0fe..d00801aee969 100644 --- a/packages/engine/Source/Scene/ImplicitMetadataView.js +++ b/packages/engine/Source/Scene/ImplicitMetadataView.js @@ -9,8 +9,8 @@ import defaultValue from "../Core/defaultValue.js"; * * @param {MetadataTable} options.metadataTable The metadata table. * @param {MetadataClass} options.class The class that the metadata conforms to. - * @param {Number} options.entityId The ID of the entity the metadata belongs to. - * @param {Object} options.propertyTableJson The JSON that contains the property table of the entity. + * @param {number} options.entityId The ID of the entity the metadata belongs to. + * @param {object} options.propertyTableJson The JSON that contains the property table of the entity. * * @alias ImplicitMetadataView * @constructor @@ -59,7 +59,7 @@ Object.defineProperties(ImplicitMetadataView.prototype, { * Extra user-defined properties. * * @memberof ImplicitMetadataView.prototype - * @type {Object} + * @type {object} * @readonly */ extras: { @@ -72,7 +72,7 @@ Object.defineProperties(ImplicitMetadataView.prototype, { * An object containing extensions. * * @memberof ImplicitMetadataView.prototype - * @type {Object} + * @type {object} * @readonly */ extensions: { @@ -85,8 +85,8 @@ Object.defineProperties(ImplicitMetadataView.prototype, { /** * Returns whether the metadata contains this property. * - * @param {String} propertyId The case-sensitive ID of the property. - * @returns {Boolean} Whether the tile has this property. + * @param {string} propertyId The case-sensitive ID of the property. + * @returns {boolean} Whether the tile has this property. * @private */ ImplicitMetadataView.prototype.hasProperty = function (propertyId) { @@ -96,8 +96,8 @@ ImplicitMetadataView.prototype.hasProperty = function (propertyId) { /** * Returns whether the metadata contains a property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @returns {Boolean} Whether the tile has a property with the given semantic. + * @param {string} semantic The case-sensitive semantic of the property. + * @returns {boolean} Whether the tile has a property with the given semantic. * @private */ ImplicitMetadataView.prototype.hasPropertyBySemantic = function (semantic) { @@ -107,8 +107,8 @@ ImplicitMetadataView.prototype.hasPropertyBySemantic = function (semantic) { /** * Returns an array of property IDs in the metadata table. * - * @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 */ ImplicitMetadataView.prototype.getPropertyIds = function (results) { @@ -121,7 +121,7 @@ ImplicitMetadataView.prototype.getPropertyIds = function (results) { * If the property is normalized the normalized value is returned. *

* - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @returns {*} The value of the property or undefined if the tile does not have this property. * @private */ @@ -135,9 +135,9 @@ ImplicitMetadataView.prototype.getProperty = function (propertyId) { * If the property is normalized a normalized value must be provided to this function. *

* - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ ImplicitMetadataView.prototype.setProperty = function (propertyId, value) { @@ -147,7 +147,7 @@ ImplicitMetadataView.prototype.setProperty = function (propertyId, value) { /** * Returns a copy of the value of the property with the given semantic in the metadata table. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @returns {*} The value of the property or undefined if the tile does not have this semantic. * @private */ @@ -158,9 +158,9 @@ ImplicitMetadataView.prototype.getPropertyBySemantic = function (semantic) { /** * Sets the value of the property with the given semantic in the metadata table. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ diff --git a/packages/engine/Source/Scene/ImplicitSubdivisionScheme.js b/packages/engine/Source/Scene/ImplicitSubdivisionScheme.js index a9c22c1bb027..75f5ecde7357 100644 --- a/packages/engine/Source/Scene/ImplicitSubdivisionScheme.js +++ b/packages/engine/Source/Scene/ImplicitSubdivisionScheme.js @@ -3,7 +3,7 @@ import DeveloperError from "../Core/DeveloperError.js"; /** * The subdivision scheme for an implicit tileset. * - * @enum {String} + * @enum {string} * @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. */ @@ -11,7 +11,7 @@ const ImplicitSubdivisionScheme = { /** * A quadtree divides a parent tile into four children, split at the midpoint * of the x and y dimensions of the bounding box - * @type {String} + * @type {string} * @constant * @private */ @@ -19,7 +19,7 @@ const ImplicitSubdivisionScheme = { /** * An octree divides a parent tile into eight children, split at the midpoint * of the x, y, and z dimensions of the bounding box. - * @type {String} + * @type {string} * @constant * @private */ @@ -29,7 +29,7 @@ const ImplicitSubdivisionScheme = { /** * Get the branching factor for the given subdivision scheme * @param {ImplicitSubdivisionScheme} subdivisionScheme The subdivision scheme - * @returns {Number} The branching factor, either 4 for QUADTREE or 8 for OCTREE + * @returns {number} The branching factor, either 4 for QUADTREE or 8 for OCTREE * @private */ ImplicitSubdivisionScheme.getBranchingFactor = function (subdivisionScheme) { diff --git a/packages/engine/Source/Scene/ImplicitSubtree.js b/packages/engine/Source/Scene/ImplicitSubtree.js index 9f0ec3cc8bad..62ed8148b1b7 100644 --- a/packages/engine/Source/Scene/ImplicitSubtree.js +++ b/packages/engine/Source/Scene/ImplicitSubtree.js @@ -28,7 +28,7 @@ import ResourceCache from "./ResourceCache.js"; * @constructor * * @param {Resource} resource The resource for this subtree. This is used for fetching external buffers as needed. - * @param {Object} [json] The JSON object for this subtree. Mutually exclusive with subtreeView. + * @param {object} [json] The JSON object for this subtree. Mutually exclusive with subtreeView. * @param {Uint8Array} [subtreeView] The contents of a subtree binary in a Uint8Array. Mutually exclusive with json. * @param {ImplicitTileset} implicitTileset The implicit tileset. This includes information about the size of subtrees * @param {ImplicitTileCoordinates} implicitCoordinates The coordinates of the subtree's root tile. @@ -127,7 +127,7 @@ Object.defineProperties(ImplicitSubtree.prototype, { * this property stores the JSON from the extension. This is used by {@link TileMetadata} * to get the extras and extensions for the tiles in the subtree. * - * @type {Object} + * @type {object} * @readonly * @private */ @@ -183,8 +183,8 @@ Object.defineProperties(ImplicitSubtree.prototype, { /** * Check if a specific tile is available at an index of the tile availability bitstream * - * @param {Number} index The index of the desired tile - * @returns {Boolean} The value of the i-th bit + * @param {number} index The index of the desired tile + * @returns {boolean} The value of the i-th bit * @private */ ImplicitSubtree.prototype.tileIsAvailableAtIndex = function (index) { @@ -195,7 +195,7 @@ ImplicitSubtree.prototype.tileIsAvailableAtIndex = function (index) { * Check if a specific tile is available at an implicit tile coordinate * * @param {ImplicitTileCoordinates} implicitCoordinates The global coordinates of a tile - * @returns {Boolean} The value of the i-th bit + * @returns {boolean} The value of the i-th bit * @private */ ImplicitSubtree.prototype.tileIsAvailableAtCoordinates = function ( @@ -208,9 +208,9 @@ ImplicitSubtree.prototype.tileIsAvailableAtCoordinates = function ( /** * Check if a specific tile's content is available at an index of the content availability bitstream * - * @param {Number} index The index of the desired tile - * @param {Number} [contentIndex=0] The index of the desired content when multiple contents are used. - * @returns {Boolean} The value of the i-th bit + * @param {number} index The index of the desired tile + * @param {number} [contentIndex=0] The index of the desired content when multiple contents are used. + * @returns {boolean} The value of the i-th bit * @private */ ImplicitSubtree.prototype.contentIsAvailableAtIndex = function ( @@ -234,8 +234,8 @@ ImplicitSubtree.prototype.contentIsAvailableAtIndex = function ( * Check if a specific tile's content is available at an implicit tile coordinate * * @param {ImplicitTileCoordinates} implicitCoordinates The global coordinates of a tile - * @param {Number} [contentIndex=0] The index of the desired content when the 3DTILES_multiple_contents extension is used. - * @returns {Boolean} The value of the i-th bit + * @param {number} [contentIndex=0] The index of the desired content when the 3DTILES_multiple_contents extension is used. + * @returns {boolean} The value of the i-th bit * @private */ ImplicitSubtree.prototype.contentIsAvailableAtCoordinates = function ( @@ -249,8 +249,8 @@ ImplicitSubtree.prototype.contentIsAvailableAtCoordinates = function ( /** * Check if a child subtree is available at an index of the child subtree availability bitstream * - * @param {Number} index The index of the desired child subtree - * @returns {Boolean} The value of the i-th bit + * @param {number} index The index of the desired child subtree + * @returns {boolean} The value of the i-th bit * @private */ ImplicitSubtree.prototype.childSubtreeIsAvailableAtIndex = function (index) { @@ -261,7 +261,7 @@ ImplicitSubtree.prototype.childSubtreeIsAvailableAtIndex = function (index) { * Check if a specific child subtree is available at an implicit tile coordinate * * @param {ImplicitTileCoordinates} implicitCoordinates The global coordinates of a child subtree - * @returns {Boolean} The value of the i-th bit + * @returns {boolean} The value of the i-th bit * @private */ ImplicitSubtree.prototype.childSubtreeIsAvailableAtCoordinates = function ( @@ -280,8 +280,8 @@ ImplicitSubtree.prototype.childSubtreeIsAvailableAtCoordinates = function ( *
  • Level 2 starts at index 5
    • * * - * @param {Number} level The 0-indexed level number relative to the root of the subtree - * @returns {Number} The first index at the desired level + * @param {number} level The 0-indexed level number relative to the root of the subtree + * @returns {number} The first index at the desired level * @private */ ImplicitSubtree.prototype.getLevelOffset = function (level) { @@ -294,8 +294,8 @@ ImplicitSubtree.prototype.getLevelOffset = function (level) { * chopping off the last 2 (quadtree) or 3 (octree) bits of the morton * index. * - * @param {Number} childIndex The morton index of the child tile relative to its parent - * @returns {Number} The index of the child's parent node + * @param {number} childIndex The morton index of the child tile relative to its parent + * @returns {number} The index of the child's parent node * @private */ ImplicitSubtree.prototype.getParentMortonIndex = function (mortonIndex) { @@ -313,7 +313,7 @@ ImplicitSubtree.prototype.getParentMortonIndex = function (mortonIndex) { * it resolves/rejects subtree.readyPromise. * * @param {ImplicitSubtree} subtree The subtree - * @param {Object} [json] The JSON object for this subtree. If parsing from a binary subtree file, this will be undefined. + * @param {object} [json] The JSON object for this subtree. If parsing from a binary subtree file, this will be undefined. * @param {Uint8Array} [subtreeView] The contents of the subtree binary * @param {ImplicitTileset} implicitTileset The implicit tileset this subtree belongs to. * @private @@ -433,8 +433,8 @@ function initialize(subtree, json, subtreeView, implicitTileset) { /** * A helper object for storing the two parts of the subtree binary * - * @typedef {Object} SubtreeChunks - * @property {Object} json The json chunk of the subtree + * @typedef {object} SubtreeChunks + * @property {object} json The json chunk of the subtree * @property {Uint8Array} binary The binary chunk of the subtree. This represents the internal buffer. * @private */ @@ -488,11 +488,11 @@ function parseSubtreeChunks(subtreeView) { * Buffers are assumed inactive until explicitly marked active. This is used * to avoid fetching unneeded buffers. * - * @typedef {Object} BufferHeader - * @property {Boolean} isExternal True if this is an external buffer - * @property {Boolean} isActive Whether this buffer is currently used. - * @property {String} [uri] The URI of the buffer (external buffers only) - * @property {Number} byteLength The byte length of the buffer, including any padding contained within. + * @typedef {object} BufferHeader + * @property {boolean} isExternal True if this is an external buffer + * @property {boolean} isActive Whether this buffer is currently used. + * @property {string} [uri] The URI of the buffer (external buffers only) + * @property {number} byteLength The byte length of the buffer, including any padding contained within. * @private */ @@ -520,12 +520,12 @@ function preprocessBuffers(bufferHeaders) { * A buffer header is the JSON header from the subtree JSON chunk plus * the isActive flag and a reference to the header for the underlying buffer * - * @typedef {Object} BufferViewHeader + * @typedef {object} BufferViewHeader * @property {BufferHeader} bufferHeader A reference to the header for the underlying buffer - * @property {Boolean} isActive Whether this bufferView is currently used. - * @property {Number} buffer The index of the underlying buffer. - * @property {Number} byteOffset The start byte of the bufferView within the buffer. - * @property {Number} byteLength The length of the bufferView. No padding is included in this length. + * @property {boolean} isActive Whether this bufferView is currently used. + * @property {number} buffer The index of the underlying buffer. + * @property {number} byteOffset The start byte of the bufferView within the buffer. + * @property {number} byteLength The length of the bufferView. No padding is included in this length. * @private */ @@ -619,7 +619,7 @@ function markActiveBufferViews(subtreeJson, bufferViewHeaders) { * allow filtering this to avoid downloading unneeded buffers. *

    * - * @param {Object} propertyTableJson The property table JSON for either a tile or some content + * @param {object} propertyTableJson The property table JSON for either a tile or some content * @param {BufferViewHeader[]} bufferViewHeaders The preprocessed buffer view headers * @private */ @@ -680,7 +680,7 @@ function markActiveMetadataBufferViews(propertyTableJson, bufferViewHeaders) { * @param {ImplicitSubtree} subtree The subtree * @param {BufferHeader[]} bufferHeaders The preprocessed buffer headers * @param {Uint8Array} internalBuffer The binary chunk of the subtree file - * @returns {Promise} A promise resolving to the dictionary of active buffers + * @returns {Promise} A promise resolving to the dictionary of active buffers * @private */ function requestActiveBuffers(subtree, bufferHeaders, internalBuffer) { @@ -729,8 +729,8 @@ function requestExternalBuffer(subtree, bufferHeader) { * extract a subarray from one of the active buffers. * * @param {BufferViewHeader[]} bufferViewHeaders - * @param {Object} buffersU8 A dictionary of buffer index to a Uint8Array of its contents. - * @returns {Object} A dictionary of buffer view index to a Uint8Array of its contents. + * @param {object} buffersU8 A dictionary of buffer index to a Uint8Array of its contents. + * @returns {object} A dictionary of buffer view index to a Uint8Array of its contents. * @private */ function parseActiveBufferViews(bufferViewHeaders, buffersU8) { @@ -755,9 +755,9 @@ function parseActiveBufferViews(bufferViewHeaders, buffersU8) { * Parse the three availability bitstreams and store them in the subtree * * @param {ImplicitSubtree} subtree The subtree to modify - * @param {Object} subtreeJson The subtree JSON + * @param {object} subtreeJson The subtree JSON * @param {ImplicitTileset} implicitTileset The implicit tileset this subtree belongs to - * @param {Object} bufferViewsU8 A dictionary of buffer view index to a Uint8Array of its contents. + * @param {object} bufferViewsU8 A dictionary of buffer view index to a Uint8Array of its contents. * @private */ function parseAvailability( @@ -812,10 +812,10 @@ function parseAvailability( * in-memory representation using an {@link ImplicitAvailabilityBitstream} * object. This handles both constants and bitstreams from a bufferView. * - * @param {Object} availabilityJson A JSON object representing the availability - * @param {Object} bufferViewsU8 A dictionary of bufferView index to its Uint8Array contents. - * @param {Number} lengthBits The length of the availability bitstream in bits - * @param {Boolean} [computeAvailableCountEnabled] If true and availabilityJson.availableCount is undefined, the availableCount will be computed. + * @param {object} availabilityJson A JSON object representing the availability + * @param {object} bufferViewsU8 A dictionary of bufferView index to its Uint8Array contents. + * @param {number} lengthBits The length of the availability bitstream in bits + * @param {boolean} [computeAvailableCountEnabled] If true and availabilityJson.availableCount is undefined, the availableCount will be computed. * @returns {ImplicitAvailabilityBitstream} The parsed bitstream object * @private */ @@ -857,7 +857,7 @@ function parseAvailabilityBitstream( * * @param {ImplicitSubtree} subtree The subtree * @param {ImplicitTileset} implicitTileset The implicit tileset this subtree belongs to. - * @param {Object} bufferViewsU8 A dictionary of bufferView index to its Uint8Array contents. + * @param {object} bufferViewsU8 A dictionary of bufferView index to its Uint8Array contents. * @private */ function parseTileMetadataTable(subtree, implicitTileset, bufferViewsU8) { @@ -882,7 +882,7 @@ function parseTileMetadataTable(subtree, implicitTileset, bufferViewsU8) { * * @param {ImplicitSubtree} subtree The subtree * @param {ImplicitTileset} implicitTileset The implicit tileset this subtree belongs to. - * @param {Object} bufferViewsU8 A dictionary of bufferView index to its Uint8Array contents. + * @param {object} bufferViewsU8 A dictionary of bufferView index to its Uint8Array contents. * @private */ function parseContentMetadataTables(subtree, implicitTileset, bufferViewsU8) { @@ -979,7 +979,7 @@ function makeContentJumpBuffers(subtree) { * Given the implicit tiling coordinates for a tile, get the index within the * subtree's tile availability bitstream. * @param {ImplicitTileCoordinates} implicitCoordinates The global coordinates of a tile - * @return {Number} The tile's index within the subtree. + * @return {number} The tile's index within the subtree. * @private */ ImplicitSubtree.prototype.getTileIndex = function (implicitCoordinates) { @@ -1001,7 +1001,7 @@ ImplicitSubtree.prototype.getTileIndex = function (implicitCoordinates) { * Given the implicit tiling coordinates for a child subtree, get the index within the * subtree's child subtree availability bitstream. * @param {ImplicitTileCoordinates} implicitCoordinates The global coordinates of a child subtree - * @return {Number} The child subtree's index within the subtree's child subtree availability bitstream. + * @return {number} The child subtree's index within the subtree's child subtree availability bitstream. * @private */ ImplicitSubtree.prototype.getChildSubtreeIndex = function ( @@ -1028,7 +1028,7 @@ ImplicitSubtree.prototype.getChildSubtreeIndex = function ( * Get the entity ID for a tile within this subtree. * @param {ImplicitSubtree} subtree The subtree * @param {ImplicitTileCoordinates} implicitCoordinates The global coordinates of a tile - * @return {Number} The entity ID for this tile for accessing tile metadata, or undefined if not applicable. + * @return {number} The entity ID for this tile for accessing tile metadata, or undefined if not applicable. * * @private */ @@ -1049,8 +1049,8 @@ function getTileEntityId(subtree, implicitCoordinates) { * Get the entity ID for a content within this subtree. * @param {ImplicitSubtree} subtree The subtree * @param {ImplicitTileCoordinates} implicitCoordinates The global coordinates of a content - * @param {Number} contentIndex The content index, for distinguishing between multiple contents. - * @return {Number} The entity ID for this content for accessing content metadata, or undefined if not applicable. + * @param {number} contentIndex The content index, for distinguishing between multiple contents. + * @return {number} The entity ID for this content for accessing content metadata, or undefined if not applicable. * * @private */ @@ -1100,7 +1100,7 @@ ImplicitSubtree.prototype.getTileMetadataView = function (implicitCoordinates) { /** * Create and return a metadata table view for a content within this subtree. * @param {ImplicitTileCoordinates} implicitCoordinates The global coordinates of a content - * @param {Number} contentIndex The index of the content used to distinguish between multiple contents + * @param {number} contentIndex The index of the content used to distinguish between multiple contents * @return {ImplicitMetadataView} The metadata view for this content, or undefined if not applicable. * * @private diff --git a/packages/engine/Source/Scene/ImplicitSubtreeCache.js b/packages/engine/Source/Scene/ImplicitSubtreeCache.js index b9bc554a764f..252594d37bb8 100644 --- a/packages/engine/Source/Scene/ImplicitSubtreeCache.js +++ b/packages/engine/Source/Scene/ImplicitSubtreeCache.js @@ -6,8 +6,8 @@ import DoubleEndedPriorityQueue from "../Core/DoubleEndedPriorityQueue.js"; * @alias ImplicitSubtreeCache * @constructor * - * @param {Object} [options] Object with the following properties - * @param {Number} [options.maximumSubtreeCount=0] The total number of subtrees this cache can store. If adding a new subtree would exceed this limit, the lowest priority subtrees will be removed until there is room, unless the subtree that is going to be removed is the parent of the new subtree, in which case it will not be removed and the new subtree will still be added, exceeding the memory limit. + * @param {object} [options] Object with the following properties + * @param {number} [options.maximumSubtreeCount=0] The total number of subtrees this cache can store. If adding a new subtree would exceed this limit, the lowest priority subtrees will be removed until there is room, unless the subtree that is going to be removed is the parent of the new subtree, in which case it will not be removed and the new subtree will still be added, exceeding the memory limit. * * @private */ @@ -15,14 +15,14 @@ function ImplicitSubtreeCache(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); /** - * @type {Number} + * @type {number} * @private */ this._maximumSubtreeCount = defaultValue(options.maximumSubtreeCount, 0); /** * A counter that goes up whenever a subtree is added. Used to sort subtrees by recency. - * @type {Number} + * @type {number} * @private */ this._subtreeRequestCounter = 0; @@ -96,7 +96,7 @@ ImplicitSubtreeCache.prototype.find = function (subtreeCoord) { /** * @param {ImplicitSubtreeCacheNode} a * @param {ImplicitSubtreeCacheNode} b - * @returns {Number} + * @returns {number} */ ImplicitSubtreeCache.comparator = function (a, b) { const aCoord = a.subtree.implicitCoordinates; @@ -115,7 +115,7 @@ ImplicitSubtreeCache.comparator = function (a, b) { * @constructor * * @param {ImplicitSubtree} subtree - * @param {Number} stamp + * @param {number} stamp * * @private */ diff --git a/packages/engine/Source/Scene/ImplicitSubtreeMetadata.js b/packages/engine/Source/Scene/ImplicitSubtreeMetadata.js index d4d05c205533..7814babf3cbc 100644 --- a/packages/engine/Source/Scene/ImplicitSubtreeMetadata.js +++ b/packages/engine/Source/Scene/ImplicitSubtreeMetadata.js @@ -9,8 +9,8 @@ import MetadataEntity from "./MetadataEntity.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles *

    * - * @param {Object} options Object with the following properties: - * @param {Object} options.subtreeMetadata The subtree metadata JSON object. + * @param {object} options Object with the following properties: + * @param {object} options.subtreeMetadata The subtree metadata JSON object. * @param {MetadataClass} options.class The class that subtree metadata conforms to. * * @alias ImplicitSubtreeMetadata @@ -57,7 +57,7 @@ Object.defineProperties(ImplicitSubtreeMetadata.prototype, { * Extra user-defined properties. * * @memberof ImplicitSubtreeMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -71,7 +71,7 @@ Object.defineProperties(ImplicitSubtreeMetadata.prototype, { * An object containing extensions. * * @memberof ImplicitSubtreeMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -85,8 +85,8 @@ Object.defineProperties(ImplicitSubtreeMetadata.prototype, { /** * Returns whether the subtree has this property. * - * @param {String} propertyId The case-sensitive ID of the property. - * @returns {Boolean} Whether the subtree has this property. + * @param {string} propertyId The case-sensitive ID of the property. + * @returns {boolean} Whether the subtree has this property. * @private */ ImplicitSubtreeMetadata.prototype.hasProperty = function (propertyId) { @@ -96,8 +96,8 @@ ImplicitSubtreeMetadata.prototype.hasProperty = function (propertyId) { /** * Returns whether the subtree has a property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @returns {Boolean} Whether the subtree has a property with the given semantic. + * @param {string} semantic The case-sensitive semantic of the property. + * @returns {boolean} Whether the subtree has a property with the given semantic. * @private */ ImplicitSubtreeMetadata.prototype.hasPropertyBySemantic = function (semantic) { @@ -111,8 +111,8 @@ ImplicitSubtreeMetadata.prototype.hasPropertyBySemantic = function (semantic) { /** * 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 */ ImplicitSubtreeMetadata.prototype.getPropertyIds = function (results) { @@ -125,7 +125,7 @@ ImplicitSubtreeMetadata.prototype.getPropertyIds = function (results) { * If the property is normalized the normalized value is returned. *

    * - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @returns {*} The value of the property or undefined if the subtree does not have this property. * @private */ @@ -139,9 +139,9 @@ ImplicitSubtreeMetadata.prototype.getProperty = function (propertyId) { * If the property is normalized a normalized value must be provided to this function. *

    * - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ ImplicitSubtreeMetadata.prototype.setProperty = function (propertyId, value) { @@ -156,7 +156,7 @@ ImplicitSubtreeMetadata.prototype.setProperty = function (propertyId, value) { /** * Returns a copy of the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @returns {*} The value of the property or undefined if the subtree does not have this semantic. * @private */ @@ -171,9 +171,9 @@ ImplicitSubtreeMetadata.prototype.getPropertyBySemantic = function (semantic) { /** * Sets the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ ImplicitSubtreeMetadata.prototype.setPropertyBySemantic = function ( diff --git a/packages/engine/Source/Scene/ImplicitTileCoordinates.js b/packages/engine/Source/Scene/ImplicitTileCoordinates.js index 7ad18c68999c..efcc652fe3d4 100644 --- a/packages/engine/Source/Scene/ImplicitTileCoordinates.js +++ b/packages/engine/Source/Scene/ImplicitTileCoordinates.js @@ -38,13 +38,13 @@ import ImplicitSubdivisionScheme from "./ImplicitSubdivisionScheme.js"; * @alias ImplicitTileCoordinates * @constructor * - * @param {Object} options An object with the following properties: + * @param {object} options An object with the following properties: * @param {ImplicitSubdivisionScheme} options.subdivisionScheme Whether the coordinates are for a quadtree or octree - * @param {Number} options.subtreeLevels The number of distinct levels within the coordinate's subtree - * @param {Number} options.level The level of a tile relative to the tile with the extension - * @param {Number} options.x The x coordinate of the tile - * @param {Number} options.y The y coordinate of the tile - * @param {Number} [options.z] The z coordinate of the tile. Only required when options.subdivisionScheme is ImplicitSubdivisionScheme.OCTREE + * @param {number} options.subtreeLevels The number of distinct levels within the coordinate's subtree + * @param {number} options.level The level of a tile relative to the tile with the extension + * @param {number} options.x The x coordinate of the tile + * @param {number} options.y The y coordinate of the tile + * @param {number} [options.z] The z coordinate of the tile. Only required when options.subdivisionScheme is ImplicitSubdivisionScheme.OCTREE * @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. */ @@ -101,7 +101,7 @@ function ImplicitTileCoordinates(options) { /** * The number of distinct levels within the coordinate's subtree * - * @type {Number} + * @type {number} * @readonly * @private */ @@ -112,7 +112,7 @@ function ImplicitTileCoordinates(options) { * (3D Tiles 1.1) or the 3DTILES_implicit_tiling extension. * Level numbers start at 0. * - * @type {Number} + * @type {number} * @readonly * @private */ @@ -121,7 +121,7 @@ function ImplicitTileCoordinates(options) { /** * X coordinate of this tile * - * @type {Number} + * @type {number} * @readonly * @private */ @@ -130,7 +130,7 @@ function ImplicitTileCoordinates(options) { /** * Y coordinate of this tile * - * @type {Number} + * @type {number} * @readonly * @private */ @@ -139,7 +139,7 @@ function ImplicitTileCoordinates(options) { /** * Z coordinate of this tile. Only defined for octrees. * - * @type {Number|undefined} + * @type {number|undefined} * @readonly * @private */ @@ -159,7 +159,7 @@ Object.defineProperties(ImplicitTileCoordinates.prototype, { * be computed more directly by concatenating the bits [z0] y0 x0 *

    * - * @type {Number} + * @type {number} * @readonly * @private */ @@ -180,7 +180,7 @@ Object.defineProperties(ImplicitTileCoordinates.prototype, { * Get the Morton index for this tile within the current level by interleaving * the bits of the x, y and z coordinates. * - * @type {Number} + * @type {number} * @readonly * @private */ @@ -196,7 +196,7 @@ Object.defineProperties(ImplicitTileCoordinates.prototype, { /** * Get the tile index by adding the Morton index to the level offset * - * @type {Number} + * @type {number} * @readonly * @private */ @@ -276,7 +276,7 @@ ImplicitTileCoordinates.prototype.getDescendantCoordinates = function ( /** * Compute the coordinates of a tile higher up in the tree by going up a number of levels. * - * @param {Number} offsetLevels The number of levels to go up in the tree + * @param {number} offsetLevels The number of levels to go up in the tree * @returns {ImplicitTileCoordinates} The coordinates of the ancestor * @private */ @@ -374,7 +374,7 @@ ImplicitTileCoordinates.prototype.getOffsetCoordinates = function ( * Given the morton index of the child, compute the coordinates of the child. * This is a special case of {@link ImplicitTileCoordinates#getDescendantCoordinates}. * - * @param {Number} childIndex The morton index of the child tile relative to its parent + * @param {number} childIndex The morton index of the child tile relative to its parent * @returns {ImplicitTileCoordinates} The tile coordinates of the child * @private */ @@ -444,7 +444,7 @@ ImplicitTileCoordinates.prototype.getParentSubtreeCoordinates = function () { * Returns whether this tile is an ancestor of another tile * * @param {ImplicitTileCoordinates} descendantCoordinates the descendant coordinates - * @returns {Boolean} true if this tile is an ancestor of the other tile + * @returns {boolean} true if this tile is an ancestor of the other tile * @private */ ImplicitTileCoordinates.prototype.isAncestor = function ( @@ -479,7 +479,7 @@ ImplicitTileCoordinates.prototype.isAncestor = function ( * Returns whether the provided coordinates are equal to this coordinate * * @param {ImplicitTileCoordinates} otherCoordinates the other coordinates - * @returns {Boolean} true if the coordinates are equal + * @returns {boolean} true if the coordinates are equal * @private */ ImplicitTileCoordinates.prototype.isEqual = function (otherCoordinates) { @@ -502,7 +502,7 @@ ImplicitTileCoordinates.prototype.isEqual = function (otherCoordinates) { /** * Returns whether this tile is the root of the implicit tileset * - * @returns {Boolean} true if this tile is the root + * @returns {boolean} true if this tile is the root * @private */ ImplicitTileCoordinates.prototype.isImplicitTilesetRoot = function () { @@ -512,7 +512,7 @@ ImplicitTileCoordinates.prototype.isImplicitTilesetRoot = function () { /** * Returns whether this tile is the root of the subtree * - * @returns {Boolean} true if this tile is the root of the subtree + * @returns {boolean} true if this tile is the root of the subtree * @private */ ImplicitTileCoordinates.prototype.isSubtreeRoot = function () { @@ -522,7 +522,7 @@ ImplicitTileCoordinates.prototype.isSubtreeRoot = function () { /** * Returns whether this tile is on the last row of tiles in the subtree * - * @returns {Boolean} true if this tile is on the last row of tiles in the subtree + * @returns {boolean} true if this tile is on the last row of tiles in the subtree * @private */ ImplicitTileCoordinates.prototype.isBottomOfSubtree = function () { @@ -532,7 +532,7 @@ ImplicitTileCoordinates.prototype.isBottomOfSubtree = function () { /** * Get a dictionary of values for templating into an implicit template URI. * - * @returns {Object} An object suitable for use with {@link Resource#getDerivedResource} + * @returns {object} An object suitable for use with {@link Resource#getDerivedResource} * @private */ ImplicitTileCoordinates.prototype.getTemplateValues = function () { @@ -555,9 +555,9 @@ const scratchCoordinatesArray = [0, 0, 0]; * octree/quadtree, compute the (level, x, y, [z]) coordinates * * @param {ImplicitSubdivisionScheme} subdivisionScheme Whether the coordinates are for a quadtree or octree - * @param {Number} subtreeLevels The number of distinct levels within the coordinate's subtree - * @param {Number} level The level of the tree - * @param {Number} mortonIndex The morton index of the tile. + * @param {number} subtreeLevels The number of distinct levels within the coordinate's subtree + * @param {number} level The level of the tree + * @param {number} mortonIndex The morton index of the tile. * @returns {ImplicitTileCoordinates} The coordinates of the tile with the given Morton index * @private */ @@ -598,8 +598,8 @@ ImplicitTileCoordinates.fromMortonIndex = function ( * the (level, x, y, [z]) coordinates * * @param {ImplicitSubdivisionScheme} subdivisionScheme Whether the coordinates are for a quadtree or octree - * @param {Number} subtreeLevels The number of distinct levels within the coordinate's subtree - * @param {Number} tileIndex The tile's index + * @param {number} subtreeLevels The number of distinct levels within the coordinate's subtree + * @param {number} tileIndex The tile's index * @returns {ImplicitTileCoordinates} The coordinates of the tile with the given tile index * @private */ diff --git a/packages/engine/Source/Scene/ImplicitTileset.js b/packages/engine/Source/Scene/ImplicitTileset.js index 45473db61de2..7b114d6dcef0 100644 --- a/packages/engine/Source/Scene/ImplicitTileset.js +++ b/packages/engine/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) { *
  • tile.extensions["3DTILES_multiple_contents"], if used instead of tile.contents or tile.content
    • * * - * @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 */ diff --git a/packages/engine/Source/Scene/InstanceAttributeSemantic.js b/packages/engine/Source/Scene/InstanceAttributeSemantic.js index d9e17b99e9d2..09b4348ae52b 100644 --- a/packages/engine/Source/Scene/InstanceAttributeSemantic.js +++ b/packages/engine/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", diff --git a/packages/engine/Source/Scene/IonImageryProvider.js b/packages/engine/Source/Scene/IonImageryProvider.js index 99ee11783ec5..16d4a83a91f6 100644 --- a/packages/engine/Source/Scene/IonImageryProvider.js +++ b/packages/engine/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.} + * @type {Promise} * @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} getTileCredits 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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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} requestImage 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.|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|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. diff --git a/packages/engine/Source/Scene/IonWorldImageryStyle.js b/packages/engine/Source/Scene/IonWorldImageryStyle.js index 68e4fc220af9..a1a320492c6e 100644 --- a/packages/engine/Source/Scene/IonWorldImageryStyle.js +++ b/packages/engine/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, diff --git a/packages/engine/Source/Scene/JsonMetadataTable.js b/packages/engine/Source/Scene/JsonMetadataTable.js index 2d43ecd740fb..ff6d963f9886 100644 --- a/packages/engine/Source/Scene/JsonMetadataTable.js +++ b/packages/engine/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.} 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} 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 undefined 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 diff --git a/packages/engine/Source/Scene/KeyframeNode.js b/packages/engine/Source/Scene/KeyframeNode.js index 2ce896905259..56d3f8a69d3d 100644 --- a/packages/engine/Source/Scene/KeyframeNode.js +++ b/packages/engine/Source/Scene/KeyframeNode.js @@ -12,7 +12,7 @@ const LoadState = Object.freeze({ * @constructor * * @param {SpatialNode} spatialNode - * @param {Number} keyframe + * @param {number} keyframe * * @private */ diff --git a/packages/engine/Source/Scene/Label.js b/packages/engine/Source/Scene/Label.js index ac8944de69ae..22fe35012797 100644 --- a/packages/engine/Source/Scene/Label.js +++ b/packages/engine/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 2.0. * * @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} true if the labels are equal; otherwise, false. + * @returns {boolean} true if the labels are equal; otherwise, false. */ 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 * isDestroyed 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) { diff --git a/packages/engine/Source/Scene/LabelCollection.js b/packages/engine/Source/Scene/LabelCollection.js index 20940366cf5f..87cdc39ae447 100644 --- a/packages/engine/Source/Scene/LabelCollection.js +++ b/packages/engine/Source/Scene/LabelCollection.js @@ -557,14 +557,14 @@ function destroyLabel(labelCollection, label) { * @alias LabelCollection * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms each label from model to world coordinates. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. * @param {Scene} [options.scene] Must be passed in for labels that use the height reference property or will be depth tested against the globe. * @param {BlendOption} [options.blendOption=BlendOption.OPAQUE_AND_TRANSLUCENT] The label blending option. The default * is used for rendering both opaque and translucent labels. However, if either all of the labels are completely opaque or all are completely translucent, * setting the technique to BlendOption.OPAQUE or BlendOption.TRANSLUCENT can improve performance by up to 2x. - * @param {Boolean} [options.show=true] Determines if the labels in the collection will be shown. + * @param {boolean} [options.show=true] Determines if the labels in the collection will be shown. * * @performance For best performance, prefer a few collections, each with many labels, to * many collections with only a few labels each. Avoid having collections where some @@ -622,7 +622,7 @@ function LabelCollection(options) { /** * Determines if labels in this collection will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -666,7 +666,7 @@ function LabelCollection(options) { * Draws the bounding sphere for each draw command in the primitive. *

    * - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -695,7 +695,7 @@ Object.defineProperties(LabelCollection.prototype, { * {@link LabelCollection#get} to iterate over all the labels * in the collection. * @memberof LabelCollection.prototype - * @type {Number} + * @type {number} */ length: { get: function () { @@ -708,7 +708,7 @@ Object.defineProperties(LabelCollection.prototype, { * Creates and adds a label with the specified initial properties to the collection. * The added label is returned so it can be modified or removed from the collection later. * - * @param {Object} [options] A template describing the label's properties as shown in Example 1. + * @param {object} [options] A template describing the label's properties as shown in Example 1. * @returns {Label} The label that was added to the collection. * * @performance Calling add is expected constant time. However, the collection's vertex buffer @@ -769,7 +769,7 @@ LabelCollection.prototype.add = function (options) { * Removes a label from the collection. Once removed, a label is no longer usable. * * @param {Label} label The label to remove. - * @returns {Boolean} true if the label was removed; false if the label was not found in the collection. + * @returns {boolean} true if the label was removed; false if the label was not found in the collection. * * @performance Calling remove is expected constant time. However, the collection's vertex buffer * is rewritten - an O(n) operation that also incurs CPU to GPU overhead. For @@ -831,7 +831,7 @@ LabelCollection.prototype.removeAll = function () { * Check whether this collection contains a given label. * * @param {Label} label The label to check for. - * @returns {Boolean} true if this collection contains the label, false otherwise. + * @returns {boolean} true if this collection contains the label, false otherwise. * * @see LabelCollection#get * @@ -847,7 +847,7 @@ LabelCollection.prototype.contains = function (label) { * {@link LabelCollection#length} to iterate over all the labels * in the collection. * - * @param {Number} index The zero-based index of the billboard. + * @param {number} index The zero-based index of the billboard. * * @returns {Label} The label at the specified index. * @@ -957,7 +957,7 @@ LabelCollection.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see LabelCollection#destroy */ diff --git a/packages/engine/Source/Scene/LabelStyle.js b/packages/engine/Source/Scene/LabelStyle.js index bfae4664a02a..2b318cd730ba 100644 --- a/packages/engine/Source/Scene/LabelStyle.js +++ b/packages/engine/Source/Scene/LabelStyle.js @@ -1,7 +1,7 @@ /** * Describes how to draw a label. * - * @enum {Number} + * @enum {number} * * @see Label#style */ @@ -9,7 +9,7 @@ const LabelStyle = { /** * Fill the text of the label, but do not outline. * - * @type {Number} + * @type {number} * @constant */ FILL: 0, @@ -17,7 +17,7 @@ const LabelStyle = { /** * Outline the text of the label, but do not fill. * - * @type {Number} + * @type {number} * @constant */ OUTLINE: 1, @@ -25,7 +25,7 @@ const LabelStyle = { /** * Fill and outline the text of the label. * - * @type {Number} + * @type {number} * @constant */ FILL_AND_OUTLINE: 2, diff --git a/packages/engine/Source/Scene/Light.js b/packages/engine/Source/Scene/Light.js index 55da007fcfb3..1fd3ac0616da 100644 --- a/packages/engine/Source/Scene/Light.js +++ b/packages/engine/Source/Scene/Light.js @@ -24,7 +24,7 @@ Object.defineProperties(Light.prototype, { /** * The intensity controls the strength of the light. intensity has a minimum value of 0.0 and no maximum value. * @memberof Light.prototype - * @type {Number} + * @type {number} */ intensity: { get: DeveloperError.throwInstantiationError, diff --git a/packages/engine/Source/Scene/MapMode2D.js b/packages/engine/Source/Scene/MapMode2D.js index 3a050da5bea3..34830f23b835 100644 --- a/packages/engine/Source/Scene/MapMode2D.js +++ b/packages/engine/Source/Scene/MapMode2D.js @@ -1,13 +1,13 @@ /** * Describes how the map will operate in 2D. * - * @enum {Number} + * @enum {number} */ const MapMode2D = { /** * The 2D map can be rotated about the z axis. * - * @type {Number} + * @type {number} * @constant */ ROTATE: 0, @@ -15,7 +15,7 @@ const MapMode2D = { /** * The 2D map can be scrolled infinitely in the horizontal direction. * - * @type {Number} + * @type {number} * @constant */ INFINITE_SCROLL: 1, diff --git a/packages/engine/Source/Scene/MapboxImageryProvider.js b/packages/engine/Source/Scene/MapboxImageryProvider.js index baff4ff617fa..0768b54ac8d2 100644 --- a/packages/engine/Source/Scene/MapboxImageryProvider.js +++ b/packages/engine/Source/Scene/MapboxImageryProvider.js @@ -11,21 +11,21 @@ const defaultCredit = new Credit( ); /** - * @typedef {Object} MapboxImageryProvider.ConstructorOptions + * @typedef {object} MapboxImageryProvider.ConstructorOptions * * Initialization options for the MapboxImageryProvider constructor * - * @property {String} [url='https://api.mapbox.com/v4/'] The Mapbox server url. - * @property {String} mapId The Mapbox Map ID. - * @property {String} accessToken The public access token for the imagery. - * @property {String} [format='png'] The format of the image request. + * @property {string} [url='https://api.mapbox.com/v4/'] The Mapbox server url. + * @property {string} mapId The Mapbox Map ID. + * @property {string} accessToken The public access token for the imagery. + * @property {string} [format='png'] The format of the image request. * @property {Ellipsoid} [ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used. - * @property {Number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying + * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying * this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely * to result in rendering problems. - * @property {Number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. + * @property {number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image. - * @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. */ /** @@ -66,7 +66,7 @@ function MapboxImageryProvider(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; @@ -75,7 +75,7 @@ function MapboxImageryProvider(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; @@ -84,7 +84,7 @@ function MapboxImageryProvider(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; @@ -93,7 +93,7 @@ function MapboxImageryProvider(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; @@ -102,7 +102,7 @@ function MapboxImageryProvider(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; @@ -110,7 +110,7 @@ function MapboxImageryProvider(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; @@ -119,7 +119,7 @@ function MapboxImageryProvider(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; @@ -127,7 +127,7 @@ function MapboxImageryProvider(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; @@ -197,7 +197,7 @@ Object.defineProperties(MapboxImageryProvider.prototype, { /** * Gets the URL of the Mapbox server. * @memberof MapboxImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -209,7 +209,7 @@ Object.defineProperties(MapboxImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof MapboxImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -221,7 +221,7 @@ Object.defineProperties(MapboxImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof MapboxImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -247,7 +247,7 @@ Object.defineProperties(MapboxImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link MapboxImageryProvider#ready} returns true. * @memberof MapboxImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -260,7 +260,7 @@ Object.defineProperties(MapboxImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link MapboxImageryProvider#ready} returns true. * @memberof MapboxImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -273,7 +273,7 @@ Object.defineProperties(MapboxImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link MapboxImageryProvider#ready} returns true. * @memberof MapboxImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -290,7 +290,7 @@ Object.defineProperties(MapboxImageryProvider.prototype, { * provider with more than a few tiles at the minimum level will lead to * rendering problems. * @memberof MapboxImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -374,7 +374,7 @@ Object.defineProperties(MapboxImageryProvider.prototype, { * as if their alpha is 1.0 everywhere. When this property is false, memory usage * and texture upload time are reduced. * @memberof MapboxImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -387,9 +387,9 @@ Object.defineProperties(MapboxImageryProvider.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} getTileCredits must not be called before the imagery provider is ready. @@ -402,11 +402,11 @@ MapboxImageryProvider.prototype.getTileCredits = function (x, y, level) { * Requests the image for a given tile. This function should * not be called before {@link MapboxImageryProvider#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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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} requestImage must not be called before the imagery provider is ready. @@ -421,12 +421,12 @@ MapboxImageryProvider.prototype.requestImage = function (x, y, level, request) { * This function is optional, so it may not exist on all ImageryProviders. * * - * @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.|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|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. diff --git a/packages/engine/Source/Scene/MapboxStyleImageryProvider.js b/packages/engine/Source/Scene/MapboxStyleImageryProvider.js index 1382fdced6a1..5ebdbf79c276 100644 --- a/packages/engine/Source/Scene/MapboxStyleImageryProvider.js +++ b/packages/engine/Source/Scene/MapboxStyleImageryProvider.js @@ -11,23 +11,23 @@ const defaultCredit = new Credit( ); /** - * @typedef {Object} MapboxStyleImageryProvider.ConstructorOptions + * @typedef {object} MapboxStyleImageryProvider.ConstructorOptions * * Initialization options for the MapboxStyleImageryProvider constructor * - * @property {Resource|String} [url='https://api.mapbox.com/styles/v1/'] The Mapbox server url. - * @property {String} [username='mapbox'] The username of the map account. - * @property {String} styleId The Mapbox Style ID. - * @property {String} accessToken The public access token for the imagery. - * @property {Number} [tilesize=512] The size of the image tiles. - * @property {Boolean} [scaleFactor] Determines if tiles are rendered at a @2x scale factor. + * @property {Resource|string} [url='https://api.mapbox.com/styles/v1/'] The Mapbox server url. + * @property {string} [username='mapbox'] The username of the map account. + * @property {string} styleId The Mapbox Style ID. + * @property {string} accessToken The public access token for the imagery. + * @property {number} [tilesize=512] The size of the image tiles. + * @property {boolean} [scaleFactor] Determines if tiles are rendered at a @2x scale factor. * @property {Ellipsoid} [ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used. - * @property {Number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying + * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying * this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely * to result in rendering problems. - * @property {Number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. + * @property {number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image. - * @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. */ /** @@ -68,7 +68,7 @@ function MapboxStyleImageryProvider(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 MapboxStyleImageryProvider(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 MapboxStyleImageryProvider(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 MapboxStyleImageryProvider(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 MapboxStyleImageryProvider(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 MapboxStyleImageryProvider(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 MapboxStyleImageryProvider(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 MapboxStyleImageryProvider(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; @@ -201,7 +201,7 @@ Object.defineProperties(MapboxStyleImageryProvider.prototype, { /** * Gets the URL of the Mapbox server. * @memberof MapboxStyleImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -213,7 +213,7 @@ Object.defineProperties(MapboxStyleImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof MapboxStyleImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -225,7 +225,7 @@ Object.defineProperties(MapboxStyleImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof MapboxStyleImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -251,7 +251,7 @@ Object.defineProperties(MapboxStyleImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link MapboxStyleImageryProvider#ready} returns true. * @memberof MapboxStyleImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -264,7 +264,7 @@ Object.defineProperties(MapboxStyleImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link MapboxStyleImageryProvider#ready} returns true. * @memberof MapboxStyleImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -277,7 +277,7 @@ Object.defineProperties(MapboxStyleImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link MapboxStyleImageryProvider#ready} returns true. * @memberof MapboxStyleImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -294,7 +294,7 @@ Object.defineProperties(MapboxStyleImageryProvider.prototype, { * provider with more than a few tiles at the minimum level will lead to * rendering problems. * @memberof MapboxStyleImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -378,7 +378,7 @@ Object.defineProperties(MapboxStyleImageryProvider.prototype, { * as if their alpha is 1.0 everywhere. When this property is false, memory usage * and texture upload time are reduced. * @memberof MapboxStyleImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -391,9 +391,9 @@ Object.defineProperties(MapboxStyleImageryProvider.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} getTileCredits must not be called before the imagery provider is ready. @@ -406,11 +406,11 @@ MapboxStyleImageryProvider.prototype.getTileCredits = function (x, y, level) { * Requests the image for a given tile. This function should * not be called before {@link MapboxStyleImageryProvider#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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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} requestImage must not be called before the imagery provider is ready. @@ -430,12 +430,12 @@ MapboxStyleImageryProvider.prototype.requestImage = function ( * This function is optional, so it may not exist on all ImageryProviders. * * - * @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.|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|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. diff --git a/packages/engine/Source/Scene/Material.js b/packages/engine/Source/Scene/Material.js index a2380e9481e6..53d4155dcc2d 100644 --- a/packages/engine/Source/Scene/Material.js +++ b/packages/engine/Source/Scene/Material.js @@ -224,16 +224,16 @@ import WaterMaterial from "../Shaders/Materials/Water.js"; * * * @alias Material + * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.strict=false] Throws errors for issues that would normally be ignored, including unused uniforms or materials. - * @param {Boolean|Function} [options.translucent=true] When true or a function that returns true, the geometry + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.strict=false] Throws errors for issues that would normally be ignored, including unused uniforms or materials. + * @param {boolean|Function} [options.translucent=true] When true or a function that returns true, the geometry * with this material is expected to appear translucent. * @param {TextureMinificationFilter} [options.minificationFilter=TextureMinificationFilter.LINEAR] The {@link TextureMinificationFilter} to apply to this material's textures. * @param {TextureMagnificationFilter} [options.magnificationFilter=TextureMagnificationFilter.LINEAR] The {@link TextureMagnificationFilter} to apply to this material's textures. - * @param {Object} options.fabric The fabric JSON used to generate the material. - * - * @constructor + * @param {object} options.fabric The fabric JSON used to generate the material. + *ructor * * @exception {DeveloperError} fabric: uniform has invalid type. * @exception {DeveloperError} fabric: uniforms and materials cannot share the same property. @@ -258,39 +258,39 @@ import WaterMaterial from "../Shaders/Materials/Water.js"; * * // Create a color material with full Fabric notation: * polygon.material = new Cesium.Material({ - * fabric : { - * type : 'Color', - * uniforms : { - * color : new Cesium.Color(1.0, 1.0, 0.0, 1.0) - * } + * fabric: { + * type: 'Color', + * uniforms: { + * color: new Cesium.Color(1.0, 1.0, 0.0, 1.0) * } + * } * }); */ function Material(options) { /** * The material type. Can be an existing type or a new type. If no type is specified in fabric, type is a GUID. - * @type {String} + * @type {string} * @default undefined */ this.type = undefined; /** * The glsl shader source for this material. - * @type {String} + * @type {string} * @default undefined */ this.shaderSource = undefined; /** * Maps sub-material names to Material objects. - * @type {Object} + * @type {object} * @default undefined */ this.materials = undefined; /** * Maps uniform names to their values. - * @type {Object} + * @type {object} * @default undefined */ this.uniforms = undefined; @@ -299,7 +299,7 @@ function Material(options) { /** * When true or a function that returns true, * the geometry is expected to appear translucent. - * @type {Boolean|Function} + * @type {boolean|Function} * @default undefined */ this.translucent = undefined; @@ -349,15 +349,15 @@ Material._uniformList = {}; *

    * Shorthand for: new Material({fabric : {type : type}}); * - * @param {String} type The base material type. - * @param {Object} [uniforms] Overrides for the default uniforms. + * @param {string} type The base material type. + * @param {object} [uniforms] Overrides for the default uniforms. * @returns {Material} New material object. * * @exception {DeveloperError} material with that type does not exist. * * @example * const material = Cesium.Material.fromType('Color', { - * color : new Cesium.Color(1.0, 0.0, 0.0, 1.0) + * color: new Cesium.Color(1.0, 0.0, 0.0, 1.0) * }); */ Material.fromType = function (type, uniforms) { @@ -386,7 +386,7 @@ Material.fromType = function (type, uniforms) { /** * Gets whether or not this material is translucent. - * @returns {Boolean} true if this material is translucent, false otherwise. + * @returns {boolean} true if this material is translucent, false otherwise. */ Material.prototype.isTranslucent = function () { if (defined(this.translucent)) { @@ -537,7 +537,7 @@ Material.prototype.update = function (context) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see Material#destroy */ @@ -1216,19 +1216,19 @@ Material._materialCache = { /** * Gets or sets the default texture uniform value. - * @type {String} + * @type {string} */ Material.DefaultImageId = "czm_defaultImage"; /** * Gets or sets the default cube map texture uniform value. - * @type {String} + * @type {string} */ Material.DefaultCubeMapId = "czm_defaultCubeMap"; /** * Gets the name of the color material. - * @type {String} + * @type {string} * @readonly */ Material.ColorType = "Color"; @@ -1250,7 +1250,7 @@ Material._materialCache.addMaterial(Material.ColorType, { /** * Gets the name of the image material. - * @type {String} + * @type {string} * @readonly */ Material.ImageType = "Image"; @@ -1275,7 +1275,7 @@ Material._materialCache.addMaterial(Material.ImageType, { /** * Gets the name of the diffuce map material. - * @type {String} + * @type {string} * @readonly */ Material.DiffuseMapType = "DiffuseMap"; @@ -1296,7 +1296,7 @@ Material._materialCache.addMaterial(Material.DiffuseMapType, { /** * Gets the name of the alpha map material. - * @type {String} + * @type {string} * @readonly */ Material.AlphaMapType = "AlphaMap"; @@ -1317,7 +1317,7 @@ Material._materialCache.addMaterial(Material.AlphaMapType, { /** * Gets the name of the specular map material. - * @type {String} + * @type {string} * @readonly */ Material.SpecularMapType = "SpecularMap"; @@ -1338,7 +1338,7 @@ Material._materialCache.addMaterial(Material.SpecularMapType, { /** * Gets the name of the emmision map material. - * @type {String} + * @type {string} * @readonly */ Material.EmissionMapType = "EmissionMap"; @@ -1359,7 +1359,7 @@ Material._materialCache.addMaterial(Material.EmissionMapType, { /** * Gets the name of the bump map material. - * @type {String} + * @type {string} * @readonly */ Material.BumpMapType = "BumpMap"; @@ -1379,7 +1379,7 @@ Material._materialCache.addMaterial(Material.BumpMapType, { /** * Gets the name of the normal map material. - * @type {String} + * @type {string} * @readonly */ Material.NormalMapType = "NormalMap"; @@ -1399,7 +1399,7 @@ Material._materialCache.addMaterial(Material.NormalMapType, { /** * Gets the name of the grid material. - * @type {String} + * @type {string} * @readonly */ Material.GridType = "Grid"; @@ -1423,7 +1423,7 @@ Material._materialCache.addMaterial(Material.GridType, { /** * Gets the name of the stripe material. - * @type {String} + * @type {string} * @readonly */ Material.StripeType = "Stripe"; @@ -1447,7 +1447,7 @@ Material._materialCache.addMaterial(Material.StripeType, { /** * Gets the name of the checkerboard material. - * @type {String} + * @type {string} * @readonly */ Material.CheckerboardType = "Checkerboard"; @@ -1469,7 +1469,7 @@ Material._materialCache.addMaterial(Material.CheckerboardType, { /** * Gets the name of the dot material. - * @type {String} + * @type {string} * @readonly */ Material.DotType = "Dot"; @@ -1491,7 +1491,7 @@ Material._materialCache.addMaterial(Material.DotType, { /** * Gets the name of the water material. - * @type {String} + * @type {string} * @readonly */ Material.WaterType = "Water"; @@ -1521,7 +1521,7 @@ Material._materialCache.addMaterial(Material.WaterType, { /** * Gets the name of the rim lighting material. - * @type {String} + * @type {string} * @readonly */ Material.RimLightingType = "RimLighting"; @@ -1543,7 +1543,7 @@ Material._materialCache.addMaterial(Material.RimLightingType, { /** * Gets the name of the fade material. - * @type {String} + * @type {string} * @readonly */ Material.FadeType = "Fade"; @@ -1573,7 +1573,7 @@ Material._materialCache.addMaterial(Material.FadeType, { /** * Gets the name of the polyline arrow material. - * @type {String} + * @type {string} * @readonly */ Material.PolylineArrowType = "PolylineArrow"; @@ -1590,7 +1590,7 @@ Material._materialCache.addMaterial(Material.PolylineArrowType, { /** * Gets the name of the polyline glow material. - * @type {String} + * @type {string} * @readonly */ Material.PolylineDashType = "PolylineDash"; @@ -1610,7 +1610,7 @@ Material._materialCache.addMaterial(Material.PolylineDashType, { /** * Gets the name of the polyline glow material. - * @type {String} + * @type {string} * @readonly */ Material.PolylineGlowType = "PolylineGlow"; @@ -1629,7 +1629,7 @@ Material._materialCache.addMaterial(Material.PolylineGlowType, { /** * Gets the name of the polyline outline material. - * @type {String} + * @type {string} * @readonly */ Material.PolylineOutlineType = "PolylineOutline"; @@ -1651,7 +1651,7 @@ Material._materialCache.addMaterial(Material.PolylineOutlineType, { /** * Gets the name of the elevation contour material. - * @type {String} + * @type {string} * @readonly */ Material.ElevationContourType = "ElevationContour"; @@ -1670,7 +1670,7 @@ Material._materialCache.addMaterial(Material.ElevationContourType, { /** * Gets the name of the elevation contour material. - * @type {String} + * @type {string} * @readonly */ Material.ElevationRampType = "ElevationRamp"; @@ -1689,7 +1689,7 @@ Material._materialCache.addMaterial(Material.ElevationRampType, { /** * Gets the name of the slope ramp material. - * @type {String} + * @type {string} * @readonly */ Material.SlopeRampMaterialType = "SlopeRamp"; @@ -1706,7 +1706,7 @@ Material._materialCache.addMaterial(Material.SlopeRampMaterialType, { /** * Gets the name of the aspect ramp material. - * @type {String} + * @type {string} * @readonly */ Material.AspectRampMaterialType = "AspectRamp"; @@ -1723,7 +1723,7 @@ Material._materialCache.addMaterial(Material.AspectRampMaterialType, { /** * Gets the name of the elevation band material. - * @type {String} + * @type {string} * @readonly */ Material.ElevationBandType = "ElevationBand"; diff --git a/packages/engine/Source/Scene/MaterialAppearance.js b/packages/engine/Source/Scene/MaterialAppearance.js index be94c5d00329..06280407f4f7 100644 --- a/packages/engine/Source/Scene/MaterialAppearance.js +++ b/packages/engine/Source/Scene/MaterialAppearance.js @@ -17,16 +17,16 @@ import Material from "./Material.js"; * @alias MaterialAppearance * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.flat=false] When true, flat shading is used in the fragment shader, which means lighting is not taking into account. - * @param {Boolean} [options.faceForward=!options.closed] When true, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}. - * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link MaterialAppearance#renderState} has alpha blending enabled. - * @param {Boolean} [options.closed=false] When true, the geometry is expected to be closed so {@link MaterialAppearance#renderState} has backface culling enabled. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.flat=false] When true, flat shading is used in the fragment shader, which means lighting is not taking into account. + * @param {boolean} [options.faceForward=!options.closed] When true, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}. + * @param {boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link MaterialAppearance#renderState} has alpha blending enabled. + * @param {boolean} [options.closed=false] When true, the geometry is expected to be closed so {@link MaterialAppearance#renderState} has backface culling enabled. * @param {MaterialAppearance.MaterialSupportType} [options.materialSupport=MaterialAppearance.MaterialSupport.TEXTURED] The type of materials that will be supported. * @param {Material} [options.material=Material.ColorType] The material used to determine the fragment color. - * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. - * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. - * @param {Object} [options.renderState] Optional render state to override the default render state. + * @param {string} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. + * @param {string} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. + * @param {object} [options.renderState] Optional render state to override the default render state. * * @see {@link https://github.com/CesiumGS/cesium/wiki/Fabric|Fabric} * @demo {@link https://sandcastle.cesium.com/index.html?src=Materials.html|Cesium Sandcastle Material Appearance Demo} @@ -73,7 +73,7 @@ function MaterialAppearance(options) { /** * When true, the geometry is expected to appear translucent. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -108,7 +108,7 @@ Object.defineProperties(MaterialAppearance.prototype, { * * @memberof MaterialAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ vertexShaderSource: { @@ -125,7 +125,7 @@ Object.defineProperties(MaterialAppearance.prototype, { * * @memberof MaterialAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ fragmentShaderSource: { @@ -144,7 +144,7 @@ Object.defineProperties(MaterialAppearance.prototype, { * * @memberof MaterialAppearance.prototype * - * @type {Object} + * @type {object} * @readonly */ renderState: { @@ -160,7 +160,7 @@ Object.defineProperties(MaterialAppearance.prototype, { * * @memberof MaterialAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -212,7 +212,7 @@ Object.defineProperties(MaterialAppearance.prototype, { * * @memberof MaterialAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -231,7 +231,7 @@ Object.defineProperties(MaterialAppearance.prototype, { * * @memberof MaterialAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -250,7 +250,7 @@ Object.defineProperties(MaterialAppearance.prototype, { * * @function * - * @returns {String} The full GLSL fragment shader source. + * @returns {string} The full GLSL fragment shader source. */ MaterialAppearance.prototype.getFragmentShaderSource = Appearance.prototype.getFragmentShaderSource; @@ -260,7 +260,7 @@ MaterialAppearance.prototype.getFragmentShaderSource = * * @function * - * @returns {Boolean} true if the appearance is translucent. + * @returns {boolean} true if the appearance is translucent. */ MaterialAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent; @@ -271,17 +271,17 @@ MaterialAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent; * * @function * - * @returns {Object} The render state. + * @returns {object} The render state. */ MaterialAppearance.prototype.getRenderState = Appearance.prototype.getRenderState; /** * @typedef MaterialAppearance.MaterialSupportType - * @type {Object} + * @type {object} * @property {VertexFormat} vertexFormat - * @property {String} vertexShaderSource - * @property {String} fragmentShaderSource + * @property {string} vertexShaderSource + * @property {string} fragmentShaderSource */ /** diff --git a/packages/engine/Source/Scene/Megatexture.js b/packages/engine/Source/Scene/Megatexture.js index 5e9db2fc72af..759563bd9cfb 100644 --- a/packages/engine/Source/Scene/Megatexture.js +++ b/packages/engine/Source/Scene/Megatexture.js @@ -23,9 +23,9 @@ import TextureWrap from "../Renderer/TextureWrap.js"; * * @param {Context} context * @param {Cartesian3} dimensions - * @param {Number} channelCount + * @param {number} channelCount * @param {MetadataComponentType} componentType - * @param {Number} [textureMemoryByteLength] + * @param {number} [textureMemoryByteLength] * * @private */ @@ -106,7 +106,7 @@ function Megatexture( } /** - * @type {Number} + * @type {number} * @readonly */ this.channelCount = channelCount; @@ -124,7 +124,7 @@ function Megatexture( this.voxelCountPerTile = Cartesian3.clone(dimensions, new Cartesian3()); /** - * @type {Number} + * @type {number} * @readonly */ this.maximumTileCount = @@ -245,7 +245,7 @@ function Megatexture( this.emptyList = this.nodes[0]; /** - * @type {Number} + * @type {number} * @readonly */ this.occupiedCount = 0; @@ -255,13 +255,13 @@ function Megatexture( * @alias MegatextureNode * @constructor * - * @param {Number} index + * @param {number} index * * @private */ function MegatextureNode(index) { /** - * @type {Number} + * @type {number} */ this.index = index; @@ -278,7 +278,7 @@ function MegatextureNode(index) { /** * @param {Array} data - * @returns {Number} + * @returns {number} */ Megatexture.prototype.add = function (data) { if (this.isFull()) { @@ -307,7 +307,7 @@ Megatexture.prototype.add = function (data) { }; /** - * @param {Number} index + * @param {number} index */ Megatexture.prototype.remove = function (index) { if (index < 0 || index >= this.maximumTileCount) { @@ -334,18 +334,18 @@ Megatexture.prototype.remove = function (index) { }; /** - * @returns {Boolean} + * @returns {boolean} */ Megatexture.prototype.isFull = function () { return this.emptyList === undefined; }; /** - * @param {Number} tileCount + * @param {number} tileCount * @param {Cartesian3} dimensions - * @param {Number} channelCount number of channels in the metadata. Must be 1 to 4. + * @param {number} channelCount number of channels in the metadata. Must be 1 to 4. * @param {MetadataComponentType} componentType - * @returns {Number} + * @returns {number} */ Megatexture.getApproximateTextureMemoryByteLength = function ( tileCount, @@ -393,7 +393,7 @@ Megatexture.getApproximateTextureMemoryByteLength = function ( }; /** - * @param {Number} index + * @param {number} index * @param {Float32Array|Uint16Array|Uint8Array} data */ Megatexture.prototype.writeDataToTexture = function (index, data) { @@ -459,7 +459,7 @@ Megatexture.prototype.writeDataToTexture = function (index, data) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see Megatexture#destroy */ diff --git a/packages/engine/Source/Scene/MetadataClass.js b/packages/engine/Source/Scene/MetadataClass.js index 875c683e239a..49b9b609e188 100644 --- a/packages/engine/Source/Scene/MetadataClass.js +++ b/packages/engine/Source/Scene/MetadataClass.js @@ -11,13 +11,13 @@ import MetadataClassProperty from "./MetadataClassProperty.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Metadata|3D Metadata Specification} for 3D Tiles *

    * - * @param {Object} options Object with the following properties: - * @param {String} options.id The ID of the class. - * @param {String} [options.name] The name of the class. - * @param {String} [options.description] The description of the class. - * @param {Object.} [options.properties] The class properties, where each key is the property ID. + * @param {object} options Object with the following properties: + * @param {string} options.id The ID of the class. + * @param {string} [options.name] The name of the class. + * @param {string} [options.description] The description of the class. + * @param {Object} [options.properties] The class properties, where each key is the property ID. * @param {*} [options.extras] Extra user-defined properties. - * @param {Object} [options.extensions] An object containing extensions. + * @param {object} [options.extensions] An object containing extensions. * * @alias MetadataClass * @constructor @@ -54,10 +54,10 @@ function MetadataClass(options) { /** * Creates a {@link MetadataClass} from either 3D Tiles 1.1, 3DTILES_metadata, EXT_structural_metadata, or EXT_feature_metadata. * - * @param {Object} options Object with the following properties: - * @param {String} options.id The ID of the class. - * @param {Object} options.class The class JSON object. - * @param {Object.} [options.enums] A dictionary of enums. + * @param {object} options Object with the following properties: + * @param {string} options.id The ID of the class. + * @param {object} options.class The class JSON object. + * @param {Object} [options.enums] A dictionary of enums. * * @returns {MetadataClass} The newly created metadata class. * @@ -101,7 +101,7 @@ Object.defineProperties(MetadataClass.prototype, { * The class properties. * * @memberof MetadataClass.prototype - * @type {Object.} + * @type {Object} * @readonly */ properties: { @@ -114,7 +114,7 @@ Object.defineProperties(MetadataClass.prototype, { * A dictionary mapping semantics to class properties. * * @memberof MetadataClass.prototype - * @type {Object.} + * @type {Object} * @readonly * * @private @@ -129,7 +129,7 @@ Object.defineProperties(MetadataClass.prototype, { * The ID of the class. * * @memberof MetadataClass.prototype - * @type {String} + * @type {string} * @readonly */ id: { @@ -142,7 +142,7 @@ Object.defineProperties(MetadataClass.prototype, { * The name of the class. * * @memberof MetadataClass.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -155,7 +155,7 @@ Object.defineProperties(MetadataClass.prototype, { * The description of the class. * * @memberof MetadataClass.prototype - * @type {String} + * @type {string} * @readonly */ description: { @@ -181,7 +181,7 @@ Object.defineProperties(MetadataClass.prototype, { * An object containing extensions. * * @memberof MetadataClass.prototype - * @type {Object} + * @type {object} * @readonly */ extensions: { diff --git a/packages/engine/Source/Scene/MetadataClassProperty.js b/packages/engine/Source/Scene/MetadataClassProperty.js index f5dedda7a307..b21c05c06fd7 100644 --- a/packages/engine/Source/Scene/MetadataClassProperty.js +++ b/packages/engine/Source/Scene/MetadataClassProperty.js @@ -18,27 +18,27 @@ import MetadataComponentType from "./MetadataComponentType.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Metadata|3D Metadata Specification} for 3D Tiles *

    * - * @param {Object} options Object with the following properties: - * @param {String} options.id The ID of the property. + * @param {object} options Object with the following properties: + * @param {string} options.id The ID of the property. * @param {MetadataType} options.type The type of the property such as SCALAR, VEC2, VEC3. * @param {MetadataComponentType} [options.componentType] The component type of the property. This includes integer (e.g. INT8 or UINT16), and floating point (FLOAT32 and FLOAT64) values. * @param {MetadataEnum} [options.enumType] The enum type of the property. Only defined when type is ENUM. - * @param {Boolean} [options.isArray=false] True if a property is an array (either fixed length or variable length), false otherwise. - * @param {Boolean} [options.isVariableLengthArray=false] True if a property is a variable length array, false otherwise. - * @param {Number} [options.arrayLength] The number of array elements. Only defined for fixed length arrays. - * @param {Boolean} [options.normalized=false] Whether the property is normalized. - * @param {Number|Number[]|Number[][]} [options.min] A number or an array of numbers storing the minimum allowable value of this property. Only defined when type is a numeric type. - * @param {Number|Number[]|Number[][]} [options.max] A number or an array of numbers storing the maximum allowable value of this property. Only defined when type is a numeric type. - * @param {Number|Number[]|Number[][]} [options.offset] The offset to be added to property values as part of the value transform. - * @param {Number|Number[]|Number[][]} [options.scale] The scale to be multiplied to property values as part of the value transform. - * @param {Boolean|Number|String|Array} [options.noData] The no-data sentinel value that represents null values. - * @param {Boolean|Number|String|Array} [options.default] A default value to use when an entity's property value is not defined. - * @param {Boolean} [options.required=false] Whether the property is required. - * @param {String} [options.name] The name of the property. - * @param {String} [options.description] The description of the property. - * @param {String} [options.semantic] An identifier that describes how this property should be interpreted. + * @param {boolean} [options.isArray=false] True if a property is an array (either fixed length or variable length), false otherwise. + * @param {boolean} [options.isVariableLengthArray=false] True if a property is a variable length array, false otherwise. + * @param {number} [options.arrayLength] The number of array elements. Only defined for fixed length arrays. + * @param {boolean} [options.normalized=false] Whether the property is normalized. + * @param {number|number[]|number[][]} [options.min] A number or an array of numbers storing the minimum allowable value of this property. Only defined when type is a numeric type. + * @param {number|number[]|number[][]} [options.max] A number or an array of numbers storing the maximum allowable value of this property. Only defined when type is a numeric type. + * @param {number|number[]|number[][]} [options.offset] The offset to be added to property values as part of the value transform. + * @param {number|number[]|number[][]} [options.scale] The scale to be multiplied to property values as part of the value transform. + * @param {boolean|number|string|Array} [options.noData] The no-data sentinel value that represents null values. + * @param {boolean|number|string|Array} [options.default] A default value to use when an entity's property value is not defined. + * @param {boolean} [options.required=false] Whether the property is required. + * @param {string} [options.name] The name of the property. + * @param {string} [options.description] The description of the property. + * @param {string} [options.semantic] An identifier that describes how this property should be interpreted. * @param {*} [options.extras] Extra user-defined properties. - * @param {Object} [options.extensions] An object containing extensions. + * @param {object} [options.extensions] An object containing extensions. * * @alias MetadataClassProperty * @constructor @@ -125,10 +125,10 @@ function MetadataClassProperty(options) { /** * Creates a {@link MetadataClassProperty} from either 3D Tiles 1.1, 3DTILES_metadata, EXT_structural_metadata, or EXT_feature_metadata. * - * @param {Object} options Object with the following properties: - * @param {String} options.id The ID of the property. - * @param {Object} options.property The property JSON object. - * @param {Object.} [options.enums] A dictionary of enums. + * @param {object} options Object with the following properties: + * @param {string} options.id The ID of the property. + * @param {object} options.property The property JSON object. + * @param {Object} [options.enums] A dictionary of enums. * * @returns {MetadataClassProperty} The newly created metadata class property. * @@ -197,7 +197,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * The ID of the property. * * @memberof MetadataClassProperty.prototype - * @type {String} + * @type {string} * @readonly */ id: { @@ -210,7 +210,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * The name of the property. * * @memberof MetadataClassProperty.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -223,7 +223,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * The description of the property. * * @memberof MetadataClassProperty.prototype - * @type {String} + * @type {string} * @readonly */ description: { @@ -293,7 +293,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * false otherwise. * * @memberof MetadataClassProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ isArray: { @@ -306,7 +306,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * True if a property is a variable length array, false otherwise. * * @memberof MetadataClassProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ isVariableLengthArray: { @@ -320,7 +320,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * arrays. * * @memberof MetadataClassProperty.prototype - * @type {Number} + * @type {number} * @readonly */ arrayLength: { @@ -333,7 +333,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * Whether the property is normalized. * * @memberof MetadataClassProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ normalized: { @@ -346,7 +346,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * A number or an array of numbers storing the maximum allowable value of this property. Only defined when type is a numeric type. * * @memberof MetadataClassProperty.prototype - * @type {Number|Number[]|Number[][]} + * @type {number|number[]|number[][]} * @readonly */ max: { @@ -359,7 +359,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * A number or an array of numbers storing the minimum allowable value of this property. Only defined when type is a numeric type. * * @memberof MetadataClassProperty.prototype - * @type {Number|Number[]|Number[][]} + * @type {number|number[]|number[][]} * @readonly */ min: { @@ -372,7 +372,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * The no-data sentinel value that represents null values * * @memberof MetadataClassProperty.prototype - * @type {Boolean|Number|String|Array} + * @type {boolean|number|string|Array} * @readonly */ noData: { @@ -385,7 +385,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * A default value to use when an entity's property value is not defined. * * @memberof MetadataClassProperty.prototype - * @type {Boolean|Number|String|Array} + * @type {boolean|number|string|Array} * @readonly */ default: { @@ -398,7 +398,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * Whether the property is required. * * @memberof MetadataClassProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ required: { @@ -411,7 +411,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * An identifier that describes how this property should be interpreted. * * @memberof MetadataClassProperty.prototype - * @type {String} + * @type {string} * @readonly */ semantic: { @@ -425,7 +425,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * undefined, they default to identity so this property is set false * * @memberof MetadataClassProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @private */ @@ -439,7 +439,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * The offset to be added to property values as part of the value transform. * * @memberof MetadataClassProperty.prototype - * @type {Number|Number[]|Number[][]} + * @type {number|number[]|number[][]} * @readonly */ offset: { @@ -452,7 +452,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * The scale to be multiplied to property values as part of the value transform. * * @memberof MetadataClassProperty.prototype - * @type {Number|Number[]|Number[][]} + * @type {number|number[]|number[][]} * @readonly */ scale: { @@ -478,7 +478,7 @@ Object.defineProperties(MetadataClassProperty.prototype, { * An object containing extensions. * * @memberof MetadataClassProperty.prototype - * @type {Object} + * @type {object} * @readonly */ extensions: { @@ -865,7 +865,7 @@ function arrayEquals(left, right) { * other sizes) are passed through unaltered. * * @param {*} value the original, normalized values. - * @param {Boolean} [enableNestedArrays=false] If true, arrays of vectors are represented as nested arrays. This is used for JSON encoding but not binary encoding + * @param {boolean} [enableNestedArrays=false] If true, arrays of vectors are represented as nested arrays. This is used for JSON encoding but not binary encoding * @returns {*} The appropriate vector or matrix type if the value is a vector or matrix type, respectively. If the property is an array of vectors or matrices, an array of the appropriate vector or matrix type is returned. Otherwise, the value is returned unaltered. * @private */ @@ -904,7 +904,7 @@ MetadataClassProperty.prototype.unpackVectorAndMatrixTypes = function ( * All other values (including arrays of other sizes) are passed through unaltered. * * @param {*} value The value of this property - * @param {Boolean} [enableNestedArrays=false] If true, arrays of vectors are represented as nested arrays. This is used for JSON encoding but not binary encoding + * @param {boolean} [enableNestedArrays=false] If true, arrays of vectors are represented as nested arrays. This is used for JSON encoding but not binary encoding * @returns {*} An array of the appropriate length if the property is a vector or matrix type. Otherwise, the value is returned unaltered. * @private */ @@ -939,7 +939,7 @@ MetadataClassProperty.prototype.packVectorAndMatrixTypes = function ( * Validates whether the given value conforms to the property. * * @param {*} value The value. - * @returns {String|undefined} An error message if the value does not conform to the property, otherwise undefined. + * @returns {string|undefined} An error message if the value does not conform to the property, otherwise undefined. * @private */ MetadataClassProperty.prototype.validate = function (value) { diff --git a/packages/engine/Source/Scene/MetadataComponentType.js b/packages/engine/Source/Scene/MetadataComponentType.js index 3093451e4613..ad7ab3afdfcd 100644 --- a/packages/engine/Source/Scene/MetadataComponentType.js +++ b/packages/engine/Source/Scene/MetadataComponentType.js @@ -7,49 +7,49 @@ import FeatureDetection from "../Core/FeatureDetection.js"; /** * An enum of metadata component types. * - * @enum {String} + * @enum {string} * @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. */ const MetadataComponentType = { /** * An 8-bit signed integer * - * @type {String} + * @type {string} * @constant */ INT8: "INT8", /** * An 8-bit unsigned integer * - * @type {String} + * @type {string} * @constant */ UINT8: "UINT8", /** * A 16-bit signed integer * - * @type {String} + * @type {string} * @constant */ INT16: "INT16", /** * A 16-bit unsigned integer * - * @type {String} + * @type {string} * @constant */ UINT16: "UINT16", /** * A 32-bit signed integer * - * @type {String} + * @type {string} * @constant */ INT32: "INT32", /** * A 32-bit unsigned integer * - * @type {String} + * @type {string} * @constant */ UINT32: "UINT32", @@ -58,7 +58,7 @@ const MetadataComponentType = { * * @see FeatureDetection.supportsBigInt * - * @type {String} + * @type {string} * @constant */ INT64: "INT64", @@ -67,21 +67,21 @@ const MetadataComponentType = { * * @see FeatureDetection.supportsBigInt * - * @type {String} + * @type {string} * @constant */ UINT64: "UINT64", /** * A 32-bit (single precision) floating point number * - * @type {String} + * @type {string} * @constant */ FLOAT32: "FLOAT32", /** * A 64-bit (double precision) floating point number * - * @type {String} + * @type {string} * @constant */ FLOAT64: "FLOAT64", @@ -95,7 +95,7 @@ const MetadataComponentType = { *

    * * @param {MetadataComponentType} type The type. - * @returns {Number|BigInt} The minimum value. + * @returns {number|bigint} The minimum value. * * @private */ @@ -143,7 +143,7 @@ MetadataComponentType.getMinimum = function (type) { *

    * * @param {MetadataComponentType} type The type. - * @returns {Number|BigInt} The maximum value. + * @returns {number|bigint} The maximum value. * * @private */ @@ -189,7 +189,7 @@ MetadataComponentType.getMaximum = function (type) { * Returns whether the type is an integer type. * * @param {MetadataComponentType} type The type. - * @returns {Boolean} Whether the type is an integer type. + * @returns {boolean} Whether the type is an integer type. * * @private */ @@ -217,7 +217,7 @@ MetadataComponentType.isIntegerType = function (type) { * Returns whether the type is an unsigned integer type. * * @param {MetadataComponentType} type The type. - * @returns {Boolean} Whether the type is an unsigned integer type. + * @returns {boolean} Whether the type is an unsigned integer type. * * @private */ @@ -242,7 +242,7 @@ MetadataComponentType.isUnsignedIntegerType = function (type) { * {@link Cartesian3}, or {@link Cartesian4} classes. This includes all numeric * types except for types requiring 64-bit integers * @param {MetadataComponentType} type The type to check - * @return {Boolean} true if the type can be encoded as a vector type, or false otherwise + * @return {boolean} true if the type can be encoded as a vector type, or false otherwise * @private */ MetadataComponentType.isVectorCompatible = function (type) { @@ -274,9 +274,9 @@ MetadataComponentType.isVectorCompatible = function (type) { * small precision differences. *

    * - * @param {Number|BigInt} value The integer value. + * @param {number|bigint} value The integer value. * @param {MetadataComponentType} type The type. - * @returns {Number} The normalized value. + * @returns {number} The normalized value. * * @exception {DeveloperError} value must be a number or a BigInt * @exception {DeveloperError} type must be an integer type @@ -307,9 +307,9 @@ MetadataComponentType.normalize = function (value, type) { * Returns a BigInt for the INT64 and UINT64 types if BigInt is supported on this platform. *

    * - * @param {Number} value The normalized value. + * @param {number} value The normalized value. * @param {MetadataComponentType} type The type. - * @returns {Number|BigInt} The integer value. + * @returns {number|bigint} The integer value. * * @exception {DeveloperError} type must be an integer type * @@ -371,7 +371,7 @@ MetadataComponentType.unapplyValueTransform = function (value, offset, scale) { * Gets the size in bytes for the numeric type. * * @param {MetadataComponentType} type The type. - * @returns {Number} The size in bytes. + * @returns {number} The size in bytes. * * @private */ diff --git a/packages/engine/Source/Scene/MetadataEntity.js b/packages/engine/Source/Scene/MetadataEntity.js index e6648aba79d5..750ab53dedb6 100644 --- a/packages/engine/Source/Scene/MetadataEntity.js +++ b/packages/engine/Source/Scene/MetadataEntity.js @@ -40,8 +40,8 @@ Object.defineProperties(MetadataEntity.prototype, { /** * Returns whether the entity has this property. * - * @param {String} propertyId The case-sensitive ID of the property. - * @returns {Boolean} Whether the entity has this property. + * @param {string} propertyId The case-sensitive ID of the property. + * @returns {boolean} Whether the entity has this property. * @private */ MetadataEntity.prototype.hasProperty = function (propertyId) { @@ -51,8 +51,8 @@ MetadataEntity.prototype.hasProperty = function (propertyId) { /** * Returns whether the entity has a property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @returns {Boolean} Whether the entity has a property with the given semantic. + * @param {string} semantic The case-sensitive semantic of the property. + * @returns {boolean} Whether the entity has a property with the given semantic. * @private */ MetadataEntity.prototype.hasPropertyBySemantic = function (semantic) { @@ -62,8 +62,8 @@ MetadataEntity.prototype.hasPropertyBySemantic = function (semantic) { /** * 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 */ MetadataEntity.prototype.getPropertyIds = function (results) { @@ -76,7 +76,7 @@ MetadataEntity.prototype.getPropertyIds = function (results) { * If the property is normalized the normalized value is returned. *

    * - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @returns {*} The value of the property or undefined if the entity does not have this property. * @private */ @@ -90,9 +90,9 @@ MetadataEntity.prototype.getProperty = function (propertyId) { * If the property is normalized a normalized value must be provided to this function. *

    * - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ MetadataEntity.prototype.setProperty = function (propertyId, value) { @@ -102,7 +102,7 @@ MetadataEntity.prototype.setProperty = function (propertyId, value) { /** * Returns a copy of the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @returns {*} The value of the property or undefined if the entity does not have this property. * @private */ @@ -113,9 +113,9 @@ MetadataEntity.prototype.getPropertyBySemantic = function (semantic) { /** * Sets the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ MetadataEntity.prototype.setPropertyBySemantic = function (semantic, value) { @@ -125,10 +125,10 @@ MetadataEntity.prototype.setPropertyBySemantic = function (semantic, value) { /** * Returns whether the entity has this property. * - * @param {String} propertyId The case-sensitive ID of the property. - * @param {Object} properties The dictionary containing properties. + * @param {string} propertyId The case-sensitive ID of the property. + * @param {object} properties The dictionary containing properties. * @param {MetadataClass} classDefinition The class. - * @returns {Boolean} Whether the entity has this property. + * @returns {boolean} Whether the entity has this property. * * @private */ @@ -163,10 +163,10 @@ MetadataEntity.hasProperty = function ( /** * Returns whether the entity has a property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @param {Object} properties The dictionary containing properties. + * @param {string} semantic The case-sensitive semantic of the property. + * @param {object} properties The dictionary containing properties. * @param {MetadataClass} classDefinition The class. - * @returns {Boolean} Whether the entity has a property with the given semantic. + * @returns {boolean} Whether the entity has a property with the given semantic. * * @private */ @@ -193,10 +193,10 @@ MetadataEntity.hasPropertyBySemantic = function ( /** * Returns an array of property IDs. * - * @param {Object} properties The dictionary containing properties. + * @param {object} properties The dictionary containing properties. * @param {MetadataClass} classDefinition The class. - * @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 */ @@ -246,8 +246,8 @@ MetadataEntity.getPropertyIds = function ( * If the property is normalized the normalized value is returned. *

    * - * @param {String} propertyId The case-sensitive ID of the property. - * @param {Object} properties The dictionary containing properties. + * @param {string} propertyId The case-sensitive ID of the property. + * @param {object} properties The dictionary containing properties. * @param {MetadataClass} classDefinition The class. * @returns {*} The value of the property or undefined if the entity does not have this property. * @@ -301,11 +301,11 @@ MetadataEntity.getProperty = function ( * If the property is normalized a normalized value must be provided to this function. *

    * - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. - * @param {Object} properties The dictionary containing properties. + * @param {object} properties The dictionary containing properties. * @param {MetadataClass} classDefinition The class. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * * @private */ @@ -351,8 +351,8 @@ MetadataEntity.setProperty = function ( /** * Returns a copy of the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @param {Object} properties The dictionary containing properties. + * @param {string} semantic The case-sensitive semantic of the property. + * @param {object} properties The dictionary containing properties. * @param {MetadataClass} classDefinition The class. * @returns {*} The value of the property or undefined if the entity does not have this property. * @@ -384,11 +384,11 @@ MetadataEntity.getPropertyBySemantic = function ( /** * Sets the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @param {*} value The value of the property that will be copied. - * @param {Object} properties The dictionary containing properties. + * @param {object} properties The dictionary containing properties. * @param {MetadataClass} classDefinition The class. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ MetadataEntity.setPropertyBySemantic = function ( diff --git a/packages/engine/Source/Scene/MetadataEnum.js b/packages/engine/Source/Scene/MetadataEnum.js index d3f5cf671dd6..ed23d940cd4e 100644 --- a/packages/engine/Source/Scene/MetadataEnum.js +++ b/packages/engine/Source/Scene/MetadataEnum.js @@ -10,14 +10,14 @@ import MetadataComponentType from "./MetadataComponentType.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Metadata|3D Metadata Specification} for 3D Tiles *

    * - * @param {Object} options Object with the following properties: - * @param {String} options.id The ID of the enum. + * @param {object} options Object with the following properties: + * @param {string} options.id The ID of the enum. * @param {MetadataEnumValue[]} options.values The enum values. * @param {MetadataComponentType} [options.valueType=MetadataComponentType.UINT16] The enum value type. - * @param {String} [options.name] The name of the enum. - * @param {String} [options.description] The description of the enum. + * @param {string} [options.name] The name of the enum. + * @param {string} [options.description] The description of the enum. * @param {*} [options.extras] Extra user-defined properties. - * @param {Object} [options.extensions] An object containing extensions. + * @param {object} [options.extensions] An object containing extensions. * * @alias MetadataEnum * @constructor @@ -62,9 +62,9 @@ function MetadataEnum(options) { /** * Creates a {@link MetadataEnum} from either 3D Tiles 1.1, 3DTILES_metadata, EXT_structural_metadata, or EXT_feature_metadata. * - * @param {Object} options Object with the following properties: - * @param {String} options.id The ID of the enum. - * @param {Object} options.enum The enum JSON object. + * @param {object} options Object with the following properties: + * @param {string} options.id The ID of the enum. + * @param {object} options.enum The enum JSON object. * * @returns {MetadataEnum} The newly created metadata enum. * @@ -114,7 +114,7 @@ Object.defineProperties(MetadataEnum.prototype, { * A dictionary mapping enum integer values to names. * * @memberof MetadataEnum.prototype - * @type {Object.} + * @type {Object} * @readonly * * @private @@ -129,7 +129,7 @@ Object.defineProperties(MetadataEnum.prototype, { * A dictionary mapping enum names to integer values. * * @memberof MetadataEnum.prototype - * @type {Object.} + * @type {Object} * @readonly * * @private @@ -157,7 +157,7 @@ Object.defineProperties(MetadataEnum.prototype, { * The ID of the enum. * * @memberof MetadataEnum.prototype - * @type {String} + * @type {string} * @readonly */ id: { @@ -170,7 +170,7 @@ Object.defineProperties(MetadataEnum.prototype, { * The name of the enum. * * @memberof MetadataEnum.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -183,7 +183,7 @@ Object.defineProperties(MetadataEnum.prototype, { * The description of the enum. * * @memberof MetadataEnum.prototype - * @type {String} + * @type {string} * @readonly */ description: { @@ -209,7 +209,7 @@ Object.defineProperties(MetadataEnum.prototype, { * An object containing extensions. * * @memberof MetadataEnum.prototype - * @type {Object} + * @type {object} * @readonly */ extensions: { diff --git a/packages/engine/Source/Scene/MetadataEnumValue.js b/packages/engine/Source/Scene/MetadataEnumValue.js index 5efec85e104d..d08232daf26e 100644 --- a/packages/engine/Source/Scene/MetadataEnumValue.js +++ b/packages/engine/Source/Scene/MetadataEnumValue.js @@ -8,12 +8,12 @@ import defaultValue from "../Core/defaultValue.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Metadata|3D Metadata Specification} for 3D Tiles *

    * - * @param {Object} options Object with the following properties: - * @param {Number} options.value The integer value. - * @param {String} options.name The name of the enum value. - * @param {String} [options.description] The description of the enum value. + * @param {object} options Object with the following properties: + * @param {number} options.value The integer value. + * @param {string} options.name The name of the enum value. + * @param {string} [options.description] The description of the enum value. * @param {*} [options.extras] Extra user-defined properties. - * @param {Object} [options.extensions] An object containing extensions. + * @param {object} [options.extensions] An object containing extensions. * * @alias MetadataEnumValue * @constructor @@ -40,7 +40,7 @@ function MetadataEnumValue(options) { /** * Creates a {@link MetadataEnumValue} from either 3D Tiles 1.1, 3DTILES_metadata, EXT_structural_metadata, or EXT_feature_metadata. * - * @param {Object} value The enum value JSON object. + * @param {object} value The enum value JSON object. * * @returns {MetadataEnumValue} The newly created metadata enum value. * @@ -66,7 +66,7 @@ Object.defineProperties(MetadataEnumValue.prototype, { * The integer value. * * @memberof MetadataEnumValue.prototype - * @type {Number} + * @type {number} * @readonly */ value: { @@ -79,7 +79,7 @@ Object.defineProperties(MetadataEnumValue.prototype, { * The name of the enum value. * * @memberof MetadataEnumValue.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -92,7 +92,7 @@ Object.defineProperties(MetadataEnumValue.prototype, { * The description of the enum value. * * @memberof MetadataEnumValue.prototype - * @type {String} + * @type {string} * @readonly */ description: { @@ -118,7 +118,7 @@ Object.defineProperties(MetadataEnumValue.prototype, { * An object containing extensions. * * @memberof MetadataEnumValue.prototype - * @type {Object} + * @type {object} * @readonly */ extensions: { diff --git a/packages/engine/Source/Scene/MetadataSchema.js b/packages/engine/Source/Scene/MetadataSchema.js index e92677aca91c..b9fb5c0b505d 100644 --- a/packages/engine/Source/Scene/MetadataSchema.js +++ b/packages/engine/Source/Scene/MetadataSchema.js @@ -11,15 +11,15 @@ import MetadataEnum from "./MetadataEnum.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Metadata|3D Metadata Specification} for 3D Tiles *

    * - * @param {Object} options Object with the following properties: - * @param {String} [options.id] The ID of the schema - * @param {String} [options.name] The name of the schema. - * @param {String} [options.description] The description of the schema. - * @param {String} [options.version] The application-specific version of the schema. - * @param {Object.} [options.classes] Classes defined in the schema, where each key is the class ID. - * @param {Object.} [options.enums] Enums defined in the schema, where each key is the enum ID. + * @param {object} options Object with the following properties: + * @param {string} [options.id] The ID of the schema + * @param {string} [options.name] The name of the schema. + * @param {string} [options.description] The description of the schema. + * @param {string} [options.version] The application-specific version of the schema. + * @param {Object} [options.classes] Classes defined in the schema, where each key is the class ID. + * @param {Object} [options.enums] Enums defined in the schema, where each key is the enum ID. * @param {*} [options.extras] Extra user-defined properties. - * @param {Object} [options.extensions] An object containing extensions. + * @param {object} [options.extensions] An object containing extensions. * * @alias MetadataSchema * @constructor @@ -44,7 +44,7 @@ function MetadataSchema(options) { /** * Creates a {@link MetadataSchema} from either 3D Tiles 1.1, 3DTILES_metadata, EXT_structural_metadata, or EXT_feature_metadata. * - * @param {Object} schema The schema JSON object. + * @param {object} schema The schema JSON object. * * @returns {MetadataSchema} The newly created metadata schema * @@ -98,7 +98,7 @@ Object.defineProperties(MetadataSchema.prototype, { * Classes defined in the schema. * * @memberof MetadataSchema.prototype - * @type {Object.} + * @type {Object} * @readonly */ classes: { @@ -111,7 +111,7 @@ Object.defineProperties(MetadataSchema.prototype, { * Enums defined in the schema. * * @memberof MetadataSchema.prototype - * @type {Object.} + * @type {Object} * @readonly */ enums: { @@ -124,7 +124,7 @@ Object.defineProperties(MetadataSchema.prototype, { * The ID of the schema. * * @memberof MetadataSchema.prototype - * @type {String} + * @type {string} * @readonly */ id: { @@ -137,7 +137,7 @@ Object.defineProperties(MetadataSchema.prototype, { * The name of the schema. * * @memberof MetadataSchema.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -150,7 +150,7 @@ Object.defineProperties(MetadataSchema.prototype, { * The description of the schema. * * @memberof MetadataSchema.prototype - * @type {String} + * @type {string} * @readonly */ description: { @@ -163,7 +163,7 @@ Object.defineProperties(MetadataSchema.prototype, { * The application-specific version of the schema. * * @memberof MetadataSchema.prototype - * @type {String} + * @type {string} * @readonly */ version: { @@ -189,7 +189,7 @@ Object.defineProperties(MetadataSchema.prototype, { * An object containing extensions. * * @memberof MetadataSchema.prototype - * @type {Object} + * @type {object} * @readonly */ extensions: { diff --git a/packages/engine/Source/Scene/MetadataSchemaLoader.js b/packages/engine/Source/Scene/MetadataSchemaLoader.js index be21b606d479..6fc9f0a05d53 100644 --- a/packages/engine/Source/Scene/MetadataSchemaLoader.js +++ b/packages/engine/Source/Scene/MetadataSchemaLoader.js @@ -15,10 +15,10 @@ import ResourceLoaderState from "./ResourceLoaderState.js"; * @constructor * @augments ResourceLoader * - * @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. - * @param {String} [options.cacheKey] The cache key of the resource. + * @param {string} [options.cacheKey] The cache key of the resource. * * @exception {DeveloperError} One of options.schema and options.resource must be defined. * @@ -57,7 +57,7 @@ Object.defineProperties(MetadataSchemaLoader.prototype, { * * @memberof MetadataSchemaLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * @private */ @@ -71,7 +71,7 @@ Object.defineProperties(MetadataSchemaLoader.prototype, { * * @memberof MetadataSchemaLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -98,7 +98,7 @@ Object.defineProperties(MetadataSchemaLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ MetadataSchemaLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/MetadataSemantic.js b/packages/engine/Source/Scene/MetadataSemantic.js index fbac22547549..867af8ac5fbc 100644 --- a/packages/engine/Source/Scene/MetadataSemantic.js +++ b/packages/engine/Source/Scene/MetadataSemantic.js @@ -11,7 +11,7 @@ const MetadataSemantic = { /** * A unique identifier, stored as a STRING. * - * @type {String} + * @type {string} * @constant * @private */ @@ -19,7 +19,7 @@ const MetadataSemantic = { /** * A name, stored as a STRING. This does not have to be unique. * - * @type {String} + * @type {string} * @constant * @private */ @@ -27,7 +27,7 @@ const MetadataSemantic = { /** * A description, stored as a STRING. * - * @type {String} + * @type {string} * @constant * @private */ @@ -35,7 +35,7 @@ const MetadataSemantic = { /** * The number of tiles in a tileset, stored as a UINT64. * - * @type {String} + * @type {string} * @constant * @private */ @@ -43,7 +43,7 @@ const MetadataSemantic = { /** * A bounding box for a tile, stored as an array of 12 FLOAT32 or FLOAT64 components. The components are the same format as for boundingVolume.box in 3D Tiles 1.0. This semantic is used to provide a tighter bounding volume than the one implicitly calculated in implicit tiling. * - * @type {String} + * @type {string} * @constant * @private */ @@ -51,7 +51,7 @@ const MetadataSemantic = { /** * A bounding region for a tile, stored as an array of 6 FLOAT64 components. The components are [west, south, east, north, minimumHeight, maximumHeight]. This semantic is used to provide a tighter bounding volume than the one implicitly calculated in implicit tiling. * - * @type {String} + * @type {string} * @constant * @private */ @@ -59,7 +59,7 @@ const MetadataSemantic = { /** * A bounding sphere for a tile, stored as an array of 4 FLOAT32 or FLOAT64 components. The components are [centerX, centerY, centerZ, radius]. This semantic is used to provide a tighter bounding volume than the one implicitly calculated in implicit tiling. * - * @type {String} + * @type {string} * @constant * @private */ @@ -67,7 +67,7 @@ const MetadataSemantic = { /** * The minimum height of a tile above (or below) the WGS84 ellipsoid, stored as a FLOAT32 or a FLOAT64. This semantic is used to tighten bounding regions implicitly calculated in implicit tiling. * - * @type {String} + * @type {string} * @constant * @private */ @@ -75,7 +75,7 @@ const MetadataSemantic = { /** * The maximum height of a tile above (or below) the WGS84 ellipsoid, stored as a FLOAT32 or a FLOAT64. This semantic is used to tighten bounding regions implicitly calculated in implicit tiling. * - * @type {String} + * @type {string} * @constant * @private */ @@ -85,7 +85,7 @@ const MetadataSemantic = { * * @see {@link https://cesium.com/blog/2013/04/25/horizon-culling/|Horizon Culling} * - * @type {String} + * @type {string} * @constant * @private */ @@ -93,7 +93,7 @@ const MetadataSemantic = { /** * The geometric error for a tile, stored as a FLOAT32 or a FLOAT64. This semantic is used to override the geometric error implicitly calculated in implicit tiling. * - * @type {String} + * @type {string} * @constant * @private */ @@ -101,7 +101,7 @@ const MetadataSemantic = { /** * A bounding box for the content of a tile, stored as an array of 12 FLOAT32 or FLOAT64 components. The components are the same format as for boundingVolume.box in 3D Tiles 1.0. This semantic is used to provide a tighter bounding volume than the one implicitly calculated in implicit tiling. * - * @type {String} + * @type {string} * @constant * @private */ @@ -109,7 +109,7 @@ const MetadataSemantic = { /** * A bounding region for the content of a tile, stored as an array of 6 FLOAT64 components. The components are [west, south, east, north, minimumHeight, maximumHeight]. This semantic is used to provide a tighter bounding volume than the one implicitly calculated in implicit tiling. * - * @type {String} + * @type {string} * @constant * @private */ @@ -117,7 +117,7 @@ const MetadataSemantic = { /** * A bounding sphere for the content of a tile, stored as an array of 4 FLOAT32 or FLOAT64 components. The components are [centerX, centerY, centerZ, radius]. This semantic is used to provide a tighter bounding volume than the one implicitly calculated in implicit tiling. * - * @type {String} + * @type {string} * @constant * @private */ @@ -125,7 +125,7 @@ const MetadataSemantic = { /** * The minimum height of the content of a tile above (or below) the WGS84 ellipsoid, stored as a FLOAT32 or a FLOAT64 * - * @type {String} + * @type {string} * @constant * @private */ @@ -133,7 +133,7 @@ const MetadataSemantic = { /** * The maximum height of the content of a tile above (or below) the WGS84 ellipsoid, stored as a FLOAT32 or a FLOAT64 * - * @type {String} + * @type {string} * @constant * @private */ @@ -143,7 +143,7 @@ const MetadataSemantic = { * * @see {@link https://cesium.com/blog/2013/04/25/horizon-culling/|Horizon Culling} * - * @type {String} + * @type {string} * @constant * @private */ diff --git a/packages/engine/Source/Scene/MetadataTable.js b/packages/engine/Source/Scene/MetadataTable.js index a660159ef4c2..9a3857716060 100644 --- a/packages/engine/Source/Scene/MetadataTable.js +++ b/packages/engine/Source/Scene/MetadataTable.js @@ -13,11 +13,11 @@ import MetadataTableProperty from "./MetadataTableProperty.js"; * For 3D Tiles Next details, see the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles, as well as the {@link https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata|EXT_feature_metadata Extension} for glTF. *

    * - * @param {Object} options Object with the following properties: - * @param {Number} options.count The number of entities in the table. - * @param {Object} [options.properties] A dictionary containing properties. + * @param {object} options Object with the following properties: + * @param {number} options.count The number of entities in the table. + * @param {object} [options.properties] A dictionary containing properties. * @param {MetadataClass} options.class The class that properties conform to. - * @param {Object.} [options.bufferViews] An object mapping bufferView IDs to Uint8Array objects. + * @param {Object} [options.bufferViews] An object mapping bufferView IDs to Uint8Array objects. * * @alias MetadataTable * @constructor @@ -63,7 +63,7 @@ Object.defineProperties(MetadataTable.prototype, { * The number of entities in the table. * * @memberof MetadataTable.prototype - * @type {Number} + * @type {number} * @readonly * @private */ @@ -91,7 +91,7 @@ Object.defineProperties(MetadataTable.prototype, { * The size of all typed arrays used in this table. * * @memberof MetadataTable.prototype - * @type {Number} + * @type {number} * @readonly * @private */ @@ -105,8 +105,8 @@ Object.defineProperties(MetadataTable.prototype, { /** * 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 */ MetadataTable.prototype.hasProperty = function (propertyId) { @@ -116,8 +116,8 @@ MetadataTable.prototype.hasProperty = function (propertyId) { /** * Returns whether the table has a property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @returns {Boolean} Whether the table has a property with the given semantic. + * @param {string} semantic The case-sensitive semantic of the property. + * @returns {boolean} Whether the table has a property with the given semantic. * @private */ MetadataTable.prototype.hasPropertyBySemantic = function (semantic) { @@ -131,8 +131,8 @@ MetadataTable.prototype.hasPropertyBySemantic = function (semantic) { /** * 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 */ MetadataTable.prototype.getPropertyIds = function (results) { @@ -157,8 +157,8 @@ MetadataTable.prototype.getPropertyIds = function (results) { * may lose precision when read. *

    * - * @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 undefined if the entity does not have this property. * * @exception {DeveloperError} index is required and between zero and count - 1 @@ -200,10 +200,10 @@ MetadataTable.prototype.getProperty = function (index, propertyId) { * may lose precision when set." *

    * - * @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. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * * @exception {DeveloperError} index is required and between zero and count - 1 * @exception {DeveloperError} value does not match type @@ -228,8 +228,8 @@ MetadataTable.prototype.setProperty = function (index, propertyId, value) { /** * Returns a copy of the value of the property with the given semantic. * - * @param {Number} index The index of the entity. - * @param {String} semantic The case-sensitive semantic of the property. + * @param {number} index The index of the entity. + * @param {string} semantic The case-sensitive semantic of the property. * @returns {*} The value of the property or undefined if the entity does not have this semantic. * * @exception {DeveloperError} index is required and between zero and count - 1 @@ -256,10 +256,10 @@ MetadataTable.prototype.getPropertyBySemantic = function (index, semantic) { /** * Sets the value of the property with the given semantic. * - * @param {Number} index The index of the entity. - * @param {String} semantic The case-sensitive semantic of the property. + * @param {number} index The index of the entity. + * @param {string} semantic The case-sensitive semantic of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * * @exception {DeveloperError} index is required and between zero and count - 1 * @exception {DeveloperError} value does not match type @@ -292,7 +292,7 @@ MetadataTable.prototype.setPropertyBySemantic = function ( /** * Returns a typed array containing the property values for a given propertyId. * - * @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 undefined if the property values are not stored in a typed array. * * @private @@ -314,7 +314,7 @@ MetadataTable.prototype.getPropertyTypedArray = function (propertyId) { /** * Returns a typed array containing the property values for the property with the given semantic. * - * @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 undefined if the property values are not stored in a typed array. * * @private diff --git a/packages/engine/Source/Scene/MetadataTableProperty.js b/packages/engine/Source/Scene/MetadataTableProperty.js index 484eb7133440..8198e0151652 100644 --- a/packages/engine/Source/Scene/MetadataTableProperty.js +++ b/packages/engine/Source/Scene/MetadataTableProperty.js @@ -19,11 +19,11 @@ import MetadataType from "./MetadataType.js"; * for glTF. For the legacy glTF extension, see {@link https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata|EXT_feature_metadata Extension} *

    * - * @param {Object} options Object with the following properties: - * @param {Number} options.count The number of elements in each property array. - * @param {Object} options.property The property JSON object. + * @param {object} options Object with the following properties: + * @param {number} options.count The number of elements in each property array. + * @param {object} options.property The property JSON object. * @param {MetadataClassProperty} options.classProperty The class property. - * @param {Object.} options.bufferViews An object mapping bufferView IDs to Uint8Array objects. + * @param {Object} options.bufferViews An object mapping bufferView IDs to Uint8Array objects. * * @alias MetadataTableProperty * @constructor @@ -226,7 +226,7 @@ Object.defineProperties(MetadataTableProperty.prototype, { * undefined, they default to identity so this property is set false * * @memberof MetadataClassProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @private */ @@ -240,7 +240,7 @@ Object.defineProperties(MetadataTableProperty.prototype, { * The offset to be added to property values as part of the value transform. * * @memberof MetadataClassProperty.prototype - * @type {Number|Number[]|Number[][]} + * @type {number|number[]|number[][]} * @readonly * @private */ @@ -254,7 +254,7 @@ Object.defineProperties(MetadataTableProperty.prototype, { * The scale to be multiplied to property values as part of the value transform. * * @memberof MetadataClassProperty.prototype - * @type {Number|Number[]|Number[][]} + * @type {number|number[]|number[][]} * @readonly * @private */ @@ -310,7 +310,7 @@ Object.defineProperties(MetadataTableProperty.prototype, { /** * Returns a copy of the value at the given index. * - * @param {Number} index The index. + * @param {number} index The index. * @returns {*} The value of the property. * * @private @@ -337,7 +337,7 @@ MetadataTableProperty.prototype.get = function (index) { /** * Sets the value at the given index. * - * @param {Number} index The index. + * @param {number} index The index. * @param {*} value The value of the property. * * @private diff --git a/packages/engine/Source/Scene/MetadataType.js b/packages/engine/Source/Scene/MetadataType.js index e50d3d181ccb..9bb0a2e8c7d5 100644 --- a/packages/engine/Source/Scene/MetadataType.js +++ b/packages/engine/Source/Scene/MetadataType.js @@ -11,70 +11,70 @@ import Matrix4 from "../Core/Matrix4.js"; * An enum of metadata types. These metadata types are containers containing * one or more components of type {@link MetadataComponentType} * - * @enum {String} + * @enum {string} * @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. */ const MetadataType = { /** * A single component * - * @type {String} + * @type {string} * @constant */ SCALAR: "SCALAR", /** * A vector with two components * - * @type {String} + * @type {string} * @constant */ VEC2: "VEC2", /** * A vector with three components * - * @type {String} + * @type {string} * @constant */ VEC3: "VEC3", /** * A vector with four components * - * @type {String} + * @type {string} * @constant */ VEC4: "VEC4", /** * A 2x2 matrix, stored in column-major format. * - * @type {String} + * @type {string} * @constant */ MAT2: "MAT2", /** * A 3x3 matrix, stored in column-major format. * - * @type {String} + * @type {string} * @constant */ MAT3: "MAT3", /** * A 4x4 matrix, stored in column-major format. * - * @type {String} + * @type {string} * @constant */ MAT4: "MAT4", /** * A boolean (true/false) value * - * @type {String} + * @type {string} * @constant */ BOOLEAN: "BOOLEAN", /** * A UTF-8 encoded string value * - * @type {String} + * @type {string} * @constant */ STRING: "STRING", @@ -83,7 +83,7 @@ const MetadataType = { * * @see MetadataEnum * - * @type {String} + * @type {string} * @constant */ ENUM: "ENUM", @@ -93,7 +93,7 @@ const MetadataType = { * Check if a type is VEC2, VEC3 or VEC4 * * @param {MetadataType} type The type - * @return {Boolean} true if the type is a vector, false otherwise + * @return {boolean} true if the type is a vector, false otherwise * @private */ MetadataType.isVectorType = function (type) { @@ -115,7 +115,7 @@ MetadataType.isVectorType = function (type) { * Check if a type is MAT2, MAT3 or MAT4 * * @param {MetadataType} type The type - * @return {Boolean} true if the type is a matrix, false otherwise + * @return {boolean} true if the type is a matrix, false otherwise * @private */ MetadataType.isMatrixType = function (type) { @@ -138,7 +138,7 @@ MetadataType.isMatrixType = function (type) { * a VECN returns N, and a MATN returns N*N. All other types return 1. * * @param {MetadataType} type The type to get the component count for - * @return {Number} The number of components + * @return {number} The number of components * @private */ MetadataType.getComponentCount = function (type) { @@ -175,7 +175,7 @@ MetadataType.getComponentCount = function (type) { * Get the corresponding vector or matrix class. This is used to simplify * packing and unpacking code. * @param {MetadataType} type The metadata type - * @return {Object} The appropriate CartesianN class for vector types, MatrixN class for matrix types, or undefined otherwise. + * @return {object} The appropriate CartesianN class for vector types, MatrixN class for matrix types, or undefined otherwise. * @private */ MetadataType.getMathType = function (type) { diff --git a/packages/engine/Source/Scene/Model/B3dmLoader.js b/packages/engine/Source/Scene/Model/B3dmLoader.js index c033b7431eb0..ebdb1bbf7115 100644 --- a/packages/engine/Source/Scene/Model/B3dmLoader.js +++ b/packages/engine/Source/Scene/Model/B3dmLoader.js @@ -38,21 +38,21 @@ const FeatureIdAttribute = ModelComponents.FeatureIdAttribute; * @augments ResourceLoader * @private * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Resource} options.b3dmResource The {@link Resource} containing the b3dm. * @param {ArrayBuffer} options.arrayBuffer The array buffer of the b3dm contents. - * @param {Number} [options.byteOffset] The byte offset to the beginning of the b3dm contents in the array buffer. + * @param {number} [options.byteOffset] The byte offset to the beginning of the b3dm contents in the array buffer. * @param {Resource} [options.baseResource] The {@link Resource} that paths in the glTF JSON are relative to. - * @param {Boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective. - * @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.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the glTF is loaded. + * @param {boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective. + * @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.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the glTF is loaded. * @param {Axis} [options.upAxis=Axis.Y] The up-axis of the glTF model. * @param {Axis} [options.forwardAxis=Axis.X] The forward-axis of the glTF model. - * @param {Boolean} [options.loadAttributesAsTypedArray=false] If true, load all attributes as typed arrays instead of GPU buffers. If the attributes are interleaved in the glTF they will be de-interleaved in the typed array. - * @param {Boolean} [options.loadAttributesFor2D=false] If true, load the positions buffer and any instanced attribute buffers as typed arrays for accurately projecting models to 2D. - * @param {Boolean} [options.loadIndicesForWireframe=false] If true, load the index buffer as a typed array. This is useful for creating wireframe indices in WebGL1. - * @param {Boolean} [options.loadPrimitiveOutline=true] If true, load outlines from the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time. - * @param {Boolean} [options.loadForClassification=false] If true and if the model has feature IDs, load the feature IDs and indices as typed arrays. This is useful for batching features for classification. + * @param {boolean} [options.loadAttributesAsTypedArray=false] If true, load all attributes as typed arrays instead of GPU buffers. If the attributes are interleaved in the glTF they will be de-interleaved in the typed array. + * @param {boolean} [options.loadAttributesFor2D=false] If true, load the positions buffer and any instanced attribute buffers as typed arrays for accurately projecting models to 2D. + * @param {boolean} [options.loadIndicesForWireframe=false] If true, load the index buffer as a typed array. This is useful for creating wireframe indices in WebGL1. + * @param {boolean} [options.loadPrimitiveOutline=true] If true, load outlines from the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time. + * @param {boolean} [options.loadForClassification=false] If true and if the model has feature IDs, load the feature IDs and indices as typed arrays. This is useful for batching features for classification. * */ function B3dmLoader(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -133,7 +133,7 @@ Object.defineProperties(B3dmLoader.prototype, { * * @memberof B3dmLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * @private */ @@ -164,7 +164,7 @@ Object.defineProperties(B3dmLoader.prototype, { * * @memberof B3dmLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -192,7 +192,7 @@ Object.defineProperties(B3dmLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ B3dmLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/Model/ClassificationModelDrawCommand.js b/packages/engine/Source/Scene/Model/ClassificationModelDrawCommand.js index 90bc1507fec5..4d23fa50ef79 100644 --- a/packages/engine/Source/Scene/Model/ClassificationModelDrawCommand.js +++ b/packages/engine/Source/Scene/Model/ClassificationModelDrawCommand.js @@ -18,7 +18,7 @@ import StencilOperation from "../StencilOperation.js"; * derived commands and returns only the necessary commands depending on the * given frame state. * - * @param {Object} options An object containing the following options: + * @param {object} options An object containing the following options: * @param {DrawCommand} options.command The draw command from which to derive other commands from. * @param {PrimitiveRenderResources} options.primitiveRenderResources The render resources of the primitive associated with the command. * @@ -348,7 +348,7 @@ Object.defineProperties(ClassificationModelDrawCommand.prototype, { * The batch lengths used to generate multiple draw commands. * * @memberof ClassificationModelDrawCommand.prototype - * @type {Number[]} + * @type {number[]} * * @readonly * @private @@ -363,7 +363,7 @@ Object.defineProperties(ClassificationModelDrawCommand.prototype, { * The batch offsets used to generate multiple draw commands. * * @memberof ClassificationModelDrawCommand.prototype - * @type {Number[]} + * @type {number[]} * * @readonly * @private diff --git a/packages/engine/Source/Scene/Model/CustomShader.js b/packages/engine/Source/Scene/Model/CustomShader.js index 463d277dcb7e..f3cb58ac4130 100644 --- a/packages/engine/Source/Scene/Model/CustomShader.js +++ b/packages/engine/Source/Scene/Model/CustomShader.js @@ -11,9 +11,9 @@ import CustomShaderTranslucencyMode from "./CustomShaderTranslucencyMode.js"; /** * An object describing a uniform, its type, and an initial value * - * @typedef {Object} UniformSpecifier + * @typedef {object} UniformSpecifier * @property {UniformType} type The Glsl type of the uniform. - * @property {Boolean|Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4|TextureUniform} value The initial value of the uniform + * @property {boolean|number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4|TextureUniform} value The initial value of the uniform * * @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. */ @@ -29,13 +29,13 @@ import CustomShaderTranslucencyMode from "./CustomShaderTranslucencyMode.js"; *
  • Using a dictionary automatically de-duplicates variable names
    • *
  • Queries such as variableSet.hasOwnProperty("position") are straightforward
    • * - * @typedef {Object} VariableSet + * @typedef {Object} VariableSet * @private */ /** * Variable sets parsed from the user-defined vertex shader text. - * @typedef {Object} VertexVariableSets + * @typedef {object} VertexVariableSets * @property {VariableSet} attributeSet A set of all unique attributes used in the vertex shader via the vsInput.attributes struct. * @property {VariableSet} featureIdSet A set of all unique feature ID sets used in the vertex shader via the vsInput.featureIds struct. * @property {VariableSet} metadataSet A set of all unique metadata properties used in the vertex shader via the vsInput.metadata struct. @@ -44,7 +44,7 @@ import CustomShaderTranslucencyMode from "./CustomShaderTranslucencyMode.js"; /** * Variable sets parsed from the user-defined fragment shader text. - * @typedef {Object} FragmentVariableSets + * @typedef {object} FragmentVariableSets * @property {VariableSet} attributeSet A set of all unique attributes used in the fragment shader via the fsInput.attributes struct * @property {VariableSet} featureIdSet A set of all unique feature ID sets used in the fragment shader via the fsInput.featureIds struct. * @property {VariableSet} metadataSet A set of all unique metadata properties used in the fragment shader via the fsInput.metadata struct. @@ -74,14 +74,14 @@ import CustomShaderTranslucencyMode from "./CustomShaderTranslucencyMode.js"; * See the {@link https://github.com/CesiumGS/cesium/tree/main/Documentation/CustomShaderGuide|Custom Shader Guide} for more detailed documentation. *

    * - * @param {Object} options An object with the following options + * @param {object} options An object with the following options * @param {CustomShaderMode} [options.mode=CustomShaderMode.MODIFY_MATERIAL] The custom shader mode, which determines how the custom shader code is inserted into the fragment shader. * @param {LightingModel} [options.lightingModel] The lighting model (e.g. PBR or unlit). If present, this overrides the default lighting for the model. * @param {CustomShaderTranslucencyMode} [options.translucencyMode=CustomShaderTranslucencyMode.INHERIT] The translucency mode, which determines how the custom shader will be applied. If the value is CustomShaderTransulcencyMode.OPAQUE or CustomShaderTransulcencyMode.TRANSLUCENT, the custom shader will override settings from the model's material. If the value is CustomShaderTransulcencyMode.INHERIT, the custom shader will render as either opaque or translucent depending on the primitive's material settings. - * @param {Object.} [options.uniforms] A dictionary for user-defined uniforms. The key is the uniform name that will appear in the GLSL code. The value is an object that describes the uniform type and initial value - * @param {Object.} [options.varyings] A dictionary for declaring additional GLSL varyings used in the shader. The key is the varying name that will appear in the GLSL code. The value is the data type of the varying. For each varying, the declaration will be added to the top of the shader automatically. The caller is responsible for assigning a value in the vertex shader and using the value in the fragment shader. - * @param {String} [options.vertexShaderText] The custom vertex shader as a string of GLSL code. It must include a GLSL function called vertexMain. See the example for the expected signature. If not specified, the custom vertex shader step will be skipped in the computed vertex shader. - * @param {String} [options.fragmentShaderText] The custom fragment shader as a string of GLSL code. It must include a GLSL function called fragmentMain. See the example for the expected signature. If not specified, the custom fragment shader step will be skipped in the computed fragment shader. + * @param {Object} [options.uniforms] A dictionary for user-defined uniforms. The key is the uniform name that will appear in the GLSL code. The value is an object that describes the uniform type and initial value + * @param {Object} [options.varyings] A dictionary for declaring additional GLSL varyings used in the shader. The key is the varying name that will appear in the GLSL code. The value is the data type of the varying. For each varying, the declaration will be added to the top of the shader automatically. The caller is responsible for assigning a value in the vertex shader and using the value in the fragment shader. + * @param {string} [options.vertexShaderText] The custom vertex shader as a string of GLSL code. It must include a GLSL function called vertexMain. See the example for the expected signature. If not specified, the custom vertex shader step will be skipped in the computed vertex shader. + * @param {string} [options.fragmentShaderText] The custom fragment shader as a string of GLSL code. It must include a GLSL function called fragmentMain. See the example for the expected signature. If not specified, the custom fragment shader step will be skipped in the computed fragment shader. * * @alias CustomShader * @constructor @@ -141,7 +141,7 @@ function CustomShader(options) { /** * Additional uniforms as declared by the user. * - * @type {Object.} + * @type {Object} * @readonly */ this.uniforms = defaultValue(options.uniforms, defaultValue.EMPTY_OBJECT); @@ -149,21 +149,21 @@ function CustomShader(options) { * Additional varyings as declared by the user. * This is used by {@link CustomShaderPipelineStage} * - * @type {Object.} + * @type {Object} * @readonly */ this.varyings = defaultValue(options.varyings, defaultValue.EMPTY_OBJECT); /** * The user-defined GLSL code for the vertex shader * - * @type {String} + * @type {string} * @readonly */ this.vertexShaderText = options.vertexShaderText; /** * The user-defined GLSL code for the fragment shader * - * @type {String} + * @type {string} * @readonly */ this.fragmentShaderText = options.fragmentShaderText; @@ -205,7 +205,7 @@ function CustomShader(options) { * The map of uniform names to a function that returns a value. This map * is combined with the overall uniform map used by the {@link DrawCommand} * - * @type {Object.} + * @type {Object} * @readonly * @private */ @@ -404,8 +404,8 @@ function validateBuiltinVariables(customShader) { /** * Update the value of a uniform declared in the shader - * @param {String} uniformName The GLSL name of the uniform. This must match one of the uniforms declared in the constructor - * @param {Boolean|Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4|String|Resource} value The new value of the uniform. + * @param {string} uniformName The GLSL name of the uniform. This must match one of the uniforms declared in the constructor + * @param {boolean|number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4|string|Resource} value The new value of the uniform. */ CustomShader.prototype.setUniform = function (uniformName, value) { //>>includeStart('debug', pragmas.debug); @@ -440,7 +440,7 @@ CustomShader.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see CustomShader#destroy * @private diff --git a/packages/engine/Source/Scene/Model/CustomShaderMode.js b/packages/engine/Source/Scene/Model/CustomShaderMode.js index 06ce352d1469..2ba1b8d59dc3 100644 --- a/packages/engine/Source/Scene/Model/CustomShaderMode.js +++ b/packages/engine/Source/Scene/Model/CustomShaderMode.js @@ -2,7 +2,7 @@ * An enum describing how the {@link CustomShader} will be added to the * fragment shader. This determines how the shader interacts with the material. * - * @enum {String} + * @enum {string} * * @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. */ @@ -11,7 +11,7 @@ const CustomShaderMode = { * The custom shader will be used to modify the results of the material stage * before lighting is applied. * - * @type {String} + * @type {string} * @constant */ MODIFY_MATERIAL: "MODIFY_MATERIAL", @@ -19,7 +19,7 @@ const CustomShaderMode = { * The custom shader will be used instead of the material stage. This is a hint * to optimize out the material processing code. * - * @type {String} + * @type {string} * @constant */ REPLACE_MATERIAL: "REPLACE_MATERIAL", @@ -29,7 +29,7 @@ const CustomShaderMode = { * Convert the shader mode to an uppercase identifier for use in GLSL define * directives. For example: #define CUSTOM_SHADER_MODIFY_MATERIAL * @param {CustomShaderMode} customShaderMode The shader mode - * @return {String} The name of the GLSL macro to use + * @return {string} The name of the GLSL macro to use * * @private */ diff --git a/packages/engine/Source/Scene/Model/CustomShaderTranslucencyMode.js b/packages/engine/Source/Scene/Model/CustomShaderTranslucencyMode.js index 65c53408aebe..aa8d5803c7a9 100644 --- a/packages/engine/Source/Scene/Model/CustomShaderTranslucencyMode.js +++ b/packages/engine/Source/Scene/Model/CustomShaderTranslucencyMode.js @@ -2,7 +2,7 @@ * An enum for controling how {@link CustomShader} handles translucency compared with the original * primitive. * - * @enum {Number} + * @enum {number} * * @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. */ @@ -12,21 +12,21 @@ const CustomShaderTranslucencyMode = { * translucent material, the custom shader will also be considered translucent. If the primitive * used an opaque material, the custom shader will be considered opaque. * - * @type {Number} + * @type {number} * @constant */ INHERIT: 0, /** * Force the primitive to render the primitive as opaque, ignoring any material settings. * - * @type {Number} + * @type {number} * @constant */ OPAQUE: 1, /** * Force the primitive to render the primitive as translucent, ignoring any material settings. * - * @type {Number} + * @type {number} * @constant */ TRANSLUCENT: 2, diff --git a/packages/engine/Source/Scene/Model/GeoJsonLoader.js b/packages/engine/Source/Scene/Model/GeoJsonLoader.js index 47b90ebda83e..239edbb679cc 100644 --- a/packages/engine/Source/Scene/Model/GeoJsonLoader.js +++ b/packages/engine/Source/Scene/Model/GeoJsonLoader.js @@ -37,8 +37,8 @@ import BufferUsage from "../../Renderer/BufferUsage.js"; * @augments ResourceLoader * @private * - * @param {Object} options Object with the following properties: - * @param {Object} options.geoJson The GeoJson object. + * @param {object} options Object with the following properties: + * @param {object} options.geoJson The GeoJson object. */ function GeoJsonLoader(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -64,7 +64,7 @@ Object.defineProperties(GeoJsonLoader.prototype, { * * @memberof GeoJsonLoader.prototype * - * @type {Promise.|Undefined} + * @type {Promise|Undefined} * @readonly * @private */ @@ -78,7 +78,7 @@ Object.defineProperties(GeoJsonLoader.prototype, { * * @memberof GeoJsonLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -105,7 +105,7 @@ Object.defineProperties(GeoJsonLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ GeoJsonLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/Model/I3dmLoader.js b/packages/engine/Source/Scene/Model/I3dmLoader.js index b94cbd79b104..0bb74d099817 100644 --- a/packages/engine/Source/Scene/Model/I3dmLoader.js +++ b/packages/engine/Source/Scene/Model/I3dmLoader.js @@ -53,19 +53,19 @@ const Instances = ModelComponents.Instances; * @augments ResourceLoader * @private * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Resource} options.i3dmResource The {@link Resource} containing the i3dm. * @param {ArrayBuffer} options.arrayBuffer The array buffer of the i3dm contents. - * @param {Number} [options.byteOffset=0] The byte offset to the beginning of the i3dm contents in the array buffer. + * @param {number} [options.byteOffset=0] The byte offset to the beginning of the i3dm contents in the array buffer. * @param {Resource} [options.baseResource] The {@link Resource} that paths in the glTF JSON are relative to. - * @param {Boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective. - * @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.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the glTF is loaded. + * @param {boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective. + * @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.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the glTF is loaded. * @param {Axis} [options.upAxis=Axis.Y] The up-axis of the glTF model. * @param {Axis} [options.forwardAxis=Axis.X] The forward-axis of the glTF model. - * @param {Boolean} [options.loadAttributesAsTypedArray=false] Load all attributes as typed arrays instead of GPU buffers. If the attributes are interleaved in the glTF they will be de-interleaved in the typed array. - * @param {Boolean} [options.loadIndicesForWireframe=false] Load the index buffer as a typed array so wireframe indices can be created for WebGL1. - * @param {Boolean} [options.loadPrimitiveOutline=true] If true, load outlines from the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time. + * @param {boolean} [options.loadAttributesAsTypedArray=false] Load all attributes as typed arrays instead of GPU buffers. If the attributes are interleaved in the glTF they will be de-interleaved in the typed array. + * @param {boolean} [options.loadIndicesForWireframe=false] Load the index buffer as a typed array so wireframe indices can be created for WebGL1. + * @param {boolean} [options.loadPrimitiveOutline=true] If true, load outlines from the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time. */ function I3dmLoader(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -144,7 +144,7 @@ Object.defineProperties(I3dmLoader.prototype, { * * @memberof I3dmLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * @private */ @@ -175,7 +175,7 @@ Object.defineProperties(I3dmLoader.prototype, { * * @memberof I3dmLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -204,7 +204,7 @@ Object.defineProperties(I3dmLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ I3dmLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/Model/LightingModel.js b/packages/engine/Source/Scene/Model/LightingModel.js index f36715f3271f..66d2f5795fe3 100644 --- a/packages/engine/Source/Scene/Model/LightingModel.js +++ b/packages/engine/Source/Scene/Model/LightingModel.js @@ -1,7 +1,7 @@ /** * The lighting model to use for lighting a {@link Model}. * - * @enum {Number} + * @enum {number} * * @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. */ @@ -12,7 +12,7 @@ const LightingModel = { * when computing out_FragColor. The alpha mode is still * applied. * - * @type {Number} + * @type {number} * @constant */ UNLIT: 0, @@ -21,7 +21,7 @@ const LightingModel = { * both PBR metallic roughness and PBR specular glossiness. Image-based * lighting is also applied when possible. * - * @type {Number} + * @type {number} * @constant */ PBR: 1, diff --git a/packages/engine/Source/Scene/Model/MaterialPipelineStage.js b/packages/engine/Source/Scene/Model/MaterialPipelineStage.js index 6d7167d1e919..d049899380d5 100644 --- a/packages/engine/Source/Scene/Model/MaterialPipelineStage.js +++ b/packages/engine/Source/Scene/Model/MaterialPipelineStage.js @@ -142,10 +142,10 @@ MaterialPipelineStage.process = function ( * Process a single texture transformation and add it to the shader and uniform map. * * @param {ShaderBuilder} shaderBuilder The shader builder to modify - * @param {Object.} uniformMap The uniform map to modify. + * @param {Object} uniformMap The uniform map to modify. * @param {ModelComponents.TextureReader} textureReader The texture to add to the shader - * @param {String} uniformName The name of the sampler uniform such as u_baseColorTexture - * @param {String} defineName The name of the texture for use in the defines, minus any prefix or suffix. For example, "BASE_COLOR" or "EMISSIVE" + * @param {string} uniformName The name of the sampler uniform such as u_baseColorTexture + * @param {string} defineName The name of the texture for use in the defines, minus any prefix or suffix. For example, "BASE_COLOR" or "EMISSIVE" * * @private */ @@ -180,10 +180,10 @@ function processTextureTransform( * Process a single texture and add it to the shader and uniform map. * * @param {ShaderBuilder} shaderBuilder The shader builder to modify - * @param {Object.} uniformMap The uniform map to modify. + * @param {Object} uniformMap The uniform map to modify. * @param {ModelComponents.TextureReader} textureReader The texture to add to the shader - * @param {String} uniformName The name of the sampler uniform such as u_baseColorTexture - * @param {String} defineName The name of the texture for use in the defines, minus any prefix or suffix. For example, "BASE_COLOR" or "EMISSIVE" + * @param {string} uniformName The name of the sampler uniform such as u_baseColorTexture + * @param {string} defineName The name of the texture for use in the defines, minus any prefix or suffix. For example, "BASE_COLOR" or "EMISSIVE" * * @private */ diff --git a/packages/engine/Source/Scene/Model/MetadataPipelineStage.js b/packages/engine/Source/Scene/Model/MetadataPipelineStage.js index df4ba81ceae3..5bfd442ed656 100644 --- a/packages/engine/Source/Scene/Model/MetadataPipelineStage.js +++ b/packages/engine/Source/Scene/Model/MetadataPipelineStage.js @@ -120,7 +120,7 @@ MetadataPipelineStage.process = function ( * return as a flattened Array * @param {PropertyAttribute[]} propertyAttributes The PropertyAttributes with properties to be described * @param {ModelComponents.Primitive} primitive The primitive to be rendered - * @param {Object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset) + * @param {object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset) * @returns {Object[]} An array of objects containing information about each PropertyAttributeProperty * @private */ @@ -137,7 +137,7 @@ function getPropertyAttributesInfo(propertyAttributes, primitive, statistics) { * Collect info about the properties of a single PropertyAttribute * @param {PropertyAttribute} propertyAttribute The PropertyAttribute with properties to be described * @param {ModelComponents.Primitive} primitive The primitive to be rendered - * @param {Object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset) + * @param {object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset) * @returns {Object[]} An array of objects containing information about each PropertyAttributeProperty * @private */ @@ -177,7 +177,7 @@ function getPropertyAttributeInfo(propertyAttribute, primitive, statistics) { * Collect info about all properties of all propertyTextures, and * return as a flattened Array * @param {PropertyTexture[]} propertyTextures The PropertyTextures with properties to be described - * @param {Object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset) + * @param {object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset) * @returns {Object[]} An array of objects containing information about each PropertyTextureProperty * @private */ @@ -193,7 +193,7 @@ function getPropertyTexturesInfo(propertyTextures, statistics) { /** * Collect info about the properties of a single PropertyTexture * @param {PropertyTexture} propertyTexture The PropertyTexture with properties to be described - * @param {Object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset) + * @param {object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset) * @returns {Object[]} An array of objects containing information about each PropertyTextureProperty * @private */ @@ -278,8 +278,8 @@ const floatConversions = { /** * For a type with integer components, find a corresponding float-component type - * @param {String} type The name of a GLSL type with integer components - * @returns {String} The name of a GLSL type of the same dimension with float components, if available; otherwise the input type + * @param {string} type The name of a GLSL type with integer components + * @returns {string} The name of a GLSL type of the same dimension with float components, if available; otherwise the input type * @private */ function convertToFloatComponents(type) { @@ -354,7 +354,7 @@ function declareStructsAndFunctions(shaderBuilder) { /** * Update the shader for a single PropertyAttributeProperty * @param {PrimitiveRenderResources} renderResources The render resources for the primitive - * @param {Object} propertyInfo Info about the PropertyAttributeProperty + * @param {object} propertyInfo Info about the PropertyAttributeProperty * @private */ function processPropertyAttributeProperty(renderResources, propertyInfo) { @@ -367,7 +367,7 @@ function processPropertyAttributeProperty(renderResources, propertyInfo) { * Add fields to the Metadata struct, and metadata value assignments to the * initializeMetadata function, for a PropertyAttributeProperty * @param {PrimitiveRenderResources} renderResources The render resources for the primitive - * @param {Object} propertyInfo Info about the PropertyAttributeProperty + * @param {object} propertyInfo Info about the PropertyAttributeProperty * @private */ function addPropertyAttributePropertyMetadata(renderResources, propertyInfo) { @@ -423,7 +423,7 @@ function processPropertyTextureProperty(renderResources, propertyInfo) { * Add fields to the Metadata struct, and metadata value expressions to the * initializeMetadata function, for a PropertyTextureProperty * @param {PrimitiveRenderResources} renderResources The render resources for the primitive - * @param {Object} propertyInfo Info about the PropertyTextureProperty + * @param {object} propertyInfo Info about the PropertyTextureProperty * @private */ function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) { @@ -480,7 +480,7 @@ function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) { * to the initializeMetadata function, for a PropertyAttributeProperty or * PropertyTextureProperty * @param {ShaderBuilder} shaderBuilder The shader builder for the primitive - * @param {Object} propertyInfo Info about the PropertyAttributeProperty or PropertyTextureProperty + * @param {object} propertyInfo Info about the PropertyAttributeProperty or PropertyTextureProperty * @private */ function addPropertyMetadataClass(shaderBuilder, propertyInfo) { @@ -525,7 +525,7 @@ function addPropertyMetadataClass(shaderBuilder, propertyInfo) { * expressions to the initializeMetadata function, for a * PropertyAttributeProperty or PropertyTextureProperty * @param {ShaderBuilder} shaderBuilder The shader builder for the primitive - * @param {Object} propertyInfo Info about the PropertyAttributeProperty or PropertyTextureProperty + * @param {object} propertyInfo Info about the PropertyAttributeProperty or PropertyTextureProperty * @private */ function addPropertyMetadataStatistics(shaderBuilder, propertyInfo) { @@ -577,39 +577,38 @@ function addPropertyMetadataStatistics(shaderBuilder, propertyInfo) { /** * Construct GLSL assignment statements to set metadata spec values in a struct * @param {Object[]} fieldNames An object with the following properties: - * @param {String} fieldNames[].specName The name of the property in the spec - * @param {String} fieldNames[].shaderName The name of the property in the shader - * @param {Object} values A source of property values, keyed on fieldNames[].specName - * @param {String} struct The name of the struct to which values will be assigned - * @param {String} type The type of the values to be assigned - * @returns {Array.<{name: String, value}>} Objects containing the property name (in the shader) and a GLSL assignment statement for the property value + * @param {string} fieldNames[].specName The name of the property in the spec + * @param {string} fieldNames[].shaderName The name of the property in the shader + * @param {object} values A source of property values, keyed on fieldNames[].specName + * @param {string} struct The name of the struct to which values will be assigned + * @param {string} type The type of the values to be assigned + * @returns {Array<{name: string, value: any}>} Objects containing the property name (in the shader) and a GLSL assignment statement for the property value * @private */ function getStructAssignments(fieldNames, values, struct, type) { - return defined(values) - ? fieldNames.map(constructAssignment).filter(defined) - : []; - function constructAssignment(field) { const value = values[field.specName]; if (defined(value)) { return `${struct}.${field.shaderName} = ${type}(${value});`; } } + return defined(values) + ? fieldNames.map(constructAssignment).filter(defined) + : []; } /** * Handle offset/scale transform for a property value * This wraps the GLSL value expression with a czm_valueTransform() call * - * @param {Object} options Object with the following properties: - * @param {String} options.valueExpression The GLSL value expression without the transform - * @param {String} options.metadataVariable The name of the GLSL variable that will contain the property value - * @param {String} options.glslType The GLSL type of the variable + * @param {object} options Object with the following properties: + * @param {string} options.valueExpression The GLSL value expression without the transform + * @param {string} options.metadataVariable The name of the GLSL variable that will contain the property value + * @param {string} options.glslType The GLSL type of the variable * @param {ShaderDestination} options.shaderDestination Which shader(s) use this variable * @param {PrimitiveRenderResources} options.renderResources The render resources for this primitive * @param {(PropertyAttributeProperty|PropertyTextureProperty)} options.property The property from which the value is derived - * @returns {String} A wrapped GLSL value expression + * @returns {string} A wrapped GLSL value expression * @private */ function addValueTransformUniforms(options) { diff --git a/packages/engine/Source/Scene/Model/Model.js b/packages/engine/Source/Scene/Model/Model.js index cc1888dc4e07..59980de218e2 100644 --- a/packages/engine/Source/Scene/Model/Model.js +++ b/packages/engine/Source/Scene/Model/Model.js @@ -112,22 +112,22 @@ import StyleCommandsNeeded from "./StyleCommandsNeeded.js"; * * @privateParam {ResourceLoader} options.loader The loader used to load resources for this model. * @privateParam {ModelType} options.type Type of this model, to distinguish individual glTF files from 3D Tiles internally. - * @privateParam {Object} options Object with the following properties: + * @privateParam {object} options Object with the following properties: * @privateParam {Resource} options.resource The Resource to the 3D model. - * @privateParam {Boolean} [options.show=true] Whether or not to render the model. + * @privateParam {boolean} [options.show=true] Whether or not to render the model. * @privateParam {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms the model from model to world coordinates. - * @privateParam {Number} [options.scale=1.0] A uniform scale applied to this model. - * @privateParam {Number} [options.minimumPixelSize=0.0] The approximate minimum pixel size of the model regardless of zoom. - * @privateParam {Number} [options.maximumScale] The maximum scale size of a model. An upper limit for minimumPixelSize. - * @privateParam {Object} [options.id] A user-defined object to return when the model is picked with {@link Scene#pick}. - * @privateParam {Boolean} [options.allowPicking=true] When true, each primitive is pickable with {@link Scene#pick}. - * @privateParam {Boolean} [options.clampAnimations=true] Determines if the model's animations should hold a pose over frames where no keyframes are specified. + * @privateParam {number} [options.scale=1.0] A uniform scale applied to this model. + * @privateParam {number} [options.minimumPixelSize=0.0] The approximate minimum pixel size of the model regardless of zoom. + * @privateParam {number} [options.maximumScale] The maximum scale size of a model. An upper limit for minimumPixelSize. + * @privateParam {object} [options.id] A user-defined object to return when the model is picked with {@link Scene#pick}. + * @privateParam {boolean} [options.allowPicking=true] When true, each primitive is pickable with {@link Scene#pick}. + * @privateParam {boolean} [options.clampAnimations=true] Determines if the model's animations should hold a pose over frames where no keyframes are specified. * @privateParam {ShadowMode} [options.shadows=ShadowMode.ENABLED] Determines whether the model casts or receives shadows from light sources. - * @privateParam {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Draws the bounding sphere for each draw command in the model. - * @privateParam {Boolean} [options.enableDebugWireframe=false] For debugging only. This must be set to true for debugWireframe to work in WebGL1. This cannot be set after the model has loaded. - * @privateParam {Boolean} [options.debugWireframe=false] For debugging only. Draws the model in wireframe. Will only work for WebGL1 if enableDebugWireframe is set to true. - * @privateParam {Boolean} [options.cull=true] Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used. - * @privateParam {Boolean} [options.opaquePass=Pass.OPAQUE] The pass to use in the {@link DrawCommand} for the opaque portions of the model. + * @privateParam {boolean} [options.debugShowBoundingVolume=false] For debugging only. Draws the bounding sphere for each draw command in the model. + * @privateParam {boolean} [options.enableDebugWireframe=false] For debugging only. This must be set to true for debugWireframe to work in WebGL1. This cannot be set after the model has loaded. + * @privateParam {boolean} [options.debugWireframe=false] For debugging only. Draws the model in wireframe. Will only work for WebGL1 if enableDebugWireframe is set to true. + * @privateParam {boolean} [options.cull=true] Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used. + * @privateParam {boolean} [options.opaquePass=Pass.OPAQUE] The pass to use in the {@link DrawCommand} for the opaque portions of the model. * @privateParam {CustomShader} [options.customShader] A custom shader. This will add user-defined GLSL code to the vertex and fragment shaders. Using custom shaders with a {@link Cesium3DTileStyle} may lead to undefined behavior. * @privateParam {Cesium3DTileContent} [options.content] The tile content this model belongs to. This property will be undefined if model is not loaded as part of a tileset. * @privateParam {HeightReference} [options.heightReference=HeightReference.NONE] Determines how the model is drawn relative to terrain. @@ -135,23 +135,23 @@ import StyleCommandsNeeded from "./StyleCommandsNeeded.js"; * @privateParam {DistanceDisplayCondition} [options.distanceDisplayCondition] The condition specifying at what distance from the camera that this model will be displayed. * @privateParam {Color} [options.color] A color that blends with the model's rendered color. * @privateParam {ColorBlendMode} [options.colorBlendMode=ColorBlendMode.HIGHLIGHT] Defines how the color blends with the model. - * @privateParam {Number} [options.colorBlendAmount=0.5] Value used to determine the color strength when the colorBlendMode is MIX. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two. + * @privateParam {number} [options.colorBlendAmount=0.5] Value used to determine the color strength when the colorBlendMode is MIX. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two. * @privateParam {Color} [options.silhouetteColor=Color.RED] The silhouette color. If more than 256 models have silhouettes enabled, there is a small chance that overlapping models will have minor artifacts. - * @privateParam {Number} [options.silhouetteSize=0.0] The size of the silhouette in pixels. - * @privateParam {Boolean} [options.enableShowOutline=true] Whether to enable outlines for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set to false to avoid the additional processing of geometry at load time. When false, the showOutlines and outlineColor options are ignored. - * @privateParam {Boolean} [options.showOutline=true] Whether to display the outline for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. When true, outlines are displayed. When false, outlines are not displayed. + * @privateParam {number} [options.silhouetteSize=0.0] The size of the silhouette in pixels. + * @privateParam {boolean} [options.enableShowOutline=true] Whether to enable outlines for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set to false to avoid the additional processing of geometry at load time. When false, the showOutlines and outlineColor options are ignored. + * @privateParam {boolean} [options.showOutline=true] Whether to display the outline for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. When true, outlines are displayed. When false, outlines are not displayed. * @privateParam {Color} [options.outlineColor=Color.BLACK] The color to use when rendering outlines. * @privateParam {ClippingPlaneCollection} [options.clippingPlanes] The {@link ClippingPlaneCollection} used to selectively disable rendering the model. * @privateParam {Cartesian3} [options.lightColor] The light color when shading the model. When undefined the scene's light color is used instead. * @privateParam {ImageBasedLighting} [options.imageBasedLighting] The properties for managing image-based lighting on this model. - * @privateParam {Boolean} [options.backFaceCulling=true] Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if the model's color is translucent. - * @privateParam {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas. - * @privateParam {Boolean} [options.showCreditsOnScreen=false] Whether to display the credits of this model on screen. + * @privateParam {boolean} [options.backFaceCulling=true] Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if the model's color is translucent. + * @privateParam {Credit|string} [options.credit] A credit for the data source, which is displayed on the canvas. + * @privateParam {boolean} [options.showCreditsOnScreen=false] Whether to display the credits of this model on screen. * @privateParam {SplitDirection} [options.splitDirection=SplitDirection.NONE] The {@link SplitDirection} split to apply to this model. - * @privateParam {Boolean} [options.projectTo2D=false] Whether to accurately project the model's positions in 2D. If this is true, the model will be projected accurately to 2D, but it will use more memory to do so. If this is false, the model will use less memory and will still render in 2D / CV mode, but its positions may be inaccurate. This disables minimumPixelSize and prevents future modification to the model matrix. This also cannot be set after the model has loaded. - * @privateParam {String|Number} [options.featureIdLabel="featureId_0"] Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. - * @privateParam {String|Number} [options.instanceFeatureIdLabel="instanceFeatureId_0"] Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. - * @privateParam {Object} [options.pointCloudShading] Options for constructing a {@link PointCloudShading} object to control point attenuation based on geometric error and lighting. + * @privateParam {boolean} [options.projectTo2D=false] Whether to accurately project the model's positions in 2D. If this is true, the model will be projected accurately to 2D, but it will use more memory to do so. If this is false, the model will use less memory and will still render in 2D / CV mode, but its positions may be inaccurate. This disables minimumPixelSize and prevents future modification to the model matrix. This also cannot be set after the model has loaded. + * @privateParam {string|number} [options.featureIdLabel="featureId_0"] Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. + * @privateParam {string|number} [options.instanceFeatureIdLabel="instanceFeatureId_0"] Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. + * @privateParam {object} [options.pointCloudShading] Options for constructing a {@link PointCloudShading} object to control point attenuation based on geometric error and lighting. * @privateParam {ClassificationType} [options.classificationType] Determines whether terrain, 3D Tiles or both will be classified by this model. This cannot be set after the model has loaded. * @@ -214,7 +214,7 @@ function Model(options) { * The scale value after being clamped by the maximum scale parameter. * Used to adjust bounding spheres without repeated calculation. * - * @type {Number} + * @type {number} * @private */ this._clampedScale = defined(this._maximumScale) @@ -227,7 +227,7 @@ function Model(options) { * Whether or not the ModelSceneGraph should call updateModelMatrix. * This will be true if any of the model matrix, scale, minimum pixel size, or maximum scale are dirty. * - * @type {Number} + * @type {number} * @private */ this._updateModelMatrix = false; @@ -430,7 +430,7 @@ function Model(options) { * {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. * When true, outlines are displayed. When false, outlines are not displayed. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -659,7 +659,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -679,7 +679,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -749,7 +749,7 @@ Object.defineProperties(Model.prototype, { * Determines if the model's animations should hold a pose over frames where no keyframes are specified. * * @memberof Model.prototype - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -768,7 +768,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -941,7 +941,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Number} + * @type {number} * * @private */ @@ -978,7 +978,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Object} + * @type {object} * * @default undefined * @@ -1002,7 +1002,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -1074,7 +1074,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Number} + * @type {number} * * @default 0.5 */ @@ -1115,7 +1115,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Number} + * @type {number} * * @default 0.0 */ @@ -1177,7 +1177,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -1201,7 +1201,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -1234,7 +1234,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -1266,7 +1266,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {String} + * @type {string} * @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. */ featureIdLabel: { @@ -1302,7 +1302,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {String} + * @type {string} * @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. */ instanceFeatureIdLabel: { @@ -1411,7 +1411,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -1435,7 +1435,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Number} + * @type {number} * * @default 1.0 */ @@ -1457,7 +1457,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -1475,7 +1475,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Number} + * @type {number} * * @default 0.0 */ @@ -1498,7 +1498,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Number} + * @type {number} */ maximumScale: { get: function () { @@ -1554,7 +1554,7 @@ Object.defineProperties(Model.prototype, { * * @memberof Model.prototype * - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -1661,7 +1661,7 @@ Object.defineProperties(Model.prototype, { * Returns the node with the given name in the glTF. This is used to * modify a node's transform for user-defined animation. * - * @param {String} name The name of the node in the glTF. + * @param {string} name The name of the node in the glTF. * @returns {ModelNode} The node, or undefined if no node with the name exists. * * @exception {DeveloperError} The model is not loaded. Use Model.readyPromise or wait for Model.ready to be true. @@ -1689,8 +1689,8 @@ Model.prototype.getNode = function (name) { * multiple stage values, call Model.applyArticulations() to * cause the node matrices to be recalculated. * - * @param {String} articulationStageKey The name of the articulation, a space, and the name of the stage. - * @param {Number} value The numeric value of this stage of the articulation. + * @param {string} articulationStageKey The name of the articulation, a space, and the name of the stage. + * @param {number} value The numeric value of this stage of the articulation. * * @exception {DeveloperError} The model is not loaded. Use Model.readyPromise or wait for Model.ready to be true. * @@ -2386,7 +2386,7 @@ function addCreditsToCreditDisplay(model, frameState) { * If the model color's alpha is equal to zero, then it is considered invisible, * not translucent. * - * @returns {Boolean} true if the model is translucent, otherwise false. + * @returns {boolean} true if the model is translucent, otherwise false. * @private */ Model.prototype.isTranslucent = function () { @@ -2398,7 +2398,7 @@ Model.prototype.isTranslucent = function () { * Gets whether or not the model is invisible, i.e. if the model color's alpha * is equal to zero. * - * @returns {Boolean} true if the model is invisible, otherwise false. + * @returns {boolean} true if the model is invisible, otherwise false. * @private */ Model.prototype.isInvisible = function () { @@ -2418,7 +2418,7 @@ function supportsSilhouettes(frameState) { *

    * * @param {FrameState} The frame state. - * @returns {Boolean} true if the model has silhouettes, otherwise false. + * @returns {boolean} true if the model has silhouettes, otherwise false. * @private */ Model.prototype.hasSilhouette = function (frameState) { @@ -2440,7 +2440,7 @@ function supportsSkipLevelOfDetail(frameState) { * is supported (i.e. the context supports stencil buffers). * * @param {FrameState} frameState The frame state. - * @returns {Boolean} true if the model is part of a tileset that uses the skipLevelOfDetail optimization, false otherwise. + * @returns {boolean} true if the model is part of a tileset that uses the skipLevelOfDetail optimization, false otherwise. * @private */ Model.prototype.hasSkipLevelOfDetail = function (frameState) { @@ -2456,7 +2456,7 @@ Model.prototype.hasSkipLevelOfDetail = function (frameState) { /** * Gets whether or not clipping planes are enabled for this model. * - * @returns {Boolean} true if clipping planes are enabled for this model, false. + * @returns {boolean} true if clipping planes are enabled for this model, false. * @private */ Model.prototype.isClippingEnabled = function () { @@ -2474,7 +2474,7 @@ Model.prototype.isClippingEnabled = function () { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see Model#destroy */ @@ -2584,26 +2584,26 @@ Model.prototype.destroyModelResources = function () { *

    * The model can be a traditional glTF asset with a .gltf extension or a Binary glTF using the .glb extension. * - * @param {Object} options Object with the following properties: - * @param {String|Resource} options.url The url to the .gltf or .glb file. - * @param {String|Resource} [options.basePath=''] The base path that paths in the glTF JSON are relative to. - * @param {Boolean} [options.show=true] Whether or not to render the model. + * @param {object} options Object with the following properties: + * @param {string|Resource} options.url The url to the .gltf or .glb file. + * @param {string|Resource} [options.basePath=''] The base path that paths in the glTF JSON are relative to. + * @param {boolean} [options.show=true] Whether or not to render the model. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms the model from model to world coordinates. - * @param {Number} [options.scale=1.0] A uniform scale applied to this model. - * @param {Number} [options.minimumPixelSize=0.0] The approximate minimum pixel size of the model regardless of zoom. - * @param {Number} [options.maximumScale] The maximum scale size of a model. An upper limit for minimumPixelSize. - * @param {Object} [options.id] A user-defined object to return when the model is picked with {@link Scene#pick}. - * @param {Boolean} [options.allowPicking=true] When true, each primitive is pickable with {@link Scene#pick}. - * @param {Boolean} [options.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the model is loaded. - * @param {Boolean} [options.asynchronous=true] Determines if model WebGL resource creation will be spread out over several frames or block until completion once all glTF files are loaded. - * @param {Boolean} [options.clampAnimations=true] Determines if the model's animations should hold a pose over frames where no keyframes are specified. + * @param {number} [options.scale=1.0] A uniform scale applied to this model. + * @param {number} [options.minimumPixelSize=0.0] The approximate minimum pixel size of the model regardless of zoom. + * @param {number} [options.maximumScale] The maximum scale size of a model. An upper limit for minimumPixelSize. + * @param {object} [options.id] A user-defined object to return when the model is picked with {@link Scene#pick}. + * @param {boolean} [options.allowPicking=true] When true, each primitive is pickable with {@link Scene#pick}. + * @param {boolean} [options.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the model is loaded. + * @param {boolean} [options.asynchronous=true] Determines if model WebGL resource creation will be spread out over several frames or block until completion once all glTF files are loaded. + * @param {boolean} [options.clampAnimations=true] Determines if the model's animations should hold a pose over frames where no keyframes are specified. * @param {ShadowMode} [options.shadows=ShadowMode.ENABLED] Determines whether the model casts or receives shadows from light sources. - * @param {Boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Draws the bounding sphere for each draw command in the model. - * @param {Boolean} [options.enableDebugWireframe=false] For debugging only. This must be set to true for debugWireframe to work in WebGL1. This cannot be set after the model has loaded. - * @param {Boolean} [options.debugWireframe=false] For debugging only. Draws the model in wireframe. Will only work for WebGL1 if enableDebugWireframe is set to true. - * @param {Boolean} [options.cull=true] Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used. - * @param {Boolean} [options.opaquePass=Pass.OPAQUE] The pass to use in the {@link DrawCommand} for the opaque portions of the model. + * @param {boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective. + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Draws the bounding sphere for each draw command in the model. + * @param {boolean} [options.enableDebugWireframe=false] For debugging only. This must be set to true for debugWireframe to work in WebGL1. This cannot be set after the model has loaded. + * @param {boolean} [options.debugWireframe=false] For debugging only. Draws the model in wireframe. Will only work for WebGL1 if enableDebugWireframe is set to true. + * @param {boolean} [options.cull=true] Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used. + * @param {boolean} [options.opaquePass=Pass.OPAQUE] The pass to use in the {@link DrawCommand} for the opaque portions of the model. * @param {Axis} [options.upAxis=Axis.Y] The up-axis of the glTF model. * @param {Axis} [options.forwardAxis=Axis.Z] The forward-axis of the glTF model. * @param {CustomShader} [options.customShader] A custom shader. This will add user-defined GLSL code to the vertex and fragment shaders. Using custom shaders with a {@link Cesium3DTileStyle} may lead to undefined behavior. @@ -2613,23 +2613,23 @@ Model.prototype.destroyModelResources = function () { * @param {DistanceDisplayCondition} [options.distanceDisplayCondition] The condition specifying at what distance from the camera that this model will be displayed. * @param {Color} [options.color] A color that blends with the model's rendered color. * @param {ColorBlendMode} [options.colorBlendMode=ColorBlendMode.HIGHLIGHT] Defines how the color blends with the model. - * @param {Number} [options.colorBlendAmount=0.5] Value used to determine the color strength when the colorBlendMode is MIX. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two. + * @param {number} [options.colorBlendAmount=0.5] Value used to determine the color strength when the colorBlendMode is MIX. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two. * @param {Color} [options.silhouetteColor=Color.RED] The silhouette color. If more than 256 models have silhouettes enabled, there is a small chance that overlapping models will have minor artifacts. - * @param {Number} [options.silhouetteSize=0.0] The size of the silhouette in pixels. - * @param {Boolean} [options.enableShowOutline=true] Whether to enable outlines for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time. When false, the showOutlines and outlineColor options are ignored. - * @param {Boolean} [options.showOutline=true] Whether to display the outline for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. When true, outlines are displayed. When false, outlines are not displayed. + * @param {number} [options.silhouetteSize=0.0] The size of the silhouette in pixels. + * @param {boolean} [options.enableShowOutline=true] Whether to enable outlines for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time. When false, the showOutlines and outlineColor options are ignored. + * @param {boolean} [options.showOutline=true] Whether to display the outline for models using the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. When true, outlines are displayed. When false, outlines are not displayed. * @param {Color} [options.outlineColor=Color.BLACK] The color to use when rendering outlines. * @param {ClippingPlaneCollection} [options.clippingPlanes] The {@link ClippingPlaneCollection} used to selectively disable rendering the model. * @param {Cartesian3} [options.lightColor] The light color when shading the model. When undefined the scene's light color is used instead. * @param {ImageBasedLighting} [options.imageBasedLighting] The properties for managing image-based lighting on this model. - * @param {Boolean} [options.backFaceCulling=true] Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if the model's color is translucent. - * @param {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas. - * @param {Boolean} [options.showCreditsOnScreen=false] Whether to display the credits of this model on screen. + * @param {boolean} [options.backFaceCulling=true] Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if the model's color is translucent. + * @param {Credit|string} [options.credit] A credit for the data source, which is displayed on the canvas. + * @param {boolean} [options.showCreditsOnScreen=false] Whether to display the credits of this model on screen. * @param {SplitDirection} [options.splitDirection=SplitDirection.NONE] The {@link SplitDirection} split to apply to this model. - * @param {Boolean} [options.projectTo2D=false] Whether to accurately project the model's positions in 2D. If this is true, the model will be projected accurately to 2D, but it will use more memory to do so. If this is false, the model will use less memory and will still render in 2D / CV mode, but its positions may be inaccurate. This disables minimumPixelSize and prevents future modification to the model matrix. This also cannot be set after the model has loaded. - * @param {String|Number} [options.featureIdLabel="featureId_0"] Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. - * @param {String|Number} [options.instanceFeatureIdLabel="instanceFeatureId_0"] Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. - * @param {Object} [options.pointCloudShading] Options for constructing a {@link PointCloudShading} object to control point attenuation and lighting. + * @param {boolean} [options.projectTo2D=false] Whether to accurately project the model's positions in 2D. If this is true, the model will be projected accurately to 2D, but it will use more memory to do so. If this is false, the model will use less memory and will still render in 2D / CV mode, but its positions may be inaccurate. This disables minimumPixelSize and prevents future modification to the model matrix. This also cannot be set after the model has loaded. + * @param {string|number} [options.featureIdLabel="featureId_0"] Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. + * @param {string|number} [options.instanceFeatureIdLabel="instanceFeatureId_0"] Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority. + * @param {object} [options.pointCloudShading] Options for constructing a {@link PointCloudShading} object to control point attenuation and lighting. * @param {ClassificationType} [options.classificationType] Determines whether terrain, 3D Tiles or both will be classified by this model. This cannot be set after the model has loaded. * * @returns {Model} The newly created model. diff --git a/packages/engine/Source/Scene/Model/ModelAlphaOptions.js b/packages/engine/Source/Scene/Model/ModelAlphaOptions.js index 2393decfa503..050a88670f10 100644 --- a/packages/engine/Source/Scene/Model/ModelAlphaOptions.js +++ b/packages/engine/Source/Scene/Model/ModelAlphaOptions.js @@ -17,7 +17,7 @@ function ModelAlphaOptions() { /** * Determines the alpha threshold below which fragments are discarded * - * @type {Number} + * @type {number} * @private */ this.alphaCutoff = undefined; diff --git a/packages/engine/Source/Scene/Model/ModelAnimation.js b/packages/engine/Source/Scene/Model/ModelAnimation.js index 569cb0133233..c78535b402a0 100644 --- a/packages/engine/Source/Scene/Model/ModelAnimation.js +++ b/packages/engine/Source/Scene/Model/ModelAnimation.js @@ -37,7 +37,7 @@ function ModelAnimation(model, animation, options) { * This is slightly more efficient that not removing it, but if, for example, * time is reversed, the animation is not played again. * - * @type {Boolean} + * @type {boolean} * @default false */ this.removeOnStop = defaultValue(options.removeOnStop, false); @@ -149,7 +149,7 @@ Object.defineProperties(ModelAnimation.prototype, { * * @memberof ModelAnimation.prototype * - * @type {String} + * @type {string} * @readonly */ name: { @@ -196,7 +196,7 @@ Object.defineProperties(ModelAnimation.prototype, { * * @memberof ModelAnimation.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -213,7 +213,7 @@ Object.defineProperties(ModelAnimation.prototype, { * * @memberof ModelAnimation.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -246,7 +246,7 @@ Object.defineProperties(ModelAnimation.prototype, { * * @memberof ModelAnimation.prototype * - * @type {Number} + * @type {number} * @readonly * * @default undefined @@ -284,7 +284,7 @@ Object.defineProperties(ModelAnimation.prototype, { * * @memberof ModelAnimation.prototype * - * @type {Number} + * @type {number} * @readonly * * @default 1.0 @@ -300,7 +300,7 @@ Object.defineProperties(ModelAnimation.prototype, { * * @memberof ModelAnimation.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -387,7 +387,7 @@ function initialize(runtimeAnimation) { /** * Evaluate all animation channels to advance this animation. * - * @param {Number} time The local animation time. + * @param {number} time The local animation time. * * @private */ @@ -403,9 +403,9 @@ ModelAnimation.prototype.animate = function (time) { * A function used to compute the local animation time for a ModelAnimation. * @callback ModelAnimation.AnimationTimeCallback * - * @param {Number} duration The animation's original duration in seconds. - * @param {Number} seconds The seconds since the animation started, in scene time. - * @returns {Number} Returns the local animation time. + * @param {number} duration The animation's original duration in seconds. + * @param {number} seconds The seconds since the animation started, in scene time. + * @returns {number} Returns the local animation time. * * @example * // Use real time for model animation (assuming animateWhilePaused was set to true) diff --git a/packages/engine/Source/Scene/Model/ModelAnimationChannel.js b/packages/engine/Source/Scene/Model/ModelAnimationChannel.js index f0f7bed155b6..a75db523484c 100644 --- a/packages/engine/Source/Scene/Model/ModelAnimationChannel.js +++ b/packages/engine/Source/Scene/Model/ModelAnimationChannel.js @@ -18,7 +18,7 @@ const AnimatedPropertyType = ModelComponents.AnimatedPropertyType; * channel is responsible for interpolating between the keyframe values of an animated * property, then applying the change to the target node. * - * @param {Object} options An object containing the following options: + * @param {object} options An object containing the following options: * @param {ModelComponents.AnimationChannel} options.channel The corresponding animation channel components from the 3D model. * @param {ModelAnimation} options.runtimeAnimation The runtime animation containing this channel. * @param {ModelRuntimeNode} options.runtimeNode The runtime node that this channel will animate. @@ -254,7 +254,7 @@ function initialize(runtimeChannel) { /** * Animates the target node property based on its spline. * - * @param {Number} time The local animation time. + * @param {number} time The local animation time. * * @private */ diff --git a/packages/engine/Source/Scene/Model/ModelAnimationCollection.js b/packages/engine/Source/Scene/Model/ModelAnimationCollection.js index 8c1c0eb76972..0e8a93fe33d7 100644 --- a/packages/engine/Source/Scene/Model/ModelAnimationCollection.js +++ b/packages/engine/Source/Scene/Model/ModelAnimationCollection.js @@ -56,7 +56,7 @@ function ModelAnimationCollection(model) { * to the model's animations. By default, this is based on scene time, so models using * the default will not animate regardless of this setting. * - * @type {Boolean} + * @type {boolean} * @default false */ this.animateWhilePaused = false; @@ -72,7 +72,7 @@ Object.defineProperties(ModelAnimationCollection.prototype, { * * @memberof ModelAnimationCollection.prototype * - * @type {Number} + * @type {number} * @readonly */ length: { @@ -110,15 +110,15 @@ function addAnimation(collection, animation, options) { * This raises the {@link ModelAnimationCollection#animationAdded} event so, for example, a UI can stay in sync. *

    * - * @param {Object} options Object with the following properties: - * @param {String} [options.name] The glTF animation name that identifies the animation. Must be defined if options.index is undefined. - * @param {Number} [options.index] The glTF animation index that identifies the animation. Must be defined if options.name is undefined. + * @param {object} options Object with the following properties: + * @param {string} [options.name] The glTF animation name that identifies the animation. Must be defined if options.index is undefined. + * @param {number} [options.index] The glTF animation index that identifies the animation. Must be defined if options.name is undefined. * @param {JulianDate} [options.startTime] The scene time to start playing the animation. When this is undefined, the animation starts at the next frame. - * @param {Number} [options.delay=0.0] The delay, in seconds, from startTime to start playing. This will only affect the animation if options.loop is ModelAnimationLoop.NONE. + * @param {number} [options.delay=0.0] The delay, in seconds, from startTime to start playing. This will only affect the animation if options.loop is ModelAnimationLoop.NONE. * @param {JulianDate} [options.stopTime] The scene time to stop playing the animation. When this is undefined, the animation is played for its full duration. - * @param {Boolean} [options.removeOnStop=false] When true, the animation is removed after it stops playing. This will only affect the animation if options.loop is ModelAnimationLoop.NONE. - * @param {Number} [options.multiplier=1.0] Values greater than 1.0 increase the speed that the animation is played relative to the scene clock speed; values less than 1.0 decrease the speed. - * @param {Boolean} [options.reverse=false] When true, the animation is played in reverse. + * @param {boolean} [options.removeOnStop=false] When true, the animation is removed after it stops playing. This will only affect the animation if options.loop is ModelAnimationLoop.NONE. + * @param {number} [options.multiplier=1.0] Values greater than 1.0 increase the speed that the animation is played relative to the scene clock speed; values less than 1.0 decrease the speed. + * @param {boolean} [options.reverse=false] When true, the animation is played in reverse. * @param {ModelAnimationLoop} [options.loop=ModelAnimationLoop.NONE] Determines if and how the animation is looped. * @param {ModelAnimation.AnimationTimeCallback} [options.animationTime=undefined] If defined, computes the local animation time for this animation. * @returns {ModelAnimation} The animation that was added to the collection. @@ -230,13 +230,13 @@ ModelAnimationCollection.prototype.add = function (options) { * This raises the {@link ModelAnimationCollection#animationAdded} event for each model so, for example, a UI can stay in sync. *

    * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {JulianDate} [options.startTime] The scene time to start playing the animations. When this is undefined, the animations starts at the next frame. - * @param {Number} [options.delay=0.0] The delay, in seconds, from startTime to start playing. This will only affect the animation if options.loop is ModelAnimationLoop.NONE. + * @param {number} [options.delay=0.0] The delay, in seconds, from startTime to start playing. This will only affect the animation if options.loop is ModelAnimationLoop.NONE. * @param {JulianDate} [options.stopTime] The scene time to stop playing the animations. When this is undefined, the animations are played for its full duration. - * @param {Boolean} [options.removeOnStop=false] When true, the animations are removed after they stop playing. This will only affect the animation if options.loop is ModelAnimationLoop.NONE. - * @param {Number} [options.multiplier=1.0] Values greater than 1.0 increase the speed that the animations play relative to the scene clock speed; values less than 1.0 decrease the speed. - * @param {Boolean} [options.reverse=false] When true, the animations are played in reverse. + * @param {boolean} [options.removeOnStop=false] When true, the animations are removed after they stop playing. This will only affect the animation if options.loop is ModelAnimationLoop.NONE. + * @param {number} [options.multiplier=1.0] Values greater than 1.0 increase the speed that the animations play relative to the scene clock speed; values less than 1.0 decrease the speed. + * @param {boolean} [options.reverse=false] When true, the animations are played in reverse. * @param {ModelAnimationLoop} [options.loop=ModelAnimationLoop.NONE] Determines if and how the animations are looped. * @param {ModelAnimation.AnimationTimeCallback} [options.animationTime=undefined] If defined, computes the local animation time for all of the animations. * @returns {ModelAnimation[]} An array of {@link ModelAnimation} objects, one for each animation added to the collection. If there are no glTF animations, the array is empty. @@ -289,7 +289,7 @@ ModelAnimationCollection.prototype.addAll = function (options) { *

    * * @param {ModelAnimation} runtimeAnimation The runtime animation to remove. - * @returns {Boolean} true if the animation was removed; false if the animation was not found in the collection. + * @returns {boolean} true if the animation was removed; false if the animation was not found in the collection. * * @example * const a = model.activeAnimations.add({ @@ -336,7 +336,7 @@ ModelAnimationCollection.prototype.removeAll = function () { * Determines whether this collection contains a given animation. * * @param {ModelAnimation} runtimeAnimation The runtime animation to check for. - * @returns {Boolean} true if this collection contains the animation, false otherwise. + * @returns {boolean} true if this collection contains the animation, false otherwise. */ ModelAnimationCollection.prototype.contains = function (runtimeAnimation) { if (defined(runtimeAnimation)) { @@ -352,7 +352,7 @@ ModelAnimationCollection.prototype.contains = function (runtimeAnimation) { * it to the left, changing their indices. This function is commonly used to iterate over * all the animations in the collection. * - * @param {Number} index The zero-based index of the animation. + * @param {number} index The zero-based index of the animation. * @returns {ModelAnimation} The runtime animation at the specified index. * * @example @@ -396,7 +396,7 @@ function createAnimationRemovedFunction( * that have stopped. * * @param {FrameState} frameState The current frame state. - * @returns {Boolean} true if an animation played during this update, false otherwise. + * @returns {boolean} true if an animation played during this update, false otherwise. * * @private */ diff --git a/packages/engine/Source/Scene/Model/ModelArticulation.js b/packages/engine/Source/Scene/Model/ModelArticulation.js index dfb743f30acd..401be000165b 100644 --- a/packages/engine/Source/Scene/Model/ModelArticulation.js +++ b/packages/engine/Source/Scene/Model/ModelArticulation.js @@ -9,7 +9,7 @@ import ModelArticulationStage from "./ModelArticulationStage.js"; * {@link ModelSceneGraph}. This is defined in a model by the * AGI_articulations extension. * - * @param {Object} options An object containing the following options: + * @param {object} options An object containing the following options: * @param {ModelComponents.Articulation} options.articulation The articulation components from the 3D model. * @param {ModelSceneGraph} options.sceneGraph The scene graph this articulation belongs to. * @@ -80,7 +80,7 @@ Object.defineProperties(ModelArticulation.prototype, { * The name of this articulation. * * @memberof ModelArticulation.prototype - * @type {String} + * @type {string} * @readonly * * @private @@ -150,8 +150,8 @@ function initialize(runtimeArticulation) { /** * Sets the current value of an articulation stage. * - * @param {String} stageName The name of the articulation stage. - * @param {Number} value The numeric value of this stage of the articulation. + * @param {string} stageName The name of the articulation stage. + * @param {number} value The numeric value of this stage of the articulation. * * @private */ diff --git a/packages/engine/Source/Scene/Model/ModelArticulationStage.js b/packages/engine/Source/Scene/Model/ModelArticulationStage.js index b8aa7d9b6c36..e0805f8aa651 100644 --- a/packages/engine/Source/Scene/Model/ModelArticulationStage.js +++ b/packages/engine/Source/Scene/Model/ModelArticulationStage.js @@ -12,7 +12,7 @@ const articulationEpsilon = CesiumMath.EPSILON16; * An in-memory representation of an articulation stage belonging to a * {@link ModelArticulation}. * - * @param {Object} options An object containing the following options: + * @param {object} options An object containing the following options: * @param {ModelComponents.ArticulationStage} options.stage The articulation stage components from the 3D model. * @param {ModelArticulation} options.runtimeArticulation The runtime articulation that this stage belongs to. * @@ -76,7 +76,7 @@ Object.defineProperties(ModelArticulationStage.prototype, { * The name of this articulation stage. * * @memberof ModelArticulationStage.prototype - * @type {String} + * @type {string} * @readonly * * @private @@ -107,7 +107,7 @@ Object.defineProperties(ModelArticulationStage.prototype, { * The minimum value of this articulation stage. * * @memberof ModelArticulationStage.prototype - * @type {Number} + * @type {number} * @readonly * * @private @@ -122,7 +122,7 @@ Object.defineProperties(ModelArticulationStage.prototype, { * The maximum value of this articulation stage. * * @memberof ModelArticulationStage.prototype - * @type {Number} + * @type {number} * @readonly * * @private @@ -137,7 +137,7 @@ Object.defineProperties(ModelArticulationStage.prototype, { * The current value of this articulation stage. * * @memberof ModelArticulationStage.prototype - * @type {Number} + * @type {number} * * @private */ diff --git a/packages/engine/Source/Scene/Model/ModelDrawCommand.js b/packages/engine/Source/Scene/Model/ModelDrawCommand.js index db756cf01741..a82b75fc4b52 100644 --- a/packages/engine/Source/Scene/Model/ModelDrawCommand.js +++ b/packages/engine/Source/Scene/Model/ModelDrawCommand.js @@ -24,7 +24,7 @@ import StyleCommandsNeeded from "./StyleCommandsNeeded.js"; * This manages the derived commands and pushes only the necessary commands depending * on the given frame state. * - * @param {Object} options An object containing the following options: + * @param {object} options An object containing the following options: * @param {DrawCommand} options.command The draw command from which to derive other commands from. * @param {PrimitiveRenderResources} options.primitiveRenderResources The render resources of the primitive associated with the command. * @@ -346,7 +346,7 @@ Object.defineProperties(ModelDrawCommand.prototype, { * translucent. * * @memberof ModelDrawCommand.prototype - * @type {Boolean} + * @type {boolean} * * @private */ @@ -390,7 +390,7 @@ Object.defineProperties(ModelDrawCommand.prototype, { * Whether to draw the bounding sphere associated with this draw command. * * @memberof ModelDrawCommand.prototype - * @type {Boolean} + * @type {boolean} * * @private */ diff --git a/packages/engine/Source/Scene/Model/ModelFeature.js b/packages/engine/Source/Scene/Model/ModelFeature.js index 80672a0f225d..7dba22eebb80 100644 --- a/packages/engine/Source/Scene/Model/ModelFeature.js +++ b/packages/engine/Source/Scene/Model/ModelFeature.js @@ -16,9 +16,9 @@ import defined from "../../Core/defined.js"; * @alias ModelFeature * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Model} options.model The model the feature belongs to. - * @param {Number} options.featureId The unique integral identifier for this feature. + * @param {number} options.featureId The unique integral identifier for this feature. * * @example * // On mouse over, display all the properties for a feature in the console log. @@ -48,7 +48,7 @@ Object.defineProperties(ModelFeature.prototype, { * * @memberof ModelFeature.prototype * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -123,7 +123,7 @@ Object.defineProperties(ModelFeature.prototype, { * * @memberof ModelFeature.prototype * - * @type {Number} + * @type {number} * * @readonly * @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. @@ -138,8 +138,8 @@ Object.defineProperties(ModelFeature.prototype, { /** * Returns whether the feature contains this property. * - * @param {String} name The case-sensitive name of the property. - * @returns {Boolean} Whether the feature contains this property. + * @param {string} name The case-sensitive name of the property. + * @returns {boolean} Whether the feature contains this property. */ ModelFeature.prototype.hasProperty = function (name) { return this._featureTable.hasProperty(this._featureId, name); @@ -148,7 +148,7 @@ ModelFeature.prototype.hasProperty = function (name) { /** * Returns a copy of the value of the feature's property with the given name. * - * @param {String} name The case-sensitive name of the property. + * @param {string} name The case-sensitive name of the property. * @returns {*} The value of the property or undefined if the feature does not have this property. * * @example @@ -178,7 +178,7 @@ ModelFeature.prototype.getProperty = function (name) { * previous {@link https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_feature_metadata|EXT_feature_metadata Extension} for glTF. *

    * - * @param {String} name The semantic or property ID of the feature. Semantics are checked before property IDs in each granularity of metadata. + * @param {string} name The semantic or property ID of the feature. Semantics are checked before property IDs in each granularity of metadata. * @return {*} The value of the property or undefined if the feature does not have this property. * * @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. @@ -194,8 +194,8 @@ ModelFeature.prototype.getPropertyInherited = function (name) { /** * Returns an array of property IDs for the feature. * - * @param {String[]} [results] An array into which to store the results. - * @returns {String[]} The IDs of the feature's properties. + * @param {string[]} [results] An array into which to store the results. + * @returns {string[]} The IDs of the feature's properties. */ ModelFeature.prototype.getPropertyIds = function (results) { return this._featureTable.getPropertyIds(results); @@ -204,9 +204,9 @@ ModelFeature.prototype.getPropertyIds = function (results) { /** * Sets the value of the feature's property with the given name. * - * @param {String} name The case-sensitive name of the property. + * @param {string} name The case-sensitive name of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * * @exception {DeveloperError} Inherited batch table hierarchy property is read only. * diff --git a/packages/engine/Source/Scene/Model/ModelFeatureTable.js b/packages/engine/Source/Scene/Model/ModelFeatureTable.js index 9fc650f512d8..1a18a39029d8 100644 --- a/packages/engine/Source/Scene/Model/ModelFeatureTable.js +++ b/packages/engine/Source/Scene/Model/ModelFeatureTable.js @@ -13,7 +13,7 @@ import ModelType from "./ModelType.js"; * Manages the {@link ModelFeature}s in a {@link Model}. * Extracts the properties from a {@link PropertyTable}. * - * @param {Object} options An object containing the following options: + * @param {object} options An object containing the following options: * @param {Model} options.model The model that owns this feature table. * @param {PropertyTable} options.propertyTable The property table from the model used to initialize the model. * @@ -68,7 +68,7 @@ Object.defineProperties(ModelFeatureTable.prototype, { * * @memberof ModelFeatureTable.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -85,7 +85,7 @@ Object.defineProperties(ModelFeatureTable.prototype, { * * @memberof ModelFeatureTable.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -105,7 +105,7 @@ Object.defineProperties(ModelFeatureTable.prototype, { * * @memberof ModelFeatureTable.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -288,7 +288,7 @@ ModelFeatureTable.prototype.applyStyle = function (style) { * isDestroyed 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. * * @see ModelFeatureTable#destroy * @private diff --git a/packages/engine/Source/Scene/Model/ModelLightingOptions.js b/packages/engine/Source/Scene/Model/ModelLightingOptions.js index bc00a2b69e04..747034dbe46b 100644 --- a/packages/engine/Source/Scene/Model/ModelLightingOptions.js +++ b/packages/engine/Source/Scene/Model/ModelLightingOptions.js @@ -4,7 +4,7 @@ import LightingModel from "./LightingModel.js"; /** * Options for configuring the {@link LightingPipelineStage} * - * @param {Object} options An object containing the following options + * @param {object} options An object containing the following options * @param {LightingModel} [options.lightingModel=LightingModel.UNLIT] The lighting model to use * * @alias ModelLightingOptions diff --git a/packages/engine/Source/Scene/Model/ModelNode.js b/packages/engine/Source/Scene/Model/ModelNode.js index e0877858924c..2ddc3fb5420b 100644 --- a/packages/engine/Source/Scene/Model/ModelNode.js +++ b/packages/engine/Source/Scene/Model/ModelNode.js @@ -38,7 +38,7 @@ Object.defineProperties(ModelNode.prototype, { * * @memberof ModelNode.prototype * - * @type {String} + * @type {string} * @readonly */ name: { @@ -52,7 +52,7 @@ Object.defineProperties(ModelNode.prototype, { * * @memberof ModelNode.prototype * - * @type {Number} + * @type {number} * @readonly */ id: { @@ -65,7 +65,7 @@ Object.defineProperties(ModelNode.prototype, { * Determines if this node and its children will be shown. * * @memberof ModelNode.prototype - * @type {Boolean} + * @type {boolean} * * @default true */ diff --git a/packages/engine/Source/Scene/Model/ModelRenderResources.js b/packages/engine/Source/Scene/Model/ModelRenderResources.js index d7de0ad2dd77..e3f7610bd852 100644 --- a/packages/engine/Source/Scene/Model/ModelRenderResources.js +++ b/packages/engine/Source/Scene/Model/ModelRenderResources.js @@ -43,7 +43,7 @@ function ModelRenderResources(model) { * A dictionary mapping uniform name to functions that return the uniform * values. * - * @type {Object.} + * @type {Object} * @readonly * * @private @@ -65,7 +65,7 @@ function ModelRenderResources(model) { * The pipeline stages simply set the options, the render state is created * when the {@link DrawCommand} is constructed. * - * @type {Object} + * @type {object} * @readonly * * @private @@ -83,7 +83,7 @@ function ModelRenderResources(model) { * Whether the model has a silhouette. This value indicates what draw commands * are needed and is set by ModelSilhouettePipelineStage. * - * @type {Boolean} + * @type {boolean} * @default false * * @private @@ -95,7 +95,7 @@ function ModelRenderResources(model) { * optimization. This value indicates what draw commands are needed and * is set by TilesetPipelineStage. * - * @type {Boolean} + * @type {boolean} * @default false * * @private diff --git a/packages/engine/Source/Scene/Model/ModelRuntimeNode.js b/packages/engine/Source/Scene/Model/ModelRuntimeNode.js index 41f6caccb59f..ac1eba5e805f 100644 --- a/packages/engine/Source/Scene/Model/ModelRuntimeNode.js +++ b/packages/engine/Source/Scene/Model/ModelRuntimeNode.js @@ -13,12 +13,12 @@ import NodeStatisticsPipelineStage from "./NodeStatisticsPipelineStage.js"; /** * An in-memory representation of a node as part of the {@link ModelSceneGraph}. * - * @param {Object} options An object containing the following options: + * @param {object} options An object containing the following options: * @param {ModelComponents.Node} options.node The corresponding node components from the 3D model. * @param {Matrix4} options.transform The transform of this node, excluding transforms from the node's ancestors or children. * @param {Matrix4} options.transformToRoot The product of the transforms of all the node's ancestors, excluding the node's own transform. * @param {ModelSceneGraph} options.sceneGraph The scene graph this node belongs to. - * @param {Number[]} options.children The indices of the children of this node in the runtime nodes array of the scene graph. + * @param {number[]} options.children The indices of the children of this node in the runtime nodes array of the scene graph. * * @alias ModelRuntimeNode * @constructor @@ -67,7 +67,7 @@ function ModelRuntimeNode(options) { * Whether or not to show this node and its children. This can be toggled * by the user through {@link ModelNode}. * - * @type {Boolean} + * @type {boolean} * * @default true * @@ -81,7 +81,7 @@ function ModelRuntimeNode(options) { * own transform. If this is true, the node will ignore animations in the * model's asset. * - * @type {Boolean} + * @type {boolean} * * @private */ @@ -222,7 +222,7 @@ Object.defineProperties(ModelRuntimeNode.prototype, { * The indices of the children of this node in the scene graph. * * @memberof ModelRuntimeNode.prototype - * @type {Number[]} + * @type {number[]} * @readonly * * @private @@ -438,7 +438,7 @@ Object.defineProperties(ModelRuntimeNode.prototype, { * in the model's asset to affect the node's properties. * * @memberof ModelRuntimeNode.prototype - * @type {Number[]} + * @type {number[]} * * @private */ @@ -541,7 +541,7 @@ function updateTransformFromParameters(runtimeNode, transformParameters) { /** * Returns the child with the given index. * - * @param {Number} index The index of the child. + * @param {number} index The index of the child. * * @returns {ModelRuntimeNode} * diff --git a/packages/engine/Source/Scene/Model/ModelRuntimePrimitive.js b/packages/engine/Source/Scene/Model/ModelRuntimePrimitive.js index 0fce1dd66d30..5593643409ea 100644 --- a/packages/engine/Source/Scene/Model/ModelRuntimePrimitive.js +++ b/packages/engine/Source/Scene/Model/ModelRuntimePrimitive.js @@ -30,7 +30,7 @@ import WireframePipelineStage from "./WireframePipelineStage.js"; * In memory representation of a single primitive, that is, a primitive * and its corresponding mesh. * - * @param {Object} options An object containing the following options: + * @param {object} options An object containing the following options: * @param {ModelComponents.Primitive} options.primitive The primitive component. * @param {ModelComponents.Node} options.node The node that this primitive belongs to. * @param {Model} options.model The {@link Model} this primitive belongs to. @@ -141,7 +141,7 @@ function ModelRuntimePrimitive(options) { * Model; this is just a reference. *

    * - * @type {Number[]} + * @type {number[]} * * @private */ @@ -157,7 +157,7 @@ function ModelRuntimePrimitive(options) { * Model; this is just a reference. *

    * - * @type {Number[]} + * @type {number[]} * * @private */ diff --git a/packages/engine/Source/Scene/Model/ModelSceneGraph.js b/packages/engine/Source/Scene/Model/ModelSceneGraph.js index d7f2d8f8badc..1ff305d3adcf 100644 --- a/packages/engine/Source/Scene/Model/ModelSceneGraph.js +++ b/packages/engine/Source/Scene/Model/ModelSceneGraph.js @@ -28,7 +28,7 @@ import PrimitiveRenderResources from "./PrimitiveRenderResources.js"; /** * An in memory representation of the scene graph for a {@link Model} * - * @param {Object} options An object containing the following options + * @param {object} options An object containing the following options * @param {Model} options.model The model this scene graph belongs to * @param {ModelComponents} options.modelComponents The model components describing the model * @@ -99,7 +99,7 @@ function ModelSceneGraph(options) { /** * The indices of the root nodes in the runtime nodes array. * - * @type {Number[]} + * @type {number[]} * @readonly * * @private @@ -111,7 +111,7 @@ function ModelSceneGraph(options) { * to the nodes that will be manipulated by their skin, as opposed to the nodes * acting as joints for the skin. * - * @type {Number[]} + * @type {number[]} * @readonly * * @private @@ -375,7 +375,7 @@ function computeModelMatrix2D(sceneGraph, frameState) { * @param {ModelSceneGraph} sceneGraph The scene graph * @param {ModelComponents.Node} node The current node * @param {Matrix4} transformToRoot The transforms of this node's ancestors. - * @returns {Number} The index of this node in the runtimeNodes array. + * @returns {number} The index of this node in the runtimeNodes array. * * @private */ @@ -713,7 +713,7 @@ ModelSceneGraph.prototype.updateJointMatrices = function () { * @callback traverseSceneGraphCallback * * @param {ModelRuntimePrimitive} runtimePrimitive The runtime primitive for the current step of the traversal - * @param {Object} [options] A dictionary of additional options to be passed to the callback, or undefined if the callback does not need any additional information. + * @param {object} [options] A dictionary of additional options to be passed to the callback, or undefined if the callback does not need any additional information. * * @private */ @@ -725,9 +725,9 @@ ModelSceneGraph.prototype.updateJointMatrices = function () { * * @param {ModelSceneGraph} sceneGraph The scene graph. * @param {ModelRuntimeNode} runtimeNode The current runtime node. - * @param {Boolean} visibleNodesOnly Whether to only traverse nodes that are visible. + * @param {boolean} visibleNodesOnly Whether to only traverse nodes that are visible. * @param {traverseSceneGraphCallback} callback The callback to perform on the runtime primitives of the node. - * @param {Object} [callbackOptions] A dictionary of additional options to be passed to the callback, if needed. + * @param {object} [callbackOptions] A dictionary of additional options to be passed to the callback, if needed. * * @private */ @@ -790,7 +790,7 @@ const scratchBackFaceCullingOptions = { /** * Traverses through all draw commands and changes the back-face culling setting. * - * @param {Boolean} backFaceCulling The new value for the back-face culling setting. + * @param {boolean} backFaceCulling The new value for the back-face culling setting. * * @private */ @@ -841,7 +841,7 @@ const scratchShowBoundingVolumeOptions = { /** * Traverses through all draw commands and changes whether to show the debug bounding volume. * - * @param {Boolean} debugShowBoundingVolume The new value for showing the debug bounding volume. + * @param {boolean} debugShowBoundingVolume The new value for showing the debug bounding volume. * * @private */ @@ -926,8 +926,8 @@ function pushPrimitiveDrawCommands(runtimePrimitive, options) { /** * Sets the current value of an articulation stage. * - * @param {String} articulationStageKey The name of the articulation, a space, and the name of the stage. - * @param {Number} value The numeric value of this stage of the articulation. + * @param {string} articulationStageKey The name of the articulation, a space, and the name of the stage. + * @param {number} value The numeric value of this stage of the articulation. * * @private */ diff --git a/packages/engine/Source/Scene/Model/ModelSilhouettePipelineStage.js b/packages/engine/Source/Scene/Model/ModelSilhouettePipelineStage.js index d94a052299b3..abcdee908fc0 100644 --- a/packages/engine/Source/Scene/Model/ModelSilhouettePipelineStage.js +++ b/packages/engine/Source/Scene/Model/ModelSilhouettePipelineStage.js @@ -19,7 +19,7 @@ const ModelSilhouettePipelineStage = { * Tracks how many silhouettes have been created. This value is used to * assign a reference number to the stencil. * - * @type {Number} + * @type {number} * @private */ ModelSilhouettePipelineStage.silhouettesLength = 0; diff --git a/packages/engine/Source/Scene/Model/ModelSkin.js b/packages/engine/Source/Scene/Model/ModelSkin.js index 82b85c7e0d35..72f7dca5549c 100644 --- a/packages/engine/Source/Scene/Model/ModelSkin.js +++ b/packages/engine/Source/Scene/Model/ModelSkin.js @@ -7,7 +7,7 @@ import defaultValue from "../../Core/defaultValue.js"; * Skins should only be initialized after all of the {@link ModelRuntimeNode}s have been instantiated * by the scene graph. * - * @param {Object} options An object containing the following options: + * @param {object} options An object containing the following options: * @param {ModelComponents.Skin} options.skin The corresponding skin components from the 3D model * @param {ModelSceneGraph} options.sceneGraph The scene graph this skin belongs to. * diff --git a/packages/engine/Source/Scene/Model/ModelStatistics.js b/packages/engine/Source/Scene/Model/ModelStatistics.js index 3b641cb04220..3188895efc5a 100644 --- a/packages/engine/Source/Scene/Model/ModelStatistics.js +++ b/packages/engine/Source/Scene/Model/ModelStatistics.js @@ -15,7 +15,7 @@ function ModelStatistics() { /** * Total number of points across all POINTS primitives in this model. * - * @type {Number} + * @type {number} * @private */ this.pointsLength = 0; @@ -24,7 +24,7 @@ function ModelStatistics() { * Total number of triangles across all TRIANGLES, TRIANGLE_STRIP or * TRIANGLE_FAN primitives in this model. * - * @type {Number} + * @type {number} * @private */ this.trianglesLength = 0; @@ -35,7 +35,7 @@ function ModelStatistics() { * buffers of all the model's primitives. Any attributes generated by the * pipeline are included in this total. * - * @type {Number} + * @type {number} * @private */ this.geometryByteLength = 0; @@ -44,7 +44,7 @@ function ModelStatistics() { * Total size of all textures in bytes. This includes materials, * feature ID textures, and property textures. * - * @type {Number} + * @type {number} * @private */ this.texturesByteLength = 0; @@ -53,7 +53,7 @@ function ModelStatistics() { * Total size of property tables. This excludes the batch textures used for * picking and styling. * - * @type {Number} + * @type {number} * @private */ this.propertyTablesByteLength = 0; @@ -77,7 +77,7 @@ Object.defineProperties(ModelStatistics.prototype, { * * @memberof ModelStatistics.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -121,7 +121,7 @@ ModelStatistics.prototype.clear = function () { * counted again. * * @param {Buffer} buffer The GPU buffer associated with the model. - * @param {Boolean} hasCpuCopy Whether the buffer has a copy on the CPU via typed array. + * @param {boolean} hasCpuCopy Whether the buffer has a copy on the CPU via typed array. * * @private */ diff --git a/packages/engine/Source/Scene/Model/ModelType.js b/packages/engine/Source/Scene/Model/ModelType.js index afd78417b2c0..56e39db6b383 100644 --- a/packages/engine/Source/Scene/Model/ModelType.js +++ b/packages/engine/Source/Scene/Model/ModelType.js @@ -6,7 +6,7 @@ import DeveloperError from "../../Core/DeveloperError.js"; * which include individual glTF models, and various 3D Tiles formats * (including glTF via 3DTILES_content_gltf). * - * @enum {String} + * @enum {string} * @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. */ @@ -18,7 +18,7 @@ const ModelType = { * which is for 3D Tiles *

    * - * @type {String} + * @type {string} * @constant */ GLTF: "GLTF", @@ -30,28 +30,28 @@ const ModelType = { * which is for individual models *

    * - * @type {String} + * @type {string} * @constant */ TILE_GLTF: "TILE_GLTF", /** * A 3D Tiles 1.0 Batched 3D Model * - * @type {String} + * @type {string} * @constant */ TILE_B3DM: "B3DM", /** * A 3D Tiles 1.0 Instanced 3D Model * - * @type {String} + * @type {string} * @constant */ TILE_I3DM: "I3DM", /** * A 3D Tiles 1.0 Point Cloud * - * @type {String} + * @type {string} * @constant */ TILE_PNTS: "PNTS", @@ -59,7 +59,7 @@ const ModelType = { /** * GeoJSON content for MAXAR_content_geojson extension * - * @type {String} + * @type {string} * @constant */ TILE_GEOJSON: "TILE_GEOJSON", @@ -68,7 +68,7 @@ const ModelType = { /** * Check if a model is used for 3D Tiles. * @param {ModelType} modelType The type of model - * @returns {Boolean} true if the model is a 3D Tiles format, false otherwise + * @returns {boolean} true if the model is a 3D Tiles format, false otherwise */ ModelType.is3DTiles = function (modelType) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Scene/Model/ModelUtility.js b/packages/engine/Source/Scene/Model/ModelUtility.js index b99f9e8076bd..20b06b70167d 100644 --- a/packages/engine/Source/Scene/Model/ModelUtility.js +++ b/packages/engine/Source/Scene/Model/ModelUtility.js @@ -21,8 +21,8 @@ function ModelUtility() {} * Create a function for reporting when a model fails to load * * @param {Model} model The model to report about - * @param {String} type The type of object to report about - * @param {String} path The URI of the model file + * @param {string} type The type of object to report about + * @param {string} path The URI of the model file * @returns {Function} An error function that throws an error for the failed model * * @private @@ -70,7 +70,7 @@ ModelUtility.getNodeTransform = function (node) { * * @param {ModelComponents.Primitive|ModelComponents.Instances} object The primitive components or instances object * @param {VertexAttributeSemantic|InstanceAttributeSemantic} semantic The semantic to search for - * @param {Number} [setIndex] The set index of the semantic. May be undefined for some semantics (POSITION, NORMAL, TRANSLATION, ROTATION, for example) + * @param {number} [setIndex] The set index of the semantic. May be undefined for some semantics (POSITION, NORMAL, TRANSLATION, ROTATION, for example) * @return {ModelComponents.Attribute} The selected attribute, or undefined if not found. * * @private @@ -96,7 +96,7 @@ ModelUtility.getAttributeBySemantic = function (object, semantic, setIndex) { * as custom attributes do not have a semantic. * * @param {ModelComponents.Primitive|ModelComponents.Instances} object The primitive components or instances object - * @param {String} name The name of the attribute as it appears in the model file. + * @param {string} name The name of the attribute as it appears in the model file. * @return {ModelComponents.Attribute} The selected attribute, or undefined if not found. * * @private @@ -117,8 +117,8 @@ ModelUtility.getAttributeByName = function (object, name) { /** * Find a feature ID from an array with label or positionalLabel matching the * given label - * @param {Array.} featureIds - * @param {String} label the label to search for + * @param {ModelComponents.FeatureIdAttribute[]|ModelComponents.FeatureIdImplicitRange[]|ModelComponents.FeatureIdTexture[]} featureIds + * @param {string} label the label to search for * @returns {ModelComponents.FeatureIdAttribute|ModelComponents.FeatureIdImplicitRange|ModelComponents.FeatureIdTexture} The feature ID set if found, otherwise undefined * * @private @@ -215,7 +215,7 @@ const cartesianMinScratch = new Cartesian3(); * @param {Cartesian3} [instancingTranslationMin] The component-wise minimum value of the instancing translation attribute. * @param {Cartesian3} [instancingTranslationMax] The component-wise maximum value of the instancing translation attribute. * - * @returns {Object} An object containing the minimum and maximum position values. + * @returns {object} An object containing the minimum and maximum position values. * * @private */ @@ -324,9 +324,9 @@ ModelUtility.getCullFace = function (modelMatrix, primitiveType) { * // Returns "_1234" * ModelUtility.sanitizeGlslIdentifier("1234"); * - * @param {String} identifier The original identifier. + * @param {string} identifier The original identifier. * - * @returns {String} The sanitized version of the identifier. + * @returns {string} The sanitized version of the identifier. */ ModelUtility.sanitizeGlslIdentifier = function (identifier) { // Remove non-alphanumeric characters and replace with a single underscore. @@ -371,7 +371,7 @@ ModelUtility.supportedExtensions = { * supported. If an unsupported extension is found, this throws * a {@link RuntimeError} with the extension name. * - * @param {Array} extensionsRequired The extensionsRequired array in the glTF. + * @param {string[]} extensionsRequired The extensionsRequired array in the glTF. */ ModelUtility.checkSupportedExtensions = function (extensionsRequired) { const length = extensionsRequired.length; diff --git a/packages/engine/Source/Scene/Model/NodeRenderResources.js b/packages/engine/Source/Scene/Model/NodeRenderResources.js index d81c9600f5d6..aa908ffaee85 100644 --- a/packages/engine/Source/Scene/Model/NodeRenderResources.js +++ b/packages/engine/Source/Scene/Model/NodeRenderResources.js @@ -45,7 +45,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) { * A dictionary mapping uniform name to functions that return the uniform * values. Inherited from the model render resources. * - * @type {Object.} + * @type {Object} * @readonly * * @private @@ -69,7 +69,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) { * when the {@link DrawCommand} is constructed. Inherited from the model * render resources. * - * @type {Object} + * @type {object} * @readonly * * @private @@ -83,7 +83,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) { * Whether the model has a silhouette. This value indicates what draw commands * are needed. Inherited from the model render resources. * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -95,7 +95,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) { * optimization. This value indicates what draw commands are needed. * Inherited from the model render resources. * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -129,7 +129,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) { * The index to give to the next vertex attribute added to the attributes array. * POSITION takes index 0. * - * @type {Number} + * @type {number} * * @private */ @@ -139,7 +139,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) { * The set index to assign to feature ID vertex attribute(s) created from the * offset/repeat in the feature ID attribute. * - * @type {Number} + * @type {number} * @default 0 * * @private @@ -149,7 +149,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) { /** * The number of instances. This value is set by InstancingPipelineStage. * - * @type {Number} + * @type {number} * @default 0 * * @private diff --git a/packages/engine/Source/Scene/Model/PntsLoader.js b/packages/engine/Source/Scene/Model/PntsLoader.js index 58da7fe30aed..ac6013e1cd7f 100644 --- a/packages/engine/Source/Scene/Model/PntsLoader.js +++ b/packages/engine/Source/Scene/Model/PntsLoader.js @@ -42,10 +42,10 @@ const MetallicRoughness = ModelComponents.MetallicRoughness; * @augments ResourceLoader * @private * - * @param {Object} options An object containing the following properties + * @param {object} options An object containing the following properties * @param {ArrayBuffer} options.arrayBuffer The array buffer of the pnts contents - * @param {Number} [options.byteOffset] The byte offset to the beginning of the pnts contents in the array buffer - * @param {Boolean} [options.loadAttributesFor2D=false] If true, load the positions buffer as a typed array for accurately projecting models to 2D. + * @param {number} [options.byteOffset] The byte offset to the beginning of the pnts contents in the array buffer + * @param {boolean} [options.loadAttributesFor2D=false] If true, load the positions buffer as a typed array for accurately projecting models to 2D. */ function PntsLoader(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); @@ -86,7 +86,7 @@ Object.defineProperties(PntsLoader.prototype, { * * @memberof PntsLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * @private */ @@ -100,7 +100,7 @@ Object.defineProperties(PntsLoader.prototype, { * * @memberof PntsLoader.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -144,7 +144,7 @@ Object.defineProperties(PntsLoader.prototype, { /** * Loads the resource. - * @returns {Promise.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} A promise which resolves to the loader when the resource loading is completed. * @private */ PntsLoader.prototype.load = function () { diff --git a/packages/engine/Source/Scene/Model/PointCloudStylingPipelineStage.js b/packages/engine/Source/Scene/Model/PointCloudStylingPipelineStage.js index 369f5d427617..cb8e8af2cfd6 100644 --- a/packages/engine/Source/Scene/Model/PointCloudStylingPipelineStage.js +++ b/packages/engine/Source/Scene/Model/PointCloudStylingPipelineStage.js @@ -355,7 +355,7 @@ function addShaderFunctionsAndDefines(shaderBuilder, shaderFunctionInfo) { * function. * * @param {Function} source The style function. - * @param {String[]} propertyNames The array of property names to add to. + * @param {string[]} propertyNames The array of property names to add to. * * @private */ diff --git a/packages/engine/Source/Scene/Model/PrimitiveOutlineGenerator.js b/packages/engine/Source/Scene/Model/PrimitiveOutlineGenerator.js index 06d2dcf8890c..2e6e73a2cfe6 100644 --- a/packages/engine/Source/Scene/Model/PrimitiveOutlineGenerator.js +++ b/packages/engine/Source/Scene/Model/PrimitiveOutlineGenerator.js @@ -32,10 +32,10 @@ const MAX_GLTF_UINT8_INDEX = 255; * @alias PrimitiveOutlineGenerator * @constructor * - * @param {Number} options Object with the following properties: + * @param {number} options Object with the following properties: * @param {Uint8Array|Uint16Array|Uint32Array} options.triangleIndices The original triangle indices of the primitive. The constructor takes ownership of this typed array as it will be modified internally. Use the updatedTriangleIndices getter to get the final result. - * @param {Number[]} options.outlineIndices The indices of edges in the triangle from the CESIUM_primitive_outline extension - * @param {Number} options.originalVertexCount The original number of vertices in the primitive + * @param {number[]} options.outlineIndices The indices of edges in the triangle from the CESIUM_primitive_outline extension + * @param {number} options.originalVertexCount The original number of vertices in the primitive * @example * // The constructor will compute the updated indices and generate outline * // coordinates. @@ -88,7 +88,7 @@ function PrimitiveOutlineGenerator(options) { /** * How many vertices were originally in the primitive * - * @type {Number} + * @type {number} * * @private */ @@ -120,7 +120,7 @@ function PrimitiveOutlineGenerator(options) { * Array containing the indices of any vertices that must be copied and * appended to the list. * - * @type {Number[]} + * @type {number[]} * * @private */ @@ -294,14 +294,14 @@ function initialize(outlineGenerator) { * and if found, computes outline coordinates for the three vertices. If not * possible, one of the vertices is returned so it can be copied. * - * @param {Number[]} outlineCoordinates An array to store the computed outline coordinates. There are 3 components per vertex. This will be modified in place. - * @param {Number} i0 The index of the first vertex of the triangle. - * @param {Number} i1 The index of the second vertex of the triangle. - * @param {Number} i2 The index of the third vertex of the triangle. - * @param {Boolean} hasEdge01 Whether there is an outline edge between vertices 0 and 1 of the triangle - * @param {Boolean} hasEdge12 Whether there is an outline edge between vertices 1 and 2 of the triangle - * @param {Boolean} hasEdge20 Whether there is an outline edge between vertices 2 and 0 of the triangle - * @returns {Number} If it's not possible to compute consistent outline coordinates for this triangle, the index of the most constrained vertex of i0, i1 and i2 is returned. Otherwise, this function returns undefined to indicate a successful match. + * @param {number[]} outlineCoordinates An array to store the computed outline coordinates. There are 3 components per vertex. This will be modified in place. + * @param {number} i0 The index of the first vertex of the triangle. + * @param {number} i1 The index of the second vertex of the triangle. + * @param {number} i2 The index of the third vertex of the triangle. + * @param {boolean} hasEdge01 Whether there is an outline edge between vertices 0 and 1 of the triangle + * @param {boolean} hasEdge12 Whether there is an outline edge between vertices 1 and 2 of the triangle + * @param {boolean} hasEdge20 Whether there is an outline edge between vertices 2 and 0 of the triangle + * @returns {number} If it's not possible to compute consistent outline coordinates for this triangle, the index of the most constrained vertex of i0, i1 and i2 is returned. Otherwise, this function returns undefined to indicate a successful match. * * @private */ @@ -448,12 +448,12 @@ function matchAndStoreCoordinates( * Then we can find an ordering that works for all three vertices with a * bitwise AND. * - * @param {Number[]} outlineCoordinates The array of outline coordinates - * @param {Number} vertexIndex The index of the vertex to compute the mask for - * @param {Number} a The outline coordinate for edge 2-0 - * @param {Number} b The outline coordinate for edge 0-1 - * @param {Number} c The outline coordinate for edge 1-2 - * @returns {Number} A bitmask with 6 bits where a 1 indicates the corresponding ordering is valid. + * @param {number[]} outlineCoordinates The array of outline coordinates + * @param {number} vertexIndex The index of the vertex to compute the mask for + * @param {number} a The outline coordinate for edge 2-0 + * @param {number} b The outline coordinate for edge 0-1 + * @param {number} c The outline coordinate for edge 1-2 + * @returns {number} A bitmask with 6 bits where a 1 indicates the corresponding ordering is valid. * * @private */ @@ -483,8 +483,8 @@ function computeOrderMask(outlineCoordinates, vertexIndex, a, b, c) { * Compute the popcount for 6-bit integers (values 0-63). This is the * number of 1s in the binary representation of the value. * - * @param {Number} value The value to compute the popcount for - * @returns {Number} The number of 1s in the binary representation of value + * @param {number} value The value to compute the popcount for + * @returns {number} The number of 1s in the binary representation of value * * @private */ @@ -601,7 +601,7 @@ PrimitiveOutlineGenerator.createTexture = function (context) { * mostly 0 values, except for the last value which is brighter to indicate * the outline. * - * @param {Number} size The width of the texture for this mip level + * @param {number} size The width of the texture for this mip level * @returns {Uint8Array} A typed array containing the texels of the mip level * * @private @@ -634,8 +634,8 @@ function createMipLevel(size) { * @alias EdgeSet * @constructor * - * @param {Number[]} edgeIndices An array of vertex indices with an even number of elements where each pair of indices defines an edge. - * @param {Number} originalVertexCount The original number of vertices. This is used for computing a hash function. + * @param {number[]} edgeIndices An array of vertex indices with an even number of elements where each pair of indices defines an edge. + * @param {number} originalVertexCount The original number of vertices. This is used for computing a hash function. * * @private */ @@ -644,7 +644,7 @@ function EdgeSet(edgeIndices, originalVertexCount) { * Original number of vertices in the primitive. This is used for computing * the hash key * - * @type {Number} + * @type {number} * * @private */ @@ -673,9 +673,9 @@ function EdgeSet(edgeIndices, originalVertexCount) { /** * Check if an edge exists in the set. The order of the input vertices does * not matter. - * @param {Number} a The first index - * @param {Number} b The second index - * @returns {Boolean} true if there is an edge between a and b + * @param {number} a The first index + * @param {number} b The second index + * @returns {boolean} true if there is an edge between a and b * * @private */ diff --git a/packages/engine/Source/Scene/Model/PrimitiveRenderResources.js b/packages/engine/Source/Scene/Model/PrimitiveRenderResources.js index 5a0d8d1cceb9..ccf947bd3fd0 100644 --- a/packages/engine/Source/Scene/Model/PrimitiveRenderResources.js +++ b/packages/engine/Source/Scene/Model/PrimitiveRenderResources.js @@ -57,7 +57,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * The index to give to the next vertex attribute added to the attributes * array. POSITION takes index 0. Inherited from the node render resources. * - * @type {Number} + * @type {number} * * @private */ @@ -68,7 +68,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * offset/repeat in the feature ID attribute. Inherited from the node render * resources. * - * @type {Number} + * @type {number} * * @private */ @@ -79,7 +79,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * A dictionary mapping uniform name to functions that return the uniform * values. Inherited from the node render resources. * - * @type {Object.} + * @type {Object} * @readonly * * @private @@ -103,7 +103,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * is created when the {@link DrawCommand} is constructed. Inherited from * the node render resources. * - * @type {Object} + * @type {object} * @readonly * * @private @@ -114,7 +114,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * Whether the model has a silhouette. This value indicates what draw commands * are needed. Inherited from the node render resources. * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -126,7 +126,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * optimization. This value indicates what draw commands are needed. * Inherited from the node render resources. * - * @type {Boolean} + * @type {boolean} * @readonly * * @private @@ -148,7 +148,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * The number of instances. Default is 0, if instancing is not used. * Inherited from the node render resources. * - * @type {Number} + * @type {number} * @readonly * * @private @@ -180,7 +180,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * The number of indices in the primitive. The interpretation of this * depends on the primitive type. * - * @type {Number} + * @type {number} * @readonly * * @private @@ -194,7 +194,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * When present, picking and styling can use this. This value is set by * SelectedFeatureIdPipelineStage. * - * @type {Boolean} + * @type {boolean} * @default false * * @private @@ -287,7 +287,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) { * The shader variable to use for picking. If picking is enabled, this value * is set by PickingPipelineStage. * - * @type {String} + * @type {string} * * @private */ diff --git a/packages/engine/Source/Scene/Model/StyleCommandsNeeded.js b/packages/engine/Source/Scene/Model/StyleCommandsNeeded.js index fe6c1703f553..a673bbf3b1bc 100644 --- a/packages/engine/Source/Scene/Model/StyleCommandsNeeded.js +++ b/packages/engine/Source/Scene/Model/StyleCommandsNeeded.js @@ -2,7 +2,7 @@ * An enum describing what commands (opaque or translucent) are required by * a {@link Cesium3DTileStyle}. * - * @enum {Number} + * @enum {number} * @private */ const StyleCommandsNeeded = { diff --git a/packages/engine/Source/Scene/Model/TextureManager.js b/packages/engine/Source/Scene/Model/TextureManager.js index daff92818191..fb13fda62919 100644 --- a/packages/engine/Source/Scene/Model/TextureManager.js +++ b/packages/engine/Source/Scene/Model/TextureManager.js @@ -29,7 +29,7 @@ function TextureManager() { /** * Get one of the loaded textures - * @param {String} textureId The unique ID of the texture loaded by {@link TextureManager#loadTexture2D} + * @param {string} textureId The unique ID of the texture loaded by {@link TextureManager#loadTexture2D} * @return {Texture} The texture or undefined if no texture exists */ TextureManager.prototype.getTexture = function (textureId) { @@ -60,7 +60,7 @@ function fetchTexture2D(textureManager, textureId, textureUniform) { * Load a texture 2D asynchronously. Note that {@link TextureManager#update} * must be called in the render loop to finish processing the textures. * - * @param {String} textureId A unique ID to identify this texture. + * @param {string} textureId A unique ID to identify this texture. * @param {TextureUniform} textureUniform A description of the texture * * @private @@ -203,7 +203,7 @@ TextureManager.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see TextureManager#destroy * @private diff --git a/packages/engine/Source/Scene/Model/TextureUniform.js b/packages/engine/Source/Scene/Model/TextureUniform.js index b74ddfef8429..ef0b4b809806 100644 --- a/packages/engine/Source/Scene/Model/TextureUniform.js +++ b/packages/engine/Source/Scene/Model/TextureUniform.js @@ -11,17 +11,17 @@ import TextureWrap from "../../Renderer/TextureWrap.js"; * A simple struct that serves as a value of a sampler2D-valued * uniform. This is used with {@link CustomShader} and {@link TextureManager} * - * @param {Object} options An object with the following properties: + * @param {object} options An object with the following properties: * @param {Uint8Array} [options.typedArray] A typed array storing the contents of a texture. Values are stored in row-major order. Since WebGL uses a y-up convention for textures, rows are listed from bottom to top. - * @param {Number} [options.width] The width of the image. Required when options.typedArray is present - * @param {Number} [options.height] The height of the image. Required when options.typedArray is present. - * @param {String|Resource} [options.url] A URL string or resource pointing to a texture image. - * @param {Boolean} [options.repeat=true] When defined, the texture sampler will be set to wrap in both directions + * @param {number} [options.width] The width of the image. Required when options.typedArray is present + * @param {number} [options.height] The height of the image. Required when options.typedArray is present. + * @param {string|Resource} [options.url] A URL string or resource pointing to a texture image. + * @param {boolean} [options.repeat=true] When defined, the texture sampler will be set to wrap in both directions * @param {PixelFormat} [options.pixelFormat=PixelFormat.RGBA] When options.typedArray is defined, this is used to determine the pixel format of the texture * @param {PixelDatatype} [options.pixelDatatype=PixelDatatype.UNSIGNED_BYTE] When options.typedArray is defined, this is the data type of pixel values in the typed array. * @param {TextureMinificationFilter} [options.minificationFilter=TextureMinificationFilter.LINEAR] The minification filter of the texture sampler. * @param {TextureMagnificationFilter} [options.magnificationFilter=TextureMagnificationFilter.LINEAR] The magnification filter of the texture sampler. - * @param {Number} [options.maximumAnisotropy=1.0] The maximum anisotropy of the texture sampler + * @param {number} [options.maximumAnisotropy=1.0] The maximum anisotropy of the texture sampler * * @alias TextureUniform * @constructor diff --git a/packages/engine/Source/Scene/Model/UniformType.js b/packages/engine/Source/Scene/Model/UniformType.js index 999d134042ad..d8cd20aee2ca 100644 --- a/packages/engine/Source/Scene/Model/UniformType.js +++ b/packages/engine/Source/Scene/Model/UniformType.js @@ -2,7 +2,7 @@ * An enum of the basic GLSL uniform types. These can be used with * {@link CustomShader} to declare user-defined uniforms. * - * @enum {String} + * @enum {string} * * @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. */ @@ -10,111 +10,111 @@ const UniformType = { /** * A single floating point value. * - * @type {String} + * @type {string} * @constant */ FLOAT: "float", /** * A vector of 2 floating point values. * - * @type {String} + * @type {string} * @constant */ VEC2: "vec2", /** * A vector of 3 floating point values. * - * @type {String} + * @type {string} * @constant */ VEC3: "vec3", /** * A vector of 4 floating point values. * - * @type {String} + * @type {string} * @constant */ VEC4: "vec4", /** * A single integer value * - * @type {String} + * @type {string} * @constant */ INT: "int", /** * A vector of 2 integer values. * - * @type {String} + * @type {string} * @constant */ INT_VEC2: "ivec2", /** * A vector of 3 integer values. * - * @type {String} + * @type {string} * @constant */ INT_VEC3: "ivec3", /** * A vector of 4 integer values. * - * @type {String} + * @type {string} * @constant */ INT_VEC4: "ivec4", /** * A single boolean value. * - * @type {String} + * @type {string} * @constant */ BOOL: "bool", /** * A vector of 2 boolean values. * - * @type {String} + * @type {string} * @constant */ BOOL_VEC2: "bvec2", /** * A vector of 3 boolean values. * - * @type {String} + * @type {string} * @constant */ BOOL_VEC3: "bvec3", /** * A vector of 4 boolean values. * - * @type {String} + * @type {string} * @constant */ BOOL_VEC4: "bvec4", /** * A 2x2 matrix of floating point values. * - * @type {String} + * @type {string} * @constant */ MAT2: "mat2", /** * A 3x3 matrix of floating point values. * - * @type {String} + * @type {string} * @constant */ MAT3: "mat2", /** * A 3x3 matrix of floating point values. * - * @type {String} + * @type {string} * @constant */ MAT4: "mat4", /** * A 2D sampled texture. - * @type {String} + * @type {string} * @constant */ SAMPLER_2D: "sampler2D", diff --git a/packages/engine/Source/Scene/Model/VaryingType.js b/packages/engine/Source/Scene/Model/VaryingType.js index 53bd15775f73..3b588dd175bb 100644 --- a/packages/engine/Source/Scene/Model/VaryingType.js +++ b/packages/engine/Source/Scene/Model/VaryingType.js @@ -2,7 +2,7 @@ * An enum for the GLSL varying types. These can be used for declaring varyings * in {@link CustomShader} * - * @enum {String} + * @enum {string} * * @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. */ @@ -10,49 +10,49 @@ const VaryingType = { /** * A single floating point value. * - * @type {String} + * @type {string} * @constant */ FLOAT: "float", /** * A vector of 2 floating point values. * - * @type {String} + * @type {string} * @constant */ VEC2: "vec2", /** * A vector of 3 floating point values. * - * @type {String} + * @type {string} * @constant */ VEC3: "vec3", /** * A vector of 4 floating point values. * - * @type {String} + * @type {string} * @constant */ VEC4: "vec4", /** * A 2x2 matrix of floating point values. * - * @type {String} + * @type {string} * @constant */ MAT2: "mat2", /** * A 3x3 matrix of floating point values. * - * @type {String} + * @type {string} * @constant */ MAT3: "mat2", /** * A 3x3 matrix of floating point values. * - * @type {String} + * @type {string} * @constant */ MAT4: "mat4", diff --git a/packages/engine/Source/Scene/ModelAnimationLoop.js b/packages/engine/Source/Scene/ModelAnimationLoop.js index d285da0ff02d..9b661a0bab85 100644 --- a/packages/engine/Source/Scene/ModelAnimationLoop.js +++ b/packages/engine/Source/Scene/ModelAnimationLoop.js @@ -1,7 +1,7 @@ /** * Determines if and how a glTF animation is looped. * - * @enum {Number} + * @enum {number} * * @see ModelAnimationCollection#add */ @@ -9,7 +9,7 @@ const ModelAnimationLoop = { /** * Play the animation once; do not loop it. * - * @type {Number} + * @type {number} * @constant */ NONE: 0, @@ -17,7 +17,7 @@ const ModelAnimationLoop = { /** * Loop the animation playing it from the start immediately after it stops. * - * @type {Number} + * @type {number} * @constant */ REPEAT: 1, @@ -25,7 +25,7 @@ const ModelAnimationLoop = { /** * Loop the animation. First, playing it forward, then in reverse, then forward, and so on. * - * @type {Number} + * @type {number} * @constant */ MIRRORED_REPEAT: 2, diff --git a/packages/engine/Source/Scene/ModelComponents.js b/packages/engine/Source/Scene/ModelComponents.js index 06b3ac503c83..4cbb1e2fec19 100644 --- a/packages/engine/Source/Scene/ModelComponents.js +++ b/packages/engine/Source/Scene/ModelComponents.js @@ -25,7 +25,7 @@ function Quantization() { /** * Whether the quantized attribute is oct-encoded. * - * @type {Boolean} + * @type {boolean} * @private */ this.octEncoded = false; @@ -33,7 +33,7 @@ function Quantization() { /** * Whether the oct-encoded values are stored as ZXY instead of XYZ. This is true when decoding from Draco. * - * @type {Boolean} + * @type {boolean} * @private */ this.octEncodedZXY = false; @@ -43,7 +43,7 @@ function Quantization() { * This is typically computed as (1 << quantizationBits) - 1. * For oct-encoded values this value is a single Number. * - * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} + * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} * @private */ this.normalizationRange = undefined; @@ -53,7 +53,7 @@ function Quantization() { * The type should match the attribute type - e.g. if the attribute type * is AttributeType.VEC4 the offset should be a Cartesian4. * - * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} + * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} * @private */ this.quantizedVolumeOffset = undefined; @@ -63,7 +63,7 @@ function Quantization() { * The type should match the attribute type - e.g. if the attribute type * is AttributeType.VEC4 the dimensions should be a Cartesian4. * - * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} + * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} * @private */ this.quantizedVolumeDimensions = undefined; @@ -75,7 +75,7 @@ function Quantization() { * The type should match the attribute type - e.g. if the attribute type * is AttributeType.VEC4 the dimensions should be a Cartesian4. * - * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} + * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} * @private */ this.quantizedVolumeStepSize = undefined; @@ -118,7 +118,7 @@ function Attribute() { /** * The attribute name. Must be unique within the attributes array. * - * @type {String} + * @type {string} * @private */ this.name = undefined; @@ -182,7 +182,7 @@ function Attribute() { /** * Whether the attribute is normalized. * - * @type {Boolean} + * @type {boolean} * @default false * @private */ @@ -191,7 +191,7 @@ function Attribute() { /** * The number of elements. * - * @type {Number} + * @type {number} * @private */ this.count = undefined; @@ -206,7 +206,7 @@ function Attribute() { * Must be defined for POSITION attributes. *

    * - * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} + * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} * @private */ this.min = undefined; @@ -221,7 +221,7 @@ function Attribute() { * Must be defined for POSITION attributes. *

    * - * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} + * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} * @private */ this.max = undefined; @@ -229,7 +229,7 @@ function Attribute() { /** * A constant value used for all elements when typed array and buffer are undefined. * - * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} + * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} * @private */ this.constant = undefined; @@ -262,7 +262,7 @@ function Attribute() { /** * The byte offset of elements in the buffer. * - * @type {Number} + * @type {number} * @default 0 * @private */ @@ -271,7 +271,7 @@ function Attribute() { /** * The byte stride of elements in the buffer. When undefined the elements are tightly packed. * - * @type {Number} + * @type {number} * @private */ this.byteStride = undefined; @@ -297,7 +297,7 @@ function Indices() { /** * The number of indices. * - * @type {Number} + * @type {number} * @private */ this.count = undefined; @@ -332,7 +332,7 @@ function FeatureIdAttribute() { /** * How many unique features are defined in this set of feature IDs * - * @type {Number} + * @type {number} * @private */ this.featureCount = undefined; @@ -340,7 +340,7 @@ function FeatureIdAttribute() { /** * This value indicates that no feature is indicated with this vertex * - * @type {Number} + * @type {number} * @private */ this.nullFeatureId = undefined; @@ -350,7 +350,7 @@ function FeatureIdAttribute() { * feature IDs are used for classification, but no metadata is associated. * * - * @type {Number} + * @type {number} * @private */ this.propertyTableId = undefined; @@ -358,7 +358,7 @@ function FeatureIdAttribute() { /** * The set index of feature ID attribute containing feature IDs. * - * @type {Number} + * @type {number} * @private */ this.setIndex = undefined; @@ -367,7 +367,7 @@ function FeatureIdAttribute() { * The label to identify this set of feature IDs. This is used in picking, * styling and shaders. * - * @type {String} + * @type {string} * @private */ this.label = undefined; @@ -377,7 +377,7 @@ function FeatureIdAttribute() { * This will always be either "featureId_N" for primitives or * "instanceFeatureId_N" for instances. * - * @type {String} + * @type {string} * @private */ this.positionalLabel = undefined; @@ -397,7 +397,7 @@ function FeatureIdImplicitRange() { /** * How many unique features are defined in this set of feature IDs * - * @type {Number} + * @type {number} * @private */ this.featureCount = undefined; @@ -405,7 +405,7 @@ function FeatureIdImplicitRange() { /** * This value indicates that no feature is indicated with this vertex * - * @type {Number} + * @type {number} * @private */ this.nullFeatureId = undefined; @@ -414,7 +414,7 @@ function FeatureIdImplicitRange() { * The ID of the property table that feature IDs index into. If undefined, * feature IDs are used for classification, but no metadata is associated. * - * @type {Number} + * @type {number} * @private */ this.propertyTableId = undefined; @@ -422,7 +422,7 @@ function FeatureIdImplicitRange() { /** * The first feature ID to use when setIndex is undefined * - * @type {Number} + * @type {number} * @default 0 * @private */ @@ -431,7 +431,7 @@ function FeatureIdImplicitRange() { /** * Number of times each feature ID is repeated before being incremented. * - * @type {Number} + * @type {number} * @private */ this.repeat = undefined; @@ -440,7 +440,7 @@ function FeatureIdImplicitRange() { * The label to identify this set of feature IDs. This is used in picking, * styling and shaders. * - * @type {String} + * @type {string} * @private */ this.label = undefined; @@ -450,7 +450,7 @@ function FeatureIdImplicitRange() { * This will always be either "featureId_N" for primitives or * "instanceFeatureId_N" for instances. * - * @type {String} + * @type {string} * @private */ this.positionalLabel = undefined; @@ -468,7 +468,7 @@ function FeatureIdTexture() { /** * How many unique features are defined in this set of feature IDs * - * @type {Number} + * @type {number} * @private */ this.featureCount = undefined; @@ -476,7 +476,7 @@ function FeatureIdTexture() { /** * This value indicates that no feature is indicated with this texel * - * @type {Number} + * @type {number} * @private */ this.nullFeatureId = undefined; @@ -485,7 +485,7 @@ function FeatureIdTexture() { * The ID of the property table that feature IDs index into. If undefined, * feature IDs are used for classification, but no metadata is associated. * - * @type {String} + * @type {string} * @private */ this.propertyTableId = undefined; @@ -502,7 +502,7 @@ function FeatureIdTexture() { * The label to identify this set of feature IDs. This is used in picking, * styling and shaders. * - * @type {String} + * @type {string} * @private */ this.label = undefined; @@ -512,7 +512,7 @@ function FeatureIdTexture() { * This will always be either "featureId_N" for primitives or * "instanceFeatureId_N" for instances. * - * @type {String} + * @type {string} * @private */ this.positionalLabel = undefined; @@ -589,7 +589,7 @@ function Primitive() { * The feature IDs associated with this primitive. Feature ID types may * be interleaved * - * @type {Array.} + * @type {Array} * @private */ this.featureIds = []; @@ -598,7 +598,7 @@ function Primitive() { * The property texture IDs. These indices correspond to the array of * property textures. * - * @type {Number[]} + * @type {number[]} * @private */ this.propertyTextureIds = []; @@ -607,7 +607,7 @@ function Primitive() { * The property attribute IDs. These indices correspond to the array of * property attributes in the EXT_structural_metadata extension. * - * @type {Number[]} + * @type {number[]} * @private */ this.propertyAttributeIds = []; @@ -643,7 +643,7 @@ function Instances() { * The feature ID attributes associated with this set of instances. * Feature ID attribute types may be interleaved. * - * @type {Array.} + * @type {Array} * @private */ this.featureIds = []; @@ -653,7 +653,7 @@ function Instances() { * use EXT_mesh_gpu_instancing, the transform is applied in object space. For i3dm files, * the instance transform is in world space. * - * @type {Boolean} + * @type {boolean} * @private */ this.transformInWorldSpace = false; @@ -672,7 +672,7 @@ function Skin() { * The index of the skin in the glTF. This is useful for finding the skin * that applies to a node after the skin is instantiated at runtime. * - * @type {Number} + * @type {number} * @private */ this.index = undefined; @@ -706,7 +706,7 @@ function Node() { /** * The name of the node. * - * @type {String} + * @type {string} * @private */ this.name = undefined; @@ -715,7 +715,7 @@ function Node() { * The index of the node in the glTF. This is useful for finding the nodes * that belong to a skin after they have been instantiated at runtime. * - * @type {Number} + * @type {number} * @private */ this.index = undefined; @@ -790,7 +790,7 @@ function Node() { * An array of weights to be applied to the primitives' morph targets. * These are supplied by either the node or its mesh. * - * @type {Number[]} + * @type {number[]} * @private */ this.morphWeights = []; @@ -799,7 +799,7 @@ function Node() { * The name of the articulation affecting this node, as defined by the * AGI_articulations extension. * - * @type {String} + * @type {string} * @private */ this.articulationName = undefined; @@ -828,7 +828,7 @@ function Scene() { * this enum are used to look up the appropriate property on the runtime node. * * @alias {ModelComponents.AnimatedPropertyType} - * @enum {String} + * @enum {string} * * @private */ @@ -852,7 +852,7 @@ function AnimationSampler() { /** * The timesteps of the animation. * - * @type {Number[]} + * @type {number[]} * @private */ this.input = []; @@ -868,7 +868,7 @@ function AnimationSampler() { /** * The keyframe data of the animation. * - * @type {Number[]|Cartesian3[]|Quaternion[]} + * @type {number[]|Cartesian3[]|Quaternion[]} * @private */ this.output = []; @@ -938,7 +938,7 @@ function Animation() { /** * The name of the animation. * - * @type {String} + * @type {string} * @private */ this.name = undefined; @@ -973,7 +973,7 @@ function ArticulationStage() { /** * The name of the articulation stage. * - * @type {String} + * @type {string} * @private */ this.name = undefined; @@ -989,7 +989,7 @@ function ArticulationStage() { /** * The minimum value for the range of motion of this articulation stage. * - * @type {Number} + * @type {number} * @private */ this.minimumValue = undefined; @@ -997,7 +997,7 @@ function ArticulationStage() { /** * The maximum value for the range of motion of this articulation stage. * - * @type {Number} + * @type {number} * @private */ this.maximumValue = undefined; @@ -1005,7 +1005,7 @@ function ArticulationStage() { /** * The initial value for this articulation stage. * - * @type {Number} + * @type {number} * @private */ this.initialValue = undefined; @@ -1023,7 +1023,7 @@ function Articulation() { /** * The name of the articulation. * - * @type {String} + * @type {string} * @private */ this.name = undefined; @@ -1165,7 +1165,7 @@ function TextureReader() { * when textures are shared to avoid attaching a texture in multiple uniform * slots in the shader. * - * @type {Number} + * @type {number} * @private */ this.index = undefined; @@ -1173,7 +1173,7 @@ function TextureReader() { /** * The texture coordinate set. * - * @type {Number} + * @type {number} * @default 0 * @private */ @@ -1190,7 +1190,7 @@ function TextureReader() { /** * The texture channels to read from. When undefined all channels are read. * - * @type {String} + * @type {string} */ this.channels = undefined; } @@ -1234,7 +1234,7 @@ function MetallicRoughness() { /** * The metallic factor. * - * @type {Number} + * @type {number} * @default 1.0 * @private */ @@ -1243,7 +1243,7 @@ function MetallicRoughness() { /** * The roughness factor. * - * @type {Number} + * @type {number} * @default 1.0 * @private */ @@ -1315,7 +1315,7 @@ function SpecularGlossiness() { /** * The glossiness factor. * - * @type {Number} + * @type {number} * @default 1.0 * @private */ @@ -1407,7 +1407,7 @@ function Material() { /** * The alpha cutoff value of the material for the MASK alpha mode. * - * @type {Number} + * @type {number} * @default 0.5 * @private */ @@ -1416,7 +1416,7 @@ function Material() { /** * Specifies whether the material is double sided. * - * @type {Boolean} + * @type {boolean} * @default false * @private */ @@ -1425,7 +1425,7 @@ function Material() { /** * Specifies whether the material is unlit. * - * @type {Boolean} + * @type {boolean} * @default false * @private */ diff --git a/packages/engine/Source/Scene/Moon.js b/packages/engine/Source/Scene/Moon.js index e657320ef248..aef70fb880b3 100644 --- a/packages/engine/Source/Scene/Moon.js +++ b/packages/engine/Source/Scene/Moon.js @@ -17,11 +17,11 @@ import Material from "./Material.js"; * @alias Moon * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.show=true] Determines whether the moon will be rendered. - * @param {String} [options.textureUrl=buildModuleUrl('Assets/Textures/moonSmall.jpg')] The moon texture. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.show=true] Determines whether the moon will be rendered. + * @param {string} [options.textureUrl=buildModuleUrl('Assets/Textures/moonSmall.jpg')] The moon texture. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.MOON] The moon ellipsoid. - * @param {Boolean} [options.onlySunLighting=true] Use the sun as the only light source. + * @param {boolean} [options.onlySunLighting=true] Use the sun as the only light source. * * * @example @@ -40,14 +40,14 @@ function Moon(options) { /** * Determines if the moon will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); /** * The moon texture. - * @type {String} + * @type {string} * @default buildModuleUrl('Assets/Textures/moonSmall.jpg') */ this.textureUrl = url; @@ -56,7 +56,7 @@ function Moon(options) { /** * Use the sun as the only light source. - * @type {Boolean} + * @type {boolean} * @default true */ this.onlySunLighting = defaultValue(options.onlySunLighting, true); @@ -142,7 +142,7 @@ Moon.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see Moon#destroy */ diff --git a/packages/engine/Source/Scene/Multiple3DTileContent.js b/packages/engine/Source/Scene/Multiple3DTileContent.js index b3c71194297f..51b20bb93a45 100644 --- a/packages/engine/Source/Scene/Multiple3DTileContent.js +++ b/packages/engine/Source/Scene/Multiple3DTileContent.js @@ -27,7 +27,7 @@ import preprocess3DTileContent from "./preprocess3DTileContent.js"; * @param {Cesium3DTileset} tileset The tileset this content belongs to * @param {Cesium3DTile} tile The content this content belongs to * @param {Resource} tilesetResource The resource that points to the tileset. This will be used to derive each inner content's resource. - * @param {Object} contentsJson Either the tile JSON containing the contents array (3D Tiles 1.1), or 3DTILES_multiple_contents extension JSON + * @param {object} contentsJson Either the tile JSON containing the contents array (3D Tiles 1.1), or 3DTILES_multiple_contents extension JSON * * @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. @@ -80,7 +80,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * Part of the {@link Cesium3DTileContent} interface. Multiple3DTileContent checks if any of the inner contents have dirty featurePropertiesDirty. * @memberof Multiple3DTileContent.prototype * - * @type {Boolean} + * @type {boolean} * * @private */ @@ -111,7 +111,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * * @memberof Multiple3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -128,7 +128,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * * @memberof Multiple3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -145,7 +145,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * * @memberof Multiple3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -162,7 +162,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * * @memberof Multiple3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -179,7 +179,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * * @memberof Multiple3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -196,7 +196,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * * @memberof Multiple3DTileContent.prototype * - * @type {Number} + * @type {number} * @readonly * * @private @@ -221,7 +221,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * * @memberof Multiple3DTileContent.prototype * - * @type {Promise.|undefined} + * @type {Promise|undefined} * @readonly * * @private @@ -263,7 +263,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * have a single URL, so this returns undefined. * @memberof Multiple3DTileContent.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -327,7 +327,7 @@ Object.defineProperties(Multiple3DTileContent.prototype, { * {@link Cesium3DTileset#debugShowUrl}. * @memberof Multiple3DTileContent.prototype * - * @type {String[]} + * @type {string[]} * @readonly * @private */ @@ -386,7 +386,7 @@ function cancelPendingRequests(multipleContents, originalContentState) { * requests are successfully scheduled. *

    * - * @return {Number} The number of attempted requests that were unable to be scheduled. + * @return {number} The number of attempted requests that were unable to be scheduled. * @private */ Multiple3DTileContent.prototype.requestInnerContents = function () { @@ -419,8 +419,8 @@ Multiple3DTileContent.prototype.requestInnerContents = function () { /** * Check if all requests for inner contents can be scheduled at once. This is slower, but it avoids a potential memory leak. - * @param {String[]} serverKeys The server keys for all of the inner contents - * @return {Boolean} True if the request scheduler has enough open slots for all inner contents + * @param {string[]} serverKeys The server keys for all of the inner contents + * @return {boolean} True if the request scheduler has enough open slots for all inner contents * @private */ function canScheduleAllRequests(serverKeys) { diff --git a/packages/engine/Source/Scene/NeverTileDiscardPolicy.js b/packages/engine/Source/Scene/NeverTileDiscardPolicy.js index 77b6035d8435..555eb450bde1 100644 --- a/packages/engine/Source/Scene/NeverTileDiscardPolicy.js +++ b/packages/engine/Source/Scene/NeverTileDiscardPolicy.js @@ -10,7 +10,7 @@ function NeverTileDiscardPolicy(options) {} /** * 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. */ NeverTileDiscardPolicy.prototype.isReady = function () { return true; @@ -20,7 +20,7 @@ NeverTileDiscardPolicy.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. */ NeverTileDiscardPolicy.prototype.shouldDiscardImage = function (image) { return false; diff --git a/packages/engine/Source/Scene/OIT.js b/packages/engine/Source/Scene/OIT.js index 8e3d4accaafe..4f479831b49e 100644 --- a/packages/engine/Source/Scene/OIT.js +++ b/packages/engine/Source/Scene/OIT.js @@ -131,8 +131,8 @@ function destroyResources(oit) { * @private * @param {OIT} oit * @param {Context} context - * @param {Number} width - * @param {Number} height + * @param {number} width + * @param {number} height */ function updateTextures(oit, context, width, height) { destroyTextures(oit); @@ -165,7 +165,7 @@ function updateTextures(oit, context, width, height) { * @private * @param {OIT} oit * @param {Context} context - * @returns {Boolean} + * @returns {boolean} */ function updateFramebuffers(oit, context) { destroyFramebuffers(oit); @@ -236,8 +236,8 @@ function updateFramebuffers(oit, context) { * @param {Context} context * @param {PassState} passState * @param {Framebuffer} framebuffer - * @param {Boolean} useHDR - * @param {Number} numSamples + * @param {boolean} useHDR + * @param {number} numSamples */ OIT.prototype.update = function ( context, @@ -510,8 +510,8 @@ const alphaShaderSource = * @private * @param {Context} context * @param {ShaderProgram} shaderProgram - * @param {String} keyword - * @param {String} source + * @param {string} keyword + * @param {string} source * @returns {ShaderProgram} */ function getTranslucentShaderProgram(context, shaderProgram, keyword, source) { @@ -941,7 +941,7 @@ OIT.prototype.clear = function (context, passState, clearColor) { /** * @private - * @returns {Boolean} + * @returns {boolean} */ OIT.prototype.isSupported = function () { return this._translucentMRTSupport || this._translucentMultipassSupport; @@ -949,7 +949,7 @@ OIT.prototype.isSupported = function () { /** * @private - * @returns {Boolean} + * @returns {boolean} */ OIT.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/OctahedralProjectedCubeMap.js b/packages/engine/Source/Scene/OctahedralProjectedCubeMap.js index ff54df0c5a0b..8ba8225759d7 100644 --- a/packages/engine/Source/Scene/OctahedralProjectedCubeMap.js +++ b/packages/engine/Source/Scene/OctahedralProjectedCubeMap.js @@ -51,7 +51,7 @@ Object.defineProperties(OctahedralProjectedCubeMap.prototype, { /** * The url to the KTX2 file containing the specular environment map and convoluted mipmaps. * @memberof OctahedralProjectedCubeMap.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -85,7 +85,7 @@ Object.defineProperties(OctahedralProjectedCubeMap.prototype, { /** * The maximum number of mip levels. * @memberOf OctahedralProjectedCubeMap.prototype - * @type {Number} + * @type {number} * @readonly */ maximumMipmapLevel: { @@ -96,7 +96,7 @@ Object.defineProperties(OctahedralProjectedCubeMap.prototype, { /** * Determines if the texture atlas is complete and ready to use. * @memberof OctahedralProjectedCubeMap.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -416,7 +416,7 @@ OctahedralProjectedCubeMap.prototype.update = function (frameState) { * isDestroyed 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. * * @see OctahedralProjectedCubeMap#destroy */ diff --git a/packages/engine/Source/Scene/OpenStreetMapImageryProvider.js b/packages/engine/Source/Scene/OpenStreetMapImageryProvider.js index e45c8a44583c..f3b9c42b1476 100644 --- a/packages/engine/Source/Scene/OpenStreetMapImageryProvider.js +++ b/packages/engine/Source/Scene/OpenStreetMapImageryProvider.js @@ -12,17 +12,17 @@ const defaultCredit = new Credit( ); /** - * @typedef {Object} OpenStreetMapImageryProvider.ConstructorOptions + * @typedef {object} OpenStreetMapImageryProvider.ConstructorOptions * * Initialization options for the OpenStreetMapImageryProvider constructor * - * @property {String} [url='https://a.tile.openstreetmap.org'] The OpenStreetMap server url. - * @property {String} [fileExtension='png'] The file extension for images on the server. + * @property {string} [url='https://a.tile.openstreetmap.org'] The OpenStreetMap server url. + * @property {string} [fileExtension='png'] The file extension for images on the server. * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle of the layer. - * @property {Number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. - * @property {Number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. + * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. + * @property {number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. * @property {Ellipsoid} [ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used. - * @property {Credit|String} [credit='MapQuest, Open Street Map and contributors, CC-BY-SA'] A credit for the data source, which is displayed on the canvas. + * @property {Credit|string} [credit='MapQuest, Open Street Map and contributors, CC-BY-SA'] A credit for the data source, which is displayed on the canvas. */ /** diff --git a/packages/engine/Source/Scene/OrderedGroundPrimitiveCollection.js b/packages/engine/Source/Scene/OrderedGroundPrimitiveCollection.js index 5d682f3acc99..f52d0cb95301 100644 --- a/packages/engine/Source/Scene/OrderedGroundPrimitiveCollection.js +++ b/packages/engine/Source/Scene/OrderedGroundPrimitiveCollection.js @@ -23,7 +23,7 @@ Object.defineProperties(OrderedGroundPrimitiveCollection.prototype, { * * @memberof OrderedGroundPrimitiveCollection.prototype * - * @type {Number} + * @type {number} * @readonly */ length: { @@ -37,7 +37,7 @@ Object.defineProperties(OrderedGroundPrimitiveCollection.prototype, { * Adds a primitive to the collection. * * @param {GroundPrimitive} primitive The primitive to add. - * @param {Number} [zIndex = 0] The index of the primitive + * @param {number} [zIndex = 0] The index of the primitive * @returns {GroundPrimitive} The primitive added to the collection. */ OrderedGroundPrimitiveCollection.prototype.add = function (primitive, zIndex) { @@ -72,7 +72,7 @@ OrderedGroundPrimitiveCollection.prototype.add = function (primitive, zIndex) { /** * Adjusts the z-index * @param {GroundPrimitive} primitive - * @param {Number} zIndex + * @param {number} zIndex */ OrderedGroundPrimitiveCollection.prototype.set = function (primitive, zIndex) { //>>includeStart('debug', pragmas.debug); @@ -93,9 +93,9 @@ OrderedGroundPrimitiveCollection.prototype.set = function (primitive, zIndex) { /** * Removes a primitive from the collection. * - * @param {Object} primitive The primitive to remove. - * @param {Boolean} [doNotDestroy = false] - * @returns {Boolean} true if the primitive was removed; false if the primitive is undefined or was not found in the collection. + * @param {object} primitive The primitive to remove. + * @param {boolean} [doNotDestroy = false] + * @returns {boolean} true if the primitive was removed; false if the primitive is undefined or was not found in the collection. */ OrderedGroundPrimitiveCollection.prototype.remove = function ( primitive, @@ -153,8 +153,8 @@ OrderedGroundPrimitiveCollection.prototype.removeAll = function () { /** * Determines if this collection contains a primitive. * - * @param {Object} primitive The primitive to check for. - * @returns {Boolean} true if the primitive is in the collection; false if the primitive is undefined or was not found in the collection. + * @param {object} primitive The primitive to check for. + * @returns {boolean} true if the primitive is in the collection; false if the primitive is undefined or was not found in the collection. */ OrderedGroundPrimitiveCollection.prototype.contains = function (primitive) { if (!defined(primitive)) { @@ -184,7 +184,7 @@ OrderedGroundPrimitiveCollection.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see OrderedGroundPrimitiveCollection#destroy */ diff --git a/packages/engine/Source/Scene/Particle.js b/packages/engine/Source/Scene/Particle.js index eac5a196e5e8..a304f03475eb 100644 --- a/packages/engine/Source/Scene/Particle.js +++ b/packages/engine/Source/Scene/Particle.js @@ -12,16 +12,16 @@ const defaultSize = new Cartesian2(1.0, 1.0); * @alias Particle * @constructor * - * @param {Object} options An object with the following properties: - * @param {Number} [options.mass=1.0] The mass of the particle in kilograms. + * @param {object} options An object with the following properties: + * @param {number} [options.mass=1.0] The mass of the particle in kilograms. * @param {Cartesian3} [options.position=Cartesian3.ZERO] The initial position of the particle in world coordinates. * @param {Cartesian3} [options.velocity=Cartesian3.ZERO] The velocity vector of the particle in world coordinates. - * @param {Number} [options.life=Number.MAX_VALUE] The life of the particle in seconds. - * @param {Object} [options.image] The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard. + * @param {number} [options.life=Number.MAX_VALUE] The life of the particle in seconds. + * @param {object} [options.image] The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard. * @param {Color} [options.startColor=Color.WHITE] The color of a particle when it is born. * @param {Color} [options.endColor=Color.WHITE] The color of a particle when it dies. - * @param {Number} [options.startScale=1.0] The scale of the particle when it is born. - * @param {Number} [options.endScale=1.0] The scale of the particle when it dies. + * @param {number} [options.startScale=1.0] The scale of the particle when it is born. + * @param {number} [options.endScale=1.0] The scale of the particle when it dies. * @param {Cartesian2} [options.imageSize=new Cartesian2(1.0, 1.0)] The dimensions, width by height, to scale the particle image in pixels. */ function Particle(options) { @@ -29,7 +29,7 @@ function Particle(options) { /** * The mass of the particle in kilograms. - * @type {Number} + * @type {number} * @default 1.0 */ this.mass = defaultValue(options.mass, 1.0); @@ -51,13 +51,13 @@ function Particle(options) { ); /** * The life of the particle in seconds. - * @type {Number} + * @type {number} * @default Number.MAX_VALUE */ this.life = defaultValue(options.life, Number.MAX_VALUE); /** * The image to use for the particle. - * @type {Object} + * @type {object} * @default undefined */ this.image = options.image; @@ -75,13 +75,13 @@ function Particle(options) { this.endColor = Color.clone(defaultValue(options.endColor, Color.WHITE)); /** * the scale of the particle when it is born. - * @type {Number} + * @type {number} * @default 1.0 */ this.startScale = defaultValue(options.startScale, 1.0); /** * The scale of the particle when it dies. - * @type {Number} + * @type {number} * @default 1.0 */ this.endScale = defaultValue(options.endScale, 1.0); @@ -105,7 +105,7 @@ Object.defineProperties(Particle.prototype, { /** * Gets the age of the particle in seconds. * @memberof Particle.prototype - * @type {Number} + * @type {number} */ age: { get: function () { @@ -115,7 +115,7 @@ Object.defineProperties(Particle.prototype, { /** * Gets the age normalized to a value in the range [0.0, 1.0]. * @memberof Particle.prototype - * @type {Number} + * @type {number} */ normalizedAge: { get: function () { diff --git a/packages/engine/Source/Scene/ParticleBurst.js b/packages/engine/Source/Scene/ParticleBurst.js index ac486fb9f556..d1ef8b720c10 100644 --- a/packages/engine/Source/Scene/ParticleBurst.js +++ b/packages/engine/Source/Scene/ParticleBurst.js @@ -6,29 +6,29 @@ import defaultValue from "../Core/defaultValue.js"; * @alias ParticleBurst * @constructor * - * @param {Object} [options] An object with the following properties: - * @param {Number} [options.time=0.0] The time in seconds after the beginning of the particle system's lifetime that the burst will occur. - * @param {Number} [options.minimum=0.0] The minimum number of particles emmitted in the burst. - * @param {Number} [options.maximum=50.0] The maximum number of particles emitted in the burst. + * @param {object} [options] An object with the following properties: + * @param {number} [options.time=0.0] The time in seconds after the beginning of the particle system's lifetime that the burst will occur. + * @param {number} [options.minimum=0.0] The minimum number of particles emmitted in the burst. + * @param {number} [options.maximum=50.0] The maximum number of particles emitted in the burst. */ function ParticleBurst(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); /** * The time in seconds after the beginning of the particle system's lifetime that the burst will occur. - * @type {Number} + * @type {number} * @default 0.0 */ this.time = defaultValue(options.time, 0.0); /** * The minimum number of particles emitted. - * @type {Number} + * @type {number} * @default 0.0 */ this.minimum = defaultValue(options.minimum, 0.0); /** * The maximum number of particles emitted. - * @type {Number} + * @type {number} * @default 50.0 */ this.maximum = defaultValue(options.maximum, 50.0); @@ -40,7 +40,7 @@ Object.defineProperties(ParticleBurst.prototype, { /** * true if the burst has been completed; false otherwise. * @memberof ParticleBurst.prototype - * @type {Boolean} + * @type {boolean} */ complete: { get: function () { diff --git a/packages/engine/Source/Scene/ParticleSystem.js b/packages/engine/Source/Scene/ParticleSystem.js index d8ca0918a2e1..acb93e907257 100644 --- a/packages/engine/Source/Scene/ParticleSystem.js +++ b/packages/engine/Source/Scene/ParticleSystem.js @@ -21,36 +21,36 @@ const defaultImageSize = new Cartesian2(1.0, 1.0); * @alias ParticleSystem * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.show=true] Whether to display the particle system. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.show=true] Whether to display the particle system. * @param {ParticleSystem.updateCallback} [options.updateCallback] The callback function to be called each frame to update a particle. * @param {ParticleEmitter} [options.emitter=new CircleEmitter(0.5)] The particle emitter for this system. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms the particle system from model to world coordinates. * @param {Matrix4} [options.emitterModelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms the particle system emitter within the particle systems local coordinate system. - * @param {Number} [options.emissionRate=5] The number of particles to emit per second. + * @param {number} [options.emissionRate=5] The number of particles to emit per second. * @param {ParticleBurst[]} [options.bursts] An array of {@link ParticleBurst}, emitting bursts of particles at periodic times. - * @param {Boolean} [options.loop=true] Whether the particle system should loop its bursts when it is complete. - * @param {Number} [options.scale=1.0] Sets the scale to apply to the image of the particle for the duration of its particleLife. - * @param {Number} [options.startScale] The initial scale to apply to the image of the particle at the beginning of its life. - * @param {Number} [options.endScale] The final scale to apply to the image of the particle at the end of its life. + * @param {boolean} [options.loop=true] Whether the particle system should loop its bursts when it is complete. + * @param {number} [options.scale=1.0] Sets the scale to apply to the image of the particle for the duration of its particleLife. + * @param {number} [options.startScale] The initial scale to apply to the image of the particle at the beginning of its life. + * @param {number} [options.endScale] The final scale to apply to the image of the particle at the end of its life. * @param {Color} [options.color=Color.WHITE] Sets the color of a particle for the duration of its particleLife. * @param {Color} [options.startColor] The color of the particle at the beginning of its life. * @param {Color} [options.endColor] The color of the particle at the end of its life. - * @param {Object} [options.image] The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard. + * @param {object} [options.image] The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard. * @param {Cartesian2} [options.imageSize=new Cartesian2(1.0, 1.0)] If set, overrides the minimumImageSize and maximumImageSize inputs that scale the particle image's dimensions in pixels. * @param {Cartesian2} [options.minimumImageSize] Sets the minimum bound, width by height, above which to randomly scale the particle image's dimensions in pixels. * @param {Cartesian2} [options.maximumImageSize] Sets the maximum bound, width by height, below which to randomly scale the particle image's dimensions in pixels. - * @param {Boolean} [options.sizeInMeters] Sets if the size of particles is in meters or pixels. true to size the particles in meters; otherwise, the size is in pixels. - * @param {Number} [options.speed=1.0] If set, overrides the minimumSpeed and maximumSpeed inputs with this value. - * @param {Number} [options.minimumSpeed] Sets the minimum bound in meters per second above which a particle's actual speed will be randomly chosen. - * @param {Number} [options.maximumSpeed] Sets the maximum bound in meters per second below which a particle's actual speed will be randomly chosen. - * @param {Number} [options.lifetime=Number.MAX_VALUE] How long the particle system will emit particles, in seconds. - * @param {Number} [options.particleLife=5.0] If set, overrides the minimumParticleLife and maximumParticleLife inputs with this value. - * @param {Number} [options.minimumParticleLife] Sets the minimum bound in seconds for the possible duration of a particle's life above which a particle's actual life will be randomly chosen. - * @param {Number} [options.maximumParticleLife] Sets the maximum bound in seconds for the possible duration of a particle's life below which a particle's actual life will be randomly chosen. - * @param {Number} [options.mass=1.0] Sets the minimum and maximum mass of particles in kilograms. - * @param {Number} [options.minimumMass] Sets the minimum bound for the mass of a particle in kilograms. A particle's actual mass will be chosen as a random amount above this value. - * @param {Number} [options.maximumMass] Sets the maximum mass of particles in kilograms. A particle's actual mass will be chosen as a random amount below this value. + * @param {boolean} [options.sizeInMeters] Sets if the size of particles is in meters or pixels. true to size the particles in meters; otherwise, the size is in pixels. + * @param {number} [options.speed=1.0] If set, overrides the minimumSpeed and maximumSpeed inputs with this value. + * @param {number} [options.minimumSpeed] Sets the minimum bound in meters per second above which a particle's actual speed will be randomly chosen. + * @param {number} [options.maximumSpeed] Sets the maximum bound in meters per second below which a particle's actual speed will be randomly chosen. + * @param {number} [options.lifetime=Number.MAX_VALUE] How long the particle system will emit particles, in seconds. + * @param {number} [options.particleLife=5.0] If set, overrides the minimumParticleLife and maximumParticleLife inputs with this value. + * @param {number} [options.minimumParticleLife] Sets the minimum bound in seconds for the possible duration of a particle's life above which a particle's actual life will be randomly chosen. + * @param {number} [options.maximumParticleLife] Sets the maximum bound in seconds for the possible duration of a particle's life below which a particle's actual life will be randomly chosen. + * @param {number} [options.mass=1.0] Sets the minimum and maximum mass of particles in kilograms. + * @param {number} [options.minimumMass] Sets the minimum bound for the mass of a particle in kilograms. A particle's actual mass will be chosen as a random amount above this value. + * @param {number} [options.maximumMass] Sets the maximum mass of particles in kilograms. A particle's actual mass will be chosen as a random amount below this value. * @demo {@link https://cesium.com/learn/cesiumjs-learn/cesiumjs-particle-systems/|Particle Systems Tutorial} * @demo {@link https://sandcastle.cesium.com/?src=Particle%20System.html&label=Showcases|Particle Systems Tutorial Demo} * @demo {@link https://sandcastle.cesium.com/?src=Particle%20System%20Fireworks.html&label=Showcases|Particle Systems Fireworks Demo} @@ -60,7 +60,7 @@ function ParticleSystem(options) { /** * Whether to display the particle system. - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -74,14 +74,14 @@ function ParticleSystem(options) { /** * Whether the particle system should loop it's bursts when it is complete. - * @type {Boolean} + * @type {boolean} * @default true */ this.loop = defaultValue(options.loop, true); /** * The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard. - * @type {Object} + * @type {object} * @default undefined */ this.image = defaultValue(options.image, undefined); @@ -290,7 +290,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * The initial scale to apply to the image of the particle at the beginning of its life. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default 1.0 */ startScale: { @@ -307,7 +307,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * The final scale to apply to the image of the particle at the end of its life. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default 1.0 */ endScale: { @@ -324,7 +324,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * The number of particles to emit per second. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default 5 */ emissionRate: { @@ -342,7 +342,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * Sets the minimum bound in meters per second above which a particle's actual speed will be randomly chosen. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default 1.0 */ minimumSpeed: { @@ -359,7 +359,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * Sets the maximum bound in meters per second below which a particle's actual speed will be randomly chosen. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default 1.0 */ maximumSpeed: { @@ -376,7 +376,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * Sets the minimum bound in seconds for the possible duration of a particle's life above which a particle's actual life will be randomly chosen. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default 5.0 */ minimumParticleLife: { @@ -393,7 +393,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * Sets the maximum bound in seconds for the possible duration of a particle's life below which a particle's actual life will be randomly chosen. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default 5.0 */ maximumParticleLife: { @@ -411,7 +411,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * Sets the minimum mass of particles in kilograms. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default 1.0 */ minimumMass: { @@ -428,7 +428,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * Sets the maximum mass of particles in kilograms. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default 1.0 */ maximumMass: { @@ -483,7 +483,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * Gets or sets if the particle size is in meters or pixels. true to size particles in meters; otherwise, the size is in pixels. * @memberof ParticleSystem.prototype - * @type {Boolean} + * @type {boolean} * @default false */ sizeInMeters: { @@ -500,7 +500,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * How long the particle system will emit particles, in seconds. * @memberof ParticleSystem.prototype - * @type {Number} + * @type {number} * @default Number.MAX_VALUE */ lifetime: { @@ -527,7 +527,7 @@ Object.defineProperties(ParticleSystem.prototype, { /** * When true, the particle system has reached the end of its lifetime; false otherwise. * @memberof ParticleSystem.prototype - * @type {Boolean} + * @type {boolean} */ isComplete: { get: function () { @@ -864,7 +864,7 @@ ParticleSystem.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see ParticleSystem#destroy */ @@ -897,7 +897,7 @@ ParticleSystem.prototype.destroy = function () { * @callback ParticleSystem.updateCallback * * @param {Particle} particle The particle being updated. - * @param {Number} dt The time in seconds since the last update. + * @param {number} dt The time in seconds since the last update. * * @example * function applyGravity(particle, dt) { diff --git a/packages/engine/Source/Scene/PerInstanceColorAppearance.js b/packages/engine/Source/Scene/PerInstanceColorAppearance.js index dfc1a75c43a1..a2a32ec136b9 100644 --- a/packages/engine/Source/Scene/PerInstanceColorAppearance.js +++ b/packages/engine/Source/Scene/PerInstanceColorAppearance.js @@ -14,14 +14,14 @@ import Appearance from "./Appearance.js"; * @alias PerInstanceColorAppearance * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.flat=false] When true, flat shading is used in the fragment shader, which means lighting is not taking into account. - * @param {Boolean} [options.faceForward=!options.closed] When true, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}. - * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link PerInstanceColorAppearance#renderState} has alpha blending enabled. - * @param {Boolean} [options.closed=false] When true, the geometry is expected to be closed so {@link PerInstanceColorAppearance#renderState} has backface culling enabled. - * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. - * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. - * @param {Object} [options.renderState] Optional render state to override the default render state. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.flat=false] When true, flat shading is used in the fragment shader, which means lighting is not taking into account. + * @param {boolean} [options.faceForward=!options.closed] When true, the fragment shader flips the surface normal as needed to ensure that the normal faces the viewer to avoid dark spots. This is useful when both sides of a geometry should be shaded like {@link WallGeometry}. + * @param {boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link PerInstanceColorAppearance#renderState} has alpha blending enabled. + * @param {boolean} [options.closed=false] When true, the geometry is expected to be closed so {@link PerInstanceColorAppearance#renderState} has backface culling enabled. + * @param {string} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. + * @param {string} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. + * @param {object} [options.renderState] Optional render state to override the default render state. * * @example * // A solid white line segment @@ -97,7 +97,7 @@ function PerInstanceColorAppearance(options) { * When true, the geometry is expected to appear translucent so * {@link PerInstanceColorAppearance#renderState} has alpha blending enabled. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -125,7 +125,7 @@ Object.defineProperties(PerInstanceColorAppearance.prototype, { * * @memberof PerInstanceColorAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ vertexShaderSource: { @@ -139,7 +139,7 @@ Object.defineProperties(PerInstanceColorAppearance.prototype, { * * @memberof PerInstanceColorAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ fragmentShaderSource: { @@ -158,7 +158,7 @@ Object.defineProperties(PerInstanceColorAppearance.prototype, { * * @memberof PerInstanceColorAppearance.prototype * - * @type {Object} + * @type {object} * @readonly */ renderState: { @@ -174,7 +174,7 @@ Object.defineProperties(PerInstanceColorAppearance.prototype, { * * @memberof PerInstanceColorAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -207,7 +207,7 @@ Object.defineProperties(PerInstanceColorAppearance.prototype, { * * @memberof PerInstanceColorAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -226,7 +226,7 @@ Object.defineProperties(PerInstanceColorAppearance.prototype, { * * @memberof PerInstanceColorAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -267,7 +267,7 @@ PerInstanceColorAppearance.FLAT_VERTEX_FORMAT = VertexFormat.POSITION_ONLY; * * @function * - * @returns {String} The full GLSL fragment shader source. + * @returns {string} The full GLSL fragment shader source. */ PerInstanceColorAppearance.prototype.getFragmentShaderSource = Appearance.prototype.getFragmentShaderSource; @@ -277,7 +277,7 @@ PerInstanceColorAppearance.prototype.getFragmentShaderSource = * * @function * - * @returns {Boolean} true if the appearance is translucent. + * @returns {boolean} true if the appearance is translucent. */ PerInstanceColorAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent; @@ -289,7 +289,7 @@ PerInstanceColorAppearance.prototype.isTranslucent = * * @function * - * @returns {Object} The render state. + * @returns {object} The render state. */ PerInstanceColorAppearance.prototype.getRenderState = Appearance.prototype.getRenderState; diff --git a/packages/engine/Source/Scene/PerformanceDisplay.js b/packages/engine/Source/Scene/PerformanceDisplay.js index e130db87eb62..d379843b32a1 100644 --- a/packages/engine/Source/Scene/PerformanceDisplay.js +++ b/packages/engine/Source/Scene/PerformanceDisplay.js @@ -52,7 +52,7 @@ Object.defineProperties(PerformanceDisplay.prototype, { * The display should indicate the FPS is being throttled. * @memberof PerformanceDisplay.prototype * - * @type {Boolean} + * @type {boolean} */ throttled: { get: function () { @@ -78,7 +78,7 @@ Object.defineProperties(PerformanceDisplay.prototype, { * Update the display. This function should only be called once per frame, because * each call records a frame in the internal buffer and redraws the display. * - * @param {Boolean} [renderedThisFrame=true] If provided, the FPS count will only update and display if true. + * @param {boolean} [renderedThisFrame=true] If provided, the FPS count will only update and display if true. */ PerformanceDisplay.prototype.update = function (renderedThisFrame) { const time = getTimestamp(); diff --git a/packages/engine/Source/Scene/PntsParser.js b/packages/engine/Source/Scene/PntsParser.js index 8dde6b23ade8..eb60db304b65 100644 --- a/packages/engine/Source/Scene/PntsParser.js +++ b/packages/engine/Source/Scene/PntsParser.js @@ -28,7 +28,7 @@ const sizeOfUint32 = Uint32Array.BYTES_PER_ELEMENT; * * @param {*} arrayBuffer The array buffer containing the pnts * @param {*} [byteOffset=0] The byte offset of the beginning of the pnts in the array buffer - * @returns {Object} An object containing a parsed representation of the point cloud + * @returns {object} An object containing a parsed representation of the point cloud */ PntsParser.parse = function (arrayBuffer, byteOffset) { byteOffset = defaultValue(byteOffset, 0); diff --git a/packages/engine/Source/Scene/PointCloudEyeDomeLighting.js b/packages/engine/Source/Scene/PointCloudEyeDomeLighting.js index e247beac473f..a4ef56deca6f 100644 --- a/packages/engine/Source/Scene/PointCloudEyeDomeLighting.js +++ b/packages/engine/Source/Scene/PointCloudEyeDomeLighting.js @@ -254,7 +254,7 @@ PointCloudEyeDomeLighting.prototype.update = function ( * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see PointCloudEyeDomeLighting#destroy */ diff --git a/packages/engine/Source/Scene/PointCloudShading.js b/packages/engine/Source/Scene/PointCloudShading.js index 658b534deca5..2a46b8fc75c0 100644 --- a/packages/engine/Source/Scene/PointCloudShading.js +++ b/packages/engine/Source/Scene/PointCloudShading.js @@ -5,16 +5,16 @@ import PointCloudEyeDomeLighting from "./PointCloudEyeDomeLighting.js"; * Options for performing point attenuation based on geometric error when rendering * point clouds using 3D Tiles. * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.attenuation=false] Perform point attenuation based on geometric error. - * @param {Number} [options.geometricErrorScale=1.0] Scale to be applied to each tile's geometric error. - * @param {Number} [options.maximumAttenuation] Maximum attenuation in pixels. Defaults to the Cesium3DTileset's maximumScreenSpaceError. - * @param {Number} [options.baseResolution] Average base resolution for the dataset in meters. Substitute for Geometric Error when not available. - * @param {Boolean} [options.eyeDomeLighting=true] When true, use eye dome lighting when drawing with point attenuation. - * @param {Number} [options.eyeDomeLightingStrength=1.0] Increasing this value increases contrast on slopes and edges. - * @param {Number} [options.eyeDomeLightingRadius=1.0] Increase the thickness of contours from eye dome lighting. - * @param {Boolean} [options.backFaceCulling=false] Determines whether back-facing points are hidden. This option works only if data has normals included. - * @param {Boolean} [options.normalShading=true] Determines whether a point cloud that contains normals is shaded by the scene's light source. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.attenuation=false] Perform point attenuation based on geometric error. + * @param {number} [options.geometricErrorScale=1.0] Scale to be applied to each tile's geometric error. + * @param {number} [options.maximumAttenuation] Maximum attenuation in pixels. Defaults to the Cesium3DTileset's maximumScreenSpaceError. + * @param {number} [options.baseResolution] Average base resolution for the dataset in meters. Substitute for Geometric Error when not available. + * @param {boolean} [options.eyeDomeLighting=true] When true, use eye dome lighting when drawing with point attenuation. + * @param {number} [options.eyeDomeLightingStrength=1.0] Increasing this value increases contrast on slopes and edges. + * @param {number} [options.eyeDomeLightingRadius=1.0] Increase the thickness of contours from eye dome lighting. + * @param {boolean} [options.backFaceCulling=false] Determines whether back-facing points are hidden. This option works only if data has normals included. + * @param {boolean} [options.normalShading=true] Determines whether a point cloud that contains normals is shaded by the scene's light source. * * @alias PointCloudShading * @constructor @@ -24,14 +24,14 @@ function PointCloudShading(options) { /** * Perform point attenuation based on geometric error. - * @type {Boolean} + * @type {boolean} * @default false */ this.attenuation = defaultValue(pointCloudShading.attenuation, false); /** * Scale to be applied to the geometric error before computing attenuation. - * @type {Number} + * @type {number} * @default 1.0 */ this.geometricErrorScale = defaultValue( @@ -41,7 +41,7 @@ function PointCloudShading(options) { /** * Maximum point attenuation in pixels. If undefined, the Cesium3DTileset's maximumScreenSpaceError will be used. - * @type {Number} + * @type {number} */ this.maximumAttenuation = pointCloudShading.maximumAttenuation; @@ -49,7 +49,7 @@ function PointCloudShading(options) { * Average base resolution for the dataset in meters. * Used in place of geometric error when geometric error is 0. * If undefined, an approximation will be computed for each tile that has geometric error of 0. - * @type {Number} + * @type {number} */ this.baseResolution = pointCloudShading.baseResolution; @@ -58,14 +58,14 @@ function PointCloudShading(options) { * Requires support for EXT_frag_depth, OES_texture_float, and WEBGL_draw_buffers extensions in WebGL 1.0, * otherwise eye dome lighting is ignored. * - * @type {Boolean} + * @type {boolean} * @default true */ this.eyeDomeLighting = defaultValue(pointCloudShading.eyeDomeLighting, true); /** * Eye dome lighting strength (apparent contrast) - * @type {Number} + * @type {number} * @default 1.0 */ this.eyeDomeLightingStrength = defaultValue( @@ -75,7 +75,7 @@ function PointCloudShading(options) { /** * Thickness of contours from eye dome lighting - * @type {Number} + * @type {number} * @default 1.0 */ this.eyeDomeLightingRadius = defaultValue( @@ -87,7 +87,7 @@ function PointCloudShading(options) { * Determines whether back-facing points are hidden. * This option works only if data has normals included. * - * @type {Boolean} + * @type {boolean} * @default false */ this.backFaceCulling = defaultValue(pointCloudShading.backFaceCulling, false); @@ -95,7 +95,7 @@ function PointCloudShading(options) { /** * Determines whether a point cloud that contains normals is shaded by the scene's light source. * - * @type {Boolean} + * @type {boolean} * @default true */ this.normalShading = defaultValue(pointCloudShading.normalShading, true); @@ -105,7 +105,7 @@ function PointCloudShading(options) { * Determines if point cloud shading is supported. * * @param {Scene} scene The scene. - * @returns {Boolean} true if point cloud shading is supported; otherwise, returns false + * @returns {boolean} true if point cloud shading is supported; otherwise, returns false */ PointCloudShading.isSupported = function (scene) { return PointCloudEyeDomeLighting.isSupported(scene.context); diff --git a/packages/engine/Source/Scene/PointPrimitive.js b/packages/engine/Source/Scene/PointPrimitive.js index 75ed8ca5e36d..08307252f649 100644 --- a/packages/engine/Source/Scene/PointPrimitive.js +++ b/packages/engine/Source/Scene/PointPrimitive.js @@ -147,7 +147,7 @@ Object.defineProperties(PointPrimitive.prototype, { * Determines if this point will be shown. Use this to hide or show a point, instead * of removing it and re-adding it to the collection. * @memberof PointPrimitive.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -286,7 +286,7 @@ Object.defineProperties(PointPrimitive.prototype, { /** * Gets or sets the inner size of the point in pixels. * @memberof PointPrimitive.prototype - * @type {Number} + * @type {number} */ pixelSize: { get: function () { @@ -369,7 +369,7 @@ Object.defineProperties(PointPrimitive.prototype, { * Gets or sets the outline width in pixels. This width adds to pixelSize, * increasing the total size of the point. * @memberof PointPrimitive.prototype - * @type {Number} + * @type {number} */ outlineWidth: { get: function () { @@ -421,7 +421,7 @@ Object.defineProperties(PointPrimitive.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 PointPrimitive.prototype - * @type {Number} + * @type {number} * @default 0.0 */ disableDepthTestDistance: { @@ -472,7 +472,7 @@ Object.defineProperties(PointPrimitive.prototype, { /** * Determines whether or not this point will be shown or hidden because it was clustered. * @memberof PointPrimitive.prototype - * @type {Boolean} + * @type {boolean} * @private */ clusterShow: { @@ -635,7 +635,7 @@ PointPrimitive.getScreenSpaceBoundingBox = function ( * are equal. Points in different collections can be equal. * * @param {PointPrimitive} other The point to compare for equality. - * @returns {Boolean} true if the points are equal; otherwise, false. + * @returns {boolean} true if the points are equal; otherwise, false. */ PointPrimitive.prototype.equals = function (other) { return ( diff --git a/packages/engine/Source/Scene/PointPrimitiveCollection.js b/packages/engine/Source/Scene/PointPrimitiveCollection.js index 5c06e1a7f95b..ce42db08cf2b 100644 --- a/packages/engine/Source/Scene/PointPrimitiveCollection.js +++ b/packages/engine/Source/Scene/PointPrimitiveCollection.js @@ -58,13 +58,13 @@ const attributeLocations = { * @alias PointPrimitiveCollection * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms each point from model to world coordinates. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. * @param {BlendOption} [options.blendOption=BlendOption.OPAQUE_AND_TRANSLUCENT] The point blending option. The default * is used for rendering both opaque and translucent points. However, if either all of the points are completely opaque or all are completely translucent, * setting the technique to BlendOption.OPAQUE or BlendOption.TRANSLUCENT can improve performance by up to 2x. - * @param {Boolean} [options.show=true] Determines if the primitives in the collection will be shown. + * @param {boolean} [options.show=true] Determines if the primitives in the collection will be shown. * * @performance For best performance, prefer a few collections, each with many points, to * many collections with only a few points each. Organize collections so that points @@ -131,7 +131,7 @@ function PointPrimitiveCollection(options) { /** * Determines if primitives in this collection will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -179,7 +179,7 @@ function PointPrimitiveCollection(options) { * Draws the bounding sphere for each draw command in the primitive. *

    * - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -232,7 +232,7 @@ Object.defineProperties(PointPrimitiveCollection.prototype, { * {@link PointPrimitiveCollection#get} to iterate over all the points * in the collection. * @memberof PointPrimitiveCollection.prototype - * @type {Number} + * @type {number} */ length: { get: function () { @@ -255,7 +255,7 @@ function destroyPointPrimitives(pointPrimitives) { * Creates and adds a point with the specified initial properties to the collection. * The added point is returned so it can be modified or removed from the collection later. * - * @param {Object}[options] A template describing the point's properties as shown in Example 1. + * @param {object}[options] A template describing the point's properties as shown in Example 1. * @returns {PointPrimitive} The point that was added to the collection. * * @performance Calling add is expected constant time. However, the collection's vertex buffer @@ -300,7 +300,7 @@ PointPrimitiveCollection.prototype.add = function (options) { * Removes a point from the collection. * * @param {PointPrimitive} pointPrimitive The point to remove. - * @returns {Boolean} true if the point was removed; false if the point was not found in the collection. + * @returns {boolean} true if the point was removed; false if the point was not found in the collection. * * @performance Calling remove is expected constant time. However, the collection's vertex buffer * is rewritten - an O(n) operation that also incurs CPU to GPU overhead. For @@ -394,7 +394,7 @@ PointPrimitiveCollection.prototype._updatePointPrimitive = function ( * Check whether this collection contains a given point. * * @param {PointPrimitive} [pointPrimitive] The point to check for. - * @returns {Boolean} true if this collection contains the point, false otherwise. + * @returns {boolean} true if this collection contains the point, false otherwise. * * @see PointPrimitiveCollection#get */ @@ -411,7 +411,7 @@ PointPrimitiveCollection.prototype.contains = function (pointPrimitive) { * {@link PointPrimitiveCollection#length} to iterate over all the points * in the collection. * - * @param {Number} index The zero-based index of the point. + * @param {number} index The zero-based index of the point. * @returns {PointPrimitive} The point at the specified index. * * @performance Expected constant time. If points were removed from the collection and @@ -1181,7 +1181,7 @@ PointPrimitiveCollection.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see PointPrimitiveCollection#destroy */ diff --git a/packages/engine/Source/Scene/Polyline.js b/packages/engine/Source/Scene/Polyline.js index 0590f6c92eda..b8eda50752e0 100644 --- a/packages/engine/Source/Scene/Polyline.js +++ b/packages/engine/Source/Scene/Polyline.js @@ -21,13 +21,13 @@ import Material from "./Material.js"; * @internalConstructor * @class * - * @privateParam {Object} options Object with the following properties: - * @privateParam {Boolean} [options.show=true] true if this polyline will be shown; otherwise, false. - * @privateParam {Number} [options.width=1.0] The width of the polyline in pixels. - * @privateParam {Boolean} [options.loop=false] Whether a line segment will be added between the last and first line positions to make this line a loop. + * @privateParam {object} options Object with the following properties: + * @privateParam {boolean} [options.show=true] true if this polyline will be shown; otherwise, false. + * @privateParam {number} [options.width=1.0] The width of the polyline in pixels. + * @privateParam {boolean} [options.loop=false] Whether a line segment will be added between the last and first line positions to make this line a loop. * @privateParam {Material} [options.material=Material.ColorType] The material. * @privateParam {Cartesian3[]} [options.positions] The positions. - * @privateParam {Object} [options.id] The user-defined object to be returned when this polyline is picked. + * @privateParam {object} [options.id] The user-defined object to be returned when this polyline is picked. * @privateParam {DistanceDisplayCondition} [options.distanceDisplayCondition] The condition specifying at what distance from the camera that this polyline will be displayed. * @privateParam {PolylineCollection} polylineCollection The renderable polyline collection. * @@ -118,7 +118,7 @@ Object.defineProperties(Polyline.prototype, { * Determines if this polyline will be shown. Use this to hide or show a polyline, instead * of removing it and re-adding it to the collection. * @memberof Polyline.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -221,7 +221,7 @@ Object.defineProperties(Polyline.prototype, { /** * Gets or sets the width of the polyline. * @memberof Polyline.prototype - * @type {Number} + * @type {number} */ width: { get: function () { @@ -245,7 +245,7 @@ Object.defineProperties(Polyline.prototype, { /** * Gets or sets whether a line segment will be added between the first and last polyline positions. * @memberof Polyline.prototype - * @type {Boolean} + * @type {boolean} */ loop: { get: function () { @@ -316,7 +316,7 @@ Object.defineProperties(Polyline.prototype, { /** * Gets the destruction status of this polyline * @memberof Polyline.prototype - * @type {Boolean} + * @type {boolean} * @default false * @private */ diff --git a/packages/engine/Source/Scene/PolylineCollection.js b/packages/engine/Source/Scene/PolylineCollection.js index 3f9150479a0a..81973318e16e 100644 --- a/packages/engine/Source/Scene/PolylineCollection.js +++ b/packages/engine/Source/Scene/PolylineCollection.js @@ -77,10 +77,10 @@ const attributeLocations = { * @alias PolylineCollection * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms each polyline from model to world coordinates. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. - * @param {Boolean} [options.show=true] Determines if the polylines in the collection will be shown. + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. + * @param {boolean} [options.show=true] Determines if the polylines in the collection will be shown. * * @performance For best performance, prefer a few collections, each with many polylines, to * many collections with only a few polylines each. Organize collections so that polylines @@ -120,7 +120,7 @@ function PolylineCollection(options) { /** * Determines if polylines in this collection will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -145,7 +145,7 @@ function PolylineCollection(options) { * Draws the bounding sphere for each draw command in the primitive. *

    * - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -200,7 +200,7 @@ Object.defineProperties(PolylineCollection.prototype, { * {@link PolylineCollection#get} to iterate over all the polylines * in the collection. * @memberof PolylineCollection.prototype - * @type {Number} + * @type {number} */ length: { get: function () { @@ -214,7 +214,7 @@ Object.defineProperties(PolylineCollection.prototype, { * Creates and adds a polyline with the specified initial properties to the collection. * The added polyline is returned so it can be modified or removed from the collection later. * - * @param {Object}[options] A template describing the polyline's properties as shown in Example 1. + * @param {object}[options] A template describing the polyline's properties as shown in Example 1. * @returns {Polyline} The polyline that was added to the collection. * * @performance After calling add, {@link PolylineCollection#update} is called and @@ -251,7 +251,7 @@ PolylineCollection.prototype.add = function (options) { * Removes a polyline from the collection. * * @param {Polyline} polyline The polyline to remove. - * @returns {Boolean} true if the polyline was removed; false if the polyline was not found in the collection. + * @returns {boolean} true if the polyline was removed; false if the polyline was not found in the collection. * * @performance After calling remove, {@link PolylineCollection#update} is called and * the collection's vertex buffer is rewritten - an O(n) operation that also incurs CPU to GPU overhead. @@ -320,7 +320,7 @@ PolylineCollection.prototype.removeAll = function () { * Determines if this collection contains the specified polyline. * * @param {Polyline} polyline The polyline to check for. - * @returns {Boolean} true if this collection contains the polyline, false otherwise. + * @returns {boolean} true if this collection contains the polyline, false otherwise. * * @see PolylineCollection#get */ @@ -335,7 +335,7 @@ PolylineCollection.prototype.contains = function (polyline) { * {@link PolylineCollection#length} to iterate over all the polylines * in the collection. * - * @param {Number} index The zero-based index of the polyline. + * @param {number} index The zero-based index of the polyline. * @returns {Polyline} The polyline at the specified index. * * @performance If polylines were removed from the collection and @@ -786,7 +786,7 @@ function createCommandLists( * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see PolylineCollection#destroy */ diff --git a/packages/engine/Source/Scene/PolylineColorAppearance.js b/packages/engine/Source/Scene/PolylineColorAppearance.js index 89b14b043104..27c577fa1b7c 100644 --- a/packages/engine/Source/Scene/PolylineColorAppearance.js +++ b/packages/engine/Source/Scene/PolylineColorAppearance.js @@ -22,11 +22,11 @@ if (!FeatureDetection.isInternetExplorer()) { * @alias PolylineColorAppearance * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link PolylineColorAppearance#renderState} has alpha blending enabled. - * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. - * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. - * @param {Object} [options.renderState] Optional render state to override the default render state. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link PolylineColorAppearance#renderState} has alpha blending enabled. + * @param {string} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. + * @param {string} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. + * @param {object} [options.renderState] Optional render state to override the default render state. * * @example * // A solid white line segment @@ -70,7 +70,7 @@ function PolylineColorAppearance(options) { * When true, the geometry is expected to appear translucent so * {@link PolylineColorAppearance#renderState} has alpha blending enabled. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -102,7 +102,7 @@ Object.defineProperties(PolylineColorAppearance.prototype, { * * @memberof PolylineColorAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ vertexShaderSource: { @@ -116,7 +116,7 @@ Object.defineProperties(PolylineColorAppearance.prototype, { * * @memberof PolylineColorAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ fragmentShaderSource: { @@ -134,7 +134,7 @@ Object.defineProperties(PolylineColorAppearance.prototype, { * * @memberof PolylineColorAppearance.prototype * - * @type {Object} + * @type {object} * @readonly */ renderState: { @@ -150,7 +150,7 @@ Object.defineProperties(PolylineColorAppearance.prototype, { * * @memberof PolylineColorAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -195,7 +195,7 @@ PolylineColorAppearance.VERTEX_FORMAT = VertexFormat.POSITION_ONLY; * * @function * - * @returns {String} The full GLSL fragment shader source. + * @returns {string} The full GLSL fragment shader source. */ PolylineColorAppearance.prototype.getFragmentShaderSource = Appearance.prototype.getFragmentShaderSource; @@ -205,7 +205,7 @@ PolylineColorAppearance.prototype.getFragmentShaderSource = * * @function * - * @returns {Boolean} true if the appearance is translucent. + * @returns {boolean} true if the appearance is translucent. */ PolylineColorAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent; @@ -217,7 +217,7 @@ PolylineColorAppearance.prototype.isTranslucent = * * @function * - * @returns {Object} The render state. + * @returns {object} The render state. */ PolylineColorAppearance.prototype.getRenderState = Appearance.prototype.getRenderState; diff --git a/packages/engine/Source/Scene/PolylineMaterialAppearance.js b/packages/engine/Source/Scene/PolylineMaterialAppearance.js index 01f961149910..0f048aa81ea2 100644 --- a/packages/engine/Source/Scene/PolylineMaterialAppearance.js +++ b/packages/engine/Source/Scene/PolylineMaterialAppearance.js @@ -21,12 +21,12 @@ if (!FeatureDetection.isInternetExplorer()) { * @alias PolylineMaterialAppearance * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link PolylineMaterialAppearance#renderState} has alpha blending enabled. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.translucent=true] When true, the geometry is expected to appear translucent so {@link PolylineMaterialAppearance#renderState} has alpha blending enabled. * @param {Material} [options.material=Material.ColorType] The material used to determine the fragment color. - * @param {String} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. - * @param {String} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. - * @param {Object} [options.renderState] Optional render state to override the default render state. + * @param {string} [options.vertexShaderSource] Optional GLSL vertex shader source to override the default vertex shader. + * @param {string} [options.fragmentShaderSource] Optional GLSL fragment shader source to override the default fragment shader. + * @param {object} [options.renderState] Optional render state to override the default render state. * * @see {@link https://github.com/CesiumGS/cesium/wiki/Fabric|Fabric} * @@ -72,7 +72,7 @@ function PolylineMaterialAppearance(options) { * When true, the geometry is expected to appear translucent so * {@link PolylineMaterialAppearance#renderState} has alpha blending enabled. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -104,7 +104,7 @@ Object.defineProperties(PolylineMaterialAppearance.prototype, { * * @memberof PolylineMaterialAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ vertexShaderSource: { @@ -125,7 +125,7 @@ Object.defineProperties(PolylineMaterialAppearance.prototype, { * * @memberof PolylineMaterialAppearance.prototype * - * @type {String} + * @type {string} * @readonly */ fragmentShaderSource: { @@ -144,7 +144,7 @@ Object.defineProperties(PolylineMaterialAppearance.prototype, { * * @memberof PolylineMaterialAppearance.prototype * - * @type {Object} + * @type {object} * @readonly */ renderState: { @@ -160,7 +160,7 @@ Object.defineProperties(PolylineMaterialAppearance.prototype, { * * @memberof PolylineMaterialAppearance.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -206,7 +206,7 @@ PolylineMaterialAppearance.VERTEX_FORMAT = VertexFormat.POSITION_AND_ST; * * @function * - * @returns {String} The full GLSL fragment shader source. + * @returns {string} The full GLSL fragment shader source. */ PolylineMaterialAppearance.prototype.getFragmentShaderSource = Appearance.prototype.getFragmentShaderSource; @@ -216,7 +216,7 @@ PolylineMaterialAppearance.prototype.getFragmentShaderSource = * * @function * - * @returns {Boolean} true if the appearance is translucent. + * @returns {boolean} true if the appearance is translucent. */ PolylineMaterialAppearance.prototype.isTranslucent = Appearance.prototype.isTranslucent; @@ -228,7 +228,7 @@ PolylineMaterialAppearance.prototype.isTranslucent = * * @function * - * @returns {Object} The render state. + * @returns {object} The render state. */ PolylineMaterialAppearance.prototype.getRenderState = Appearance.prototype.getRenderState; diff --git a/packages/engine/Source/Scene/PostProcessStage.js b/packages/engine/Source/Scene/PostProcessStage.js index 1af387e0ae54..ab05093b5c67 100644 --- a/packages/engine/Source/Scene/PostProcessStage.js +++ b/packages/engine/Source/Scene/PostProcessStage.js @@ -26,17 +26,17 @@ import PostProcessStageSampleMode from "./PostProcessStageSampleMode.js"; * @alias PostProcessStage * @constructor * - * @param {Object} options An object with the following properties: - * @param {String} options.fragmentShader The fragment shader to use. The default sampler2D uniforms are colorTexture and depthTexture. The color texture is the output of rendering the scene or the previous stage. The depth texture is the output from rendering the scene. The shader should contain one or both uniforms. There is also a vec2 varying named v_textureCoordinates that can be used to sample the textures. - * @param {Object} [options.uniforms] An object whose properties will be used to set the shaders uniforms. The properties can be constant values or a function. A constant value can also be a URI, data URI, or HTML element to use as a texture. - * @param {Number} [options.textureScale=1.0] A number in the range (0.0, 1.0] used to scale the texture dimensions. A scale of 1.0 will render this post-process stage to a texture the size of the viewport. - * @param {Boolean} [options.forcePowerOfTwo=false] Whether or not to force the texture dimensions to be both equal powers of two. The power of two will be the next power of two of the minimum of the dimensions. + * @param {object} options An object with the following properties: + * @param {string} options.fragmentShader The fragment shader to use. The default sampler2D uniforms are colorTexture and depthTexture. The color texture is the output of rendering the scene or the previous stage. The depth texture is the output from rendering the scene. The shader should contain one or both uniforms. There is also a vec2 varying named v_textureCoordinates that can be used to sample the textures. + * @param {object} [options.uniforms] An object whose properties will be used to set the shaders uniforms. The properties can be constant values or a function. A constant value can also be a URI, data URI, or HTML element to use as a texture. + * @param {number} [options.textureScale=1.0] A number in the range (0.0, 1.0] used to scale the texture dimensions. A scale of 1.0 will render this post-process stage to a texture the size of the viewport. + * @param {boolean} [options.forcePowerOfTwo=false] Whether or not to force the texture dimensions to be both equal powers of two. The power of two will be the next power of two of the minimum of the dimensions. * @param {PostProcessStageSampleMode} [options.sampleMode=PostProcessStageSampleMode.NEAREST] How to sample the input color texture. * @param {PixelFormat} [options.pixelFormat=PixelFormat.RGBA] The color pixel format of the output texture. * @param {PixelDatatype} [options.pixelDatatype=PixelDatatype.UNSIGNED_BYTE] The pixel data type of the output texture. * @param {Color} [options.clearColor=Color.BLACK] The color to clear the output texture to. * @param {BoundingRectangle} [options.scissorRectangle] The rectangle to use for the scissor test. - * @param {String} [options.name=createGuid()] The unique name of this post-process stage for reference by other stages in a composite. If a name is not supplied, a GUID will be generated. + * @param {string} [options.name=createGuid()] The unique name of this post-process stage for reference by other stages in a composite. If a name is not supplied, a GUID will be generated. * * @exception {DeveloperError} options.textureScale must be greater than 0.0 and less than or equal to 1.0. * @exception {DeveloperError} options.pixelFormat must be a color format. @@ -176,7 +176,7 @@ function PostProcessStage(options) { /** * Whether or not to execute this post-process stage when ready. * - * @type {Boolean} + * @type {boolean} */ this.enabled = true; this._enabled = true; @@ -189,7 +189,7 @@ Object.defineProperties(PostProcessStage.prototype, { * to load. * * @memberof PostProcessStage.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -201,7 +201,7 @@ Object.defineProperties(PostProcessStage.prototype, { * The unique name of this post-process stage for reference by other stages in a {@link PostProcessStageComposite}. * * @memberof PostProcessStage.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -221,7 +221,7 @@ Object.defineProperties(PostProcessStage.prototype, { *

    * * @memberof PostProcessStage.prototype - * @type {String} + * @type {string} * @readonly */ fragmentShader: { @@ -244,7 +244,7 @@ Object.defineProperties(PostProcessStage.prototype, { *

    * * @memberof PostProcessStage.prototype - * @type {Object} + * @type {object} * @readonly */ uniforms: { @@ -256,7 +256,7 @@ Object.defineProperties(PostProcessStage.prototype, { * A number in the range (0.0, 1.0] used to scale the output texture dimensions. A scale of 1.0 will render this post-process stage to a texture the size of the viewport. * * @memberof PostProcessStage.prototype - * @type {Number} + * @type {number} * @readonly */ textureScale: { @@ -268,7 +268,7 @@ Object.defineProperties(PostProcessStage.prototype, { * Whether or not to force the output texture dimensions to be both equal powers of two. The power of two will be the next power of two of the minimum of the dimensions. * * @memberof PostProcessStage.prototype - * @type {Number} + * @type {number} * @readonly */ forcePowerOfTwo: { @@ -875,7 +875,7 @@ function createSelectedTexture(stage, context) { /** * A function that will be called before execute. Used to create WebGL resources and load any textures. * @param {Context} context The context. - * @param {Boolean} useLogDepth Whether the scene uses a logarithmic depth buffer. + * @param {boolean} useLogDepth Whether the scene uses a logarithmic depth buffer. * @private */ PostProcessStage.prototype.update = function (context, useLogDepth) { @@ -995,7 +995,7 @@ PostProcessStage.prototype.execute = function ( * isDestroyed 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. * * @see PostProcessStage#destroy */ diff --git a/packages/engine/Source/Scene/PostProcessStageCollection.js b/packages/engine/Source/Scene/PostProcessStageCollection.js index 6017377ca3b8..1bdb38ca5e34 100644 --- a/packages/engine/Source/Scene/PostProcessStageCollection.js +++ b/packages/engine/Source/Scene/PostProcessStageCollection.js @@ -105,7 +105,7 @@ Object.defineProperties(PostProcessStageCollection.prototype, { * Determines if all of the post-process stages in the collection are ready to be executed. * * @memberof PostProcessStageCollection.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -231,7 +231,7 @@ Object.defineProperties(PostProcessStageCollection.prototype, { * The number of post-process stages in this collection. * * @memberof PostProcessStageCollection.prototype - * @type {Number} + * @type {number} * @readonly */ length: { @@ -286,7 +286,7 @@ Object.defineProperties(PostProcessStageCollection.prototype, { * Whether the collection has a stage that has selected features. * * @memberof PostProcessStageCollection.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @private */ @@ -453,7 +453,7 @@ PostProcessStageCollection.prototype.add = function (stage) { * Removes a post-process stage from the collection and destroys it. * * @param {PostProcessStage|PostProcessStageComposite} stage The post-process stage to remove from the collection. - * @return {Boolean} Whether the post-process stage was removed. + * @return {boolean} Whether the post-process stage was removed. */ PostProcessStageCollection.prototype.remove = function (stage) { if (!this.contains(stage)) { @@ -489,7 +489,7 @@ PostProcessStageCollection.prototype.remove = function (stage) { * Returns whether the collection contains a post-process stage. * * @param {PostProcessStage|PostProcessStageComposite} stage The post-process stage. - * @return {Boolean} Whether the collection contains the post-process stage. + * @return {boolean} Whether the collection contains the post-process stage. */ PostProcessStageCollection.prototype.contains = function (stage) { return ( @@ -502,7 +502,7 @@ PostProcessStageCollection.prototype.contains = function (stage) { /** * Gets the post-process stage at index. * - * @param {Number} index The index of the post-process stage. + * @param {number} index The index of the post-process stage. * @return {PostProcessStage|PostProcessStageComposite} The post-process stage at index. */ PostProcessStageCollection.prototype.get = function (index) { @@ -532,7 +532,7 @@ PostProcessStageCollection.prototype.removeAll = function () { /** * Gets a post-process stage in the collection by its name. * - * @param {String} name The name of the post-process stage. + * @param {string} name The name of the post-process stage. * @return {PostProcessStage|PostProcessStageComposite} The post-process stage. * * @private @@ -545,7 +545,7 @@ PostProcessStageCollection.prototype.getStageByName = function (name) { * Called before the post-process stages in the collection are executed. Calls update for each stage and creates WebGL resources. * * @param {Context} context The context. - * @param {Boolean} useLogDepth Whether the scene uses a logarithmic depth buffer. + * @param {boolean} useLogDepth Whether the scene uses a logarithmic depth buffer. * * @private */ @@ -703,7 +703,7 @@ function getOutputTexture(stage) { /** * Gets the output texture of a stage with the given name. * - * @param {String} stageName The name of the stage. + * @param {string} stageName The name of the stage. * @return {Texture|undefined} The texture rendered to by the stage with the given name. * * @private @@ -854,7 +854,7 @@ PostProcessStageCollection.prototype.copy = function (context, framebuffer) { * isDestroyed 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. * * @see PostProcessStageCollection#destroy */ diff --git a/packages/engine/Source/Scene/PostProcessStageComposite.js b/packages/engine/Source/Scene/PostProcessStageComposite.js index cd6b5c897752..bcea9587afa0 100644 --- a/packages/engine/Source/Scene/PostProcessStageComposite.js +++ b/packages/engine/Source/Scene/PostProcessStageComposite.js @@ -16,11 +16,11 @@ import destroyObject from "../Core/destroyObject.js"; * @alias PostProcessStageComposite * @constructor * - * @param {Object} options An object with the following properties: + * @param {object} options An object with the following properties: * @param {Array} options.stages An array of {@link PostProcessStage}s or composites to be executed in order. - * @param {Boolean} [options.inputPreviousStageTexture=true] Whether to execute each post-process stage where the input to one stage is the output of the previous. Otherwise, the input to each contained stage is the output of the stage that executed before the composite. - * @param {String} [options.name=createGuid()] The unique name of this post-process stage for reference by other composites. If a name is not supplied, a GUID will be generated. - * @param {Object} [options.uniforms] An alias to the uniforms of post-process stages. + * @param {boolean} [options.inputPreviousStageTexture=true] Whether to execute each post-process stage where the input to one stage is the output of the previous. Otherwise, the input to each contained stage is the output of the stage that executed before the composite. + * @param {string} [options.name=createGuid()] The unique name of this post-process stage for reference by other composites. If a name is not supplied, a GUID will be generated. + * @param {object} [options.uniforms] An alias to the uniforms of post-process stages. * * @exception {DeveloperError} options.stages.length must be greater than 0.0. * @@ -119,7 +119,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, { * Determines if this post-process stage is ready to be executed. * * @memberof PostProcessStageComposite.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -138,7 +138,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, { * The unique name of this post-process stage for reference by other stages in a PostProcessStageComposite. * * @memberof PostProcessStageComposite.prototype - * @type {String} + * @type {string} * @readonly */ name: { @@ -150,7 +150,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, { * Whether or not to execute this post-process stage when ready. * * @memberof PostProcessStageComposite.prototype - * @type {Boolean} + * @type {boolean} */ enabled: { get: function () { @@ -167,7 +167,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, { /** * An alias to the uniform values of the post-process stages. May be undefined; in which case, get each stage to set uniform values. * @memberof PostProcessStageComposite.prototype - * @type {Object} + * @type {object} */ uniforms: { get: function () { @@ -181,7 +181,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, { * or the output texture of the previous stage. * * @memberof PostProcessStageComposite.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ inputPreviousStageTexture: { @@ -193,7 +193,7 @@ Object.defineProperties(PostProcessStageComposite.prototype, { * The number of post-process stages in this composite. * * @memberof PostProcessStageComposite.prototype - * @type {Number} + * @type {number} * @readonly */ length: { @@ -245,7 +245,7 @@ PostProcessStageComposite.prototype._isSupported = function (context) { /** * Gets the post-process stage at index * - * @param {Number} index The index of the post-process stage or composite. + * @param {number} index The index of the post-process stage or composite. * @return {PostProcessStage|PostProcessStageComposite} The post-process stage or composite at index. * * @exception {DeveloperError} index must be greater than or equal to 0. @@ -298,7 +298,7 @@ function isSelectedTextureDirty(stage) { /** * A function that will be called before execute. Updates each post-process stage in the composite. * @param {Context} context The context. - * @param {Boolean} useLogDepth Whether the scene uses a logarithmic depth buffer. + * @param {boolean} useLogDepth Whether the scene uses a logarithmic depth buffer. * @private */ PostProcessStageComposite.prototype.update = function (context, useLogDepth) { @@ -330,7 +330,7 @@ PostProcessStageComposite.prototype.update = function (context, useLogDepth) { * isDestroyed 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. * * @see PostProcessStageComposite#destroy */ diff --git a/packages/engine/Source/Scene/PostProcessStageLibrary.js b/packages/engine/Source/Scene/PostProcessStageLibrary.js index 73db1b8adcf6..b24dfab4538b 100644 --- a/packages/engine/Source/Scene/PostProcessStageLibrary.js +++ b/packages/engine/Source/Scene/PostProcessStageLibrary.js @@ -198,7 +198,7 @@ PostProcessStageLibrary.createDepthOfFieldStage = function () { *

    * * @param {Scene} scene The scene. - * @return {Boolean} Whether this post process stage is supported. + * @return {boolean} Whether this post process stage is supported. * * @see {Context#depthTexture} * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/|WEBGL_depth_texture} @@ -257,7 +257,7 @@ PostProcessStageLibrary.createEdgeDetectionStage = function () { *

    * * @param {Scene} scene The scene. - * @return {Boolean} Whether this post process stage is supported. + * @return {boolean} Whether this post process stage is supported. * * @see {Context#depthTexture} * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/|WEBGL_depth_texture} @@ -352,7 +352,7 @@ PostProcessStageLibrary.createSilhouetteStage = function (edgeDetectionStages) { *

    * * @param {Scene} scene The scene. - * @return {Boolean} Whether this post process stage is supported. + * @return {boolean} Whether this post process stage is supported. * * @see {Context#depthTexture} * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/|WEBGL_depth_texture} @@ -628,7 +628,7 @@ PostProcessStageLibrary.createAmbientOcclusionStage = function () { *

    * * @param {Scene} scene The scene. - * @return {Boolean} Whether this post process stage is supported. + * @return {boolean} Whether this post process stage is supported. * * @see {Context#depthTexture} * @see {@link http://www.khronos.org/registry/webgl/extensions/WEBGL_depth_texture/|WEBGL_depth_texture} @@ -655,7 +655,7 @@ PostProcessStageLibrary.createFXAAStage = function () { /** * Creates a post-process stage that applies ACES tonemapping operator. - * @param {Boolean} useAutoExposure Whether or not to use auto-exposure. + * @param {boolean} useAutoExposure Whether or not to use auto-exposure. * @return {PostProcessStage} A post-process stage that applies ACES tonemapping operator. * @private */ @@ -675,7 +675,7 @@ PostProcessStageLibrary.createAcesTonemappingStage = function ( /** * Creates a post-process stage that applies filmic tonemapping operator. - * @param {Boolean} useAutoExposure Whether or not to use auto-exposure. + * @param {boolean} useAutoExposure Whether or not to use auto-exposure. * @return {PostProcessStage} A post-process stage that applies filmic tonemapping operator. * @private */ @@ -695,7 +695,7 @@ PostProcessStageLibrary.createFilmicTonemappingStage = function ( /** * Creates a post-process stage that applies Reinhard tonemapping operator. - * @param {Boolean} useAutoExposure Whether or not to use auto-exposure. + * @param {boolean} useAutoExposure Whether or not to use auto-exposure. * @return {PostProcessStage} A post-process stage that applies Reinhard tonemapping operator. * @private */ @@ -715,7 +715,7 @@ PostProcessStageLibrary.createReinhardTonemappingStage = function ( /** * Creates a post-process stage that applies modified Reinhard tonemapping operator. - * @param {Boolean} useAutoExposure Whether or not to use auto-exposure. + * @param {boolean} useAutoExposure Whether or not to use auto-exposure. * @return {PostProcessStage} A post-process stage that applies modified Reinhard tonemapping operator. * @private */ diff --git a/packages/engine/Source/Scene/PostProcessStageSampleMode.js b/packages/engine/Source/Scene/PostProcessStageSampleMode.js index d011284ac3a8..b078849fd0d8 100644 --- a/packages/engine/Source/Scene/PostProcessStageSampleMode.js +++ b/packages/engine/Source/Scene/PostProcessStageSampleMode.js @@ -1,20 +1,20 @@ /** * Determines how input texture to a {@link PostProcessStage} is sampled. * - * @enum {Number} + * @enum {number} */ const PostProcessStageSampleMode = { /** * Samples the texture by returning the closest texel. * - * @type {Number} + * @type {number} * @constant */ NEAREST: 0, /** * Samples the texture through bi-linear interpolation of the four nearest texels. * - * @type {Number} + * @type {number} * @constant */ LINEAR: 1, diff --git a/packages/engine/Source/Scene/PostProcessStageTextureCache.js b/packages/engine/Source/Scene/PostProcessStageTextureCache.js index 27dae7265101..cdc6e21a3986 100644 --- a/packages/engine/Source/Scene/PostProcessStageTextureCache.js +++ b/packages/engine/Source/Scene/PostProcessStageTextureCache.js @@ -389,7 +389,7 @@ PostProcessStageTextureCache.prototype.clear = function (context) { /** * Gets the stage with the given name. - * @param {String} name The name of the stage. + * @param {string} name The name of the stage. * @return {PostProcessStage|PostProcessStageComposite} */ PostProcessStageTextureCache.prototype.getStageByName = function (name) { @@ -398,7 +398,7 @@ PostProcessStageTextureCache.prototype.getStageByName = function (name) { /** * Gets the output texture for a stage with the given name. - * @param {String} name The name of the stage. + * @param {string} name The name of the stage. * @return {Texture|undefined} The output texture of the stage with the given name. */ PostProcessStageTextureCache.prototype.getOutputTexture = function (name) { @@ -408,7 +408,7 @@ PostProcessStageTextureCache.prototype.getOutputTexture = function (name) { /** * Gets the framebuffer for a stage with the given name. * - * @param {String} name The name of the stage. + * @param {string} name The name of the stage. * @return {Framebuffer|undefined} The framebuffer for the stage with the given name. */ PostProcessStageTextureCache.prototype.getFramebuffer = function (name) { @@ -426,7 +426,7 @@ PostProcessStageTextureCache.prototype.getFramebuffer = function (name) { * isDestroyed 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. * * @see PostProcessStageTextureCache#destroy */ diff --git a/packages/engine/Source/Scene/Primitive.js b/packages/engine/Source/Scene/Primitive.js index 1d9da3d018ba..a431decf52b1 100644 --- a/packages/engine/Source/Scene/Primitive.js +++ b/packages/engine/Source/Scene/Primitive.js @@ -63,20 +63,20 @@ import ShadowMode from "./ShadowMode.js"; * @alias Primitive * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {GeometryInstance[]|GeometryInstance} [options.geometryInstances] The geometry instances - or a single geometry instance - to render. * @param {Appearance} [options.appearance] The appearance used to render the primitive. * @param {Appearance} [options.depthFailAppearance] The appearance used to shade this primitive when it fails the depth test. - * @param {Boolean} [options.show=true] Determines if this primitive will be shown. + * @param {boolean} [options.show=true] Determines if this primitive will be shown. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The 4x4 transformation matrix that transforms the primitive (all geometry instances) from model to world coordinates. - * @param {Boolean} [options.vertexCacheOptimize=false] When true, geometry vertices are optimized for the pre and post-vertex-shader caches. - * @param {Boolean} [options.interleave=false] When true, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time. - * @param {Boolean} [options.compressVertices=true] When true, the geometry vertices are compressed, which will save memory. - * @param {Boolean} [options.releaseGeometryInstances=true] When true, the primitive does not keep a reference to the input geometryInstances to save memory. - * @param {Boolean} [options.allowPicking=true] When true, each geometry instance will only be pickable with {@link Scene#pick}. When false, GPU memory is saved. - * @param {Boolean} [options.cull=true] When true, the renderer frustum culls and horizon culls the primitive's commands based on their bounding volume. Set this to false for a small performance gain if you are manually culling the primitive. - * @param {Boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready. - * @param {Boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. + * @param {boolean} [options.vertexCacheOptimize=false] When true, geometry vertices are optimized for the pre and post-vertex-shader caches. + * @param {boolean} [options.interleave=false] When true, geometry vertex attributes are interleaved, which can slightly improve rendering performance but increases load time. + * @param {boolean} [options.compressVertices=true] When true, the geometry vertices are compressed, which will save memory. + * @param {boolean} [options.releaseGeometryInstances=true] When true, the primitive does not keep a reference to the input geometryInstances to save memory. + * @param {boolean} [options.allowPicking=true] When true, each geometry instance will only be pickable with {@link Scene#pick}. When false, GPU memory is saved. + * @param {boolean} [options.cull=true] When true, the renderer frustum culls and horizon culls the primitive's commands based on their bounding volume. Set this to false for a small performance gain if you are manually culling the primitive. + * @param {boolean} [options.asynchronous=true] Determines if the primitive will be created asynchronously or block until ready. + * @param {boolean} [options.debugShowBoundingVolume=false] For debugging only. Determines if this primitive's commands' bounding spheres are shown. * @param {ShadowMode} [options.shadows=ShadowMode.DISABLED] Determines whether this primitive casts or receives shadows from light sources. * * @example @@ -233,7 +233,7 @@ function Primitive(options) { * Determines if the primitive will be shown. This affects all geometry * instances in the primitive. * - * @type Boolean + * @type {boolean} * * @default true */ @@ -254,7 +254,7 @@ function Primitive(options) { * based on their bounding volume. Set this to false for a small performance gain * if you are manually culling the primitive. * - * @type {Boolean} + * @type {boolean} * * @default true */ @@ -266,7 +266,7 @@ function Primitive(options) { * Draws the bounding sphere for each draw command in the primitive. *

    * - * @type {Boolean} + * @type {boolean} * * @default false */ @@ -386,7 +386,7 @@ Object.defineProperties(Primitive.prototype, { * * @memberof Primitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -402,7 +402,7 @@ Object.defineProperties(Primitive.prototype, { * * @memberof Primitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default false @@ -418,7 +418,7 @@ Object.defineProperties(Primitive.prototype, { * * @memberof Primitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -434,7 +434,7 @@ Object.defineProperties(Primitive.prototype, { * * @memberof Primitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -450,7 +450,7 @@ Object.defineProperties(Primitive.prototype, { * * @memberof Primitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -466,7 +466,7 @@ Object.defineProperties(Primitive.prototype, { * * @memberof Primitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @default true @@ -484,7 +484,7 @@ Object.defineProperties(Primitive.prototype, { * * @memberof Primitive.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -496,7 +496,7 @@ Object.defineProperties(Primitive.prototype, { /** * Gets a promise that resolves when the primitive is ready to render. * @memberof Primitive.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -2388,7 +2388,7 @@ function createPickIdProperty(primitive, properties, index) { * Returns the modifiable per-instance attributes for a {@link GeometryInstance}. * * @param {*} id The id of the {@link GeometryInstance}. - * @returns {Object} The typed array in the attribute's format or undefined if the is no instance with id. + * @returns {object} The typed array in the attribute's format or undefined if the is no instance with id. * * @exception {DeveloperError} must call update before calling getGeometryInstanceAttributes. * @@ -2463,7 +2463,7 @@ Primitive.prototype.getGeometryInstanceAttributes = function (id) { * isDestroyed 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. * * @see Primitive#destroy */ diff --git a/packages/engine/Source/Scene/PrimitiveCollection.js b/packages/engine/Source/Scene/PrimitiveCollection.js index ec7ce6b65e45..89591993dfec 100644 --- a/packages/engine/Source/Scene/PrimitiveCollection.js +++ b/packages/engine/Source/Scene/PrimitiveCollection.js @@ -12,9 +12,9 @@ import DeveloperError from "../Core/DeveloperError.js"; * @alias PrimitiveCollection * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.show=true] Determines if the primitives in the collection will be shown. - * @param {Boolean} [options.destroyPrimitives=true] Determines if primitives in the collection are destroyed when they are removed. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.show=true] Determines if the primitives in the collection will be shown. + * @param {boolean} [options.destroyPrimitives=true] Determines if primitives in the collection are destroyed when they are removed. * * @example * const billboards = new Cesium.BillboardCollection(); @@ -38,7 +38,7 @@ function PrimitiveCollection(options) { /** * Determines if primitives in this collection will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -48,7 +48,7 @@ function PrimitiveCollection(options) { * {@link PrimitiveCollection#destroy} or {@link PrimitiveCollection#remove} or implicitly * by {@link PrimitiveCollection#removeAll}. * - * @type {Boolean} + * @type {boolean} * @default true * * @example @@ -76,7 +76,7 @@ Object.defineProperties(PrimitiveCollection.prototype, { * * @memberof PrimitiveCollection.prototype * - * @type {Number} + * @type {number} * @readonly */ length: { @@ -89,9 +89,9 @@ Object.defineProperties(PrimitiveCollection.prototype, { /** * Adds a primitive to the collection. * - * @param {Object} primitive The primitive to add. - * @param {Number} [index] The index to add the layer at. If omitted, the primitive will be added at the bottom of all existing primitives. - * @returns {Object} The primitive added to the collection. + * @param {object} primitive The primitive to add. + * @param {number} [index] The index to add the layer at. If omitted, the primitive will be added at the bottom of all existing primitives. + * @returns {object} The primitive added to the collection. * * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. * @@ -134,8 +134,8 @@ PrimitiveCollection.prototype.add = function (primitive, index) { /** * Removes a primitive from the collection. * - * @param {Object} [primitive] The primitive to remove. - * @returns {Boolean} true if the primitive was removed; false if the primitive is undefined or was not found in the collection. + * @param {object} [primitive] The primitive to remove. + * @returns {boolean} true if the primitive was removed; false if the primitive is undefined or was not found in the collection. * * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. * @@ -201,8 +201,8 @@ PrimitiveCollection.prototype.removeAll = function () { /** * Determines if this collection contains a primitive. * - * @param {Object} [primitive] The primitive to check for. - * @returns {Boolean} true if the primitive is in the collection; false if the primitive is undefined or was not found in the collection. + * @param {object} [primitive] The primitive to check for. + * @returns {boolean} true if the primitive is in the collection; false if the primitive is undefined or was not found in the collection. * * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. * @@ -231,7 +231,7 @@ function getPrimitiveIndex(compositePrimitive, primitive) { * Raises a primitive "up one" in the collection. If all primitives in the collection are drawn * on the globe surface, this visually moves the primitive up one. * - * @param {Object} [primitive] The primitive to raise. + * @param {object} [primitive] The primitive to raise. * * @exception {DeveloperError} primitive is not in this collection. * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. @@ -257,7 +257,7 @@ PrimitiveCollection.prototype.raise = function (primitive) { * Raises a primitive to the "top" of the collection. If all primitives in the collection are drawn * on the globe surface, this visually moves the primitive to the top. * - * @param {Object} [primitive] The primitive to raise the top. + * @param {object} [primitive] The primitive to raise the top. * * @exception {DeveloperError} primitive is not in this collection. * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. @@ -283,7 +283,7 @@ PrimitiveCollection.prototype.raiseToTop = function (primitive) { * Lowers a primitive "down one" in the collection. If all primitives in the collection are drawn * on the globe surface, this visually moves the primitive down one. * - * @param {Object} [primitive] The primitive to lower. + * @param {object} [primitive] The primitive to lower. * * @exception {DeveloperError} primitive is not in this collection. * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. @@ -309,7 +309,7 @@ PrimitiveCollection.prototype.lower = function (primitive) { * Lowers a primitive to the "bottom" of the collection. If all primitives in the collection are drawn * on the globe surface, this visually moves the primitive to the bottom. * - * @param {Object} [primitive] The primitive to lower to the bottom. + * @param {object} [primitive] The primitive to lower to the bottom. * * @exception {DeveloperError} primitive is not in this collection. * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. @@ -334,8 +334,8 @@ PrimitiveCollection.prototype.lowerToBottom = function (primitive) { /** * Returns the primitive in the collection at the specified index. * - * @param {Number} index The zero-based index of the primitive to return. - * @returns {Object} The primitive at the index. + * @param {number} index The zero-based index of the primitive to return. + * @returns {object} The primitive at the index. * * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called. * @@ -432,7 +432,7 @@ PrimitiveCollection.prototype.postPassesUpdate = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see PrimitiveCollection#destroy */ diff --git a/packages/engine/Source/Scene/PrimitiveLoadPlan.js b/packages/engine/Source/Scene/PrimitiveLoadPlan.js index e58d972d060e..31d1f5928f5f 100644 --- a/packages/engine/Source/Scene/PrimitiveLoadPlan.js +++ b/packages/engine/Source/Scene/PrimitiveLoadPlan.js @@ -37,7 +37,7 @@ function AttributeLoadPlan(attribute) { * Whether the attribute will be loaded as a GPU buffer by the time * {@link PrimitiveLoadPlan#postProcess} is finished. * - * @type {Boolean} + * @type {boolean} * @private */ this.loadBuffer = false; @@ -46,7 +46,7 @@ function AttributeLoadPlan(attribute) { * Whether the attribute will be loaded as a packed typed array by the time * {@link PrimitiveLoadPlan#postProcess} is finished. * - * @type {Boolean} + * @type {boolean} * @private */ this.loadTypedArray = false; @@ -81,7 +81,7 @@ function IndicesLoadPlan(indices) { * Whether the indices will be loaded as a GPU buffer by the time * {@link PrimitiveLoadPlan#postProcess} is finished. * - * @type {Boolean} + * @type {boolean} * @private */ this.loadBuffer = false; @@ -90,7 +90,7 @@ function IndicesLoadPlan(indices) { * Whether the indices will be loaded as a typed array copy of the GPU * buffer by the time {@link PrimitiveLoadPlan#postProcess} is finished. * - * @type {Boolean} + * @type {boolean} * @private */ this.loadTypedArray = false; @@ -145,7 +145,7 @@ function PrimitiveLoadPlan(primitive) { * Set this true to indicate that the primitive has the * CESIUM_primitive_outline extension and needs to be post-processed * - * @type {Boolean} + * @type {boolean} * @private */ this.needsOutlines = false; @@ -153,7 +153,7 @@ function PrimitiveLoadPlan(primitive) { /** * The outline edge indices from the CESIUM_primitive_outline extension * - * @type {Number[]} + * @type {number[]} * @private */ this.outlineIndices = undefined; diff --git a/packages/engine/Source/Scene/PropertyAttribute.js b/packages/engine/Source/Scene/PropertyAttribute.js index 565e6bb1f912..e3da8c952ed5 100644 --- a/packages/engine/Source/Scene/PropertyAttribute.js +++ b/packages/engine/Source/Scene/PropertyAttribute.js @@ -10,10 +10,10 @@ import PropertyAttributeProperty from "./PropertyAttributeProperty.js"; * See the {@link https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_structural_metadata|EXT_structural_metadata Extension} *

    * - * @param {Object} options Object with the following properties: - * @param {String} [options.name] Optional human-readable name to describe the attribute - * @param {Number} [options.id] A unique id to identify the property attribute, useful for debugging. This is the array index in the property attributes array - * @param {Object} options.propertyAttribute The property attribute 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 attribute + * @param {number} [options.id] A unique id to identify the property attribute, useful for debugging. This is the array index in the property attributes array + * @param {object} options.propertyAttribute The property attribute JSON, following the EXT_structural_metadata schema. * @param {MetadataClass} options.class The class that properties conform to. * * @alias PropertyAttribute @@ -58,7 +58,7 @@ Object.defineProperties(PropertyAttribute.prototype, { * * @memberof PropertyAttribute.prototype * - * @type {String} + * @type {string} * @readonly * @private */ @@ -72,7 +72,7 @@ Object.defineProperties(PropertyAttribute.prototype, { * * @memberof PropertyAttribute.prototype * - * @type {String|Number} + * @type {string|number} * @readonly * @private */ @@ -101,7 +101,7 @@ Object.defineProperties(PropertyAttribute.prototype, { * * @memberof PropertyAttribute.prototype * - * @type {Object.} + * @type {Object} * @readonly * @private */ @@ -131,7 +131,7 @@ Object.defineProperties(PropertyAttribute.prototype, { * * @memberof PropertyAttribute.prototype * - * @type {Object} + * @type {object} * @readonly * @private */ @@ -145,7 +145,7 @@ Object.defineProperties(PropertyAttribute.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 {PropertyAttributeProperty|undefined} The property, or undefined if the property does not exist. * @private */ diff --git a/packages/engine/Source/Scene/PropertyAttributeProperty.js b/packages/engine/Source/Scene/PropertyAttributeProperty.js index f7d515069cd4..607fb8611470 100644 --- a/packages/engine/Source/Scene/PropertyAttributeProperty.js +++ b/packages/engine/Source/Scene/PropertyAttributeProperty.js @@ -9,8 +9,8 @@ import defined from "../Core/defined.js"; * See the {@link https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_structural_metadata|EXT_structural_metadata Extension} *

    * - * @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. * * @alias PropertyAttributeProperty @@ -66,7 +66,7 @@ Object.defineProperties(PropertyAttributeProperty.prototype, { * The attribute semantic * * @memberof PropertyAttributeProperty.prototype - * @type {String} + * @type {string} * @readonly * @private */ @@ -81,7 +81,7 @@ Object.defineProperties(PropertyAttributeProperty.prototype, { * undefined, they default to identity so this property is set false * * @memberof MetadataClassProperty.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @private */ @@ -95,7 +95,7 @@ Object.defineProperties(PropertyAttributeProperty.prototype, { * The offset to be added to property values as part of the value transform. * * @memberof MetadataClassProperty.prototype - * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} + * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} * @readonly * @private */ @@ -109,7 +109,7 @@ Object.defineProperties(PropertyAttributeProperty.prototype, { * The scale to be multiplied to property values as part of the value transform. * * @memberof MetadataClassProperty.prototype - * @type {Number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} + * @type {number|Cartesian2|Cartesian3|Cartesian4|Matrix2|Matrix3|Matrix4} * @readonly * @private */ diff --git a/packages/engine/Source/Scene/PropertyTable.js b/packages/engine/Source/Scene/PropertyTable.js index 8271901b8233..19860c82de18 100644 --- a/packages/engine/Source/Scene/PropertyTable.js +++ b/packages/engine/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. *

    * - * @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 EXT_structural_metadata, this is the array index in the property tables array, for EXT_feature_metadata 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 EXT_structural_metadata, this is the array index in the property tables array, for EXT_feature_metadata 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 3DTILES_batch_table_hierarchy 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 3DTILES_batch_table_hierarchy 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 3DTILES_batch_table_hierarchy 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 3DTILES_batch_table_hierarchy 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. *

    * - * @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 undefined 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. *

    * - * @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. *

    * - * @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 undefined if the feature does not have this semantic. * @private */ @@ -425,10 +425,10 @@ PropertyTable.prototype.getPropertyBySemantic = function (index, semantic) { * semantics. *

    * - * @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} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ PropertyTable.prototype.setPropertyBySemantic = function ( @@ -451,7 +451,7 @@ PropertyTable.prototype.setPropertyBySemantic = function ( * values in typed arrays. *

    * - * @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 undefined if the property values are not stored in a typed array. * * @private @@ -476,7 +476,7 @@ PropertyTable.prototype.getPropertyTypedArray = function (propertyId) { * semantics. *

    * - * @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 undefined if the property values are not stored in a typed array. * * @private diff --git a/packages/engine/Source/Scene/PropertyTexture.js b/packages/engine/Source/Scene/PropertyTexture.js index 28d136766dba..4937827330ac 100644 --- a/packages/engine/Source/Scene/PropertyTexture.js +++ b/packages/engine/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. *

    * - * @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 EXT_structural_metadata, this is the array index in the property textures array, for EXT_feature_metadata 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 EXT_structural_metadata, this is the array index in the property textures array, for EXT_feature_metadata 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.} options.textures An object mapping texture IDs to {@link Texture} objects. + * @param {Object} 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 undefined if the property does not exist. * @private */ diff --git a/packages/engine/Source/Scene/PropertyTextureProperty.js b/packages/engine/Source/Scene/PropertyTextureProperty.js index 6c4eace0a849..9c1ed66239b9 100644 --- a/packages/engine/Source/Scene/PropertyTextureProperty.js +++ b/packages/engine/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. *

    * - * @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.} options.textures An object mapping texture IDs to {@link Texture} objects. + * @param {Object} 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 [0, 1] 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) { diff --git a/packages/engine/Source/Scene/QuadtreePrimitive.js b/packages/engine/Source/Scene/QuadtreePrimitive.js index 795b71bf78e2..8d042f40d235 100644 --- a/packages/engine/Source/Scene/QuadtreePrimitive.js +++ b/packages/engine/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. */ diff --git a/packages/engine/Source/Scene/QuadtreeTile.js b/packages/engine/Source/Scene/QuadtreeTile.js index 19f5b5abc480..601458acbbf7 100644 --- a/packages/engine/Source/Scene/QuadtreeTile.js +++ b/packages/engine/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 * START or LOADING. * @memberof QuadtreeTile.prototype - * @type {Boolean} + * @type {boolean} */ needsLoading: { get: function () { @@ -386,7 +386,7 @@ Object.defineProperties(QuadtreeTile.prototype, { * eligibleForUnloading property, the value of that property is returned. * Otherwise, this property returns true. * @memberof QuadtreeTile.prototype - * @type {Boolean} + * @type {boolean} */ eligibleForUnloading: { get: function () { diff --git a/packages/engine/Source/Scene/QuadtreeTileLoadState.js b/packages/engine/Source/Scene/QuadtreeTileLoadState.js index c76ebcea90c9..5be7703b2bf2 100644 --- a/packages/engine/Source/Scene/QuadtreeTileLoadState.js +++ b/packages/engine/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 = { diff --git a/packages/engine/Source/Scene/QuadtreeTileProvider.js b/packages/engine/Source/Scene/QuadtreeTileProvider.js index 92c6a90a9838..bb7f5fb73fb8 100644 --- a/packages/engine/Source/Scene/QuadtreeTileProvider.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/ResourceCache.js b/packages/engine/Source/Scene/ResourceCache.js index 862b39aeeaa1..d80625bc6b56 100644 --- a/packages/engine/Source/Scene/ResourceCache.js +++ b/packages/engine/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 diff --git a/packages/engine/Source/Scene/ResourceCacheKey.js b/packages/engine/Source/Scene/ResourceCacheKey.js index b8075efed854..71d983242d5a 100644 --- a/packages/engine/Source/Scene/ResourceCacheKey.js +++ b/packages/engine/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) { diff --git a/packages/engine/Source/Scene/ResourceCacheStatistics.js b/packages/engine/Source/Scene/ResourceCacheStatistics.js index 70fef98fbc39..187f267bf363 100644 --- a/packages/engine/Source/Scene/ResourceCacheStatistics.js +++ b/packages/engine/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; diff --git a/packages/engine/Source/Scene/ResourceLoader.js b/packages/engine/Source/Scene/ResourceLoader.js index aa5756207e6e..03c1fde78517 100644 --- a/packages/engine/Source/Scene/ResourceLoader.js +++ b/packages/engine/Source/Scene/ResourceLoader.js @@ -25,7 +25,7 @@ Object.defineProperties(ResourceLoader.prototype, { * * @memberof ResourceLoader.prototype * - * @type {Promise.|undefined} + * @type {Promise|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.} A promise which resolves to the loader when the resource loading is completed. + * @returns {Promise} 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 * isDestroyed 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. * * @see ResourceLoader#destroy * @private diff --git a/packages/engine/Source/Scene/ResourceLoaderState.js b/packages/engine/Source/Scene/ResourceLoaderState.js index df206e2943f1..8e86d7621c99 100644 --- a/packages/engine/Source/Scene/ResourceLoaderState.js +++ b/packages/engine/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 */ diff --git a/packages/engine/Source/Scene/SDFSettings.js b/packages/engine/Source/Scene/SDFSettings.js index 66748dde8d49..0ce45f7cc781 100644 --- a/packages/engine/Source/Scene/SDFSettings.js +++ b/packages/engine/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, diff --git a/packages/engine/Source/Scene/Scene.js b/packages/engine/Source/Scene/Scene.js index 40d9c4f8e3ba..9bd9bd90d06c 100644 --- a/packages/engine/Source/Scene/Scene.js +++ b/packages/engine/Source/Scene/Scene.js @@ -85,20 +85,20 @@ const requestRenderAfterFrame = function (scene) { * @alias Scene * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {HTMLCanvasElement} options.canvas The HTML canvas element to create the scene for. * @param {ContextOptions} [options.contextOptions] Context and WebGL creation properties. * @param {Element} [options.creditContainer] The HTML element in which the credits will be displayed. * @param {Element} [options.creditViewport] The HTML element in which to display the credit popup. If not specified, the viewport will be a added as a sibling of the canvas. * @param {MapProjection} [options.mapProjection=new GeographicProjection()] The map projection to use in 2D and Columbus View modes. - * @param {Boolean} [options.orderIndependentTranslucency=true] If true and the configuration supports it, use order independent translucency. - * @param {Boolean} [options.scene3DOnly=false] If true, optimizes memory use and performance for 3D mode but disables the ability to use 2D or Columbus View. - * @param {Boolean} [options.shadows=false] Determines if shadows are cast by light sources. + * @param {boolean} [options.orderIndependentTranslucency=true] If true and the configuration supports it, use order independent translucency. + * @param {boolean} [options.scene3DOnly=false] If true, optimizes memory use and performance for 3D mode but disables the ability to use 2D or Columbus View. + * @param {boolean} [options.shadows=false] Determines if shadows are cast by light sources. * @param {MapMode2D} [options.mapMode2D=MapMode2D.INFINITE_SCROLL] Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. - * @param {Boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. - * @param {Number} [options.maximumRenderTimeChange=0.0] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. - * @param {Number} [options.depthPlaneEllipsoidOffset=0.0] Adjust the DepthPlane to address rendering artefacts below ellipsoid zero elevation. - * @param {Number} [options.msaaSamples=1] If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. + * @param {boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. + * @param {number} [options.maximumRenderTimeChange=0.0] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. + * @param {number} [options.depthPlaneEllipsoidOffset=0.0] Adjust the DepthPlane to address rendering artefacts below ellipsoid zero elevation. + * @param {number} [options.msaaSamples=1] If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. * * @see CesiumWidget * @see {@link http://www.khronos.org/registry/webgl/specs/latest/#5.2|WebGLContextAttributes} @@ -223,7 +223,7 @@ function Scene(options) { * after the event is raised. If this property is false, the render function * returns normally after raising the event. * - * @type {Boolean} + * @type {boolean} * @default false */ this.rethrowRenderErrors = false; @@ -232,7 +232,7 @@ function Scene(options) { * Determines whether or not to instantly complete the * scene transition animation on user input. * - * @type {Boolean} + * @type {boolean} * @default true */ this.completeMorphOnUserInput = true; @@ -280,7 +280,7 @@ function Scene(options) { /** * Uses a bloom filter on the sun when enabled. * - * @type {Boolean} + * @type {boolean} * @default true */ this.sunBloom = true; @@ -314,7 +314,7 @@ function Scene(options) { * The current morph transition time between 2D/Columbus View and 3D, * with 0.0 being 2D or Columbus View and 1.0 being 3D. * - * @type {Number} + * @type {number} * @default 1.0 */ this.morphTime = 1.0; @@ -327,7 +327,7 @@ function Scene(options) { * true, use {@link Scene#logarithmicDepthFarToNearRatio}. *

    * - * @type {Number} + * @type {number} * @default 1000.0 */ this.farToNearRatio = 1000.0; @@ -340,7 +340,7 @@ function Scene(options) { * false, use {@link Scene#farToNearRatio}. *

    * - * @type {Number} + * @type {number} * @default 1e9 */ this.logarithmicDepthFarToNearRatio = 1e9; @@ -350,7 +350,7 @@ function Scene(options) { * to the surface shows z-fighting, decreasing this will eliminate the artifact, but decrease performance. On the * other hand, increasing this will increase performance but may cause z-fighting among primitives close to the surface. * - * @type {Number} + * @type {number} * @default 1.75e6 */ this.nearToFarDistance2D = 1.75e6; @@ -392,7 +392,7 @@ function Scene(options) { * command-dense and could benefit from batching. *

    * - * @type Boolean + * @type {boolean} * * @default false */ @@ -409,7 +409,7 @@ function Scene(options) { * yellow. *

    * - * @type Boolean + * @type {boolean} * * @default false */ @@ -421,7 +421,7 @@ function Scene(options) { * Displays frames per second and time between frames. *

    * - * @type Boolean + * @type {boolean} * * @default false */ @@ -433,7 +433,7 @@ function Scene(options) { * Indicates which frustum will have depth information displayed. *

    * - * @type Number + * @type {number} * * @default 1 */ @@ -445,7 +445,7 @@ function Scene(options) { * When true, draws outlines to show the boundaries of the camera frustums *

    * - * @type Boolean + * @type {boolean} * * @default false */ @@ -456,7 +456,7 @@ function Scene(options) { /** * When true, enables picking using the depth buffer. * - * @type Boolean + * @type {boolean} * @default true */ this.useDepthPicking = true; @@ -480,14 +480,14 @@ function Scene(options) { * const worldPosition = viewer.scene.pickPosition(movement.position); * }, Cesium.ScreenSpaceEventType.LEFT_CLICK); * - * @type {Boolean} + * @type {boolean} * @default false */ this.pickTranslucentDepth = false; /** * The time in milliseconds to wait before checking if the camera has not moved and fire the cameraMoveEnd event. - * @type {Number} + * @type {number} * @default 500.0 * @private */ @@ -515,7 +515,7 @@ function Scene(options) { /** * When false, 3D Tiles will render normally. When true, classified 3D Tile geometry will render normally and * unclassified 3D Tile geometry will render with the color multiplied by {@link Scene#invertClassificationColor}. - * @type {Boolean} + * @type {boolean} * @default false */ this.invertClassification = false; @@ -536,13 +536,13 @@ function Scene(options) { /** * The focal length for use when with cardboard or WebVR. - * @type {Number} + * @type {number} */ this.focalLength = undefined; /** * The eye separation distance in meters for use with cardboard or WebVR. - * @type {Number} + * @type {number} */ this.eyeSeparation = undefined; @@ -604,7 +604,7 @@ function Scene(options) { * @see Scene#maximumRenderTimeChange * @see Scene#requestRender * - * @type {Boolean} + * @type {boolean} * @default false */ this.requestRenderMode = defaultValue(options.requestRenderMode, false); @@ -621,7 +621,7 @@ function Scene(options) { * @see {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering} * @see Scene#requestRenderMode * - * @type {Number} + * @type {number} * @default 0.0 */ this.maximumRenderTimeChange = defaultValue( @@ -683,7 +683,7 @@ function Scene(options) { /** * The url to the KTX2 file containing the specular environment map and convoluted mipmaps for image-based lighting of PBR models. - * @type {String} + * @type {string} */ this.specularEnvironmentMaps = undefined; this._specularEnvironmentMapAtlas = undefined; @@ -740,7 +740,7 @@ Object.defineProperties(Scene.prototype, { * The drawingBufferHeight of the underlying GL context. * @memberof Scene.prototype * - * @type {Number} + * @type {number} * @readonly * * @see {@link https://www.khronos.org/registry/webgl/specs/1.0/#DOM-WebGLRenderingContext-drawingBufferHeight|drawingBufferHeight} @@ -755,7 +755,7 @@ Object.defineProperties(Scene.prototype, { * The drawingBufferHeight of the underlying GL context. * @memberof Scene.prototype * - * @type {Number} + * @type {number} * @readonly * * @see {@link https://www.khronos.org/registry/webgl/specs/1.0/#DOM-WebGLRenderingContext-drawingBufferHeight|drawingBufferHeight} @@ -770,7 +770,7 @@ Object.defineProperties(Scene.prototype, { * The maximum aliased line width, in pixels, supported by this WebGL implementation. It will be at least one. * @memberof Scene.prototype * - * @type {Number} + * @type {number} * @readonly * * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with ALIASED_LINE_WIDTH_RANGE. @@ -785,7 +785,7 @@ Object.defineProperties(Scene.prototype, { * The maximum length in pixels of one edge of a cube map, supported by this WebGL implementation. It will be at least 16. * @memberof Scene.prototype * - * @type {Number} + * @type {number} * @readonly * * @see {@link https://www.khronos.org/opengles/sdk/docs/man/xhtml/glGet.xml|glGet} with GL_MAX_CUBE_MAP_TEXTURE_SIZE. @@ -800,7 +800,7 @@ Object.defineProperties(Scene.prototype, { * Returns true if the {@link Scene#pickPosition} function is supported. * @memberof Scene.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @see Scene#pickPosition @@ -815,7 +815,7 @@ Object.defineProperties(Scene.prototype, { * Returns true if the {@link Scene#sampleHeight} and {@link Scene#sampleHeightMostDetailed} functions are supported. * @memberof Scene.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @see Scene#sampleHeight @@ -831,7 +831,7 @@ Object.defineProperties(Scene.prototype, { * Returns true if the {@link Scene#clampToHeight} and {@link Scene#clampToHeightMostDetailed} functions are supported. * @memberof Scene.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @see Scene#clampToHeight @@ -847,7 +847,7 @@ Object.defineProperties(Scene.prototype, { * Returns true if the {@link Scene#invertClassification} is supported. * @memberof Scene.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @see Scene#invertClassification @@ -862,7 +862,7 @@ Object.defineProperties(Scene.prototype, { * Returns true if specular environment maps are supported. * @memberof Scene.prototype * - * @type {Boolean} + * @type {boolean} * @readonly * * @see Scene#specularEnvironmentMaps @@ -1259,7 +1259,7 @@ Object.defineProperties(Scene.prototype, { * * @memberof Scene.prototype * - * @type {Object} + * @type {object} * @readonly * * @default undefined @@ -1273,7 +1273,7 @@ Object.defineProperties(Scene.prototype, { /** * Gets whether or not the scene is optimized for 3D only viewing. * @memberof Scene.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ scene3DOnly: { @@ -1287,7 +1287,7 @@ Object.defineProperties(Scene.prototype, { * Note that this only reflects the original construction option, and there are * other factors that could prevent OIT from functioning on a given system configuration. * @memberof Scene.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ orderIndependentTranslucency: { @@ -1299,7 +1299,7 @@ Object.defineProperties(Scene.prototype, { /** * Gets the unique identifier for this scene. * @memberof Scene.prototype - * @type {String} + * @type {string} * @readonly */ id: { @@ -1359,7 +1359,7 @@ Object.defineProperties(Scene.prototype, { /** * Gets the number of frustums used in the last frame. * @memberof Scene.prototype - * @type {Number} + * @type {number} * * @private */ @@ -1373,7 +1373,7 @@ Object.defineProperties(Scene.prototype, { * When true, splits the scene into two viewports with steroscopic views for the left and right eyes. * Used for cardboard and WebVR. * @memberof Scene.prototype - * @type {Boolean} + * @type {boolean} * @default false */ useWebVR: { @@ -1429,7 +1429,7 @@ Object.defineProperties(Scene.prototype, { * Gets or sets the position of the splitter within the viewport. Valid values are between 0.0 and 1.0. * @memberof Scene.prototype * - * @type {Number} + * @type {number} */ splitPosition: { get: function () { @@ -1446,7 +1446,7 @@ Object.defineProperties(Scene.prototype, { * be applied. When less than zero, the depth test should never be applied. Setting the disableDepthTestDistance * property of a billboard, label or point will override this value. * @memberof Scene.prototype - * @type {Number} + * @type {number} * @default 0.0 */ minimumDisableDepthTestDistance: { @@ -1469,7 +1469,7 @@ Object.defineProperties(Scene.prototype, { * Whether or not to use a logarithmic depth buffer. Enabling this option will allow for less frustums in the multi-frustum, * increasing performance. This property relies on fragmentDepth being supported. * @memberof Scene.prototype - * @type {Boolean} + * @type {boolean} */ logarithmicDepthBuffer: { get: function () { @@ -1487,7 +1487,7 @@ Object.defineProperties(Scene.prototype, { /** * The value used for gamma correction. This is only used when rendering with high dynamic range. * @memberof Scene.prototype - * @type {Number} + * @type {number} * @default 2.2 */ gamma: { @@ -1502,7 +1502,7 @@ Object.defineProperties(Scene.prototype, { /** * Whether or not to use high dynamic range rendering. * @memberof Scene.prototype - * @type {Boolean} + * @type {boolean} * @default false */ highDynamicRange: { @@ -1523,7 +1523,7 @@ Object.defineProperties(Scene.prototype, { /** * Whether or not high dynamic range rendering is supported. * @memberof Scene.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @default true */ @@ -1540,7 +1540,7 @@ Object.defineProperties(Scene.prototype, { /** * Whether or not the camera is underneath the globe. * @memberof Scene.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @default false */ @@ -1553,7 +1553,7 @@ Object.defineProperties(Scene.prototype, { /** * The sample rate of multisample antialiasing (values greater than 1 enable MSAA). * @memberof Scene.prototype - * @type {Number} + * @type {number} * @default 1 */ msaaSamples: { @@ -1569,7 +1569,7 @@ Object.defineProperties(Scene.prototype, { /** * Returns true if the Scene's context supports MSAA. * @memberof Scene.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ msaaSupported: { @@ -1583,7 +1583,7 @@ Object.defineProperties(Scene.prototype, { * measure for real pixel measurements appropriate to a particular device. * * @memberof Scene.prototype - * @type {Number} + * @type {number} * @default 1.0 * @private */ @@ -1617,7 +1617,7 @@ Object.defineProperties(Scene.prototype, { /** * Determines if a compressed texture format is supported. - * @param {String} format The texture format. May be the name of the format or the WebGL extension name, e.g. s3tc or WEBGL_compressed_texture_s3tc. + * @param {string} format The texture format. May be the name of the format or the WebGL extension name, e.g. s3tc or WEBGL_compressed_texture_s3tc. * @return {boolean} Whether or not the format is supported. */ Scene.prototype.getCompressedTextureFormatSupported = function (format) { @@ -3920,9 +3920,9 @@ Scene.prototype.clampLineWidth = function (width) { * }, Cesium.ScreenSpaceEventType.MOUSE_MOVE); * * @param {Cartesian2} windowPosition Window coordinates to perform picking on. - * @param {Number} [width=3] Width of the pick rectangle. - * @param {Number} [height=3] Height of the pick rectangle. - * @returns {Object} Object containing the picked primitive. + * @param {number} [width=3] Width of the pick rectangle. + * @param {number} [height=3] Height of the pick rectangle. + * @returns {object} Object containing the picked primitive. */ Scene.prototype.pick = function (windowPosition, width, height) { return this._picking.pick(this, windowPosition, width, height); @@ -3985,10 +3985,10 @@ Scene.prototype.pickPosition = function (windowPosition, result) { * the list are ordered by their visual order in the scene (front to back). * * @param {Cartesian2} windowPosition Window coordinates to perform picking on. - * @param {Number} [limit] If supplied, stop drilling after collecting this many picks. - * @param {Number} [width=3] Width of the pick rectangle. - * @param {Number} [height=3] Height of the pick rectangle. - * @returns {Array.<*>} Array of objects, each containing 1 picked primitives. + * @param {number} [limit] If supplied, stop drilling after collecting this many picks. + * @param {number} [width=3] Width of the pick rectangle. + * @param {number} [height=3] Height of the pick rectangle. + * @returns {any[]} Array of objects, each containing 1 picked primitives. * * @exception {DeveloperError} windowPosition is undefined. * @@ -4047,8 +4047,8 @@ function updateRequestRenderModeDeferCheckPass(scene) { * * @param {Ray} ray The ray. * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection. - * @param {Number} [width=0.1] Width of the intersection volume in meters. - * @returns {Object} An object containing the object and position of the first intersection. + * @param {number} [width=0.1] Width of the intersection volume in meters. + * @returns {object} An object containing the object and position of the first intersection. * * @exception {DeveloperError} Ray intersections are only supported in 3D mode. */ @@ -4070,9 +4070,9 @@ Scene.prototype.pickFromRay = function (ray, objectsToExclude, width) { * @private * * @param {Ray} ray The ray. - * @param {Number} [limit=Number.MAX_VALUE] If supplied, stop finding intersections after this many intersections. + * @param {number} [limit=Number.MAX_VALUE] If supplied, stop finding intersections after this many intersections. * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection. - * @param {Number} [width=0.1] Width of the intersection volume in meters. + * @param {number} [width=0.1] Width of the intersection volume in meters. * @returns {Object[]} List of objects containing the object and position of each intersection. * * @exception {DeveloperError} Ray intersections are only supported in 3D mode. @@ -4100,8 +4100,8 @@ Scene.prototype.drillPickFromRay = function ( * * @param {Ray} ray The ray. * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection. - * @param {Number} [width=0.1] Width of the intersection volume in meters. - * @returns {Promise.} A promise that resolves to an object containing the object and position of the first intersection. + * @param {number} [width=0.1] Width of the intersection volume in meters. + * @returns {Promise} A promise that resolves to an object containing the object and position of the first intersection. * * @exception {DeveloperError} Ray intersections are only supported in 3D mode. */ @@ -4125,10 +4125,10 @@ Scene.prototype.pickFromRayMostDetailed = function ( * @private * * @param {Ray} ray The ray. - * @param {Number} [limit=Number.MAX_VALUE] If supplied, stop finding intersections after this many intersections. + * @param {number} [limit=Number.MAX_VALUE] If supplied, stop finding intersections after this many intersections. * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to exclude from the ray intersection. - * @param {Number} [width=0.1] Width of the intersection volume in meters. - * @returns {Promise.} A promise that resolves to a list of objects containing the object and position of each intersection. + * @param {number} [width=0.1] Width of the intersection volume in meters. + * @returns {Promise} A promise that resolves to a list of objects containing the object and position of each intersection. * * @exception {DeveloperError} Ray intersections are only supported in 3D mode. */ @@ -4158,8 +4158,8 @@ Scene.prototype.drillPickFromRayMostDetailed = function ( * * @param {Cartographic} position The cartographic position to sample height from. * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not sample height from. - * @param {Number} [width=0.1] Width of the intersection volume in meters. - * @returns {Number} The height. This may be undefined if there was no scene geometry to sample height from. + * @param {number} [width=0.1] Width of the intersection volume in meters. + * @returns {number} The height. This may be undefined if there was no scene geometry to sample height from. * * @example * const position = new Cesium.Cartographic(-1.31968, 0.698874); @@ -4188,7 +4188,7 @@ Scene.prototype.sampleHeight = function (position, objectsToExclude, width) { * * @param {Cartesian3} cartesian The cartesian position. * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not clamp to. - * @param {Number} [width=0.1] Width of the intersection volume in meters. + * @param {number} [width=0.1] Width of the intersection volume in meters. * @param {Cartesian3} [result] An optional object to return the clamped position. * @returns {Cartesian3} The modified result parameter or a new Cartesian3 instance if one was not provided. This may be undefined if there was no scene geometry to clamp to. * @@ -4228,8 +4228,8 @@ Scene.prototype.clampToHeight = function ( * * @param {Cartographic[]} positions The cartographic positions to update with sampled heights. * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not sample height from. - * @param {Number} [width=0.1] Width of the intersection volume in meters. - * @returns {Promise.} A promise that resolves to the provided list of positions when the query has completed. + * @param {number} [width=0.1] Width of the intersection volume in meters. + * @returns {Promise} A promise that resolves to the provided list of positions when the query has completed. * * @example * const positions = [ @@ -4268,8 +4268,8 @@ Scene.prototype.sampleHeightMostDetailed = function ( * * @param {Cartesian3[]} cartesians The cartesian positions to update with clamped positions. * @param {Object[]} [objectsToExclude] A list of primitives, entities, or 3D Tiles features to not clamp to. - * @param {Number} [width=0.1] Width of the intersection volume in meters. - * @returns {Promise.} A promise that resolves to the provided list of positions when the query has completed. + * @param {number} [width=0.1] Width of the intersection volume in meters. + * @returns {Promise} A promise that resolves to the provided list of positions when the query has completed. * * @example * const cartesians = [ @@ -4331,7 +4331,7 @@ Scene.prototype.completeMorph = function () { /** * Asynchronously transitions the scene to 2D. - * @param {Number} [duration=2.0] The amount of time, in seconds, for transition animations to complete. + * @param {number} [duration=2.0] The amount of time, in seconds, for transition animations to complete. */ Scene.prototype.morphTo2D = function (duration) { let ellipsoid; @@ -4347,7 +4347,7 @@ Scene.prototype.morphTo2D = function (duration) { /** * Asynchronously transitions the scene to Columbus View. - * @param {Number} [duration=2.0] The amount of time, in seconds, for transition animations to complete. + * @param {number} [duration=2.0] The amount of time, in seconds, for transition animations to complete. */ Scene.prototype.morphToColumbusView = function (duration) { let ellipsoid; @@ -4363,7 +4363,7 @@ Scene.prototype.morphToColumbusView = function (duration) { /** * Asynchronously transitions the scene to 3D. - * @param {Number} [duration=2.0] The amount of time, in seconds, for transition animations to complete. + * @param {number} [duration=2.0] The amount of time, in seconds, for transition animations to complete. */ Scene.prototype.morphTo3D = function (duration) { let ellipsoid; @@ -4383,7 +4383,7 @@ Scene.prototype.morphTo3D = function (duration) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see Scene#destroy */ diff --git a/packages/engine/Source/Scene/SceneMode.js b/packages/engine/Source/Scene/SceneMode.js index 006ed4ed7043..2905c53cb827 100644 --- a/packages/engine/Source/Scene/SceneMode.js +++ b/packages/engine/Source/Scene/SceneMode.js @@ -1,14 +1,14 @@ /** * Indicates if the scene is viewed in 3D, 2D, or 2.5D Columbus view. * - * @enum {Number} + * @enum {number} * @see Scene#mode */ const SceneMode = { /** * Morphing between mode, e.g., 3D to 2D. * - * @type {Number} + * @type {number} * @constant */ MORPHING: 0, @@ -17,7 +17,7 @@ const SceneMode = { * Columbus View mode. A 2.5D perspective view where the map is laid out * flat and objects with non-zero height are drawn above it. * - * @type {Number} + * @type {number} * @constant */ COLUMBUS_VIEW: 1, @@ -25,7 +25,7 @@ const SceneMode = { /** * 2D mode. The map is viewed top-down with an orthographic projection. * - * @type {Number} + * @type {number} * @constant */ SCENE2D: 2, @@ -33,7 +33,7 @@ const SceneMode = { /** * 3D mode. A traditional 3D perspective view of the globe. * - * @type {Number} + * @type {number} * @constant */ SCENE3D: 3, @@ -43,7 +43,7 @@ const SceneMode = { * Returns the morph time for the given scene mode. * * @param {SceneMode} value The scene mode - * @returns {Number} The morph time + * @returns {number} The morph time */ SceneMode.getMorphTime = function (value) { if (value === SceneMode.SCENE3D) { diff --git a/packages/engine/Source/Scene/SceneTransitioner.js b/packages/engine/Source/Scene/SceneTransitioner.js index c10f8528fa98..c8f9e0f24c26 100644 --- a/packages/engine/Source/Scene/SceneTransitioner.js +++ b/packages/engine/Source/Scene/SceneTransitioner.js @@ -299,7 +299,7 @@ SceneTransitioner.prototype.morphTo3D = function (duration, ellipsoid) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. */ SceneTransitioner.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/ScreenSpaceCameraController.js b/packages/engine/Source/Scene/ScreenSpaceCameraController.js index 0763865ddec3..c52a36eeadef 100644 --- a/packages/engine/Source/Scene/ScreenSpaceCameraController.js +++ b/packages/engine/Source/Scene/ScreenSpaceCameraController.js @@ -49,41 +49,41 @@ function ScreenSpaceCameraController(scene) { * start of such events, and set true on completion. To keep inputs disabled * past the end of camera flights, you must use the other booleans (enableTranslate, * enableZoom, enableRotate, enableTilt, and enableLook). - * @type {Boolean} + * @type {boolean} * @default true */ this.enableInputs = true; /** * If true, allows the user to pan around the map. If false, the camera stays locked at the current position. * This flag only applies in 2D and Columbus view modes. - * @type {Boolean} + * @type {boolean} * @default true */ this.enableTranslate = true; /** * If true, allows the user to zoom in and out. If false, the camera is locked to the current distance from the ellipsoid. - * @type {Boolean} + * @type {boolean} * @default true */ this.enableZoom = true; /** * If true, allows the user to rotate the world which translates the user's position. * This flag only applies in 2D and 3D. - * @type {Boolean} + * @type {boolean} * @default true */ this.enableRotate = true; /** * If true, allows the user to tilt the camera. If false, the camera is locked to the current heading. * This flag only applies in 3D and Columbus view. - * @type {Boolean} + * @type {boolean} * @default true */ this.enableTilt = true; /** * If true, allows the user to use free-look. If false, the camera view direction can only be changed through translating * or rotating. This flag only applies in 3D and Columbus view modes. - * @type {Boolean} + * @type {boolean} * @default true */ this.enableLook = true; @@ -91,7 +91,7 @@ function ScreenSpaceCameraController(scene) { * A parameter in the range [0, 1) used to determine how long * the camera will continue to spin because of inertia. * With value of zero, the camera will have no inertia. - * @type {Number} + * @type {number} * @default 0.9 */ this.inertiaSpin = 0.9; @@ -99,7 +99,7 @@ function ScreenSpaceCameraController(scene) { * A parameter in the range [0, 1) used to determine how long * the camera will continue to translate because of inertia. * With value of zero, the camera will have no inertia. - * @type {Number} + * @type {number} * @default 0.9 */ this.inertiaTranslate = 0.9; @@ -107,7 +107,7 @@ function ScreenSpaceCameraController(scene) { * A parameter in the range [0, 1) used to determine how long * the camera will continue to zoom because of inertia. * With value of zero, the camera will have no inertia. - * @type {Number} + * @type {number} * @default 0.8 */ this.inertiaZoom = 0.8; @@ -115,25 +115,25 @@ function ScreenSpaceCameraController(scene) { * A parameter in the range [0, 1) used to limit the range * of various user inputs to a percentage of the window width/height per animation frame. * This helps keep the camera under control in low-frame-rate situations. - * @type {Number} + * @type {number} * @default 0.1 */ this.maximumMovementRatio = 0.1; /** * Sets the duration, in seconds, of the bounce back animations in 2D and Columbus view. - * @type {Number} + * @type {number} * @default 3.0 */ this.bounceAnimationTime = 3.0; /** * The minimum magnitude, in meters, of the camera position when zooming. Defaults to 1.0. - * @type {Number} + * @type {number} * @default 1.0 */ this.minimumZoomDistance = 1.0; /** * The maximum magnitude, in meters, of the camera position when zooming. Defaults to positive infinity. - * @type {Number} + * @type {number} * @default {@link Number.POSITIVE_INFINITY} */ this.maximumZoomDistance = Number.POSITIVE_INFINITY; @@ -218,14 +218,14 @@ function ScreenSpaceCameraController(scene) { }; /** * The minimum height the camera must be before picking the terrain instead of the ellipsoid. - * @type {Number} + * @type {number} * @default 150000.0 */ this.minimumPickingTerrainHeight = 150000.0; this._minimumPickingTerrainHeight = this.minimumPickingTerrainHeight; /** * The minimum height the camera must be before testing for collision with terrain. - * @type {Number} + * @type {number} * @default 15000.0 */ this.minimumCollisionTerrainHeight = 15000.0; @@ -233,14 +233,14 @@ function ScreenSpaceCameraController(scene) { /** * The minimum height the camera must be before switching from rotating a track ball to * free look when clicks originate on the sky or in space. - * @type {Number} + * @type {number} * @default 7500000.0 */ this.minimumTrackBallHeight = 7500000.0; this._minimumTrackBallHeight = this.minimumTrackBallHeight; /** * Enables or disables camera collision detection with terrain. - * @type {Boolean} + * @type {boolean} * @default true */ this.enableCollisionDetection = true; @@ -2902,7 +2902,7 @@ ScreenSpaceCameraController.prototype.update = function () { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see ScreenSpaceCameraController#destroy */ diff --git a/packages/engine/Source/Scene/ShadowMap.js b/packages/engine/Source/Scene/ShadowMap.js index 966b274a896a..3d8aaf1bd858 100644 --- a/packages/engine/Source/Scene/ShadowMap.js +++ b/packages/engine/Source/Scene/ShadowMap.js @@ -59,20 +59,20 @@ import ShadowMapShader from "./ShadowMapShader.js"; * @internalConstructor * @class * - * @privateParam {Object} options An object containing the following properties: + * @privateParam {object} options An object containing the following properties: * @privateParam {Context} options.context The context * @privateParam {Camera} options.lightCamera A camera representing the light source. - * @privateParam {Boolean} [options.enabled=true] Whether the shadow map is enabled. - * @privateParam {Boolean} [options.isPointLight=false] Whether the light source is a point light. Point light shadows do not use cascades. - * @privateParam {Number} [options.pointLightRadius=100.0] Radius of the point light. - * @privateParam {Boolean} [options.cascadesEnabled=true] Use multiple shadow maps to cover different partitions of the view frustum. - * @privateParam {Number} [options.numberOfCascades=4] The number of cascades to use for the shadow map. Supported values are one and four. - * @privateParam {Number} [options.maximumDistance=5000.0] The maximum distance used for generating cascaded shadows. Lower values improve shadow quality. - * @privateParam {Number} [options.size=2048] The width and height, in pixels, of each shadow map. - * @privateParam {Boolean} [options.softShadows=false] Whether percentage-closer-filtering is enabled for producing softer shadows. - * @privateParam {Number} [options.darkness=0.3] The shadow darkness. - * @privateParam {Boolean} [options.normalOffset=true] Whether a normal bias is applied to shadows. - * @privateParam {Boolean} [options.fadingEnabled=true] Whether shadows start to fade out once the light gets closer to the horizon. + * @privateParam {boolean} [options.enabled=true] Whether the shadow map is enabled. + * @privateParam {boolean} [options.isPointLight=false] Whether the light source is a point light. Point light shadows do not use cascades. + * @privateParam {number} [options.pointLightRadius=100.0] Radius of the point light. + * @privateParam {boolean} [options.cascadesEnabled=true] Use multiple shadow maps to cover different partitions of the view frustum. + * @privateParam {number} [options.numberOfCascades=4] The number of cascades to use for the shadow map. Supported values are one and four. + * @privateParam {number} [options.maximumDistance=5000.0] The maximum distance used for generating cascaded shadows. Lower values improve shadow quality. + * @privateParam {number} [options.size=2048] The width and height, in pixels, of each shadow map. + * @privateParam {boolean} [options.softShadows=false] Whether percentage-closer-filtering is enabled for producing softer shadows. + * @privateParam {number} [options.darkness=0.3] The shadow darkness. + * @privateParam {boolean} [options.normalOffset=true] Whether a normal bias is applied to shadows. + * @privateParam {boolean} [options.fadingEnabled=true] Whether shadows start to fade out once the light gets closer to the horizon. * * @exception {DeveloperError} Only one or four cascades are supported. * @@ -114,7 +114,7 @@ function ShadowMap(options) { /** * Determines the darkness of the shadows. * - * @type {Number} + * @type {number} * @default 0.3 */ this.darkness = defaultValue(options.darkness, 0.3); @@ -123,7 +123,7 @@ function ShadowMap(options) { /** * Determines whether shadows start to fade out once the light gets closer to the horizon. * - * @type {Boolean} + * @type {boolean} * @default true */ this.fadingEnabled = defaultValue(options.fadingEnabled, true); @@ -131,7 +131,7 @@ function ShadowMap(options) { /** * Determines the maximum distance of the shadow map. Only applicable for cascaded shadows. Larger distances may result in lower quality shadows. * - * @type {Number} + * @type {number} * @default 5000.0 */ this.maximumDistance = defaultValue(options.maximumDistance, 5000.0); @@ -355,7 +355,7 @@ Object.defineProperties(ShadowMap.prototype, { * Determines if the shadow map will be shown. * * @memberof ShadowMap.prototype - * @type {Boolean} + * @type {boolean} * @default true */ enabled: { @@ -372,7 +372,7 @@ Object.defineProperties(ShadowMap.prototype, { * Determines if a normal bias will be applied to shadows. * * @memberof ShadowMap.prototype - * @type {Boolean} + * @type {boolean} * @default true */ normalOffset: { @@ -392,7 +392,7 @@ Object.defineProperties(ShadowMap.prototype, { * Determines if soft shadows are enabled. Uses pcf filtering which requires more texture reads and may hurt performance. * * @memberof ShadowMap.prototype - * @type {Boolean} + * @type {boolean} * @default false */ softShadows: { @@ -409,7 +409,7 @@ Object.defineProperties(ShadowMap.prototype, { * The width and height, in pixels, of each shadow map. * * @memberof ShadowMap.prototype - * @type {Number} + * @type {number} * @default 2048 */ size: { @@ -425,7 +425,7 @@ Object.defineProperties(ShadowMap.prototype, { * Whether the shadow map is out of view of the scene camera. * * @memberof ShadowMap.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @private */ @@ -467,7 +467,7 @@ Object.defineProperties(ShadowMap.prototype, { * Whether the light source is a point light. * * @memberof ShadowMap.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @private */ @@ -481,7 +481,7 @@ Object.defineProperties(ShadowMap.prototype, { * Debug option for visualizing the cascades by color. * * @memberof ShadowMap.prototype - * @type {Boolean} + * @type {boolean} * @default false * @private */ diff --git a/packages/engine/Source/Scene/ShadowMode.js b/packages/engine/Source/Scene/ShadowMode.js index 031a15ba44a0..df6e77ddce2d 100644 --- a/packages/engine/Source/Scene/ShadowMode.js +++ b/packages/engine/Source/Scene/ShadowMode.js @@ -2,13 +2,13 @@ * Specifies whether the object casts or receives shadows from light sources when * shadows are enabled. * - * @enum {Number} + * @enum {number} */ const ShadowMode = { /** * The object does not cast or receive shadows. * - * @type {Number} + * @type {number} * @constant */ DISABLED: 0, @@ -16,7 +16,7 @@ const ShadowMode = { /** * The object casts and receives shadows. * - * @type {Number} + * @type {number} * @constant */ ENABLED: 1, @@ -24,7 +24,7 @@ const ShadowMode = { /** * The object casts shadows only. * - * @type {Number} + * @type {number} * @constant */ CAST_ONLY: 2, @@ -32,7 +32,7 @@ const ShadowMode = { /** * The object receives shadows only. * - * @type {Number} + * @type {number} * @constant */ RECEIVE_ONLY: 3, diff --git a/packages/engine/Source/Scene/ShadowVolumeAppearance.js b/packages/engine/Source/Scene/ShadowVolumeAppearance.js index 8a3186d24bf0..1e6f0603486f 100644 --- a/packages/engine/Source/Scene/ShadowVolumeAppearance.js +++ b/packages/engine/Source/Scene/ShadowVolumeAppearance.js @@ -18,8 +18,8 @@ import ShadowVolumeAppearanceFS from "../Shaders/ShadowVolumeAppearanceFS.js"; /** * Creates shaders for a ClassificationPrimitive to use a given Appearance, as well as for picking. * - * @param {Boolean} extentsCulling Discard fragments outside the instance's texture coordinate extents. - * @param {Boolean} planarExtents If true, texture coordinates will be computed using planes instead of spherical coordinates. + * @param {boolean} extentsCulling Discard fragments outside the instance's texture coordinate extents. + * @param {boolean} planarExtents If true, texture coordinates will be computed using planes instead of spherical coordinates. * @param {Appearance} appearance An Appearance to be used with a ClassificationPrimitive via GroundPrimitive. * @private */ @@ -73,7 +73,7 @@ function ShadowVolumeAppearance(extentsCulling, planarExtents, appearance) { /** * Create the fragment shader for a ClassificationPrimitive's color pass when rendering for color. * - * @param {Boolean} columbusView2D Whether the shader will be used for Columbus View or 2D. + * @param {boolean} columbusView2D Whether the shader will be used for Columbus View or 2D. * @returns {ShaderSource} Shader source for the fragment shader. */ ShadowVolumeAppearance.prototype.createFragmentShader = function ( @@ -175,11 +175,11 @@ ShadowVolumeAppearance.prototype.createPickFragmentShader = function ( /** * Create the vertex shader for a ClassificationPrimitive's color pass on the final of 3 shadow volume passes * - * @param {String[]} defines External defines to pass to the vertex shader. - * @param {String} vertexShaderSource ShadowVolumeAppearanceVS with any required modifications for computing position. - * @param {Boolean} columbusView2D Whether the shader will be used for Columbus View or 2D. + * @param {string[]} defines External defines to pass to the vertex shader. + * @param {string} vertexShaderSource ShadowVolumeAppearanceVS with any required modifications for computing position. + * @param {boolean} columbusView2D Whether the shader will be used for Columbus View or 2D. * @param {MapProjection} mapProjection Current scene's map projection. - * @returns {String} Shader source for the vertex shader. + * @returns {string} Shader source for the vertex shader. */ ShadowVolumeAppearance.prototype.createVertexShader = function ( defines, @@ -208,11 +208,11 @@ ShadowVolumeAppearance.prototype.createVertexShader = function ( /** * Create the vertex shader for a ClassificationPrimitive's pick pass on the final of 3 shadow volume passes * - * @param {String[]} defines External defines to pass to the vertex shader. - * @param {String} vertexShaderSource ShadowVolumeAppearanceVS with any required modifications for computing position and picking. - * @param {Boolean} columbusView2D Whether the shader will be used for Columbus View or 2D. + * @param {string[]} defines External defines to pass to the vertex shader. + * @param {string} vertexShaderSource ShadowVolumeAppearanceVS with any required modifications for computing position and picking. + * @param {boolean} columbusView2D Whether the shader will be used for Columbus View or 2D. * @param {MapProjection} mapProjection Current scene's map projection. - * @returns {String} Shader source for the vertex shader. + * @returns {string} Shader source for the vertex shader. */ ShadowVolumeAppearance.prototype.createPickVertexShader = function ( defines, @@ -675,11 +675,11 @@ const encodeScratch = new EncodedCartesian3(); * @private * * @param {Rectangle} boundingRectangle Rectangle object that the points will approximately bound - * @param {Number[]} textureCoordinateRotationPoints Points in the computed texture coordinate system for remapping texture coordinates + * @param {number[]} textureCoordinateRotationPoints Points in the computed texture coordinate system for remapping texture coordinates * @param {Ellipsoid} ellipsoid Ellipsoid for converting Rectangle points to world coordinates * @param {MapProjection} projection The MapProjection used for 2D and Columbus View. - * @param {Number} [height=0] The maximum height for the shadow volume. - * @returns {Object} An attributes dictionary containing planar texture coordinate attributes. + * @param {number} [height=0] The maximum height for the shadow volume. + * @returns {object} An attributes dictionary containing planar texture coordinate attributes. */ ShadowVolumeAppearance.getPlanarTextureCoordinateAttributes = function ( boundingRectangle, @@ -793,10 +793,10 @@ const sphericalScratch = new Cartesian2(); * @private * * @param {Rectangle} boundingRectangle Rectangle object that the spherical extents will approximately bound - * @param {Number[]} textureCoordinateRotationPoints Points in the computed texture coordinate system for remapping texture coordinates + * @param {number[]} textureCoordinateRotationPoints Points in the computed texture coordinate system for remapping texture coordinates * @param {Ellipsoid} ellipsoid Ellipsoid for converting Rectangle points to world coordinates * @param {MapProjection} projection The MapProjection used for 2D and Columbus View. - * @returns {Object} An attributes dictionary containing spherical texture coordinate attributes. + * @returns {object} An attributes dictionary containing spherical texture coordinate attributes. */ ShadowVolumeAppearance.getSphericalExtentGeometryInstanceAttributes = function ( boundingRectangle, @@ -929,7 +929,7 @@ ShadowVolumeAppearance.shouldUseSphericalCoordinates = function (rectangle) { * Texture coordinates for ground primitives are computed either using spherical coordinates for large areas or * using distance from planes for small areas. * - * @type {Number} + * @type {number} * @constant * @private */ diff --git a/packages/engine/Source/Scene/SingleTileImageryProvider.js b/packages/engine/Source/Scene/SingleTileImageryProvider.js index d8d0b7eb6d19..ac7e013768f4 100644 --- a/packages/engine/Source/Scene/SingleTileImageryProvider.js +++ b/packages/engine/Source/Scene/SingleTileImageryProvider.js @@ -11,13 +11,13 @@ import TileProviderError from "../Core/TileProviderError.js"; import ImageryProvider from "./ImageryProvider.js"; /** - * @typedef {Object} SingleTileImageryProvider.ConstructorOptions + * @typedef {object} SingleTileImageryProvider.ConstructorOptions * * Initialization options for the SingleTileImageryProvider constructor * - * @property {Resource|String} url The url for the tile. + * @property {Resource|string} url The url for the tile. * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image. - * @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. * @property {Ellipsoid} [ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used. */ @@ -51,7 +51,7 @@ function SingleTileImageryProvider(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; @@ -60,7 +60,7 @@ function SingleTileImageryProvider(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; @@ -69,7 +69,7 @@ function SingleTileImageryProvider(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; @@ -78,7 +78,7 @@ function SingleTileImageryProvider(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; @@ -87,7 +87,7 @@ function SingleTileImageryProvider(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; @@ -95,7 +95,7 @@ function SingleTileImageryProvider(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; @@ -104,7 +104,7 @@ function SingleTileImageryProvider(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; @@ -112,7 +112,7 @@ function SingleTileImageryProvider(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; @@ -201,7 +201,7 @@ Object.defineProperties(SingleTileImageryProvider.prototype, { /** * Gets the URL of the single, top-level imagery tile. * @memberof SingleTileImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -226,7 +226,7 @@ Object.defineProperties(SingleTileImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link SingleTileImageryProvider#ready} returns true. * @memberof SingleTileImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -247,7 +247,7 @@ Object.defineProperties(SingleTileImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link SingleTileImageryProvider#ready} returns true. * @memberof SingleTileImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -268,7 +268,7 @@ Object.defineProperties(SingleTileImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link SingleTileImageryProvider#ready} returns true. * @memberof SingleTileImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -289,7 +289,7 @@ Object.defineProperties(SingleTileImageryProvider.prototype, { * Gets the minimum level-of-detail that can be requested. This function should * not be called before {@link SingleTileImageryProvider#ready} returns true. * @memberof SingleTileImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -380,7 +380,7 @@ Object.defineProperties(SingleTileImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof SingleTileImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -392,7 +392,7 @@ Object.defineProperties(SingleTileImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof SingleTileImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -421,7 +421,7 @@ Object.defineProperties(SingleTileImageryProvider.prototype, { * as if their alpha is 1.0 everywhere. When this property is false, memory usage * and texture upload time are reduced. * @memberof SingleTileImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -434,9 +434,9 @@ Object.defineProperties(SingleTileImageryProvider.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} getTileCredits must not be called before the imagery provider is ready. @@ -449,11 +449,11 @@ SingleTileImageryProvider.prototype.getTileCredits = function (x, y, level) { * Requests the image for a given tile. This function should * not be called before {@link SingleTileImageryProvider#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.|undefined} The resolved image + * @returns {Promise|undefined} The resolved image * * @exception {DeveloperError} requestImage must not be called before the imagery provider is ready. */ @@ -482,11 +482,11 @@ SingleTileImageryProvider.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. */ SingleTileImageryProvider.prototype.pickFeatures = function ( diff --git a/packages/engine/Source/Scene/SkyAtmosphere.js b/packages/engine/Source/Scene/SkyAtmosphere.js index bd761a9eb6e2..11cccc5f23f5 100644 --- a/packages/engine/Source/Scene/SkyAtmosphere.js +++ b/packages/engine/Source/Scene/SkyAtmosphere.js @@ -46,7 +46,7 @@ function SkyAtmosphere(ellipsoid) { /** * Determines if the atmosphere is shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = true; @@ -55,7 +55,7 @@ function SkyAtmosphere(ellipsoid) { * Compute atmosphere per-fragment instead of per-vertex. * This produces better looking atmosphere with a slight performance penalty. * - * @type {Boolean} + * @type {boolean} * @default false */ this.perFragmentAtmosphere = false; @@ -83,7 +83,7 @@ function SkyAtmosphere(ellipsoid) { /** * The intensity of the light that is used for computing the sky atmosphere color. * - * @type {Number} + * @type {number} * @default 50.0 */ this.atmosphereLightIntensity = 50.0; @@ -107,7 +107,7 @@ function SkyAtmosphere(ellipsoid) { /** * The Rayleigh scale height used in the atmospheric scattering equations for the sky atmosphere, in meters. * - * @type {Number} + * @type {number} * @default 10000.0 */ this.atmosphereRayleighScaleHeight = 10000.0; @@ -115,7 +115,7 @@ function SkyAtmosphere(ellipsoid) { /** * The Mie scale height used in the atmospheric scattering equations for the sky atmosphere, in meters. * - * @type {Number} + * @type {number} * @default 3200.0 */ this.atmosphereMieScaleHeight = 3200.0; @@ -125,7 +125,7 @@ function SkyAtmosphere(ellipsoid) { *

    * Valid values are between -1.0 and 1.0. *

    - * @type {Number} + * @type {number} * @default 0.9 */ this.atmosphereMieAnisotropy = 0.9; @@ -133,7 +133,7 @@ function SkyAtmosphere(ellipsoid) { /** * The hue shift to apply to the atmosphere. Defaults to 0.0 (no shift). * A hue shift of 1.0 indicates a complete rotation of the hues available. - * @type {Number} + * @type {number} * @default 0.0 */ this.hueShift = 0.0; @@ -141,7 +141,7 @@ function SkyAtmosphere(ellipsoid) { /** * The saturation shift to apply to the atmosphere. Defaults to 0.0 (no shift). * A saturation shift of -1.0 is monochrome. - * @type {Number} + * @type {number} * @default 0.0 */ this.saturationShift = 0.0; @@ -149,7 +149,7 @@ function SkyAtmosphere(ellipsoid) { /** * The brightness shift to apply to the atmosphere. Defaults to 0.0 (no shift). * A brightness shift of -1.0 is complete darkness, which will let space show through. - * @type {Number} + * @type {number} * @default 0.0 */ this.brightnessShift = 0.0; @@ -368,7 +368,7 @@ function hasColorCorrection(skyAtmosphere) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see SkyAtmosphere#destroy */ diff --git a/packages/engine/Source/Scene/SkyBox.js b/packages/engine/Source/Scene/SkyBox.js index 2af18ef25c34..e7a11fdebfbf 100644 --- a/packages/engine/Source/Scene/SkyBox.js +++ b/packages/engine/Source/Scene/SkyBox.js @@ -30,9 +30,9 @@ import SceneMode from "./SceneMode.js"; * @alias SkyBox * @constructor * - * @param {Object} options Object with the following properties: - * @param {Object} [options.sources] The source URL or Image object for each of the six cube map faces. See the example below. - * @param {Boolean} [options.show=true] Determines if this primitive will be shown. + * @param {object} options Object with the following properties: + * @param {object} [options.sources] The source URL or Image object for each of the six cube map faces. See the example below. + * @param {boolean} [options.show=true] Determines if this primitive will be shown. * * * @example @@ -57,7 +57,7 @@ function SkyBox(options) { * negativeY, positiveZ, and negativeZ properties. * These can be either URLs or Image objects. * - * @type Object + * @type {object} * @default undefined */ this.sources = options.sources; @@ -66,7 +66,7 @@ function SkyBox(options) { /** * Determines if the sky box will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -217,7 +217,7 @@ SkyBox.prototype.update = function (frameState, useHdr) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see SkyBox#destroy */ diff --git a/packages/engine/Source/Scene/SpatialNode.js b/packages/engine/Source/Scene/SpatialNode.js index 6c078407e023..62d68f3dcebf 100644 --- a/packages/engine/Source/Scene/SpatialNode.js +++ b/packages/engine/Source/Scene/SpatialNode.js @@ -11,10 +11,10 @@ import OrientedBoundingBox from "../Core/OrientedBoundingBox.js"; * @alias SpatialNode * @constructor * - * @param {Number} level - * @param {Number} x - * @param {Number} y - * @param {Number} z + * @param {number} level + * @param {number} x + * @param {number} y + * @param {number} z * @param {SpatialNode} parent * @param {VoxelShape} shape * @param {Cartesian3} voxelDimensions @@ -125,8 +125,8 @@ SpatialNode.prototype.constructChildNodes = function (shape, voxelDimensions) { /** * @param {FrameState} frameState - * @param {Number} visibilityPlaneMask - * @returns {Number} A plane mask as described in {@link CullingVolume#computeVisibilityWithPlaneMask}. + * @param {number} visibilityPlaneMask + * @returns {number} A plane mask as described in {@link CullingVolume#computeVisibilityWithPlaneMask}. */ SpatialNode.prototype.visibility = function (frameState, visibilityPlaneMask) { const obb = this.orientedBoundingBox; @@ -136,7 +136,7 @@ SpatialNode.prototype.visibility = function (frameState, visibilityPlaneMask) { /** * @param {Cartesian3} cameraPosition - * @param {Number} screenSpaceErrorMultiplier + * @param {number} screenSpaceErrorMultiplier */ SpatialNode.prototype.computeScreenSpaceError = function ( cameraPosition, @@ -160,9 +160,9 @@ const scratchBinarySearchKeyframeNode = { /** * Find the index of a given key frame position within an array of KeyframeNodes, * or the complement (~) of the index where it would be in the sorted array. - * @param {Number} keyframe + * @param {number} keyframe * @param {KeyframeNode[]} keyframeNodes - * @returns {Number} + * @returns {number} * @private */ function findKeyframeIndex(keyframe, keyframeNodes) { @@ -177,7 +177,7 @@ function findKeyframeIndex(keyframe, keyframeNodes) { /** * Computes the most suitable keyframes for rendering, balancing between temporal and visual quality. * - * @param {Number} keyframeLocation + * @param {number} keyframeLocation */ SpatialNode.prototype.computeSurroundingRenderableKeyframeNodes = function ( keyframeLocation @@ -275,15 +275,15 @@ function getWeightedKeyframeDistance(levelDistance, keyframeDistance) { } /** - * @param {Number} frameNumber - * @returns {Boolean} + * @param {number} frameNumber + * @returns {boolean} */ SpatialNode.prototype.isVisited = function (frameNumber) { return this.visitedFrameNumber === frameNumber; }; /** - * @param {Number} keyframe + * @param {number} keyframe */ SpatialNode.prototype.createKeyframeNode = function (keyframe) { let index = findKeyframeIndex(keyframe, this.keyframeNodes); @@ -371,8 +371,8 @@ SpatialNode.prototype.addKeyframeNodeToMegatextures = function ( }; /** - * @param {Number} frameNumber - * @returns Boolean + * @param {number} frameNumber + * @returns {boolean} */ SpatialNode.prototype.isRenderable = function (frameNumber) { const previousNode = this.renderableKeyframeNodePrevious; diff --git a/packages/engine/Source/Scene/SphereEmitter.js b/packages/engine/Source/Scene/SphereEmitter.js index a29d5fd8d69f..4925d0847225 100644 --- a/packages/engine/Source/Scene/SphereEmitter.js +++ b/packages/engine/Source/Scene/SphereEmitter.js @@ -10,7 +10,7 @@ import CesiumMath from "../Core/Math.js"; * @alias SphereEmitter * @constructor * - * @param {Number} [radius=1.0] The radius of the sphere in meters. + * @param {number} [radius=1.0] The radius of the sphere in meters. */ function SphereEmitter(radius) { radius = defaultValue(radius, 1.0); @@ -26,7 +26,7 @@ Object.defineProperties(SphereEmitter.prototype, { /** * The radius of the sphere in meters. * @memberof SphereEmitter.prototype - * @type {Number} + * @type {number} * @default 1.0 */ radius: { diff --git a/packages/engine/Source/Scene/SplitDirection.js b/packages/engine/Source/Scene/SplitDirection.js index ba53422f9a6f..5d23aa289fbf 100644 --- a/packages/engine/Source/Scene/SplitDirection.js +++ b/packages/engine/Source/Scene/SplitDirection.js @@ -1,7 +1,7 @@ /** * The direction to display a primitive or ImageryLayer relative to the {@link Scene#splitPosition}. * - * @enum {Number} + * @enum {number} * * @see ImageryLayer#splitDirection * @see Cesium3DTileset#splitDirection @@ -10,7 +10,7 @@ const SplitDirection = { /** * Display the primitive or ImageryLayer to the left of the {@link Scene#splitPosition}. * - * @type {Number} + * @type {number} * @constant */ LEFT: -1.0, @@ -18,7 +18,7 @@ const SplitDirection = { /** * Always display the primitive or ImageryLayer. * - * @type {Number} + * @type {number} * @constant */ NONE: 0.0, @@ -26,7 +26,7 @@ const SplitDirection = { /** * Display the primitive or ImageryLayer to the right of the {@link Scene#splitPosition}. * - * @type {Number} + * @type {number} * @constant */ RIGHT: 1.0, diff --git a/packages/engine/Source/Scene/Splitter.js b/packages/engine/Source/Scene/Splitter.js index 58dc51739e3d..f27bd9d9bfb5 100644 --- a/packages/engine/Source/Scene/Splitter.js +++ b/packages/engine/Source/Scene/Splitter.js @@ -36,8 +36,8 @@ const Splitter = { /** * Add `czm_splitDirection` to the given uniform map. * - * @param {Object} object The object on which the `splitDirection` property may be found. - * @param {Object} uniformMap The uniform map. + * @param {object} object The object on which the `splitDirection` property may be found. + * @param {object} uniformMap The uniform map. */ addUniforms: function addUniforms(object, uniformMap) { uniformMap.czm_splitDirection = function () { diff --git a/packages/engine/Source/Scene/StencilFunction.js b/packages/engine/Source/Scene/StencilFunction.js index b730bfc94ee9..d7ac2c6d2fea 100644 --- a/packages/engine/Source/Scene/StencilFunction.js +++ b/packages/engine/Source/Scene/StencilFunction.js @@ -3,13 +3,13 @@ import WebGLConstants from "../Core/WebGLConstants.js"; /** * Determines the function used to compare stencil values for the stencil test. * - * @enum {Number} + * @enum {number} */ const StencilFunction = { /** * The stencil test never passes. * - * @type {Number} + * @type {number} * @constant */ NEVER: WebGLConstants.NEVER, @@ -17,7 +17,7 @@ const StencilFunction = { /** * The stencil test passes when the masked reference value is less than the masked stencil value. * - * @type {Number} + * @type {number} * @constant */ LESS: WebGLConstants.LESS, @@ -25,7 +25,7 @@ const StencilFunction = { /** * The stencil test passes when the masked reference value is equal to the masked stencil value. * - * @type {Number} + * @type {number} * @constant */ EQUAL: WebGLConstants.EQUAL, @@ -33,7 +33,7 @@ const StencilFunction = { /** * The stencil test passes when the masked reference value is less than or equal to the masked stencil value. * - * @type {Number} + * @type {number} * @constant */ LESS_OR_EQUAL: WebGLConstants.LEQUAL, @@ -41,7 +41,7 @@ const StencilFunction = { /** * The stencil test passes when the masked reference value is greater than the masked stencil value. * - * @type {Number} + * @type {number} * @constant */ GREATER: WebGLConstants.GREATER, @@ -49,7 +49,7 @@ const StencilFunction = { /** * The stencil test passes when the masked reference value is not equal to the masked stencil value. * - * @type {Number} + * @type {number} * @constant */ NOT_EQUAL: WebGLConstants.NOTEQUAL, @@ -57,7 +57,7 @@ const StencilFunction = { /** * The stencil test passes when the masked reference value is greater than or equal to the masked stencil value. * - * @type {Number} + * @type {number} * @constant */ GREATER_OR_EQUAL: WebGLConstants.GEQUAL, @@ -65,7 +65,7 @@ const StencilFunction = { /** * The stencil test always passes. * - * @type {Number} + * @type {number} * @constant */ ALWAYS: WebGLConstants.ALWAYS, diff --git a/packages/engine/Source/Scene/StencilOperation.js b/packages/engine/Source/Scene/StencilOperation.js index 6f992c31b540..4781a9e53fa1 100644 --- a/packages/engine/Source/Scene/StencilOperation.js +++ b/packages/engine/Source/Scene/StencilOperation.js @@ -3,13 +3,13 @@ import WebGLConstants from "../Core/WebGLConstants.js"; /** * Determines the action taken based on the result of the stencil test. * - * @enum {Number} + * @enum {number} */ const StencilOperation = { /** * Sets the stencil buffer value to zero. * - * @type {Number} + * @type {number} * @constant */ ZERO: WebGLConstants.ZERO, @@ -17,7 +17,7 @@ const StencilOperation = { /** * Does not change the stencil buffer. * - * @type {Number} + * @type {number} * @constant */ KEEP: WebGLConstants.KEEP, @@ -25,7 +25,7 @@ const StencilOperation = { /** * Replaces the stencil buffer value with the reference value. * - * @type {Number} + * @type {number} * @constant */ REPLACE: WebGLConstants.REPLACE, @@ -33,7 +33,7 @@ const StencilOperation = { /** * Increments the stencil buffer value, clamping to unsigned byte. * - * @type {Number} + * @type {number} * @constant */ INCREMENT: WebGLConstants.INCR, @@ -41,7 +41,7 @@ const StencilOperation = { /** * Decrements the stencil buffer value, clamping to zero. * - * @type {Number} + * @type {number} * @constant */ DECREMENT: WebGLConstants.DECR, @@ -49,7 +49,7 @@ const StencilOperation = { /** * Bitwise inverts the existing stencil buffer value. * - * @type {Number} + * @type {number} * @constant */ INVERT: WebGLConstants.INVERT, @@ -57,7 +57,7 @@ const StencilOperation = { /** * Increments the stencil buffer value, wrapping to zero when exceeding the unsigned byte range. * - * @type {Number} + * @type {number} * @constant */ INCREMENT_WRAP: WebGLConstants.INCR_WRAP, @@ -65,7 +65,7 @@ const StencilOperation = { /** * Decrements the stencil buffer value, wrapping to the maximum unsigned byte instead of going below zero. * - * @type {Number} + * @type {number} * @constant */ DECREMENT_WRAP: WebGLConstants.DECR_WRAP, diff --git a/packages/engine/Source/Scene/StructuralMetadata.js b/packages/engine/Source/Scene/StructuralMetadata.js index 04f108b99a08..a1aefacc9439 100644 --- a/packages/engine/Source/Scene/StructuralMetadata.js +++ b/packages/engine/Source/Scene/StructuralMetadata.js @@ -9,14 +9,14 @@ import defined from "../Core/defined.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. *

    * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {MetadataSchema} options.schema The parsed schema. * @param {PropertyTable[]} [options.propertyTables] An array of property table objects. For the legacy EXT_feature_metadata extension, this is sorted by the key in the propertyTables dictionary * @param {PropertyTexture[]} [options.propertyTextures] An array of property texture objects. For the legacy EXT_feature_metadata extension, this is sorted by the key in the propertyTextures dictionary * @param {PropertyAttribute[]} [options.propertyAttributes] An array of property attribute objects. This is new in EXT_structural_metadata - * @param {Object} [options.statistics] Statistics about metadata - * @param {Object} [options.extras] Extra user-defined properties - * @param {Object} [options.extensions] An object containing extensions + * @param {object} [options.statistics] Statistics about metadata + * @param {object} [options.extras] Extra user-defined properties + * @param {object} [options.extensions] An object containing extensions * * @alias StructuralMetadata * @constructor @@ -65,7 +65,7 @@ Object.defineProperties(StructuralMetadata.prototype, { *

    * * @memberof StructuralMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -93,7 +93,7 @@ Object.defineProperties(StructuralMetadata.prototype, { * An object containing extensions. * * @memberof StructuralMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -107,7 +107,7 @@ Object.defineProperties(StructuralMetadata.prototype, { * Number of property tables in the metadata. * * @memberof StructuralMetadata.prototype - * @type {Number} + * @type {number} * @readonly * @private */ @@ -163,7 +163,7 @@ Object.defineProperties(StructuralMetadata.prototype, { * Total size in bytes across all property tables * * @memberof StructuralMetadata.prototype - * @type {Number} + * @type {number} * @readonly * @private */ @@ -191,7 +191,7 @@ Object.defineProperties(StructuralMetadata.prototype, { * by the key in the propertyTables dictionary. *

    * - * @param {Number} propertyTableId The property table ID. + * @param {number} propertyTableId The property table ID. * @returns {PropertyTable} The property table. * @private */ @@ -210,7 +210,7 @@ StructuralMetadata.prototype.getPropertyTable = function (propertyTableId) { * by the key in the propertyTextures dictionary. *

    * - * @param {Number} propertyTextureId The index into the property textures array. + * @param {number} propertyTextureId The index into the property textures array. * @returns {PropertyTexture} The property texture * @private */ @@ -226,7 +226,7 @@ StructuralMetadata.prototype.getPropertyTexture = function (propertyTextureId) { * Gets the property attribute with the given ID. This concept is new in * EXT_structural_metadata * - * @param {Number} propertyAttributeId The index into the property attributes array. + * @param {number} propertyAttributeId The index into the property attributes array. * @returns {PropertyAttribute} The property attribute * @private */ diff --git a/packages/engine/Source/Scene/StyleExpression.js b/packages/engine/Source/Scene/StyleExpression.js index c6baa386edbd..10e49410f645 100644 --- a/packages/engine/Source/Scene/StyleExpression.js +++ b/packages/engine/Source/Scene/StyleExpression.js @@ -29,8 +29,8 @@ function StyleExpression() {} * a {@link Color}, the {@link Cartesian4} value is converted to a {@link Color} and then returned. * * @param {Cesium3DTileFeature} feature The feature whose properties may be used as variables in the expression. - * @param {Object} [result] The object onto which to store the result. - * @returns {Boolean|Number|String|RegExp|Cartesian2|Cartesian3|Cartesian4|Color} The result of evaluating the expression. + * @param {object} [result] The object onto which to store the result. + * @returns {boolean|number|string|RegExp|Cartesian2|Cartesian3|Cartesian4|Color} The result of evaluating the expression. */ StyleExpression.prototype.evaluate = function (feature, result) { DeveloperError.throwInstantiationError(); @@ -54,12 +54,12 @@ StyleExpression.prototype.evaluateColor = function (feature, result) { * Gets the shader function for this expression. * Returns undefined if the shader function can't be generated from this expression. * - * @param {String} functionSignature Signature of the generated function. - * @param {Object} variableSubstitutionMap Maps variable names to shader variable names. - * @param {Object} shaderState Stores information about the generated shader function, including whether it is translucent. - * @param {String} returnType The return type of the generated function. + * @param {string} functionSignature Signature of the generated function. + * @param {object} variableSubstitutionMap Maps variable names to shader variable names. + * @param {object} shaderState Stores information about the generated shader function, including whether it is translucent. + * @param {string} returnType The return type of the generated function. * - * @returns {String} The shader function. + * @returns {string} The shader function. * * @private */ @@ -75,7 +75,7 @@ StyleExpression.prototype.getShaderFunction = function ( /** * Gets the variables used by the expression. * - * @returns {String[]} The variables used by the expression. + * @returns {string[]} The variables used by the expression. * * @private */ diff --git a/packages/engine/Source/Scene/Sun.js b/packages/engine/Source/Scene/Sun.js index 617c2cfd3dc2..f109882c6871 100644 --- a/packages/engine/Source/Scene/Sun.js +++ b/packages/engine/Source/Scene/Sun.js @@ -43,7 +43,7 @@ function Sun() { /** * Determines if the sun will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = true; @@ -89,7 +89,7 @@ Object.defineProperties(Sun.prototype, { * Use larger values for a more pronounced flare around the Sun. * * @memberof Sun.prototype - * @type {Number} + * @type {number} * @default 1.0 */ glowFactor: { @@ -322,7 +322,7 @@ Sun.prototype.update = function (frameState, passState, useHdr) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see Sun#destroy */ diff --git a/packages/engine/Source/Scene/SunLight.js b/packages/engine/Source/Scene/SunLight.js index f4d738238d46..a0441da23979 100644 --- a/packages/engine/Source/Scene/SunLight.js +++ b/packages/engine/Source/Scene/SunLight.js @@ -4,9 +4,9 @@ import defaultValue from "../Core/defaultValue.js"; /** * A directional light source that originates from the Sun. * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Color} [options.color=Color.WHITE] The light's color. - * @param {Number} [options.intensity=2.0] The light's intensity. + * @param {number} [options.intensity=2.0] The light's intensity. * * @alias SunLight * @constructor @@ -22,7 +22,7 @@ function SunLight(options) { /** * The intensity of the light. - * @type {Number} + * @type {number} * @default 2.0 */ this.intensity = defaultValue(options.intensity, 2.0); diff --git a/packages/engine/Source/Scene/SupportedImageFormats.js b/packages/engine/Source/Scene/SupportedImageFormats.js index 60c7c3eefa6a..f98a33e32015 100644 --- a/packages/engine/Source/Scene/SupportedImageFormats.js +++ b/packages/engine/Source/Scene/SupportedImageFormats.js @@ -3,9 +3,9 @@ import defaultValue from "../Core/defaultValue.js"; /** * Image formats supported by the browser. * - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.webp=false] Whether the browser supports WebP images. - * @param {Boolean} [options.basis=false] Whether the browser supports compressed textures required to view KTX2 + Basis Universal images. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.webp=false] Whether the browser supports WebP images. + * @param {boolean} [options.basis=false] Whether the browser supports compressed textures required to view KTX2 + Basis Universal images. * * @private */ diff --git a/packages/engine/Source/Scene/TextureAtlas.js b/packages/engine/Source/Scene/TextureAtlas.js index f55d4a3dca6b..d53cf10b1ac9 100644 --- a/packages/engine/Source/Scene/TextureAtlas.js +++ b/packages/engine/Source/Scene/TextureAtlas.js @@ -38,10 +38,10 @@ const defaultInitialSize = new Cartesian2(16.0, 16.0); * @alias TextureAtlas * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Scene} options.context The context in which the texture gets created. * @param {PixelFormat} [options.pixelFormat=PixelFormat.RGBA] The pixel format of the texture. - * @param {Number} [options.borderWidthInPixels=1] The amount of spacing between adjacent images in pixels. + * @param {number} [options.borderWidthInPixels=1] The amount of spacing between adjacent images in pixels. * @param {Cartesian2} [options.initialSize=new Cartesian2(16.0, 16.0)] The initial side lengths of the texture. * * @exception {DeveloperError} borderWidthInPixels must be greater than or equal to zero. @@ -84,7 +84,7 @@ Object.defineProperties(TextureAtlas.prototype, { /** * The amount of spacing between adjacent images in pixels. * @memberof TextureAtlas.prototype - * @type {Number} + * @type {number} */ borderWidthInPixels: { get: function () { @@ -130,7 +130,7 @@ Object.defineProperties(TextureAtlas.prototype, { * Texture coordinates are subject to change if the texture atlas resizes, so it is * important to check {@link TextureAtlas#getGUID} before using old values. * @memberof TextureAtlas.prototype - * @type {Number} + * @type {number} */ numberOfImages: { get: function () { @@ -144,7 +144,7 @@ Object.defineProperties(TextureAtlas.prototype, { * Classes that use a texture atlas should check if the GUID * has changed before processing the atlas data. * @memberof TextureAtlas.prototype - * @type {String} + * @type {string} */ guid: { get: function () { @@ -368,8 +368,8 @@ function getIndex(atlas, image) { /** * If the image is already in the atlas, the existing index is returned. Otherwise, the result is undefined. * - * @param {String} id An identifier to detect whether the image already exists in the atlas. - * @returns {Number|undefined} The image index, or undefined if the image does not exist in the atlas. + * @param {string} id An identifier to detect whether the image already exists in the atlas. + * @returns {number|undefined} The image index, or undefined if the image does not exist in the atlas. */ TextureAtlas.prototype.getImageIndex = function (id) { //>>includeStart('debug', pragmas.debug); @@ -385,9 +385,9 @@ TextureAtlas.prototype.getImageIndex = function (id) { * Adds an image to the atlas synchronously. If the image is already in the atlas, the atlas is unchanged and * the existing index is used. * - * @param {String} id An identifier to detect whether the image already exists in the atlas. + * @param {string} id An identifier to detect whether the image already exists in the atlas. * @param {HTMLImageElement|HTMLCanvasElement} image An image or canvas to add to the texture atlas. - * @returns {Number} The image index. + * @returns {number} The image index. */ TextureAtlas.prototype.addImageSync = function (id, image) { //>>includeStart('debug', pragmas.debug); @@ -417,10 +417,10 @@ TextureAtlas.prototype.addImageSync = function (id, image) { * Adds an image to the atlas. If the image is already in the atlas, the atlas is unchanged and * the existing index is used. * - * @param {String} id An identifier to detect whether the image already exists in the atlas. - * @param {HTMLImageElement|HTMLCanvasElement|String|Resource|Promise|TextureAtlas.CreateImageCallback} image An image or canvas to add to the texture atlas, + * @param {string} id An identifier to detect whether the image already exists in the atlas. + * @param {HTMLImageElement|HTMLCanvasElement|string|Resource|Promise|TextureAtlas.CreateImageCallback} image An image or canvas to add to the texture atlas, * or a URL to an Image, or a Promise for an image, or a function that creates an image. - * @returns {Promise.} A Promise for the image index. + * @returns {Promise} A Promise for the image index. */ TextureAtlas.prototype.addImage = function (id, image) { //>>includeStart('debug', pragmas.debug); @@ -470,10 +470,10 @@ TextureAtlas.prototype.addImage = function (id, image) { /** * Add a sub-region of an existing atlas image as additional image indices. * - * @param {String} id The identifier of the existing image. + * @param {string} id The identifier of the existing image. * @param {BoundingRectangle} subRegion An {@link BoundingRectangle} sub-region measured in pixels from the bottom-left. * - * @returns {Promise.} A Promise for the image index. + * @returns {Promise} A Promise for the image index. */ TextureAtlas.prototype.addSubRegion = function (id, subRegion) { //>>includeStart('debug', pragmas.debug); @@ -520,7 +520,7 @@ TextureAtlas.prototype.addSubRegion = function (id, subRegion) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see TextureAtlas#destroy */ @@ -552,7 +552,7 @@ TextureAtlas.prototype.destroy = function () { /** * A function that creates an image. * @callback TextureAtlas.CreateImageCallback - * @param {String} id The identifier of the image to load. + * @param {string} id The identifier of the image to load. * @returns {HTMLImageElement|Promise} The image, or a promise that will resolve to an image. */ export default TextureAtlas; diff --git a/packages/engine/Source/Scene/TileBoundingRegion.js b/packages/engine/Source/Scene/TileBoundingRegion.js index e43a8b4922c8..733907695de2 100644 --- a/packages/engine/Source/Scene/TileBoundingRegion.js +++ b/packages/engine/Source/Scene/TileBoundingRegion.js @@ -23,12 +23,12 @@ import SceneMode from "./SceneMode.js"; * @alias TileBoundingRegion * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Rectangle} options.rectangle The rectangle specifying the longitude and latitude range of the region. - * @param {Number} [options.minimumHeight=0.0] The minimum height of the region. - * @param {Number} [options.maximumHeight=0.0] The maximum height of the region. + * @param {number} [options.minimumHeight=0.0] The minimum height of the region. + * @param {number} [options.maximumHeight=0.0] The maximum height of the region. * @param {Ellipsoid} [options.ellipsoid=Cesium.Ellipsoid.WGS84] The ellipsoid. - * @param {Boolean} [options.computeBoundingVolumes=true] True to compute the {@link TileBoundingRegion#boundingVolume} and + * @param {boolean} [options.computeBoundingVolumes=true] True to compute the {@link TileBoundingRegion#boundingVolume} and * {@link TileBoundingVolume#boundingSphere}. If false, these properties will be undefined. * * @private @@ -116,7 +116,7 @@ Object.defineProperties(TileBoundingRegion.prototype, { * * @memberof TileBoundingRegion.prototype * - * @type {Object} + * @type {object} * @readonly */ boundingVolume: { @@ -414,7 +414,7 @@ function distanceToCameraRegion(tileBB, frameState) { * Gets the distance from the camera to the closest point on the tile. This is used for level of detail selection. * * @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. */ TileBoundingRegion.prototype.distanceToCamera = function (frameState) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Scene/TileBoundingS2Cell.js b/packages/engine/Source/Scene/TileBoundingS2Cell.js index 479d81e9fa11..872529473f43 100644 --- a/packages/engine/Source/Scene/TileBoundingS2Cell.js +++ b/packages/engine/Source/Scene/TileBoundingS2Cell.js @@ -23,12 +23,12 @@ let centerCartographicScratch = new Cartographic(); * @alias TileBoundingS2Cell * @constructor * - * @param {Object} options Object with the following properties: - * @param {String} options.token The token of the S2 cell. - * @param {Number} [options.minimumHeight=0.0] The minimum height of the bounding volume. - * @param {Number} [options.maximumHeight=0.0] The maximum height of the bounding volume. + * @param {object} options Object with the following properties: + * @param {string} options.token The token of the S2 cell. + * @param {number} [options.minimumHeight=0.0] The minimum height of the bounding volume. + * @param {number} [options.maximumHeight=0.0] The maximum height of the bounding volume. * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid. - * @param {Boolean} [options.computeBoundingVolumes=true] True to compute the {@link TileBoundingS2Cell#boundingVolume} and + * @param {boolean} [options.computeBoundingVolumes=true] True to compute the {@link TileBoundingS2Cell#boundingVolume} and * {@link TileBoundingS2Cell#boundingSphere}. If false, these properties will be undefined. * * @private @@ -332,7 +332,7 @@ Object.defineProperties(TileBoundingS2Cell.prototype, { * * @memberof TileOrientedBoundingBox.prototype * - * @type {Object} + * @type {object} * @readonly */ boundingVolume: { diff --git a/packages/engine/Source/Scene/TileBoundingSphere.js b/packages/engine/Source/Scene/TileBoundingSphere.js index d623061f37cd..3e517c1a1fa1 100644 --- a/packages/engine/Source/Scene/TileBoundingSphere.js +++ b/packages/engine/Source/Scene/TileBoundingSphere.js @@ -15,7 +15,7 @@ import Primitive from "./Primitive.js"; * @constructor * * @param {Cartesian3} [center=Cartesian3.ZERO] The center of the bounding sphere. - * @param {Number} [radius=0.0] The radius of the bounding sphere. + * @param {number} [radius=0.0] The radius of the bounding sphere. * * @private */ @@ -46,7 +46,7 @@ Object.defineProperties(TileBoundingSphere.prototype, { * * @memberof TileBoundingSphere.prototype * - * @type {Number} + * @type {number} * @readonly */ radius: { @@ -60,7 +60,7 @@ Object.defineProperties(TileBoundingSphere.prototype, { * * @memberof TileBoundingSphere.prototype * - * @type {Object} + * @type {object} * @readonly */ boundingVolume: { @@ -87,7 +87,7 @@ Object.defineProperties(TileBoundingSphere.prototype, { * Computes the distance between this bounding sphere and the camera attached to frameState. * * @param {FrameState} frameState The frameState to which the camera is attached. - * @returns {Number} The distance between the camera and the bounding sphere in meters. Returns 0 if the camera is inside the bounding volume. + * @returns {number} The distance between the camera and the bounding sphere in meters. Returns 0 if the camera is inside the bounding volume. * */ TileBoundingSphere.prototype.distanceToCamera = function (frameState) { @@ -122,7 +122,7 @@ TileBoundingSphere.prototype.intersectPlane = function (plane) { * Update the bounding sphere after the tile is transformed. * * @param {Cartesian3} center The center of the bounding sphere. - * @param {Number} radius The radius of the bounding sphere. + * @param {number} radius The radius of the bounding sphere. */ TileBoundingSphere.prototype.update = function (center, radius) { Cartesian3.clone(center, this._boundingSphere.center); diff --git a/packages/engine/Source/Scene/TileBoundingVolume.js b/packages/engine/Source/Scene/TileBoundingVolume.js index 06d655078a81..f7c027edc16c 100644 --- a/packages/engine/Source/Scene/TileBoundingVolume.js +++ b/packages/engine/Source/Scene/TileBoundingVolume.js @@ -18,7 +18,7 @@ function TileBoundingVolume() {} /** * The underlying bounding volume. * - * @type {Object} + * @type {object} * @readonly */ TileBoundingVolume.prototype.boundingVolume = undefined; @@ -35,7 +35,7 @@ TileBoundingVolume.prototype.boundingSphere = undefined; * Calculates the distance between the tile and the camera. * * @param {FrameState} frameState The frame state. - * @return {Number} The distance between the tile and the camera, in meters. + * @return {number} The distance between the tile and the camera, in meters. * Returns 0.0 if the camera is inside the tile. */ TileBoundingVolume.prototype.distanceToCamera = function (frameState) { diff --git a/packages/engine/Source/Scene/TileCoordinatesImageryProvider.js b/packages/engine/Source/Scene/TileCoordinatesImageryProvider.js index 4618a09d96bc..f514050bfebf 100644 --- a/packages/engine/Source/Scene/TileCoordinatesImageryProvider.js +++ b/packages/engine/Source/Scene/TileCoordinatesImageryProvider.js @@ -5,7 +5,7 @@ import Event from "../Core/Event.js"; import GeographicTilingScheme from "../Core/GeographicTilingScheme.js"; /** - * @typedef {Object} TileCoordinatesImageryProvider.ConstructorOptions + * @typedef {object} TileCoordinatesImageryProvider.ConstructorOptions * * Initialization options for the TileCoordinatesImageryProvider constructor * @@ -14,8 +14,8 @@ import GeographicTilingScheme from "../Core/GeographicTilingScheme.js"; * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither * parameter is specified, the WGS84 ellipsoid is used. * @property {Color} [color=Color.YELLOW] The color to draw the tile box and label. - * @property {Number} [tileWidth=256] The width of the tile for level-of-detail selection purposes. - * @property {Number} [tileHeight=256] The height of the tile for level-of-detail selection purposes. + * @property {number} [tileWidth=256] The width of the tile for level-of-detail selection purposes. + * @property {number} [tileHeight=256] The height of the tile for level-of-detail selection purposes. */ /** @@ -44,7 +44,7 @@ function TileCoordinatesImageryProvider(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; @@ -53,7 +53,7 @@ function TileCoordinatesImageryProvider(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; @@ -62,7 +62,7 @@ function TileCoordinatesImageryProvider(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; @@ -71,7 +71,7 @@ function TileCoordinatesImageryProvider(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; @@ -80,7 +80,7 @@ function TileCoordinatesImageryProvider(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; @@ -88,7 +88,7 @@ function TileCoordinatesImageryProvider(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; @@ -97,7 +97,7 @@ function TileCoordinatesImageryProvider(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; @@ -105,7 +105,7 @@ function TileCoordinatesImageryProvider(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; @@ -144,7 +144,7 @@ Object.defineProperties(TileCoordinatesImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link TileCoordinatesImageryProvider#ready} returns true. * @memberof TileCoordinatesImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -157,7 +157,7 @@ Object.defineProperties(TileCoordinatesImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link TileCoordinatesImageryProvider#ready} returns true. * @memberof TileCoordinatesImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -170,7 +170,7 @@ Object.defineProperties(TileCoordinatesImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link TileCoordinatesImageryProvider#ready} returns true. * @memberof TileCoordinatesImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -183,7 +183,7 @@ Object.defineProperties(TileCoordinatesImageryProvider.prototype, { * Gets the minimum level-of-detail that can be requested. This function should * not be called before {@link TileCoordinatesImageryProvider#ready} returns true. * @memberof TileCoordinatesImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -250,7 +250,7 @@ Object.defineProperties(TileCoordinatesImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof TileCoordinatesImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -262,7 +262,7 @@ Object.defineProperties(TileCoordinatesImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof TileCoordinatesImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -291,7 +291,7 @@ Object.defineProperties(TileCoordinatesImageryProvider.prototype, { * as if their alpha is 1.0 everywhere. Setting this property to false reduces memory usage * and texture upload time. * @memberof TileCoordinatesImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -304,9 +304,9 @@ Object.defineProperties(TileCoordinatesImageryProvider.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} getTileCredits must not be called before the imagery provider is ready. @@ -323,11 +323,11 @@ TileCoordinatesImageryProvider.prototype.getTileCredits = function ( * Requests the image for a given tile. This function should * not be called before {@link TileCoordinatesImageryProvider#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.} The resolved image as a Canvas DOM object. + * @returns {Promise} The resolved image as a Canvas DOM object. */ TileCoordinatesImageryProvider.prototype.requestImage = function ( x, @@ -360,11 +360,11 @@ TileCoordinatesImageryProvider.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. */ TileCoordinatesImageryProvider.prototype.pickFeatures = function ( diff --git a/packages/engine/Source/Scene/TileDiscardPolicy.js b/packages/engine/Source/Scene/TileDiscardPolicy.js index 1977b881fcac..b07424eb0b3a 100644 --- a/packages/engine/Source/Scene/TileDiscardPolicy.js +++ b/packages/engine/Source/Scene/TileDiscardPolicy.js @@ -18,7 +18,7 @@ function TileDiscardPolicy(options) { * Determines if the discard policy is ready to process images. * @function * - * @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. */ TileDiscardPolicy.prototype.isReady = DeveloperError.throwInstantiationError; @@ -27,7 +27,7 @@ TileDiscardPolicy.prototype.isReady = DeveloperError.throwInstantiationError; * @function * * @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. */ TileDiscardPolicy.prototype.shouldDiscardImage = DeveloperError.throwInstantiationError; diff --git a/packages/engine/Source/Scene/TileImagery.js b/packages/engine/Source/Scene/TileImagery.js index 8070126ebb71..5032408bdc38 100644 --- a/packages/engine/Source/Scene/TileImagery.js +++ b/packages/engine/Source/Scene/TileImagery.js @@ -10,7 +10,7 @@ import ImageryState from "./ImageryState.js"; * @param {Imagery} imagery The imagery tile. * @param {Cartesian4} textureCoordinateRectangle The texture rectangle of the tile that is covered * by the imagery, where X=west, Y=south, Z=east, W=north. - * @param {Boolean} useWebMercatorT true to use the Web Mercator texture coordinates for this imagery tile. + * @param {boolean} useWebMercatorT true to use the Web Mercator texture coordinates for this imagery tile. */ function TileImagery(imagery, textureCoordinateRectangle, useWebMercatorT) { this.readyImagery = undefined; @@ -38,10 +38,10 @@ TileImagery.prototype.freeResources = function () { * * @param {Tile} tile The tile to which this instance belongs. * @param {FrameState} frameState The frameState. - * @param {Boolean} skipLoading True to skip loading, e.g. new requests, creating textures. This function will + * @param {boolean} skipLoading True to skip loading, e.g. new requests, creating textures. This function will * still synchronously process imagery that's already mostly ready to go, e.g. use textures * already loaded on ancestor tiles. - * @returns {Boolean} True if this instance is done loading; otherwise, false. + * @returns {boolean} True if this instance is done loading; otherwise, false. */ TileImagery.prototype.processStateMachine = function ( tile, diff --git a/packages/engine/Source/Scene/TileMapServiceImageryProvider.js b/packages/engine/Source/Scene/TileMapServiceImageryProvider.js index 8054dd12933b..320f8a9521aa 100644 --- a/packages/engine/Source/Scene/TileMapServiceImageryProvider.js +++ b/packages/engine/Source/Scene/TileMapServiceImageryProvider.js @@ -14,17 +14,17 @@ import WebMercatorTilingScheme from "../Core/WebMercatorTilingScheme.js"; import UrlTemplateImageryProvider from "./UrlTemplateImageryProvider.js"; /** - * @typedef {Object} TileMapServiceImageryProvider.ConstructorOptions + * @typedef {object} TileMapServiceImageryProvider.ConstructorOptions * * Initialization options for the TileMapServiceImageryProvider constructor * - * @property {Resource|String|Promise|Promise} [url='.'] Path to image tiles on server. - * @property {String} [fileExtension='png'] The file extension for images on the server. - * @property {Credit|String} [credit=''] A credit for the data source, which is displayed on the canvas. - * @property {Number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying + * @property {Resource|string|Promise|Promise} [url='.'] Path to image tiles on server. + * @property {string} [fileExtension='png'] The file extension for images on the server. + * @property {Credit|string} [credit=''] A credit for the data source, which is displayed on the canvas. + * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying * this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely * to result in rendering problems. - * @property {Number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. + * @property {number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image. * @property {TilingScheme} [tilingScheme] The tiling scheme specifying how the ellipsoidal * surface is broken into tiles. If this parameter is not provided, a {@link WebMercatorTilingScheme} @@ -32,9 +32,9 @@ import UrlTemplateImageryProvider from "./UrlTemplateImageryProvider.js"; * @property {Ellipsoid} [ellipsoid] The ellipsoid. If the tilingScheme is specified, * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither * parameter is specified, the WGS84 ellipsoid is used. - * @property {Number} [tileWidth=256] Pixel width of image tiles. - * @property {Number} [tileHeight=256] Pixel height of image tiles. - * @property {Boolean} [flipXY] Older versions of gdal2tiles.py flipped X and Y values in tilemapresource.xml. + * @property {number} [tileWidth=256] Pixel width of image tiles. + * @property {number} [tileHeight=256] Pixel height of image tiles. + * @property {boolean} [flipXY] Older versions of gdal2tiles.py flipped X and Y values in tilemapresource.xml. * Specifying this option will do the same, allowing for loading of these incorrect tilesets. */ diff --git a/packages/engine/Source/Scene/TileMetadata.js b/packages/engine/Source/Scene/TileMetadata.js index d960c638ac7f..c2a62d9643d9 100644 --- a/packages/engine/Source/Scene/TileMetadata.js +++ b/packages/engine/Source/Scene/TileMetadata.js @@ -9,8 +9,8 @@ import MetadataEntity from "./MetadataEntity.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles *

    * - * @param {Object} options Object with the following properties: - * @param {Object} options.tile Either the tile metadata JSON (3D Tiles 1.1), or the extension JSON attached to the tile. + * @param {object} options Object with the following properties: + * @param {object} options.tile Either the tile metadata JSON (3D Tiles 1.1), or the extension JSON attached to the tile. * @param {MetadataClass} options.class The class that the tile metadata conforms to. * * @alias TileMetadata @@ -53,7 +53,7 @@ Object.defineProperties(TileMetadata.prototype, { * Extra user-defined properties. * * @memberof TileMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -67,7 +67,7 @@ Object.defineProperties(TileMetadata.prototype, { * An object containing extensions. * * @memberof TileMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -81,8 +81,8 @@ Object.defineProperties(TileMetadata.prototype, { /** * Returns whether the tile has this property. * - * @param {String} propertyId The case-sensitive ID of the property. - * @returns {Boolean} Whether the tile has this property. + * @param {string} propertyId The case-sensitive ID of the property. + * @returns {boolean} Whether the tile has this property. * @private */ TileMetadata.prototype.hasProperty = function (propertyId) { @@ -92,8 +92,8 @@ TileMetadata.prototype.hasProperty = function (propertyId) { /** * Returns whether the tile has a property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @returns {Boolean} Whether the tile has a property with the given semantic. + * @param {string} semantic The case-sensitive semantic of the property. + * @returns {boolean} Whether the tile has a property with the given semantic. * @private */ TileMetadata.prototype.hasPropertyBySemantic = function (semantic) { @@ -107,8 +107,8 @@ TileMetadata.prototype.hasPropertyBySemantic = function (semantic) { /** * 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 */ TileMetadata.prototype.getPropertyIds = function (results) { @@ -121,7 +121,7 @@ TileMetadata.prototype.getPropertyIds = function (results) { * If the property is normalized the normalized value is returned. *

    * - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @returns {*} The value of the property or undefined if the tile does not have this property. * @private */ @@ -135,9 +135,9 @@ TileMetadata.prototype.getProperty = function (propertyId) { * If the property is normalized a normalized value must be provided to this function. *

    * - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ TileMetadata.prototype.setProperty = function (propertyId, value) { @@ -152,7 +152,7 @@ TileMetadata.prototype.setProperty = function (propertyId, value) { /** * Returns a copy of the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @returns {*} The value of the property or undefined if the tile does not have this semantic. * @private */ @@ -167,9 +167,9 @@ TileMetadata.prototype.getPropertyBySemantic = function (semantic) { /** * Sets the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ TileMetadata.prototype.setPropertyBySemantic = function (semantic, value) { diff --git a/packages/engine/Source/Scene/TileOrientedBoundingBox.js b/packages/engine/Source/Scene/TileOrientedBoundingBox.js index 35d9d85fc2b9..9737474a5007 100644 --- a/packages/engine/Source/Scene/TileOrientedBoundingBox.js +++ b/packages/engine/Source/Scene/TileOrientedBoundingBox.js @@ -106,7 +106,7 @@ Object.defineProperties(TileOrientedBoundingBox.prototype, { * * @memberof TileOrientedBoundingBox.prototype * - * @type {Object} + * @type {object} * @readonly */ boundingVolume: { @@ -133,7 +133,7 @@ Object.defineProperties(TileOrientedBoundingBox.prototype, { * Computes the distance between this bounding box and the camera attached to frameState. * * @param {FrameState} frameState The frameState to which the camera is attached. - * @returns {Number} The distance between the camera and the bounding box in meters. Returns 0 if the camera is inside the bounding volume. + * @returns {number} The distance between the camera and the bounding box in meters. Returns 0 if the camera is inside the bounding volume. */ TileOrientedBoundingBox.prototype.distanceToCamera = function (frameState) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Scene/TileReplacementQueue.js b/packages/engine/Source/Scene/TileReplacementQueue.js index fe4695b793a9..1d0ccc73c883 100644 --- a/packages/engine/Source/Scene/TileReplacementQueue.js +++ b/packages/engine/Source/Scene/TileReplacementQueue.js @@ -27,7 +27,7 @@ TileReplacementQueue.prototype.markStartOfRenderFrame = function () { * tiles. Tiles that were used last frame will not be unloaded, even if that puts the number * of tiles above the specified maximum. * - * @param {Number} maximumTiles The maximum number of tiles in the queue. + * @param {number} maximumTiles The maximum number of tiles in the queue. */ TileReplacementQueue.prototype.trimTiles = function (maximumTiles) { let tileToTrim = this.tail; diff --git a/packages/engine/Source/Scene/TileSelectionResult.js b/packages/engine/Source/Scene/TileSelectionResult.js index f263c9e3f65a..3f9525f9c152 100644 --- a/packages/engine/Source/Scene/TileSelectionResult.js +++ b/packages/engine/Source/Scene/TileSelectionResult.js @@ -52,7 +52,7 @@ const TileSelectionResult = { * or REFINED_AND_KICKED. * * @param {TileSelectionResult} value The selection result to test. - * @returns {Boolean} true if the tile was kicked, no matter if it was originally rendered or refined. + * @returns {boolean} true if the tile was kicked, no matter if it was originally rendered or refined. */ wasKicked: function (value) { return value >= TileSelectionResult.RENDERED_AND_KICKED; diff --git a/packages/engine/Source/Scene/TilesetMetadata.js b/packages/engine/Source/Scene/TilesetMetadata.js index 229da5fc13ca..ef79ef3ec369 100644 --- a/packages/engine/Source/Scene/TilesetMetadata.js +++ b/packages/engine/Source/Scene/TilesetMetadata.js @@ -9,8 +9,8 @@ import MetadataEntity from "./MetadataEntity.js"; * See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles *

    * - * @param {Object} options Object with the following properties: - * @param {Object} options.tileset The tileset metadata JSON object. + * @param {object} options Object with the following properties: + * @param {object} options.tileset The tileset metadata JSON object. * @param {MetadataClass} options.class The class that tileset metadata conforms to. * * @alias TilesetMetadata @@ -69,7 +69,7 @@ Object.defineProperties(TilesetMetadata.prototype, { * An object containing extensions. * * @memberof TilesetMetadata.prototype - * @type {Object} + * @type {object} * @readonly * @private */ @@ -83,8 +83,8 @@ Object.defineProperties(TilesetMetadata.prototype, { /** * Returns whether the tileset has this property. * - * @param {String} propertyId The case-sensitive ID of the property. - * @returns {Boolean} Whether the tileset has this property. + * @param {string} propertyId The case-sensitive ID of the property. + * @returns {boolean} Whether the tileset has this property. * @private */ TilesetMetadata.prototype.hasProperty = function (propertyId) { @@ -94,8 +94,8 @@ TilesetMetadata.prototype.hasProperty = function (propertyId) { /** * Returns whether the tileset has a property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. - * @returns {Boolean} Whether the tileset has a property with the given semantic. + * @param {string} semantic The case-sensitive semantic of the property. + * @returns {boolean} Whether the tileset has a property with the given semantic. * @private */ TilesetMetadata.prototype.hasPropertyBySemantic = function (semantic) { @@ -109,8 +109,8 @@ TilesetMetadata.prototype.hasPropertyBySemantic = function (semantic) { /** * 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 */ TilesetMetadata.prototype.getPropertyIds = function (results) { @@ -123,7 +123,7 @@ TilesetMetadata.prototype.getPropertyIds = function (results) { * If the property is normalized the normalized value is returned. *

    * - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @returns {*} The value of the property or undefined if the tileset does not have this property. * @private */ @@ -137,9 +137,9 @@ TilesetMetadata.prototype.getProperty = function (propertyId) { * If the property is normalized a normalized value must be provided to this function. *

    * - * @param {String} propertyId The case-sensitive ID of the property. + * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ TilesetMetadata.prototype.setProperty = function (propertyId, value) { @@ -154,7 +154,7 @@ TilesetMetadata.prototype.setProperty = function (propertyId, value) { /** * Returns a copy of the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @returns {*} The value of the property or undefined if the tileset does not have this semantic. * @private */ @@ -169,9 +169,9 @@ TilesetMetadata.prototype.getPropertyBySemantic = function (semantic) { /** * Sets the value of the property with the given semantic. * - * @param {String} semantic The case-sensitive semantic of the property. + * @param {string} semantic The case-sensitive semantic of the property. * @param {*} value The value of the property that will be copied. - * @returns {Boolean} true if the property was set, false otherwise. + * @returns {boolean} true if the property was set, false otherwise. * @private */ TilesetMetadata.prototype.setPropertyBySemantic = function (semantic, value) { diff --git a/packages/engine/Source/Scene/TimeDynamicImagery.js b/packages/engine/Source/Scene/TimeDynamicImagery.js index 45788ed4874e..8a12e8902b7c 100644 --- a/packages/engine/Source/Scene/TimeDynamicImagery.js +++ b/packages/engine/Source/Scene/TimeDynamicImagery.js @@ -12,7 +12,7 @@ import RequestType from "../Core/RequestType.js"; * @alias TimeDynamicImagery * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Clock} options.clock A Clock instance that is used when determining the value for the time dimension. Required when options.times is specified. * @param {TimeIntervalCollection} options.times TimeIntervalCollection with its data property being an object containing time dynamic dimension and their values. * @param {Function} options.requestImageFunction A function that will request imagery tiles. @@ -106,12 +106,12 @@ Object.defineProperties(TimeDynamicImagery.prototype, { /** * Gets the tile from the cache if its available. * - * @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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|undefined} A promise for the image that will resolve when the image is available, or * undefined if the tile is not in the cache. */ TimeDynamicImagery.prototype.getFromCache = function (x, y, level, request) { @@ -135,9 +135,9 @@ TimeDynamicImagery.prototype.getFromCache = function (x, y, level, request) { * Checks if the next interval is approaching and will start preload the tile if necessary. Otherwise it will * just add the tile to a list to preload when we approach the next interval. * - * @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. */ TimeDynamicImagery.prototype.checkApproachingInterval = function ( diff --git a/packages/engine/Source/Scene/TimeDynamicPointCloud.js b/packages/engine/Source/Scene/TimeDynamicPointCloud.js index 4a8a0269ee7a..04b3f77cab57 100644 --- a/packages/engine/Source/Scene/TimeDynamicPointCloud.js +++ b/packages/engine/Source/Scene/TimeDynamicPointCloud.js @@ -27,14 +27,14 @@ import ShadowMode from "./ShadowMode.js"; * @alias TimeDynamicPointCloud * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Clock} options.clock A {@link Clock} instance that is used when determining the value for the time dimension. * @param {TimeIntervalCollection} options.intervals A {@link TimeIntervalCollection} with its data property being an object containing a uri to a 3D Tiles Point Cloud tile and an optional transform. - * @param {Boolean} [options.show=true] Determines if the point cloud will be shown. + * @param {boolean} [options.show=true] Determines if the point cloud will be shown. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] A 4x4 transformation matrix that transforms the point cloud. * @param {ShadowMode} [options.shadows=ShadowMode.ENABLED] Determines whether the point cloud casts or receives shadows from light sources. - * @param {Number} [options.maximumMemoryUsage=256] The maximum amount of memory in MB that can be used by the point cloud. - * @param {Object} [options.shading] Options for constructing a {@link PointCloudShading} object to control point attenuation and eye dome lighting. + * @param {number} [options.maximumMemoryUsage=256] The maximum amount of memory in MB that can be used by the point cloud. + * @param {object} [options.shading] Options for constructing a {@link PointCloudShading} object to control point attenuation and eye dome lighting. * @param {Cesium3DTileStyle} [options.style] The style, defined using the {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Styling|3D Tiles Styling language}, applied to each point in the point cloud. * @param {ClippingPlaneCollection} [options.clippingPlanes] The {@link ClippingPlaneCollection} used to selectively disable rendering the point cloud. */ @@ -49,7 +49,7 @@ function TimeDynamicPointCloud(options) { /** * Determines if the point cloud will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = defaultValue(options.show, true); @@ -87,7 +87,7 @@ function TimeDynamicPointCloud(options) { * If decreasing this value results in unloading tiles, the tiles are unloaded the next frame. *

    * - * @type {Number} + * @type {number} * @default 256 * * @see TimeDynamicPointCloud#totalMemoryUsageInBytes @@ -217,7 +217,7 @@ Object.defineProperties(TimeDynamicPointCloud.prototype, { * * @memberof TimeDynamicPointCloud.prototype * - * @type {Number} + * @type {number} * @readonly * * @see TimeDynamicPointCloud#maximumMemoryUsage @@ -250,7 +250,7 @@ Object.defineProperties(TimeDynamicPointCloud.prototype, { * * @memberof TimeDynamicPointCloud.prototype * - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -787,7 +787,7 @@ TimeDynamicPointCloud.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see TimeDynamicPointCloud#destroy */ diff --git a/packages/engine/Source/Scene/Tonemapper.js b/packages/engine/Source/Scene/Tonemapper.js index 2bd6812ca0a0..b799e43ee7be 100644 --- a/packages/engine/Source/Scene/Tonemapper.js +++ b/packages/engine/Source/Scene/Tonemapper.js @@ -1,14 +1,14 @@ /** * A tonemapping algorithm when rendering with high dynamic range. * - * @enum {Number} + * @enum {number} * @private */ const Tonemapper = { /** * Use the Reinhard tonemapping operator. * - * @type {Number} + * @type {number} * @constant */ REINHARD: 0, @@ -16,7 +16,7 @@ const Tonemapper = { /** * Use the modified Reinhard tonemapping operator. * - * @type {Number} + * @type {number} * @constant */ MODIFIED_REINHARD: 1, @@ -24,7 +24,7 @@ const Tonemapper = { /** * Use the Filmic tonemapping operator. * - * @type {Number} + * @type {number} * @constant */ FILMIC: 2, @@ -32,7 +32,7 @@ const Tonemapper = { /** * Use the ACES tonemapping operator. * - * @type {Number} + * @type {number} * @constant */ ACES: 3, diff --git a/packages/engine/Source/Scene/TranslucentTileClassification.js b/packages/engine/Source/Scene/TranslucentTileClassification.js index 4b36673d889c..b171fe76adff 100644 --- a/packages/engine/Source/Scene/TranslucentTileClassification.js +++ b/packages/engine/Source/Scene/TranslucentTileClassification.js @@ -76,7 +76,7 @@ Object.defineProperties(TranslucentTileClassification.prototype, { * Gets whether or not translucent depth was rendered. * @memberof TranslucentTileClassification.prototype * - * @type {Boolean} + * @type {boolean} * @readonly */ hasTranslucentDepth: { diff --git a/packages/engine/Source/Scene/TweenCollection.js b/packages/engine/Source/Scene/TweenCollection.js index c5ee6cf394f5..e49bad844f57 100644 --- a/packages/engine/Source/Scene/TweenCollection.js +++ b/packages/engine/Source/Scene/TweenCollection.js @@ -60,7 +60,7 @@ Object.defineProperties(Tween.prototype, { * An object with properties for initial values of the tween. The properties of this object are changed during the tween's animation. * @memberof Tween.prototype * - * @type {Object} + * @type {object} * @readonly */ startObject: { @@ -73,7 +73,7 @@ Object.defineProperties(Tween.prototype, { * An object with properties for the final values of the tween. * @memberof Tween.prototype * - * @type {Object} + * @type {object} * @readonly */ stopObject: { @@ -86,7 +86,7 @@ Object.defineProperties(Tween.prototype, { * The duration, in seconds, for the tween. The tween is automatically removed from the collection when it stops. * @memberof Tween.prototype * - * @type {Number} + * @type {number} * @readonly */ duration: { @@ -99,7 +99,7 @@ Object.defineProperties(Tween.prototype, { * The delay, in seconds, before the tween starts animating. * @memberof Tween.prototype * - * @type {Number} + * @type {number} * @readonly */ delay: { @@ -184,7 +184,7 @@ Object.defineProperties(TweenCollection.prototype, { * The number of tweens in the collection. * @memberof TweenCollection.prototype * - * @type {Number} + * @type {number} * @readonly */ length: { @@ -198,11 +198,11 @@ Object.defineProperties(TweenCollection.prototype, { * Creates a tween for animating between two sets of properties. The tween starts animating at the next call to {@link TweenCollection#update}, which * is implicit when {@link Viewer} or {@link CesiumWidget} render the scene. * - * @param {Object} [options] Object with the following properties: - * @param {Object} options.startObject An object with properties for initial values of the tween. The properties of this object are changed during the tween's animation. - * @param {Object} options.stopObject An object with properties for the final values of the tween. - * @param {Number} options.duration The duration, in seconds, for the tween. The tween is automatically removed from the collection when it stops. - * @param {Number} [options.delay=0.0] The delay, in seconds, before the tween starts animating. + * @param {object} [options] Object with the following properties: + * @param {object} options.startObject An object with properties for initial values of the tween. The properties of this object are changed during the tween's animation. + * @param {object} options.stopObject An object with properties for the final values of the tween. + * @param {number} options.duration The duration, in seconds, for the tween. The tween is automatically removed from the collection when it stops. + * @param {number} [options.delay=0.0] The delay, in seconds, before the tween starts animating. * @param {EasingFunction} [options.easingFunction=EasingFunction.LINEAR_NONE] Determines the curve for animtion. * @param {TweenCollection.TweenUpdateCallback} [options.update] The callback to call at each animation update (usually tied to the a rendered frame). * @param {TweenCollection.TweenCompleteCallback} [options.complete] The callback to call when the tween finishes animating. @@ -276,13 +276,13 @@ TweenCollection.prototype.add = function (options) { * Creates a tween for animating a scalar property on the given object. The tween starts animating at the next call to {@link TweenCollection#update}, which * is implicit when {@link Viewer} or {@link CesiumWidget} render the scene. * - * @param {Object} [options] Object with the following properties: - * @param {Object} options.object The object containing the property to animate. - * @param {String} options.property The name of the property to animate. - * @param {Number} options.startValue The initial value. - * @param {Number} options.stopValue The final value. - * @param {Number} [options.duration=3.0] The duration, in seconds, for the tween. The tween is automatically removed from the collection when it stops. - * @param {Number} [options.delay=0.0] The delay, in seconds, before the tween starts animating. + * @param {object} [options] Object with the following properties: + * @param {object} options.object The object containing the property to animate. + * @param {string} options.property The name of the property to animate. + * @param {number} options.startValue The initial value. + * @param {number} options.stopValue The final value. + * @param {number} [options.duration=3.0] The duration, in seconds, for the tween. The tween is automatically removed from the collection when it stops. + * @param {number} [options.delay=0.0] The delay, in seconds, before the tween starts animating. * @param {EasingFunction} [options.easingFunction=EasingFunction.LINEAR_NONE] Determines the curve for animtion. * @param {TweenCollection.TweenUpdateCallback} [options.update] The callback to call at each animation update (usually tied to the a rendered frame). * @param {TweenCollection.TweenCompleteCallback} [options.complete] The callback to call when the tween finishes animating. @@ -343,12 +343,12 @@ TweenCollection.prototype.addProperty = function (options) { * Creates a tween for animating the alpha of all color uniforms on a {@link Material}. The tween starts animating at the next call to {@link TweenCollection#update}, which * is implicit when {@link Viewer} or {@link CesiumWidget} render the scene. * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Material} options.material The material to animate. - * @param {Number} [options.startValue=0.0] The initial alpha value. - * @param {Number} [options.stopValue=1.0] The final alpha value. - * @param {Number} [options.duration=3.0] The duration, in seconds, for the tween. The tween is automatically removed from the collection when it stops. - * @param {Number} [options.delay=0.0] The delay, in seconds, before the tween starts animating. + * @param {number} [options.startValue=0.0] The initial alpha value. + * @param {number} [options.stopValue=1.0] The final alpha value. + * @param {number} [options.duration=3.0] The duration, in seconds, for the tween. The tween is automatically removed from the collection when it stops. + * @param {number} [options.delay=0.0] The delay, in seconds, before the tween starts animating. * @param {EasingFunction} [options.easingFunction=EasingFunction.LINEAR_NONE] Determines the curve for animtion. * @param {TweenCollection.TweenUpdateCallback} [options.update] The callback to call at each animation update (usually tied to the a rendered frame). * @param {TweenCollection.TweenCompleteCallback} [options.complete] The callback to call when the tween finishes animating. @@ -416,12 +416,12 @@ TweenCollection.prototype.addAlpha = function (options) { * Creates a tween for animating the offset uniform of a {@link Material}. The tween starts animating at the next call to {@link TweenCollection#update}, which * is implicit when {@link Viewer} or {@link CesiumWidget} render the scene. * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Material} options.material The material to animate. - * @param {Number} options.startValue The initial alpha value. - * @param {Number} options.stopValue The final alpha value. - * @param {Number} [options.duration=3.0] The duration, in seconds, for the tween. The tween is automatically removed from the collection when it stops. - * @param {Number} [options.delay=0.0] The delay, in seconds, before the tween starts animating. + * @param {number} options.startValue The initial alpha value. + * @param {number} options.stopValue The final alpha value. + * @param {number} [options.duration=3.0] The duration, in seconds, for the tween. The tween is automatically removed from the collection when it stops. + * @param {number} [options.delay=0.0] The delay, in seconds, before the tween starts animating. * @param {EasingFunction} [options.easingFunction=EasingFunction.LINEAR_NONE] Determines the curve for animtion. * @param {TweenCollection.TweenUpdateCallback} [options.update] The callback to call at each animation update (usually tied to the a rendered frame). * @param {TweenCollection.TweenCancelledCallback} [options.cancel] The callback to call if the tween is canceled either because {@link Tween#cancelTween} was called or because the tween was removed from the collection. @@ -466,7 +466,7 @@ TweenCollection.prototype.addOffsetIncrement = function (options) { *

    * * @param {Tween} tween The tween to remove. - * @returns {Boolean} true if the tween was removed; false if the tween was not found in the collection. + * @returns {boolean} true if the tween was removed; false if the tween was not found in the collection. */ TweenCollection.prototype.remove = function (tween) { if (!defined(tween)) { @@ -509,7 +509,7 @@ TweenCollection.prototype.removeAll = function () { * Determines whether this collection contains a given tween. * * @param {Tween} tween The tween to check for. - * @returns {Boolean} true if this collection contains the tween, false otherwise. + * @returns {boolean} true if this collection contains the tween, false otherwise. */ TweenCollection.prototype.contains = function (tween) { return defined(tween) && this._tweens.indexOf(tween) !== -1; @@ -521,7 +521,7 @@ TweenCollection.prototype.contains = function (tween) { * it to the left, changing their indices. This function is commonly used to iterate over * all the tween in the collection. * - * @param {Number} index The zero-based index of the tween. + * @param {number} index The zero-based index of the tween. * @returns {Tween} The tween at the specified index. * * @example @@ -546,7 +546,7 @@ TweenCollection.prototype.get = function (index) { * Updates the tweens in the collection to be at the provide time. When a tween finishes, it is removed * from the collection. * - * @param {Number} [time=getTimestamp()] The time in seconds. By default tweens are synced to the system clock. + * @param {number} [time=getTimestamp()] The time in seconds. By default tweens are synced to the system clock. */ TweenCollection.prototype.update = function (time) { const tweens = this._tweens; diff --git a/packages/engine/Source/Scene/UrlTemplateImageryProvider.js b/packages/engine/Source/Scene/UrlTemplateImageryProvider.js index a6aa08654ee6..ea46b9ac6853 100644 --- a/packages/engine/Source/Scene/UrlTemplateImageryProvider.js +++ b/packages/engine/Source/Scene/UrlTemplateImageryProvider.js @@ -49,12 +49,12 @@ const pickFeaturesTags = combine(tags, { }); /** - * @typedef {Object} UrlTemplateImageryProvider.ConstructorOptions + * @typedef {object} UrlTemplateImageryProvider.ConstructorOptions * * Initialization options for the UrlTemplateImageryProvider constructor * - * @property {Promise.|Object} [options] Object with the following properties: - * @property {Resource|String} url The URL template to use to request tiles. It has the following keywords: + * @property {Promise|object} [options] Object with the following properties: + * @property {Resource|string} url The URL template to use to request tiles. It has the following keywords: *
      *
    • {z}: The level of the tile in the tiling scheme. Level zero is the root of the quadtree pyramid.
      • *
    • {x}: The tile X coordinate in the tiling scheme, where 0 is the Westernmost tile.
      • @@ -74,7 +74,7 @@ const pickFeaturesTags = combine(tags, { *
    • {width}: The width of each tile in pixels.
      • *
    • {height}: The height of each tile in pixels.
      • *
    - * @property {Resource|String} [pickFeaturesUrl] The URL template to use to pick features. If this property is not specified, + * @property {Resource|string} [pickFeaturesUrl] The URL template to use to pick features. If this property is not specified, * {@link UrlTemplateImageryProvider#pickFeatures} will immediately returned undefined, indicating no * features picked. The URL template supports all of the keywords supported by the url * parameter, plus the following: @@ -89,7 +89,7 @@ const pickFeaturesTags = combine(tags, { *
  • {latitudeProjected}: The latitude of the picked position in the projected coordinates of the tiling scheme.
    • *
  • {format}: The format in which to get feature information, as specified in the {@link GetFeatureInfoFormat}.
    • * - * @property {Object} [urlSchemeZeroPadding] Gets the URL scheme zero padding for each tile coordinate. The format is '000' where + * @property {object} [urlSchemeZeroPadding] Gets the URL scheme zero padding for each tile coordinate. The format is '000' where * each coordinate will be padded on the left with zeros to match the width of the passed string of zeros. e.g. Setting: * urlSchemeZeroPadding : { '{x}' : '0000'} * will cause an 'x' value of 12 to return the string '0012' for {x} in the generated URL. @@ -102,14 +102,14 @@ const pickFeaturesTags = combine(tags, { *
  • {reverseY}: The zero padding for the tile reverseY coordinate in the tiling scheme.
    • *
  • {reverseZ}: The zero padding for the reverseZ coordinate of the tile in the tiling scheme.
    • * - * @property {String|String[]} [subdomains='abc'] The subdomains to use for the {s} placeholder in the URL template. + * @property {string|string[]} [subdomains='abc'] The subdomains to use for the {s} placeholder in the URL template. * If this parameter is a single string, each character in the string is a subdomain. If it is * an array, each element in the array is a subdomain. - * @property {Credit|String} [credit=''] A credit for the data source, which is displayed on the canvas. - * @property {Number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying + * @property {Credit|string} [credit=''] A credit for the data source, which is displayed on the canvas. + * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying * this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely * to result in rendering problems. - * @property {Number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. + * @property {number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image. * @property {TilingScheme} [tilingScheme=WebMercatorTilingScheme] The tiling scheme specifying how the ellipsoidal * surface is broken into tiles. If this parameter is not provided, a {@link WebMercatorTilingScheme} @@ -117,9 +117,9 @@ const pickFeaturesTags = combine(tags, { * @property {Ellipsoid} [ellipsoid] The ellipsoid. If the tilingScheme is specified, * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither * parameter is specified, the WGS84 ellipsoid is used. - * @property {Number} [tileWidth=256] Pixel width of image tiles. - * @property {Number} [tileHeight=256] Pixel height of image tiles. - * @property {Boolean} [hasAlphaChannel=true] true if the images provided by this imagery provider + * @property {number} [tileWidth=256] Pixel width of image tiles. + * @property {number} [tileHeight=256] Pixel height of image tiles. + * @property {boolean} [hasAlphaChannel=true] true if the images provided by this imagery provider * include an alpha channel; otherwise, false. If this property is false, an alpha channel, if * present, will be ignored. If this property is true, any images without an alpha channel will * be treated as if their alpha is 1.0 everywhere. When this property is false, memory usage @@ -127,14 +127,14 @@ const pickFeaturesTags = combine(tags, { * @property {GetFeatureInfoFormat[]} [getFeatureInfoFormats] The formats in which to get feature information at a * specific location when {@link UrlTemplateImageryProvider#pickFeatures} is invoked. If this * parameter is not specified, feature picking is disabled. - * @property {Boolean} [enablePickFeatures=true] If true, {@link UrlTemplateImageryProvider#pickFeatures} will + * @property {boolean} [enablePickFeatures=true] If true, {@link UrlTemplateImageryProvider#pickFeatures} will * request the pickFeaturesUrl and attempt to interpret the features included in the response. If false, * {@link UrlTemplateImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable * features) without communicating with the server. Set this property to false if you know your data * source does not support picking features or if you don't want this provider's features to be pickable. Note * that this can be dynamically overridden by modifying the {@link UriTemplateImageryProvider#enablePickFeatures} * property. - * @property {Object} [customTags] Allow to replace custom keywords in the URL template. The object must have strings as keys and functions as values. + * @property {object} [customTags] Allow to replace custom keywords in the URL template. The object must have strings as keys and functions as values. */ /** @@ -219,7 +219,7 @@ function UrlTemplateImageryProvider(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; @@ -228,7 +228,7 @@ function UrlTemplateImageryProvider(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; @@ -237,7 +237,7 @@ function UrlTemplateImageryProvider(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; @@ -246,7 +246,7 @@ function UrlTemplateImageryProvider(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; @@ -255,7 +255,7 @@ function UrlTemplateImageryProvider(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; @@ -263,7 +263,7 @@ function UrlTemplateImageryProvider(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; @@ -272,7 +272,7 @@ function UrlTemplateImageryProvider(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; @@ -280,7 +280,7 @@ function UrlTemplateImageryProvider(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; @@ -307,7 +307,7 @@ function UrlTemplateImageryProvider(options) { * {@link UrlTemplateImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable * features) without communicating with the server. Set this property to false if you know your data * source does not support picking features or if you don't want this provider's features to be pickable. - * @type {Boolean} + * @type {boolean} * @default true */ this.enablePickFeatures = true; @@ -338,7 +338,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { *
  • {height}: The height of each tile in pixels.
    • * * @memberof UrlTemplateImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -362,7 +362,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { *
  • {reverseZ}: The zero padding for the reverseZ coordinate of the tile in the tiling scheme.
    • * * @memberof UrlTemplateImageryProvider.prototype - * @type {Object} + * @type {object} * @readonly */ urlSchemeZeroPadding: { @@ -388,7 +388,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { *
  • {format}: The format in which to get feature information, as specified in the {@link GetFeatureInfoFormat}.
    • * * @memberof UrlTemplateImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ pickFeaturesUrl: { @@ -414,7 +414,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link UrlTemplateImageryProvider#ready} returns true. * @memberof UrlTemplateImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly * @default 256 */ @@ -435,7 +435,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link UrlTemplateImageryProvider#ready} returns true. * @memberof UrlTemplateImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly * @default 256 */ @@ -456,7 +456,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested, or undefined if there is no limit. * This function should not be called before {@link UrlTemplateImageryProvider#ready} returns true. * @memberof UrlTemplateImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly * @default undefined */ @@ -477,7 +477,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { * Gets the minimum level-of-detail that can be requested. This function should * not be called before {@link UrlTemplateImageryProvider#ready} returns true. * @memberof UrlTemplateImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly * @default 0 */ @@ -576,7 +576,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof UrlTemplateImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -588,7 +588,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof UrlTemplateImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -626,7 +626,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { * and texture upload time are reduced. This function should * not be called before {@link ImageryProvider#ready} returns true. * @memberof UrlTemplateImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly * @default true */ @@ -648,7 +648,7 @@ Object.defineProperties(UrlTemplateImageryProvider.prototype, { * Reinitializes this instance. Reinitializing an instance already in use is supported, but it is not * recommended because existing tiles provided by the imagery provider will not be updated. * - * @param {Promise.|Object} options Any of the options that may be passed to the {@link UrlTemplateImageryProvider} constructor. + * @param {Promise|object} options Any of the options that may be passed to the {@link UrlTemplateImageryProvider} constructor. */ UrlTemplateImageryProvider.prototype.reinitialize = function (options) { const that = this; @@ -726,9 +726,9 @@ UrlTemplateImageryProvider.prototype.reinitialize = function (options) { /** * 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} getTileCredits must not be called before the imagery provider is ready. @@ -748,11 +748,11 @@ UrlTemplateImageryProvider.prototype.getTileCredits = function (x, y, level) { * Requests the image for a given tile. This function should * not be called before {@link UrlTemplateImageryProvider#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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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. */ UrlTemplateImageryProvider.prototype.requestImage = function ( @@ -778,12 +778,12 @@ UrlTemplateImageryProvider.prototype.requestImage = function ( * Asynchronously determines what features, if any, are located at a given longitude and latitude within * a tile. This function should not be called before {@link ImageryProvider#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} longitude The longitude at which to pick features. - * @param {Number} latitude The latitude at which to pick features. - * @return {Promise.|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|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. diff --git a/packages/engine/Source/Scene/Vector3DTileBatch.js b/packages/engine/Source/Scene/Vector3DTileBatch.js index a2c5950c5c5b..121dfdc2fc0b 100644 --- a/packages/engine/Source/Scene/Vector3DTileBatch.js +++ b/packages/engine/Source/Scene/Vector3DTileBatch.js @@ -4,23 +4,23 @@ * @alias Vector3DTileBatch * @constructor * - * @param {Object} options An object with the following properties: - * @param {Number} options.offset The offset of the batch into the indices buffer. - * @param {Number} options.count The number of indices in the batch. + * @param {object} options An object with the following properties: + * @param {number} options.offset The offset of the batch into the indices buffer. + * @param {number} options.count The number of indices in the batch. * @param {Color} options.color The color of the geometry in the batch. - * @param {Number[]} options.batchIds An array where each element is the batch id of the geometry in the batch. + * @param {number[]} options.batchIds An array where each element is the batch id of the geometry in the batch. * * @private */ function Vector3DTileBatch(options) { /** * The offset of the batch into the indices buffer. - * @type {Number} + * @type {number} */ this.offset = options.offset; /** * The number of indices in the batch. - * @type {Number} + * @type {number} */ this.count = options.count; /** @@ -30,7 +30,7 @@ function Vector3DTileBatch(options) { this.color = options.color; /** * An array where each element is the batch id of the geometry in the batch. - * @type {Number[]} + * @type {number[]} */ this.batchIds = options.batchIds; } diff --git a/packages/engine/Source/Scene/Vector3DTileClampedPolylines.js b/packages/engine/Source/Scene/Vector3DTileClampedPolylines.js index 30daa9d0acf8..143b934892b8 100644 --- a/packages/engine/Source/Scene/Vector3DTileClampedPolylines.js +++ b/packages/engine/Source/Scene/Vector3DTileClampedPolylines.js @@ -39,18 +39,18 @@ import Vector3DTilePolylines from "./Vector3DTilePolylines.js"; * @alias Vector3DTileClampedPolylines * @constructor * - * @param {Object} options An object with following properties: + * @param {object} options An object with following properties: * @param {Uint16Array} options.positions The positions of the polylines * @param {Uint32Array} options.counts The number or positions in the each polyline. * @param {Uint16Array} options.widths The width of each polyline. - * @param {Number} options.minimumHeight The minimum height of the tile's region. - * @param {Number} options.maximumHeight The maximum height of the tile's region. + * @param {number} options.minimumHeight The minimum height of the tile's region. + * @param {number} options.maximumHeight The maximum height of the tile's region. * @param {Rectangle} options.rectangle The rectangle containing the tile. * @param {Cartesian3} [options.center=Cartesian3.ZERO] The RTC center. * @param {Cesium3DTileBatchTable} options.batchTable The batch table for the tile containing the batched polylines. * @param {Uint16Array} options.batchIds The batch ids for each polyline. * @param {ClassificationType} options.classificationType The classification type. - * @param {Boolean} options.keepDecodedPositions Whether to keep decoded positions in memory. + * @param {boolean} options.keepDecodedPositions Whether to keep decoded positions in memory. * * @private */ @@ -123,7 +123,7 @@ Object.defineProperties(Vector3DTileClampedPolylines.prototype, { * * @memberof Vector3DTileClampedPolylines.prototype * - * @type {Number} + * @type {number} * @readonly */ trianglesLength: { @@ -137,7 +137,7 @@ Object.defineProperties(Vector3DTileClampedPolylines.prototype, { * * @memberof Vector3DTileClampedPolylines.prototype * - * @type {Number} + * @type {number} * @readonly */ geometryByteLength: { @@ -610,7 +610,7 @@ function queueCommands(primitive, frameState) { /** * Get the polyline positions for the given feature. * - * @param {Number} batchId The batch ID of the feature. + * @param {number} batchId The batch ID of the feature. */ Vector3DTileClampedPolylines.prototype.getPositions = function (batchId) { return Vector3DTilePolylines.getPolylinePositions(this, batchId); @@ -637,7 +637,7 @@ Vector3DTileClampedPolylines.prototype.createFeatures = function ( /** * Colors the entire tile when enabled is true. The resulting color will be (polyline batch table color * color). * - * @param {Boolean} enabled Whether to enable debug coloring. + * @param {boolean} enabled Whether to enable debug coloring. * @param {Color} color The debug color. */ Vector3DTileClampedPolylines.prototype.applyDebugSettings = function ( @@ -747,7 +747,7 @@ Vector3DTileClampedPolylines.prototype.update = function (frameState) { * isDestroyed 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. */ Vector3DTileClampedPolylines.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/Vector3DTileGeometry.js b/packages/engine/Source/Scene/Vector3DTileGeometry.js index e54412d2dfc6..4e4c9be5da89 100644 --- a/packages/engine/Source/Scene/Vector3DTileGeometry.js +++ b/packages/engine/Source/Scene/Vector3DTileGeometry.js @@ -16,7 +16,7 @@ import Vector3DTilePrimitive from "./Vector3DTilePrimitive.js"; * @alias Vector3DTileGeometry * @constructor * - * @param {Object} options An object with following properties: + * @param {object} options An object with following properties: * @param {Float32Array} [options.boxes] The boxes in the tile. * @param {Uint16Array} [options.boxBatchIds] The batch ids for each box. * @param {Float32Array} [options.cylinders] The cylinders in the tile. @@ -80,14 +80,14 @@ function Vector3DTileGeometry(options) { /** * Draws the wireframe of the classification geometries. - * @type {Boolean} + * @type {boolean} * @default false */ this.debugWireframe = false; /** * Forces a re-batch instead of waiting after a number of frames have been rendered. For testing only. - * @type {Boolean} + * @type {boolean} * @default false */ this.forceRebatch = false; @@ -106,7 +106,7 @@ Object.defineProperties(Vector3DTileGeometry.prototype, { * * @memberof Vector3DTileGeometry.prototype * - * @type {Number} + * @type {number} * @readonly */ trianglesLength: { @@ -123,7 +123,7 @@ Object.defineProperties(Vector3DTileGeometry.prototype, { * * @memberof Vector3DTileGeometry.prototype * - * @type {Number} + * @type {number} * @readonly */ geometryByteLength: { @@ -393,7 +393,7 @@ Vector3DTileGeometry.prototype.createFeatures = function (content, features) { /** * Colors the entire tile when enabled is true. The resulting color will be (geometry batch table color * color). * - * @param {Boolean} enabled Whether to enable debug coloring. + * @param {boolean} enabled Whether to enable debug coloring. * @param {Color} color The debug color. */ Vector3DTileGeometry.prototype.applyDebugSettings = function (enabled, color) { @@ -414,7 +414,7 @@ Vector3DTileGeometry.prototype.applyStyle = function (style, features) { * Call when updating the color of a geometry with batchId changes color. The geometries will need to be re-batched * on the next update. * - * @param {Number} batchId The batch id of the geometries whose color has changed. + * @param {number} batchId The batch id of the geometries whose color has changed. * @param {Color} color The new polygon color. */ Vector3DTileGeometry.prototype.updateCommands = function (batchId, color) { @@ -466,7 +466,7 @@ Vector3DTileGeometry.prototype.update = function (frameState) { * isDestroyed 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. */ Vector3DTileGeometry.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/Vector3DTilePoints.js b/packages/engine/Source/Scene/Vector3DTilePoints.js index 35e61689ffba..d083bc81625e 100644 --- a/packages/engine/Source/Scene/Vector3DTilePoints.js +++ b/packages/engine/Source/Scene/Vector3DTilePoints.js @@ -22,10 +22,10 @@ import VerticalOrigin from "./VerticalOrigin.js"; * @alias Vector3DTilePoints * @constructor * - * @param {Object} options An object with following properties: + * @param {object} options An object with following properties: * @param {Uint16Array} options.positions The positions of the polygons. - * @param {Number} options.minimumHeight The minimum height of the terrain covered by the tile. - * @param {Number} options.maximumHeight The maximum height of the terrain covered by the tile. + * @param {number} options.minimumHeight The minimum height of the terrain covered by the tile. + * @param {number} options.maximumHeight The maximum height of the terrain covered by the tile. * @param {Rectangle} options.rectangle The rectangle containing the tile. * @param {Cesium3DTileBatchTable} options.batchTable The batch table for the tile containing the batched polygons. * @param {Uint16Array} options.batchIds The batch ids for each polygon. @@ -66,7 +66,7 @@ Object.defineProperties(Vector3DTilePoints.prototype, { * * @memberof Vector3DTilePoints.prototype * - * @type {Number} + * @type {number} * @readonly */ pointsLength: { @@ -80,7 +80,7 @@ Object.defineProperties(Vector3DTilePoints.prototype, { * * @memberof Vector3DTilePoints.prototype * - * @type {Number} + * @type {number} * @readonly */ texturesByteLength: { @@ -227,7 +227,7 @@ Vector3DTilePoints.prototype.createFeatures = function (content, features) { /** * Colors the entire tile when enabled is true. The resulting color will be (batch table color * color). * - * @param {Boolean} enabled Whether to enable debug coloring. + * @param {boolean} enabled Whether to enable debug coloring. * @param {Color} color The debug color. */ Vector3DTilePoints.prototype.applyDebugSettings = function (enabled, color) { @@ -500,7 +500,7 @@ Vector3DTilePoints.prototype.update = function (frameState) { * isDestroyed 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. */ Vector3DTilePoints.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/Vector3DTilePolygons.js b/packages/engine/Source/Scene/Vector3DTilePolygons.js index 17048f564f18..835ae4cd1866 100644 --- a/packages/engine/Source/Scene/Vector3DTilePolygons.js +++ b/packages/engine/Source/Scene/Vector3DTilePolygons.js @@ -18,7 +18,7 @@ import Vector3DTilePrimitive from "./Vector3DTilePrimitive.js"; * @alias Vector3DTilePolygons * @constructor * - * @param {Object} options An object with following properties: + * @param {object} options An object with following properties: * @param {Float32Array|Uint16Array} options.positions The positions of the polygons. The positions must be contiguous * so that the positions for polygon n are in [c, c + counts[n]] where c = sum{counts[0], counts[n - 1]} and they are the outer ring of * the polygon in counter-clockwise order. @@ -26,8 +26,8 @@ import Vector3DTilePrimitive from "./Vector3DTilePrimitive.js"; * @param {Uint32Array} options.indices The indices of the triangulated polygons. The indices must be contiguous so that * the indices for polygon n are in [i, i + indexCounts[n]] where i = sum{indexCounts[0], indexCounts[n - 1]}. * @param {Uint32Array} options.indexCounts The number of indices for each polygon. - * @param {Number} options.minimumHeight The minimum height of the terrain covered by the tile. - * @param {Number} options.maximumHeight The maximum height of the terrain covered by the tile. + * @param {number} options.minimumHeight The minimum height of the terrain covered by the tile. + * @param {number} options.maximumHeight The maximum height of the terrain covered by the tile. * @param {Float32Array} [options.polygonMinimumHeights] An array containing the minimum heights for each polygon. * @param {Float32Array} [options.polygonMaximumHeights] An array containing the maximum heights for each polygon. * @param {Rectangle} options.rectangle The rectangle containing the tile. @@ -83,14 +83,14 @@ function Vector3DTilePolygons(options) { /** * Draws the wireframe of the classification meshes. - * @type {Boolean} + * @type {boolean} * @default false */ this.debugWireframe = false; /** * Forces a re-batch instead of waiting after a number of frames have been rendered. For testing only. - * @type {Boolean} + * @type {boolean} * @default false */ this.forceRebatch = false; @@ -109,7 +109,7 @@ Object.defineProperties(Vector3DTilePolygons.prototype, { * * @memberof Vector3DTilePolygons.prototype * - * @type {Number} + * @type {number} * @readonly */ trianglesLength: { @@ -126,7 +126,7 @@ Object.defineProperties(Vector3DTilePolygons.prototype, { * * @memberof Vector3DTilePolygons.prototype * - * @type {Number} + * @type {number} * @readonly */ geometryByteLength: { @@ -383,7 +383,7 @@ Vector3DTilePolygons.prototype.createFeatures = function (content, features) { /** * Colors the entire tile when enabled is true. The resulting color will be (polygon batch table color * color). * - * @param {Boolean} enabled Whether to enable debug coloring. + * @param {boolean} enabled Whether to enable debug coloring. * @param {Color} color The debug color. */ Vector3DTilePolygons.prototype.applyDebugSettings = function (enabled, color) { @@ -404,7 +404,7 @@ Vector3DTilePolygons.prototype.applyStyle = function (style, features) { * Call when updating the color of a polygon with batchId changes color. The polygons will need to be re-batched * on the next update. * - * @param {Number} batchId The batch id of the polygon whose color has changed. + * @param {number} batchId The batch id of the polygon whose color has changed. * @param {Color} color The new polygon color. */ Vector3DTilePolygons.prototype.updateCommands = function (batchId, color) { @@ -455,7 +455,7 @@ Vector3DTilePolygons.prototype.update = function (frameState) { * isDestroyed 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. */ Vector3DTilePolygons.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/Vector3DTilePolylines.js b/packages/engine/Source/Scene/Vector3DTilePolylines.js index d3f5f61c5f4a..e9dd0268fbcb 100644 --- a/packages/engine/Source/Scene/Vector3DTilePolylines.js +++ b/packages/engine/Source/Scene/Vector3DTilePolylines.js @@ -29,18 +29,18 @@ import Cesium3DTileFeature from "./Cesium3DTileFeature.js"; * @alias Vector3DTilePolylines * @constructor * - * @param {Object} options An object with following properties: + * @param {object} options An object with following properties: * @param {Uint16Array} options.positions The positions of the polylines * @param {Uint32Array} options.counts The number or positions in the each polyline. * @param {Uint16Array} options.widths The width of each polyline. - * @param {Number} options.minimumHeight The minimum height of the terrain covered by the tile. - * @param {Number} options.maximumHeight The maximum height of the terrain covered by the tile. + * @param {number} options.minimumHeight The minimum height of the terrain covered by the tile. + * @param {number} options.maximumHeight The maximum height of the terrain covered by the tile. * @param {Rectangle} options.rectangle The rectangle containing the tile. * @param {Cartesian3} [options.center=Cartesian3.ZERO] The RTC center. * @param {Cesium3DTileBatchTable} options.batchTable The batch table for the tile containing the batched polylines. * @param {Uint16Array} options.batchIds The batch ids for each polyline. * @param {BoundingSphere} options.boundingVolume The bounding volume for the entire batch of polylines. - * @param {Boolean} options.keepDecodedPositions Whether to keep decoded positions in memory. + * @param {boolean} options.keepDecodedPositions Whether to keep decoded positions in memory. * * @private */ @@ -99,7 +99,7 @@ Object.defineProperties(Vector3DTilePolylines.prototype, { * * @memberof Vector3DTilePolylines.prototype * - * @type {Number} + * @type {number} * @readonly */ trianglesLength: { @@ -113,7 +113,7 @@ Object.defineProperties(Vector3DTilePolylines.prototype, { * * @memberof Vector3DTilePolylines.prototype * - * @type {Number} + * @type {number} * @readonly */ geometryByteLength: { @@ -528,7 +528,7 @@ Vector3DTilePolylines.getPolylinePositions = function (polylines, batchId) { /** * Get the polyline positions for the given feature. * - * @param {Number} batchId The batch ID of the feature. + * @param {number} batchId The batch ID of the feature. */ Vector3DTilePolylines.prototype.getPositions = function (batchId) { return Vector3DTilePolylines.getPolylinePositions(this, batchId); @@ -552,7 +552,7 @@ Vector3DTilePolylines.prototype.createFeatures = function (content, features) { /** * Colors the entire tile when enabled is true. The resulting color will be (polyline batch table color * color). * - * @param {Boolean} enabled Whether to enable debug coloring. + * @param {boolean} enabled Whether to enable debug coloring. * @param {Color} color The debug color. */ Vector3DTilePolylines.prototype.applyDebugSettings = function (enabled, color) { @@ -651,7 +651,7 @@ Vector3DTilePolylines.prototype.update = function (frameState) { * isDestroyed 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. */ Vector3DTilePolylines.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/Vector3DTilePrimitive.js b/packages/engine/Source/Scene/Vector3DTilePrimitive.js index e3cbba091ea0..5ae75ea11d29 100644 --- a/packages/engine/Source/Scene/Vector3DTilePrimitive.js +++ b/packages/engine/Source/Scene/Vector3DTilePrimitive.js @@ -33,7 +33,7 @@ import Vector3DTileBatch from "./Vector3DTileBatch.js"; * @alias Vector3DTilePrimitive * @constructor * - * @param {Object} options An object with following properties: + * @param {object} options An object with following properties: * @param {Float32Array} options.positions The positions of the meshes. * @param {Uint16Array|Uint32Array} options.indices The indices of the triangulated meshes. The indices must be contiguous so that * the indices for mesh n are in [i, i + indexCounts[n]] where i = sum{indexCounts[0], indexCounts[n - 1]}. @@ -108,7 +108,7 @@ function Vector3DTilePrimitive(options) { /** * Draw the wireframe of the classification meshes. - * @type {Boolean} + * @type {boolean} * @default false */ this.debugWireframe = false; @@ -117,7 +117,7 @@ function Vector3DTilePrimitive(options) { /** * Forces a re-batch instead of waiting after a number of frames have been rendered. For testing only. - * @type {Boolean} + * @type {boolean} * @default false */ this.forceRebatch = false; @@ -156,7 +156,7 @@ Object.defineProperties(Vector3DTilePrimitive.prototype, { * * @memberof Vector3DTilePrimitive.prototype * - * @type {Number} + * @type {number} * @readonly */ trianglesLength: { @@ -170,7 +170,7 @@ Object.defineProperties(Vector3DTilePrimitive.prototype, { * * @memberof Vector3DTilePrimitive.prototype * - * @type {Number} + * @type {number} * @readonly */ geometryByteLength: { @@ -962,7 +962,7 @@ Vector3DTilePrimitive.prototype.createFeatures = function (content, features) { /** * Colors the entire tile when enabled is true. The resulting color will be (mesh batch table color * color). * - * @param {Boolean} enabled Whether to enable debug coloring. + * @param {boolean} enabled Whether to enable debug coloring. * @param {Color} color The debug color. */ Vector3DTilePrimitive.prototype.applyDebugSettings = function (enabled, color) { @@ -1053,7 +1053,7 @@ Vector3DTilePrimitive.prototype.applyStyle = function (style, features) { * Call when updating the color of a mesh with batchId changes color. The meshes will need to be re-batched * on the next update. * - * @param {Number} batchId The batch id of the meshes whose color has changed. + * @param {number} batchId The batch id of the meshes whose color has changed. * @param {Color} color The new polygon color. */ Vector3DTilePrimitive.prototype.updateCommands = function (batchId, color) { @@ -1255,7 +1255,7 @@ Vector3DTilePrimitive.prototype.update = function (frameState) { * isDestroyed 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. */ Vector3DTilePrimitive.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Scene/VertexAttributeSemantic.js b/packages/engine/Source/Scene/VertexAttributeSemantic.js index 5bbe7ab69cee..c168997fca27 100644 --- a/packages/engine/Source/Scene/VertexAttributeSemantic.js +++ b/packages/engine/Source/Scene/VertexAttributeSemantic.js @@ -5,7 +5,7 @@ import DeveloperError from "../Core/DeveloperError.js"; /** * An enum describing the built-in vertex attribute semantics. * - * @enum {String} + * @enum {string} * * @private */ @@ -13,7 +13,7 @@ const VertexAttributeSemantic = { /** * Per-vertex position. * - * @type {String} + * @type {string} * @constant */ POSITION: "POSITION", @@ -21,7 +21,7 @@ const VertexAttributeSemantic = { /** * Per-vertex normal. * - * @type {String} + * @type {string} * @constant */ NORMAL: "NORMAL", @@ -29,7 +29,7 @@ const VertexAttributeSemantic = { /** * Per-vertex tangent. * - * @type {String} + * @type {string} * @constant */ TANGENT: "TANGENT", @@ -37,7 +37,7 @@ const VertexAttributeSemantic = { /** * Per-vertex texture coordinates. * - * @type {String} + * @type {string} * @constant */ TEXCOORD: "TEXCOORD", @@ -45,7 +45,7 @@ const VertexAttributeSemantic = { /** * Per-vertex color. * - * @type {String} + * @type {string} * @constant */ COLOR: "COLOR", @@ -53,7 +53,7 @@ const VertexAttributeSemantic = { /** * Per-vertex joint IDs for skinning. * - * @type {String} + * @type {string} * @constant */ JOINTS: "JOINTS", @@ -61,7 +61,7 @@ const VertexAttributeSemantic = { /** * Per-vertex joint weights for skinning. * - * @type {String} + * @type {string} * @constant */ WEIGHTS: "WEIGHTS", @@ -69,7 +69,7 @@ const VertexAttributeSemantic = { /** * Per-vertex feature ID. * - * @type {String} + * @type {string} * @constant */ FEATURE_ID: "_FEATURE_ID", @@ -105,7 +105,7 @@ function semanticToVariableName(semantic) { * * @param {VertexAttributeSemantic} semantic The semantic. * - * @returns {Boolean} Whether the semantic can have a set index. + * @returns {boolean} Whether the semantic can have a set index. * * @private */ @@ -135,7 +135,7 @@ VertexAttributeSemantic.hasSetIndex = function (semantic) { /** * Gets the vertex attribute semantic matching the glTF semantic. * - * @param {String} gltfSemantic The glTF semantic. + * @param {string} gltfSemantic The glTF semantic. * * @returns {VertexAttributeSemantic|undefined} The vertex attribute semantic, or undefined if there is no match. * @@ -180,7 +180,7 @@ VertexAttributeSemantic.fromGltfSemantic = function (gltfSemantic) { /** * Gets the vertex attribute semantic matching the pnts semantic. * - * @param {String} pntsSemantic The pnts semantic. + * @param {string} pntsSemantic The pnts semantic. * * @returns {VertexAttributeSemantic|undefined} The vertex attribute semantic, or undefined if there is no match. * @@ -217,7 +217,7 @@ VertexAttributeSemantic.fromPntsSemantic = function (pntsSemantic) { * * @param {VertexAttributeSemantic} semantic The semantic. * - * @returns {String} The shader type. + * @returns {string} The shader type. * * @private */ @@ -252,9 +252,9 @@ VertexAttributeSemantic.getGlslType = function (semantic) { * Gets the variable name for the given semantic and set index. * * @param {VertexAttributeSemantic} semantic The semantic. - * @param {Number} [setIndex] The set index. + * @param {number} [setIndex] The set index. * - * @returns {String} The variable name. + * @returns {string} The variable name. * * @private */ diff --git a/packages/engine/Source/Scene/VerticalOrigin.js b/packages/engine/Source/Scene/VerticalOrigin.js index a87b28449c63..40764831bc49 100644 --- a/packages/engine/Source/Scene/VerticalOrigin.js +++ b/packages/engine/Source/Scene/VerticalOrigin.js @@ -8,7 +8,7 @@ *
    * * - * @enum {Number} + * @enum {number} * * @see Billboard#verticalOrigin * @see Label#verticalOrigin @@ -17,7 +17,7 @@ const VerticalOrigin = { /** * The origin is at the vertical center between BASELINE and TOP. * - * @type {Number} + * @type {number} * @constant */ CENTER: 0, @@ -25,7 +25,7 @@ const VerticalOrigin = { /** * The origin is at the bottom of the object. * - * @type {Number} + * @type {number} * @constant */ BOTTOM: 1, @@ -33,7 +33,7 @@ const VerticalOrigin = { /** * If the object contains text, the origin is at the baseline of the text, else the origin is at the bottom of the object. * - * @type {Number} + * @type {number} * @constant */ BASELINE: 2, @@ -41,7 +41,7 @@ const VerticalOrigin = { /** * The origin is at the top of the object. * - * @type {Number} + * @type {number} * @constant */ TOP: -1, diff --git a/packages/engine/Source/Scene/ViewportQuad.js b/packages/engine/Source/Scene/ViewportQuad.js index cd25c663e375..4d63acdde231 100644 --- a/packages/engine/Source/Scene/ViewportQuad.js +++ b/packages/engine/Source/Scene/ViewportQuad.js @@ -27,7 +27,7 @@ function ViewportQuad(rectangle, material) { /** * Determines if the viewport quad primitive will be shown. * - * @type {Boolean} + * @type {boolean} * @default true */ this.show = true; @@ -147,7 +147,7 @@ ViewportQuad.prototype.update = function (frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see ViewportQuad#destroy */ diff --git a/packages/engine/Source/Scene/VoxelBoxShape.js b/packages/engine/Source/Scene/VoxelBoxShape.js index a08e333f73a8..594d387a7106 100644 --- a/packages/engine/Source/Scene/VoxelBoxShape.js +++ b/packages/engine/Source/Scene/VoxelBoxShape.js @@ -72,7 +72,7 @@ function VoxelBoxShape() { ); /** - * @type {Object.} + * @type {Object} * @readonly */ this.shaderUniforms = { @@ -84,7 +84,7 @@ function VoxelBoxShape() { }; /** - * @type {Object.} + * @type {Object} * @readonly */ this.shaderDefines = { @@ -96,7 +96,7 @@ function VoxelBoxShape() { /** * The maximum number of intersections against the shape for any ray direction. - * @type {Number} + * @type {number} * @readonly */ this.shaderMaximumIntersectionsLength = 0; // not known until update @@ -144,7 +144,7 @@ const transformXYZToXZY = Matrix4.fromRotation( * @param {Cartesian3} maxBounds The maximum bounds. * @param {Cartesian3} [clipMinBounds=VoxelBoxShape.DefaultMinBounds] The minimum clip bounds. * @param {Cartesian3} [clipMaxBounds=VoxelBoxShape.DefaultMaxBounds] The maximum clip bounds. - * @returns {Boolean} Whether the shape is visible. + * @returns {boolean} Whether the shape is visible. */ VoxelBoxShape.prototype.update = function ( modelMatrix, @@ -394,10 +394,10 @@ const scratchTileMaxBounds = new Cartesian3(); * Computes an oriented bounding box for a specified tile. * The update function must be called before calling this function. * - * @param {Number} tileLevel The tile's level. - * @param {Number} tileX The tile's x coordinate. - * @param {Number} tileY The tile's y coordinate. - * @param {Number} tileZ The tile's z coordinate. + * @param {number} tileLevel The tile's level. + * @param {number} tileX The tile's x coordinate. + * @param {number} tileY The tile's y coordinate. + * @param {number} tileZ The tile's z coordinate. * @param {OrientedBoundingBox} result The oriented bounding box that will be set to enclose the specified tile * @returns {OrientedBoundingBox} The oriented bounding box. */ @@ -447,7 +447,7 @@ VoxelBoxShape.prototype.computeOrientedBoundingBoxForTile = function ( * The update function must be called before calling this function. * * @param {Cartesian3} dimensions The voxel grid dimensions for a tile. - * @returns {Number} The step size. + * @returns {number} The step size. */ VoxelBoxShape.prototype.computeApproximateStepSize = function (dimensions) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/engine/Source/Scene/VoxelContent.js b/packages/engine/Source/Scene/VoxelContent.js index b57cd815882c..eead3e8f72d3 100644 --- a/packages/engine/Source/Scene/VoxelContent.js +++ b/packages/engine/Source/Scene/VoxelContent.js @@ -11,7 +11,7 @@ import MetadataTable from "./MetadataTable.js"; * @constructor * * @param {Resource} resource The resource for this voxel content. This is used for fetching external buffers as needed. - * @param {Object} [json] Voxel JSON contents. Mutually exclusive with binary. + * @param {object} [json] Voxel JSON contents. Mutually exclusive with binary. * @param {Uint8Array} [binary] Voxel binary contents. Mutually exclusive with json. * @param {MetadataSchema} metadataSchema The metadata schema used by property tables in the voxel content * @@ -128,8 +128,8 @@ function requestBuffers(content, json, binary) { /** * A helper object for storing the two parts of the binary voxel content * - * @typedef {Object} VoxelChunks - * @property {Object} json The json chunk of the binary voxel content + * @typedef {object} VoxelChunks + * @property {object} json The json chunk of the binary voxel content * @property {Uint8Array} binary The binary chunk of the binary voxel content. This represents the internal buffer. * @private */ diff --git a/packages/engine/Source/Scene/VoxelCylinderShape.js b/packages/engine/Source/Scene/VoxelCylinderShape.js index 231a957e24a8..a14c7e3bc5b4 100644 --- a/packages/engine/Source/Scene/VoxelCylinderShape.js +++ b/packages/engine/Source/Scene/VoxelCylinderShape.js @@ -56,43 +56,43 @@ function VoxelCylinderShape() { this.shapeTransform = new Matrix4(); /** - * @type {Number} + * @type {number} * @private */ this._minimumRadius = VoxelCylinderShape.DefaultMinBounds.x; /** - * @type {Number} + * @type {number} * @private */ this._maximumRadius = VoxelCylinderShape.DefaultMaxBounds.x; /** - * @type {Number} + * @type {number} * @private */ this._minimumHeight = VoxelCylinderShape.DefaultMinBounds.y; /** - * @type {Number} + * @type {number} * @private */ this._maximumHeight = VoxelCylinderShape.DefaultMaxBounds.y; /** - * @type {Number} + * @type {number} * @private */ this._minimumAngle = VoxelCylinderShape.DefaultMinBounds.z; /** - * @type {Number} + * @type {number} * @private */ this._maximumAngle = VoxelCylinderShape.DefaultMaxBounds.z; /** - * @type {Object.} + * @type {Object} * @readonly */ this.shaderUniforms = { @@ -108,7 +108,7 @@ function VoxelCylinderShape() { }; /** - * @type {Object.} + * @type {Object} * @readonly */ this.shaderDefines = { @@ -140,7 +140,7 @@ function VoxelCylinderShape() { /** * The maximum number of intersections against the shape for any ray direction. - * @type {Number} + * @type {number} * @readonly */ this.shaderMaximumIntersectionsLength = 0; // not known until update @@ -167,7 +167,7 @@ const transformUvToLocal = Matrix4.fromRotationTranslation( * @param {Cartesian3} maxBounds The maximum bounds. * @param {Cartesian3} [clipMinBounds=VoxelCylinderShape.DefaultMinBounds] The minimum clip bounds. * @param {Cartesian3} [clipMaxBounds=VoxelCylinderShape.DefaultMaxBounds] The maximum clip bounds. - * @returns {Boolean} Whether the shape is visible. + * @returns {boolean} Whether the shape is visible. */ VoxelCylinderShape.prototype.update = function ( modelMatrix, @@ -571,10 +571,10 @@ VoxelCylinderShape.prototype.update = function ( * Computes an oriented bounding box for a specified tile. * The update function must be called before calling this function. * - * @param {Number} tileLevel The tile's level. - * @param {Number} tileX The tile's x coordinate. - * @param {Number} tileY The tile's y coordinate. - * @param {Number} tileZ The tile's z coordinate. + * @param {number} tileLevel The tile's level. + * @param {number} tileX The tile's x coordinate. + * @param {number} tileY The tile's y coordinate. + * @param {number} tileZ The tile's z coordinate. * @param {OrientedBoundingBox} result The oriented bounding box that will be set to enclose the specified tile * @returns {OrientedBoundingBox} The oriented bounding box. */ @@ -655,7 +655,7 @@ const scratchScaleRatio = new Cartesian3(); * The update function must be called before calling this function. * * @param {Cartesian3} dimensions The voxel grid dimensions for a tile. - * @returns {Number} The step size. + * @returns {number} The step size. */ VoxelCylinderShape.prototype.computeApproximateStepSize = function ( dimensions @@ -788,12 +788,12 @@ function computeLooseOrientedBoundingBox(matrix, result) { * * @function * - * @param {Number} radiusStart The radiusStart. - * @param {Number} radiusEnd The radiusEnd. - * @param {Number} heightStart The heightStart. - * @param {Number} heightEnd The heightEnd. - * @param {Number} angleStart The angleStart. - * @param {Number} angleEnd The angleEnd. + * @param {number} radiusStart The radiusStart. + * @param {number} radiusEnd The radiusEnd. + * @param {number} heightStart The heightStart. + * @param {number} heightEnd The heightEnd. + * @param {number} angleStart The angleStart. + * @param {number} angleEnd The angleEnd. * @param {Matrix4} matrix The matrix to transform the points. * @param {OrientedBoundingBox} result The object onto which to store the result. * @returns {OrientedBoundingBox} The oriented bounding box that contains this subregion. diff --git a/packages/engine/Source/Scene/VoxelEllipsoidShape.js b/packages/engine/Source/Scene/VoxelEllipsoidShape.js index 1802634e47bc..381a8948343a 100644 --- a/packages/engine/Source/Scene/VoxelEllipsoidShape.js +++ b/packages/engine/Source/Scene/VoxelEllipsoidShape.js @@ -62,13 +62,13 @@ function VoxelEllipsoidShape() { this._rectangle = new Rectangle(); /** - * @type {Number} + * @type {number} * @private */ this._minimumHeight = VoxelEllipsoidShape.DefaultMinBounds.z; /** - * @type {Number} + * @type {number} * @private */ this._maximumHeight = VoxelEllipsoidShape.DefaultMaxBounds.z; @@ -90,7 +90,7 @@ function VoxelEllipsoidShape() { this._rotation = new Matrix3(); /** - * @type {Object.} + * @type {Object} * @readonly */ this.shaderUniforms = { @@ -108,7 +108,7 @@ function VoxelEllipsoidShape() { }; /** - * @type {Object.} + * @type {Object} * @readonly */ this.shaderDefines = { @@ -147,7 +147,7 @@ function VoxelEllipsoidShape() { /** * The maximum number of intersections against the shape for any ray direction. - * @type {Number} + * @type {number} * @readonly */ this.shaderMaximumIntersectionsLength = 0; // not known until update @@ -169,7 +169,7 @@ const scratchRenderRectangle = new Rectangle(); * @param {Cartesian3} maxBounds The maximum bounds. * @param {Cartesian3} [clipMinBounds=VoxelEllipsoidShape.DefaultMinBounds] The minimum clip bounds. * @param {Cartesian3} [clipMaxBounds=VoxelEllipsoidShape.DefaultMaxBounds] The maximum clip bounds. - * @returns {Boolean} Whether the shape is visible. + * @returns {boolean} Whether the shape is visible. */ VoxelEllipsoidShape.prototype.update = function ( modelMatrix, @@ -792,10 +792,10 @@ const scratchRectangle = new Rectangle(); * Computes an oriented bounding box for a specified tile. * The update function must be called before calling this function. * - * @param {Number} tileLevel The tile's level. - * @param {Number} tileX The tile's x coordinate. - * @param {Number} tileY The tile's y coordinate. - * @param {Number} tileZ The tile's z coordinate. + * @param {number} tileLevel The tile's level. + * @param {number} tileX The tile's x coordinate. + * @param {number} tileY The tile's y coordinate. + * @param {number} tileZ The tile's z coordinate. * @param {OrientedBoundingBox} result The oriented bounding box that will be set to enclose the specified tile * @returns {OrientedBoundingBox} The oriented bounding box. */ @@ -859,7 +859,7 @@ VoxelEllipsoidShape.prototype.computeOrientedBoundingBoxForTile = function ( * The update function must be called before calling this function. * * @param {Cartesian3} dimensions The voxel grid dimensions for a tile. - * @returns {Number} The step size. + * @returns {number} The step size. */ VoxelEllipsoidShape.prototype.computeApproximateStepSize = function ( dimensions @@ -885,8 +885,8 @@ VoxelEllipsoidShape.prototype.computeApproximateStepSize = function ( * @function * * @param {Rectangle} rectangle The rectangle. - * @param {Number} minHeight The minimumZ. - * @param {Number} maxHeight The maximumZ. + * @param {number} minHeight The minimumZ. + * @param {number} maxHeight The maximumZ. * @param {Ellipsoid} ellipsoid The ellipsoid. * @param {Cartesian3} translation The translation applied to the shape * @param {Matrix3} rotation The rotation applied to the shape diff --git a/packages/engine/Source/Scene/VoxelPrimitive.js b/packages/engine/Source/Scene/VoxelPrimitive.js index 1061207674b0..cd862874da0d 100644 --- a/packages/engine/Source/Scene/VoxelPrimitive.js +++ b/packages/engine/Source/Scene/VoxelPrimitive.js @@ -30,7 +30,7 @@ import CustomShader from "./Model/CustomShader.js"; * @alias VoxelPrimitive * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {VoxelProvider} [options.provider] The voxel provider that supplies the primitive with tile data. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The model matrix used to transform the primitive. * @param {CustomShader} [options.customShader] The custom shader used to style the primitive. @@ -46,7 +46,7 @@ function VoxelPrimitive(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); /** - * @type {Boolean} + * @type {boolean} * @private */ this._ready = false; @@ -77,7 +77,7 @@ function VoxelPrimitive(options) { this._shape = undefined; /** - * @type {Boolean} + * @type {boolean} * @private */ this._shapeVisible = false; @@ -177,7 +177,7 @@ function VoxelPrimitive(options) { /** * Keeps track of when the clipping planes change * - * @type {Number} + * @type {number} * @private */ this._clippingPlanesState = 0; @@ -185,7 +185,7 @@ function VoxelPrimitive(options) { /** * Keeps track of when the clipping planes are enabled / disabled * - * @type {Boolean} + * @type {boolean} * @private */ this._clippingPlanesEnabled = false; @@ -234,7 +234,7 @@ function VoxelPrimitive(options) { this._customShaderCompilationEvent = new Event(); /** - * @type {Boolean} + * @type {boolean} * @private */ this._shaderDirty = true; @@ -252,7 +252,7 @@ function VoxelPrimitive(options) { this._drawCommandPick = undefined; /** - * @type {Object} + * @type {object} * @private */ this._pickId = undefined; @@ -290,50 +290,50 @@ function VoxelPrimitive(options) { this._transformNormalLocalToWorld = new Matrix3(); /** - * @type {Number} + * @type {number} * @private */ this._stepSizeUv = 1.0; // Rendering /** - * @type {Boolean} + * @type {boolean} * @private */ this._jitter = true; /** - * @type {Boolean} + * @type {boolean} * @private */ this._nearestSampling = false; /** - * @type {Number} + * @type {number} * @private */ this._levelBlendFactor = 0.0; /** - * @type {Number} + * @type {number} * @private */ this._stepSizeMultiplier = 1.0; /** - * @type {Boolean} + * @type {boolean} * @private */ this._depthTest = true; /** - * @type {Boolean} + * @type {boolean} * @private */ this._useLogDepth = undefined; /** - * @type {Number} + * @type {number} * @private */ this._screenSpaceError = 4.0; // in pixels @@ -346,25 +346,25 @@ function VoxelPrimitive(options) { this._debugPolylines = new PolylineCollection(); /** - * @type {Boolean} + * @type {boolean} * @private */ this._debugDraw = false; /** - * @type {Boolean} + * @type {boolean} * @private */ this._disableRender = false; /** - * @type {Boolean} + * @type {boolean} * @private */ this._disableUpdate = false; /** - * @type {Object.} + * @type {Object} * @private */ this._uniforms = { @@ -397,14 +397,14 @@ function VoxelPrimitive(options) { /** * Shape specific shader defines from the previous shape update. Used to detect if the shader needs to be rebuilt. - * @type {Object.} + * @type {Object} * @private */ this._shapeDefinesOld = {}; /** * Map uniform names to functions that return the uniform values. - * @type {Object.} + * @type {Object} * @private */ this._uniformMap = {}; @@ -449,7 +449,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * Gets a value indicating whether or not the primitive is ready for use. * * @memberof VoxelPrimitive.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -462,7 +462,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * Gets the promise that will be resolved when the primitive is ready for use. * * @memberof VoxelPrimitive.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -600,7 +600,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * Gets the minimum value per channel of the voxel data. * * @memberof VoxelPrimitive.prototype - * @type {Number[][]} + * @type {number[][]} * @readonly * * @exception {DeveloperError} If the primitive is not ready. @@ -623,7 +623,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * Gets the maximum value per channel of the voxel data. * * @memberof VoxelPrimitive.prototype - * @type {Number[][]} + * @type {number[][]} * @readonly * * @exception {DeveloperError} If the primitive is not ready. @@ -646,7 +646,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * Gets or sets whether or not this primitive should be displayed. * * @memberof VoxelPrimitive.prototype - * @type {Boolean} + * @type {boolean} */ show: { get: function () { @@ -665,7 +665,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * Gets or sets whether or not the primitive should update when the view changes. * * @memberof VoxelPrimitive.prototype - * @type {Boolean} + * @type {boolean} */ disableUpdate: { get: function () { @@ -684,7 +684,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * Gets or sets whether or not to render debug visualizations. * * @memberof VoxelPrimitive.prototype - * @type {Boolean} + * @type {boolean} */ debugDraw: { get: function () { @@ -703,7 +703,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * Gets or sets whether or not to test against depth when rendering. * * @memberof VoxelPrimitive.prototype - * @type {Boolean} + * @type {boolean} */ depthTest: { get: function () { @@ -726,7 +726,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * This reduces stair-step artifacts but introduces noise. * * @memberof VoxelPrimitive.prototype - * @type {Boolean} + * @type {boolean} */ jitter: { get: function () { @@ -748,7 +748,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * Gets or sets the nearest sampling. * * @memberof VoxelPrimitive.prototype - * @type {Boolean} + * @type {boolean} */ nearestSampling: { get: function () { @@ -772,7 +772,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * 1.0 means a full linear blend. * * @memberof VoxelPrimitive.prototype - * @type {Number} + * @type {number} * @private */ levelBlendFactor: { @@ -795,7 +795,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * result in worse performance and higher memory consumption. * * @memberof VoxelPrimitive.prototype - * @type {Number} + * @type {number} */ screenSpaceError: { get: function () { @@ -816,7 +816,7 @@ Object.defineProperties(VoxelPrimitive.prototype, { * also the worse the performance. * * @memberof VoxelPrimitive.prototype - * @type {Number} + * @type {number} */ stepSize: { get: function () { @@ -1266,7 +1266,7 @@ function initFromProvider(primitive, provider, context) { * Track changes in provider transform and primitive bounds * @param {VoxelPrimitive} primitive * @param {VoxelProvider} provider - * @returns {Boolean} Whether any of the transform or bounds changed + * @returns {boolean} Whether any of the transform or bounds changed * @private */ function checkTransformAndBounds(primitive, provider) { @@ -1302,9 +1302,9 @@ function checkTransformAndBounds(primitive, provider) { /** * Compare old and new values of a bound and update the old if it is different. * @param {VoxelPrimitive} primitive The primitive with bounds properties - * @param {String} newBoundKey A key pointing to a bounds property of type Cartesian3 or Matrix4 - * @param {String} oldBoundKey A key pointing to a bounds property of the same type as the property at newBoundKey - * @returns {Number} 1 if the bound value changed, 0 otherwise + * @param {string} newBoundKey A key pointing to a bounds property of type Cartesian3 or Matrix4 + * @param {string} oldBoundKey A key pointing to a bounds property of the same type as the property at newBoundKey + * @returns {number} 1 if the bound value changed, 0 otherwise * * @private */ @@ -1324,7 +1324,7 @@ function updateBound(primitive, newBoundKey, oldBoundKey) { * @param {VoxelPrimitive} primitive * @param {VoxelShape} shape * @param {VoxelProvider} provider - * @returns {Boolean} True if the shape is visible + * @returns {boolean} True if the shape is visible * @private */ function updateShapeAndTransforms(primitive, shape, provider) { @@ -1428,7 +1428,7 @@ function setupTraversal(primitive, provider, context) { /** * Set uniforms that come from the traversal. * @param {VoxelTraversal} traversal - * @param {Object} uniforms + * @param {object} uniforms * @private */ function setTraversalUniforms(traversal, uniforms) { @@ -1473,7 +1473,7 @@ function setTraversalUniforms(traversal, uniforms) { * Track changes in shape-related shader defines * @param {VoxelPrimitive} primitive * @param {VoxelShape} shape - * @returns {Boolean} True if any of the shape defines changed, requiring a shader rebuild + * @returns {boolean} True if any of the shape defines changed, requiring a shader rebuild * @private */ function checkShapeDefines(primitive, shape) { @@ -1491,7 +1491,7 @@ function checkShapeDefines(primitive, shape) { * Find the keyframe location to render at. Doesn't need to be a whole number. * @param {TimeIntervalCollection} timeIntervalCollection * @param {Clock} clock - * @returns {Number} + * @returns {number} * * @private */ @@ -1537,7 +1537,7 @@ function getKeyframeLocation(timeIntervalCollection, clock) { * * @param {VoxelPrimitive} primitive * @param {FrameState} frameState - * @returns {Boolean} Whether the clipping planes changed, requiring a shader rebuild + * @returns {boolean} Whether the clipping planes changed, requiring a shader rebuild * @private */ function updateClippingPlanes(primitive, frameState) { @@ -1592,7 +1592,7 @@ function updateClippingPlanes(primitive, frameState) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see VoxelPrimitive#destroy */ diff --git a/packages/engine/Source/Scene/VoxelProvider.js b/packages/engine/Source/Scene/VoxelProvider.js index 7dce93e6aacf..48a20b1e9d29 100644 --- a/packages/engine/Source/Scene/VoxelProvider.js +++ b/packages/engine/Source/Scene/VoxelProvider.js @@ -22,7 +22,7 @@ Object.defineProperties(VoxelProvider.prototype, { * Gets a value indicating whether or not the provider is ready for use. * * @memberof VoxelProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -33,7 +33,7 @@ Object.defineProperties(VoxelProvider.prototype, { * Gets the promise that will be resolved when the provider is ready for use. * * @memberof VoxelProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -141,7 +141,7 @@ Object.defineProperties(VoxelProvider.prototype, { * This should not be called before {@link VoxelProvider#ready} returns true. * * @memberof VoxelProvider.prototype - * @type {String[]} + * @type {string[]} * @readonly */ names: { @@ -177,7 +177,7 @@ Object.defineProperties(VoxelProvider.prototype, { * This should not be called before {@link VoxelProvider#ready} returns true. * * @memberof VoxelProvider.prototype - * @type {Number[][]|undefined} + * @type {number[][]|undefined} * @readonly */ minimumValues: { @@ -189,7 +189,7 @@ Object.defineProperties(VoxelProvider.prototype, { * This should not be called before {@link VoxelProvider#ready} returns true. * * @memberof VoxelProvider.prototype - * @type {Number[][]|undefined} + * @type {number[][]|undefined} * @readonly */ maximumValues: { @@ -201,7 +201,7 @@ Object.defineProperties(VoxelProvider.prototype, { * This should not be called before {@link VoxelProvider#ready} returns true. * * @memberof VoxelProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumTileCount: { @@ -213,7 +213,7 @@ Object.defineProperties(VoxelProvider.prototype, { * This should not be called before {@link VoxelProvider#ready} returns true. * * @memberof VoxelProvider.prototype - * @type {Number} + * @type {number} * @readonly * @private */ @@ -240,12 +240,12 @@ Object.defineProperties(VoxelProvider.prototype, { * This function should not be called before {@link VoxelProvider#ready} returns true. * @function * - * @param {Object} [options] Object with the following properties: - * @param {Number} [options.tileLevel=0] The tile's level. - * @param {Number} [options.tileX=0] The tile's X coordinate. - * @param {Number} [options.tileY=0] The tile's Y coordinate. - * @param {Number} [options.tileZ=0] The tile's Z coordinate. - * @privateparam {Number} [options.keyframe=0] The requested keyframe. + * @param {object} [options] Object with the following properties: + * @param {number} [options.tileLevel=0] The tile's level. + * @param {number} [options.tileX=0] The tile's X coordinate. + * @param {number} [options.tileY=0] The tile's Y coordinate. + * @param {number} [options.tileZ=0] The tile's Z coordinate. + * @privateparam {number} [options.keyframe=0] The requested keyframe. * @returns {Promise|undefined} A promise to an array of typed arrays containing the requested voxel data or undefined if there was a problem loading the data. * * @exception {DeveloperError} The provider must be ready. diff --git a/packages/engine/Source/Scene/VoxelRenderResources.js b/packages/engine/Source/Scene/VoxelRenderResources.js index 922435690dca..d83b4ac0fe62 100644 --- a/packages/engine/Source/Scene/VoxelRenderResources.js +++ b/packages/engine/Source/Scene/VoxelRenderResources.js @@ -68,7 +68,7 @@ function VoxelRenderResources(primitive) { * A dictionary mapping uniform name to functions that return the uniform * values. * - * @type {Object.} + * @type {Object} */ this.uniformMap = uniformMap; diff --git a/packages/engine/Source/Scene/VoxelShape.js b/packages/engine/Source/Scene/VoxelShape.js index f8449276f112..ed177e891416 100644 --- a/packages/engine/Source/Scene/VoxelShape.js +++ b/packages/engine/Source/Scene/VoxelShape.js @@ -68,7 +68,7 @@ Object.defineProperties(VoxelShape.prototype, { }, /** - * @type {Object.} + * @type {Object} * @readonly */ shaderUniforms: { @@ -76,7 +76,7 @@ Object.defineProperties(VoxelShape.prototype, { }, /** - * @type {Object.} + * @type {Object} * @readonly */ shaderDefines: { @@ -85,7 +85,7 @@ Object.defineProperties(VoxelShape.prototype, { /** * The maximum number of intersections against the shape for any ray direction. - * @type {Number} + * @type {number} * @readonly */ shaderMaximumIntersectionsLength: { @@ -99,7 +99,7 @@ Object.defineProperties(VoxelShape.prototype, { * @param {Matrix4} modelMatrix The model matrix. * @param {Cartesian3} minBounds The minimum bounds. * @param {Cartesian3} maxBounds The maximum bounds. - * @returns {Boolean} Whether the shape is visible. + * @returns {boolean} Whether the shape is visible. */ VoxelShape.prototype.update = DeveloperError.throwInstantiationError; @@ -107,10 +107,10 @@ VoxelShape.prototype.update = DeveloperError.throwInstantiationError; * Computes an oriented bounding box for a specified tile. * The update function must be called before calling this function. * - * @param {Number} tileLevel The tile's level. - * @param {Number} tileX The tile's x coordinate. - * @param {Number} tileY The tile's y coordinate. - * @param {Number} tileZ The tile's z coordinate. + * @param {number} tileLevel The tile's level. + * @param {number} tileX The tile's x coordinate. + * @param {number} tileY The tile's y coordinate. + * @param {number} tileZ The tile's z coordinate. * @param {OrientedBoundingBox} result The oriented bounding box that will be set to enclose the specified tile. * @returns {OrientedBoundingBox} The oriented bounding box. */ @@ -122,7 +122,7 @@ VoxelShape.prototype.computeOrientedBoundingBoxForTile = * The update function must be called before calling this function. * * @param {Cartesian3} voxelDimensions The voxel grid dimensions for a tile. - * @returns {Number} The step size. + * @returns {number} The step size. */ VoxelShape.prototype.computeApproximateStepSize = DeveloperError.throwInstantiationError; diff --git a/packages/engine/Source/Scene/VoxelShapeType.js b/packages/engine/Source/Scene/VoxelShapeType.js index 6155e99c86da..92576dae3898 100644 --- a/packages/engine/Source/Scene/VoxelShapeType.js +++ b/packages/engine/Source/Scene/VoxelShapeType.js @@ -6,7 +6,7 @@ import VoxelEllipsoidShape from "./VoxelEllipsoidShape.js"; /** * An enum of voxel shapes. The shape controls how the voxel grid is mapped to 3D space. * - * @enum {String} + * @enum {string} * * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy. */ @@ -14,7 +14,7 @@ const VoxelShapeType = { /** * A box shape. * - * @type {String} + * @type {string} * @constant * @private */ @@ -22,7 +22,7 @@ const VoxelShapeType = { /** * An ellipsoid shape. * - * @type {String} + * @type {string} * @constant * @private */ @@ -30,7 +30,7 @@ const VoxelShapeType = { /** * A cylinder shape. * - * @type {String} + * @type {string} * @constant * @private */ diff --git a/packages/engine/Source/Scene/VoxelTraversal.js b/packages/engine/Source/Scene/VoxelTraversal.js index 915cf3e121b6..104db5d587b2 100644 --- a/packages/engine/Source/Scene/VoxelTraversal.js +++ b/packages/engine/Source/Scene/VoxelTraversal.js @@ -28,8 +28,8 @@ import TextureMinificationFilter from "../Renderer/TextureMinificationFilter.js" * @param {Cartesian3} dimensions * @param {MetadataType[]} types * @param {MetadataComponentType[]} componentTypes - * @param {Number} keyframeCount - * @param {Number} [maximumTextureMemoryByteLength] + * @param {number} keyframeCount + * @param {number} [maximumTextureMemoryByteLength] * * @private */ @@ -75,19 +75,19 @@ function VoxelTraversal( const maximumTileCount = this.megatextures[0].maximumTileCount; /** - * @type {Number} + * @type {number} * @private */ this._simultaneousRequestCount = 0; /** - * @type {Boolean} + * @type {boolean} * @private */ this._debugPrint = false; /** - * @type {Number} + * @type {number} * @private */ this._frameNumber = 0; @@ -122,25 +122,25 @@ function VoxelTraversal( this._keyframeNodesInMegatexture = new Array(maximumTileCount); /** - * @type {Number} + * @type {number} * @private */ this._keyframeCount = keyframeCount; /** - * @type {Number} + * @type {number} * @private */ this._sampleCount = undefined; /** - * @type {Number} + * @type {number} * @private */ this._keyframeLocation = 0; /** - * @type {Number[]} + * @type {number[]} * @private */ this._binaryTreeKeyframeWeighting = new Array(keyframeCount); @@ -182,7 +182,7 @@ function VoxelTraversal( }); /** - * @type {Number} + * @type {number} * @readonly */ this.internalNodeTilesPerRow = internalNodeTilesPerRow; @@ -205,7 +205,7 @@ function VoxelTraversal( /** * Only generated when there are two or more samples. - * @type {Number} + * @type {number} * @readonly */ this.leafNodeTilesPerRow = undefined; @@ -232,9 +232,9 @@ VoxelTraversal.simultaneousRequestCountMaximum = 50; /** * @param {FrameState} frameState - * @param {Number} keyframeLocation - * @param {Boolean} recomputeBoundingVolumes - * @param {Boolean} pauseUpdate + * @param {number} keyframeLocation + * @param {boolean} recomputeBoundingVolumes + * @param {boolean} pauseUpdate */ VoxelTraversal.prototype.update = function ( frameState, @@ -323,7 +323,7 @@ VoxelTraversal.prototype.update = function ( /** * Check if a node is renderable. * @param {SpatialNode} tile - * @returns {Boolean} + * @returns {boolean} */ VoxelTraversal.prototype.isRenderable = function (tile) { return tile.isRenderable(this._frameNumber); @@ -335,7 +335,7 @@ VoxelTraversal.prototype.isRenderable = function (tile) { * If this object was destroyed, it should not be used; calling any function other than * isDestroyed 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. * * @see VoxelTraversal#destroy */ @@ -471,8 +471,8 @@ function requestData(that, keyframeNode) { /** * @function * - * @param {Number} x - * @returns {Number} + * @param {number} x + * @returns {number} * * @private */ @@ -531,7 +531,7 @@ function loadAndUnload(that, frameState) { /** * @ignore * @param {SpatialNode} spatialNode - * @param {Number} visibilityPlaneMask + * @param {number} visibilityPlaneMask */ function addToQueueRecursive(spatialNode, visibilityPlaneMask) { spatialNode.computeScreenSpaceError(positionWC, screenSpaceErrorMultiplier); @@ -805,8 +805,8 @@ const GpuOctreeFlag = { * * @param {VoxelTraversal} that * @param {FrameState} frameState - * @param {Number} sampleCount - * @param {Number} levelBlendFactor + * @param {number} sampleCount + * @param {number} levelBlendFactor * @private */ function generateOctree(that, sampleCount, levelBlendFactor) { @@ -823,10 +823,10 @@ function generateOctree(that, sampleCount, levelBlendFactor) { /** * @ignore * @param {SpatialNode} node - * @param {Number} childOctreeIndex - * @param {Number} childEntryIndex - * @param {Number} parentOctreeIndex - * @param {Number} parentEntryIndex + * @param {number} childOctreeIndex + * @param {number} childEntryIndex + * @param {number} parentOctreeIndex + * @param {number} parentEntryIndex */ function buildOctree( node, @@ -934,9 +934,9 @@ function generateOctree(that, sampleCount, levelBlendFactor) { /** * Compute an interpolation factor between a node and its parent * @param {SpatialNode} node - * @param {Number} targetSse - * @param {Number} levelBlendFactor - * @returns {Number} + * @param {number} targetSse + * @param {number} levelBlendFactor + * @returns {number} * @private */ function getLodLerp(node, targetSse, levelBlendFactor) { @@ -953,9 +953,9 @@ function getLodLerp(node, targetSse, levelBlendFactor) { /** * - * @param {Number[]} data - * @param {Number} texelsPerTile - * @param {Number} tilesPerRow + * @param {number[]} data + * @param {number} texelsPerTile + * @param {number} tilesPerRow * @param {Texture} texture * @private */ @@ -994,9 +994,9 @@ function copyToInternalNodeTexture(data, texelsPerTile, tilesPerRow, texture) { /** * - * @param {Number[]} data - * @param {Number} texelsPerTile - * @param {Number} tilesPerRow + * @param {number[]} data + * @param {number} texelsPerTile + * @param {number} tilesPerRow * @param {Texture} texture * @private */ @@ -1053,7 +1053,7 @@ function copyToLeafNodeTexture(data, texelsPerTile, tilesPerRow, texture) { } /** - * @param {Number} tileCount + * @param {number} tileCount * @param {Cartesian3} dimensions * @param {MetadataType[]} types * @param {MetadataComponentType[]} componentTypes diff --git a/packages/engine/Source/Scene/WebMapServiceImageryProvider.js b/packages/engine/Source/Scene/WebMapServiceImageryProvider.js index 8364208a2492..9cf1c72d68f1 100644 --- a/packages/engine/Source/Scene/WebMapServiceImageryProvider.js +++ b/packages/engine/Source/Scene/WebMapServiceImageryProvider.js @@ -32,15 +32,15 @@ const excludesReverseAxis = [ ]; /** - * @typedef {Object} WebMapServiceImageryProvider.ConstructorOptions + * @typedef {object} WebMapServiceImageryProvider.ConstructorOptions * * Initialization options for the WebMapServiceImageryProvider constructor * - * @property {Resource|String} url The URL of the WMS service. The URL supports the same keywords as the {@link UrlTemplateImageryProvider}. - * @property {String} layers The layers to include, separated by commas. - * @property {Object} [parameters=WebMapServiceImageryProvider.DefaultParameters] Additional parameters to pass to the WMS server in the GetMap URL. - * @property {Object} [getFeatureInfoParameters=WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters] Additional parameters to pass to the WMS server in the GetFeatureInfo URL. - * @property {Boolean} [enablePickFeatures=true] If true, {@link WebMapServiceImageryProvider#pickFeatures} will invoke + * @property {Resource|string} url The URL of the WMS service. The URL supports the same keywords as the {@link UrlTemplateImageryProvider}. + * @property {string} layers The layers to include, separated by commas. + * @property {object} [parameters=WebMapServiceImageryProvider.DefaultParameters] Additional parameters to pass to the WMS server in the GetMap URL. + * @property {object} [getFeatureInfoParameters=WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters] Additional parameters to pass to the WMS server in the GetFeatureInfo URL. + * @property {boolean} [enablePickFeatures=true] If true, {@link WebMapServiceImageryProvider#pickFeatures} will invoke * the GetFeatureInfo operation on the WMS server and return the features included in the response. If false, * {@link WebMapServiceImageryProvider#pickFeatures} will immediately return undefined (indicating no pickable features) * without communicating with the server. Set this property to false if you know your WMS server does not support @@ -53,22 +53,22 @@ const excludesReverseAxis = [ * @property {Ellipsoid} [ellipsoid] The ellipsoid. If the tilingScheme is specified, * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither * parameter is specified, the WGS84 ellipsoid is used. - * @property {Number} [tileWidth=256] The width of each tile in pixels. - * @property {Number} [tileHeight=256] The height of each tile in pixels. - * @property {Number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when + * @property {number} [tileWidth=256] The width of each tile in pixels. + * @property {number} [tileHeight=256] The height of each tile in pixels. + * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when * specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is * likely to result in rendering problems. - * @property {Number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. + * @property {number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. * If not specified, there is no limit. - * @property {String} [crs] CRS specification, for use with WMS specification >= 1.3.0. - * @property {String} [srs] SRS specification, for use with WMS specification 1.1.0 or 1.1.1 - * @property {Credit|String} [credit] A credit for the data source, which is displayed on the canvas. - * @property {String|String[]} [subdomains='abc'] The subdomains to use for the {s} placeholder in the URL template. + * @property {string} [crs] CRS specification, for use with WMS specification >= 1.3.0. + * @property {string} [srs] SRS specification, for use with WMS specification 1.1.0 or 1.1.1 + * @property {Credit|string} [credit] A credit for the data source, which is displayed on the canvas. + * @property {string|string[]} [subdomains='abc'] The subdomains to use for the {s} placeholder in the URL template. * If this parameter is a single string, each character in the string is a subdomain. If it is * an array, each element in the array is a subdomain. * @property {Clock} [clock] A Clock instance that is used when determining the value for the time dimension. Required when `times` is specified. * @property {TimeIntervalCollection} [times] TimeIntervalCollection with its data property being an object containing time dynamic dimension and their values. - * @property {Resource|String} [getFeatureInfoUrl] The getFeatureInfo URL of the WMS service. If the property is not defined then we use the property value of url. + * @property {Resource|string} [getFeatureInfoUrl] The getFeatureInfo URL of the WMS service. If the property is not defined then we use the property value of url. */ /** @@ -122,7 +122,7 @@ function WebMapServiceImageryProvider(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; @@ -131,7 +131,7 @@ function WebMapServiceImageryProvider(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; @@ -140,7 +140,7 @@ function WebMapServiceImageryProvider(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; @@ -149,7 +149,7 @@ function WebMapServiceImageryProvider(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; @@ -158,7 +158,7 @@ function WebMapServiceImageryProvider(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; @@ -166,7 +166,7 @@ function WebMapServiceImageryProvider(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; @@ -175,7 +175,7 @@ function WebMapServiceImageryProvider(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; @@ -183,7 +183,7 @@ function WebMapServiceImageryProvider(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; @@ -376,7 +376,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { /** * Gets the URL of the WMS server. * @memberof WebMapServiceImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -400,7 +400,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { /** * Gets the names of the WMS layers, separated by commas. * @memberof WebMapServiceImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ layers: { @@ -413,7 +413,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link WebMapServiceImageryProvider#ready} returns true. * @memberof WebMapServiceImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -426,7 +426,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link WebMapServiceImageryProvider#ready} returns true. * @memberof WebMapServiceImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -439,7 +439,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link WebMapServiceImageryProvider#ready} returns true. * @memberof WebMapServiceImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -452,7 +452,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { * Gets the minimum level-of-detail that can be requested. This function should * not be called before {@link WebMapServiceImageryProvider#ready} returns true. * @memberof WebMapServiceImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -519,7 +519,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof WebMapServiceImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -531,7 +531,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof WebMapServiceImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -560,7 +560,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { * as if their alpha is 1.0 everywhere. When this property is false, memory usage * and texture upload time are reduced. * @memberof WebMapServiceImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -576,7 +576,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { * features) without communicating with the server. Set this property to false if you know your data * source does not support picking features or if you don't want this provider's features to be pickable. * @memberof WebMapServiceImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @default true */ enablePickFeatures: { @@ -620,7 +620,7 @@ Object.defineProperties(WebMapServiceImageryProvider.prototype, { /** * Gets the getFeatureInfo URL of the WMS server. * @memberof WebMapServiceImageryProvider.prototype - * @type {Resource|String} + * @type {Resource|string} * @readonly */ getFeatureInfoUrl: { @@ -633,9 +633,9 @@ Object.defineProperties(WebMapServiceImageryProvider.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} getTileCredits must not be called before the imagery provider is ready. @@ -648,11 +648,11 @@ WebMapServiceImageryProvider.prototype.getTileCredits = function (x, y, level) { * Requests the image for a given tile. This function should * not be called before {@link WebMapServiceImageryProvider#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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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} requestImage must not be called before the imagery provider is ready. @@ -690,12 +690,12 @@ WebMapServiceImageryProvider.prototype.requestImage = function ( * Asynchronously determines what features, if any, are located at a given longitude and latitude within * a tile. This function should not be called before {@link ImageryProvider#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} longitude The longitude at which to pick features. - * @param {Number} latitude The latitude at which to pick features. - * @return {Promise.|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|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. * @@ -725,7 +725,7 @@ WebMapServiceImageryProvider.prototype.pickFeatures = function ( * format=image/jpeg * * @constant - * @type {Object} + * @type {object} */ WebMapServiceImageryProvider.DefaultParameters = Object.freeze({ service: "WMS", @@ -742,7 +742,7 @@ WebMapServiceImageryProvider.DefaultParameters = Object.freeze({ * request=GetFeatureInfo * * @constant - * @type {Object} + * @type {object} */ WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters = Object.freeze({ service: "WMS", diff --git a/packages/engine/Source/Scene/WebMapTileServiceImageryProvider.js b/packages/engine/Source/Scene/WebMapTileServiceImageryProvider.js index 18eb431deb28..dd1d95381c35 100644 --- a/packages/engine/Source/Scene/WebMapTileServiceImageryProvider.js +++ b/packages/engine/Source/Scene/WebMapTileServiceImageryProvider.js @@ -17,28 +17,28 @@ const defaultParameters = Object.freeze({ }); /** - * @typedef {Object} WebMapTileServiceImageryProvider.ConstructorOptions + * @typedef {object} WebMapTileServiceImageryProvider.ConstructorOptions * * Initialization options for the WebMapTileServiceImageryProvider constructor * - * @property {Resource|String} url The base URL for the WMTS GetTile operation (for KVP-encoded requests) or the tile-URL template (for RESTful requests). The tile-URL template should contain the following variables: {style}, {TileMatrixSet}, {TileMatrix}, {TileRow}, {TileCol}. The first two are optional if actual values are hardcoded or not required by the server. The {s} keyword may be used to specify subdomains. - * @property {String} [format='image/jpeg'] The MIME type for images to retrieve from the server. - * @property {String} layer The layer name for WMTS requests. - * @property {String} style The style name for WMTS requests. - * @property {String} tileMatrixSetID The identifier of the TileMatrixSet to use for WMTS requests. + * @property {Resource|string} url The base URL for the WMTS GetTile operation (for KVP-encoded requests) or the tile-URL template (for RESTful requests). The tile-URL template should contain the following variables: {style}, {TileMatrixSet}, {TileMatrix}, {TileRow}, {TileCol}. The first two are optional if actual values are hardcoded or not required by the server. The {s} keyword may be used to specify subdomains. + * @property {string} [format='image/jpeg'] The MIME type for images to retrieve from the server. + * @property {string} layer The layer name for WMTS requests. + * @property {string} style The style name for WMTS requests. + * @property {string} tileMatrixSetID The identifier of the TileMatrixSet to use for WMTS requests. * @property {Array} [tileMatrixLabels] A list of identifiers in the TileMatrix to use for WMTS requests, one per TileMatrix level. * @property {Clock} [clock] A Clock instance that is used when determining the value for the time dimension. Required when `times` is specified. * @property {TimeIntervalCollection} [times] TimeIntervalCollection with its data property being an object containing time dynamic dimension and their values. - * @property {Object} [dimensions] A object containing static dimensions and their values. - * @property {Number} [tileWidth=256] The tile width in pixels. - * @property {Number} [tileHeight=256] The tile height in pixels. + * @property {object} [dimensions] A object containing static dimensions and their values. + * @property {number} [tileWidth=256] The tile width in pixels. + * @property {number} [tileHeight=256] The tile height in pixels. * @property {TilingScheme} [tilingScheme] The tiling scheme corresponding to the organization of the tiles in the TileMatrixSet. * @property {Rectangle} [rectangle=Rectangle.MAX_VALUE] The rectangle covered by the layer. - * @property {Number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. - * @property {Number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. + * @property {number} [minimumLevel=0] The minimum level-of-detail supported by the imagery provider. + * @property {number} [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit. * @property {Ellipsoid} [ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used. - * @property {Credit|String} [credit] A credit for the data source, which is displayed on the canvas. - * @property {String|String[]} [subdomains='abc'] The subdomains to use for the {s} placeholder in the URL template. + * @property {Credit|string} [credit] A credit for the data source, which is displayed on the canvas. + * @property {string|string[]} [subdomains='abc'] The subdomains to use for the {s} placeholder in the URL template. * If this parameter is a single string, each character in the string is a subdomain. If it is * an array, each element in the array is a subdomain. */ @@ -140,7 +140,7 @@ function WebMapTileServiceImageryProvider(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; @@ -149,7 +149,7 @@ function WebMapTileServiceImageryProvider(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; @@ -158,7 +158,7 @@ function WebMapTileServiceImageryProvider(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; @@ -167,7 +167,7 @@ function WebMapTileServiceImageryProvider(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; @@ -176,7 +176,7 @@ function WebMapTileServiceImageryProvider(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; @@ -184,7 +184,7 @@ function WebMapTileServiceImageryProvider(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; @@ -193,7 +193,7 @@ function WebMapTileServiceImageryProvider(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; @@ -201,7 +201,7 @@ function WebMapTileServiceImageryProvider(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; @@ -390,7 +390,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { /** * Gets the URL of the service hosting the imagery. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ url: { @@ -415,7 +415,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { * Gets the width of each tile, in pixels. This function should * not be called before {@link WebMapTileServiceImageryProvider#ready} returns true. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileWidth: { @@ -428,7 +428,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { * Gets the height of each tile, in pixels. This function should * not be called before {@link WebMapTileServiceImageryProvider#ready} returns true. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ tileHeight: { @@ -441,7 +441,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { * Gets the maximum level-of-detail that can be requested. This function should * not be called before {@link WebMapTileServiceImageryProvider#ready} returns true. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {Number|undefined} + * @type {number|undefined} * @readonly */ maximumLevel: { @@ -454,7 +454,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { * Gets the minimum level-of-detail that can be requested. This function should * not be called before {@link WebMapTileServiceImageryProvider#ready} returns true. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {Number} + * @type {number} * @readonly */ minimumLevel: { @@ -521,7 +521,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { /** * Gets the mime type of images returned by this imagery provider. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {String} + * @type {string} * @readonly */ format: { @@ -533,7 +533,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { /** * Gets a value indicating whether or not the provider is ready for use. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ ready: { @@ -543,7 +543,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { /** * Gets a promise that resolves to true when the provider is ready for use. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {Promise.} + * @type {Promise} * @readonly */ readyPromise: { @@ -572,7 +572,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { * as if their alpha is 1.0 everywhere. When this property is false, memory usage * and texture upload time are reduced. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {Boolean} + * @type {boolean} * @readonly */ hasAlphaChannel: { @@ -611,7 +611,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, { /** * Gets or sets an object that contains static dimensions and their values. * @memberof WebMapTileServiceImageryProvider.prototype - * @type {Object} + * @type {object} */ dimensions: { get: function () { @@ -631,9 +631,9 @@ Object.defineProperties(WebMapTileServiceImageryProvider.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} getTileCredits must not be called before the imagery provider is ready. @@ -650,11 +650,11 @@ WebMapTileServiceImageryProvider.prototype.getTileCredits = function ( * Requests the image for a given tile. This function should * not be called before {@link WebMapTileServiceImageryProvider#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.|undefined} A promise for the image that will resolve when the image is available, or + * @returns {Promise|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} requestImage must not be called before the imagery provider is ready. @@ -692,11 +692,11 @@ WebMapTileServiceImageryProvider.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. */ WebMapTileServiceImageryProvider.prototype.pickFeatures = function ( diff --git a/packages/engine/Source/Scene/createBillboardPointCallback.js b/packages/engine/Source/Scene/createBillboardPointCallback.js index 6b2c842a0b98..a9340b81d3d5 100644 --- a/packages/engine/Source/Scene/createBillboardPointCallback.js +++ b/packages/engine/Source/Scene/createBillboardPointCallback.js @@ -1,11 +1,11 @@ /** * Creates a {@link createBillboardPointCallback.CanvasFunction} that will create a canvas with a point. * - * @param {Number} centerAlpha The alpha of the center of the point. The value must be in the range [0.0, 1.0]. - * @param {String} cssColor The CSS color string. - * @param {String} cssOutlineColor The CSS color of the point outline. - * @param {Number} cssOutlineWidth The width of the outline in pixels. - * @param {Number} pixelSize The size of the point in pixels. + * @param {number} centerAlpha The alpha of the center of the point. The value must be in the range [0.0, 1.0]. + * @param {string} cssColor The CSS color string. + * @param {string} cssOutlineColor The CSS color of the point outline. + * @param {number} cssOutlineWidth The width of the outline in pixels. + * @param {number} pixelSize The size of the point in pixels. * @return {createBillboardPointCallback.CanvasFunction} The function that will return a canvas with the point drawn on it. * * @private diff --git a/packages/engine/Source/Scene/createElevationBandMaterial.js b/packages/engine/Source/Scene/createElevationBandMaterial.js index 375964c207d6..544a1d67f6c7 100644 --- a/packages/engine/Source/Scene/createElevationBandMaterial.js +++ b/packages/engine/Source/Scene/createElevationBandMaterial.js @@ -411,15 +411,15 @@ function createLayeredEntries(layers) { /** * @typedef createElevationBandMaterialEntry * - * @property {Number} height The height. + * @property {number} height The height. * @property {Color} color The color at this height. */ /** * @typedef createElevationBandMaterialBand * * @property {createElevationBandMaterialEntry[]} entries A list of elevation entries. They will automatically be sorted from lowest to highest. If there is only one entry and extendsDownards and extendUpwards are both false, they will both be set to true. - * @property {Boolean} [extendDownwards=false] If true, the band's minimum elevation color will extend infinitely downwards. - * @property {Boolean} [extendUpwards=false] If true, the band's maximum elevation color will extend infinitely upwards. + * @property {boolean} [extendDownwards=false] If true, the band's minimum elevation color will extend infinitely downwards. + * @property {boolean} [extendUpwards=false] If true, the band's maximum elevation color will extend infinitely upwards. */ /** @@ -430,7 +430,7 @@ function createLayeredEntries(layers) { * * @function createElevationBandMaterial * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Scene} options.scene The scene where the visualization is taking place. * @param {createElevationBandMaterialBand[]} options.layers A list of bands ordered from lowest to highest precedence. * @returns {Material} A new {@link Material} instance. @@ -550,7 +550,7 @@ function createElevationBandMaterial(options) { * Function for checking if the context will allow floating point textures for heights. * * @param {Context} context The {@link Context}. - * @returns {Boolean} true if floating point textures can be used for heights. + * @returns {boolean} true if floating point textures can be used for heights. * @private */ createElevationBandMaterial._useFloatTexture = function (context) { diff --git a/packages/engine/Source/Scene/createOsmBuildings.js b/packages/engine/Source/Scene/createOsmBuildings.js index 891b1e34071f..d17e717ba374 100644 --- a/packages/engine/Source/Scene/createOsmBuildings.js +++ b/packages/engine/Source/Scene/createOsmBuildings.js @@ -13,7 +13,7 @@ import Cesium3DTileStyle from "./Cesium3DTileStyle.js"; * * @function * - * @param {Object} [options] Construction options. Any options allowed by the {@link Cesium3DTileset} constructor + * @param {object} [options] Construction options. Any options allowed by the {@link Cesium3DTileset} constructor * may be specified here. In addition to those, the following properties are supported: * @param {Color} [options.defaultColor=Color.WHITE] The default color to use for buildings * that do not have a color. This parameter is ignored if options.style is specified. @@ -21,8 +21,8 @@ import Cesium3DTileStyle from "./Cesium3DTileStyle.js"; * specified, a default style is used which gives each building or building part a * color inferred from its OpenStreetMap tags. If no color can be inferred, * options.defaultColor is used. - * @param {Boolean} [options.enableShowOutline=true] If true, enable rendering outlines. This can be set to false to avoid the additional processing of geometry at load time. - * @param {Boolean} [options.showOutline=true] Whether to show outlines around buildings. When true, + * @param {boolean} [options.enableShowOutline=true] If true, enable rendering outlines. This can be set to false to avoid the additional processing of geometry at load time. + * @param {boolean} [options.showOutline=true] Whether to show outlines around buildings. When true, * outlines are displayed. When false, outlines are not displayed. * @returns {Cesium3DTileset} * diff --git a/packages/engine/Source/Scene/createTangentSpaceDebugPrimitive.js b/packages/engine/Source/Scene/createTangentSpaceDebugPrimitive.js index 8b6f8584b8d1..5c3086e11b33 100644 --- a/packages/engine/Source/Scene/createTangentSpaceDebugPrimitive.js +++ b/packages/engine/Source/Scene/createTangentSpaceDebugPrimitive.js @@ -16,9 +16,9 @@ import Primitive from "./Primitive.js"; * * @function * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Geometry} options.geometry The Geometry instance with the attribute. - * @param {Number} [options.length=10000.0] The length of each line segment in meters. This can be negative to point the vector in the opposite direction. + * @param {number} [options.length=10000.0] The length of each line segment in meters. This can be negative to point the vector in the opposite direction. * @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The model matrix that transforms to transform the geometry from model to world coordinates. * @returns {Primitive} A new Primitive instance with geometry for the vectors. * diff --git a/packages/engine/Source/Scene/createWorldImagery.js b/packages/engine/Source/Scene/createWorldImagery.js index 36d07b0e7f8c..6e834881691f 100644 --- a/packages/engine/Source/Scene/createWorldImagery.js +++ b/packages/engine/Source/Scene/createWorldImagery.js @@ -7,7 +7,7 @@ import IonWorldImageryStyle from "./IonWorldImageryStyle.js"; * * @function * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {IonWorldImageryStyle} [options.style=IonWorldImageryStyle] The style of base imagery, only AERIAL, AERIAL_WITH_LABELS, and ROAD are currently supported. * @returns {IonImageryProvider} * diff --git a/packages/engine/Source/Scene/findContentMetadata.js b/packages/engine/Source/Scene/findContentMetadata.js index 264464a34484..db20826686ba 100644 --- a/packages/engine/Source/Scene/findContentMetadata.js +++ b/packages/engine/Source/Scene/findContentMetadata.js @@ -12,7 +12,7 @@ import oneTimeWarning from "../Core/oneTimeWarning.js"; * @function * * @param {Cesium3DTileset} tileset The tileset to query for content metadata - * @param {Object} contentHeader the JSON header for a {@link Cesium3DTileContent} + * @param {object} contentHeader the JSON header for a {@link Cesium3DTileContent} * @return {ContentMetadata} the content metadata, or undefined if not found * @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. diff --git a/packages/engine/Source/Scene/findGroupMetadata.js b/packages/engine/Source/Scene/findGroupMetadata.js index 2642efe486a1..c19bf0ba3619 100644 --- a/packages/engine/Source/Scene/findGroupMetadata.js +++ b/packages/engine/Source/Scene/findGroupMetadata.js @@ -9,7 +9,7 @@ import hasExtension from "./hasExtension.js"; * @function * * @param {Cesium3DTileset} tileset The tileset to query for group metadata - * @param {Object} contentHeader the JSON header for a {@link Cesium3DTileContent} + * @param {object} contentHeader the JSON header for a {@link Cesium3DTileContent} * @return {GroupMetadata} the group metadata, or undefined if not found * @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. diff --git a/packages/engine/Source/Scene/findTileMetadata.js b/packages/engine/Source/Scene/findTileMetadata.js index fa83968b3d1c..f455afdf9c94 100644 --- a/packages/engine/Source/Scene/findTileMetadata.js +++ b/packages/engine/Source/Scene/findTileMetadata.js @@ -14,7 +14,7 @@ import oneTimeWarning from "../Core/oneTimeWarning.js"; * @function * * @param {Cesium3DTileset} tileset The tileset to query for tile metadata - * @param {Object} tileHeader the JSON header for a {@link Cesium3DTile} + * @param {object} tileHeader the JSON header for a {@link Cesium3DTile} * @return {TileMetadata} the tile metadata, or undefined if not found * @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. diff --git a/packages/engine/Source/Scene/getClipAndStyleCode.js b/packages/engine/Source/Scene/getClipAndStyleCode.js index 41eddcf14072..5b3e71f61eab 100644 --- a/packages/engine/Source/Scene/getClipAndStyleCode.js +++ b/packages/engine/Source/Scene/getClipAndStyleCode.js @@ -3,10 +3,10 @@ import Check from "../Core/Check.js"; /** * Gets a GLSL snippet that clips a fragment using the `clip` function from {@link getClippingFunction} and styles it. * - * @param {String} samplerUniformName Name of the uniform for the clipping planes texture sampler. - * @param {String} matrixUniformName Name of the uniform for the clipping planes matrix. - * @param {String} styleUniformName Name of the uniform for the clipping planes style, a vec4. - * @returns {String} A string containing GLSL that clips and styles the current fragment. + * @param {string} samplerUniformName Name of the uniform for the clipping planes texture sampler. + * @param {string} matrixUniformName Name of the uniform for the clipping planes matrix. + * @param {string} styleUniformName Name of the uniform for the clipping planes style, a vec4. + * @returns {string} A string containing GLSL that clips and styles the current fragment. * @private */ function getClipAndStyleCode( diff --git a/packages/engine/Source/Scene/getClippingFunction.js b/packages/engine/Source/Scene/getClippingFunction.js index be41a8717b11..d17d9819b598 100644 --- a/packages/engine/Source/Scene/getClippingFunction.js +++ b/packages/engine/Source/Scene/getClippingFunction.js @@ -8,7 +8,7 @@ const textureResolutionScratch = new Cartesian2(); * * @param {ClippingPlaneCollection} clippingPlaneCollection ClippingPlaneCollection with a defined texture. * @param {Context} context The current rendering context. - * @returns {String} A string containing GLSL functions for retrieving clipping planes. + * @returns {string} A string containing GLSL functions for retrieving clipping planes. * @private */ function getClippingFunction(clippingPlaneCollection, context) { diff --git a/packages/engine/Source/Scene/hasExtension.js b/packages/engine/Source/Scene/hasExtension.js index de9622f5eb80..477f7adf3b2e 100644 --- a/packages/engine/Source/Scene/hasExtension.js +++ b/packages/engine/Source/Scene/hasExtension.js @@ -3,9 +3,9 @@ import defined from "../Core/defined.js"; /** * Check if a specific extension is present on a JSON object. This can be used * for either 3D Tiles extensions or glTF extensions - * @param {Object} json The JSON object - * @param {String} extensionName The name of the extension, e.g. '3DTILES_implicit_tiling' - * @returns {Boolean} True if the extension is present + * @param {object} json The JSON object + * @param {string} extensionName The name of the extension, e.g. '3DTILES_implicit_tiling' + * @returns {boolean} True if the extension is present * @private */ function hasExtension(json, extensionName) { diff --git a/packages/engine/Source/Scene/parseBatchTable.js b/packages/engine/Source/Scene/parseBatchTable.js index da55b2122b4e..26cb21abec7f 100644 --- a/packages/engine/Source/Scene/parseBatchTable.js +++ b/packages/engine/Source/Scene/parseBatchTable.js @@ -25,11 +25,11 @@ import oneTimeWarning from "../Core/oneTimeWarning.js"; * See the {@link https://github.com/CesiumGS/glTF/tree/3d-tiles-next/extensions/2.0/Vendor/EXT_structural_metadata|EXT_structural_metadata Extension} for glTF. *

    * - * @param {Object} options Object with the following properties: - * @param {Number} options.count The number of features in the batch table. - * @param {Object} options.batchTable The batch table JSON + * @param {object} options Object with the following properties: + * @param {number} options.count The number of features in the batch table. + * @param {object} options.batchTable The batch table JSON * @param {Uint8Array} [options.binaryBody] The batch table binary body - * @param {Boolean} [options.parseAsPropertyAttributes=false] If true, binary properties are parsed as property attributes instead of a property table. This is used for .pnts models for GPU styling. + * @param {boolean} [options.parseAsPropertyAttributes=false] If true, binary properties are parsed as property attributes instead of a property table. This is used for .pnts models for GPU styling. * @param {ModelComponents.Attribute[]} [options.customAttributeOutput] Pass in an empty array here and this method will populate it with a list of custom attributes that will store the values of the property attributes. The attributes will be created with typed arrays, the caller is responsible for uploading them to the GPU. This option is required when options.parseAsPropertyAttributes is true. * @return {StructuralMetadata} A transcoded structural metadata object * @@ -149,8 +149,8 @@ function parseBatchTable(options) { * Divide the batch table's properties into binary, JSON and hierarchy * extension as each is handled separately * - * @param {Object} batchTable The batch table JSON - * @returns {Object} The batch table divided into binary, JSON and hierarchy portions. Extras and extensions are also divided out for ease of processing. + * @param {object} batchTable The batch table JSON + * @returns {object} The batch table divided into binary, JSON and hierarchy portions. Extras and extensions are also divided out for ease of processing. * * @private */ @@ -208,11 +208,11 @@ function partitionProperties(batchTable) { * Transcode the binary properties of the batch table to be compatible with * EXT_structural_metadata * - * @param {Number} featureCount The number of features in the batch table - * @param {String} className The name of the metadata class to be created. - * @param {Object.} binaryProperties A dictionary of property ID to property definition + * @param {number} featureCount The number of features in the batch table + * @param {string} className The name of the metadata class to be created. + * @param {Object} binaryProperties A dictionary of property ID to property definition * @param {Uint8Array} [binaryBody] The binary body of the batch table - * @return {Object} Transcoded data needed for constructing a {@link StructuralMetadata} object. + * @return {object} Transcoded data needed for constructing a {@link StructuralMetadata} object. * * @private */ @@ -405,8 +405,8 @@ function transcodeBinaryPropertiesAsPropertyAttributes( * Given a property definition from the batch table, compute the equivalent * EXT_structural_metadata type definition * - * @param {Object} property The batch table property definition - * @return {Object} The corresponding structural metadata property definition + * @param {object} property The batch table property definition + * @return {object} The corresponding structural metadata property definition * @private */ function transcodePropertyType(property) { @@ -422,8 +422,8 @@ function transcodePropertyType(property) { * Convert the component type of a batch table property to the corresponding * type used with structural metadata * - * @property {String} componentType the batch table's component type - * @return {String} The corresponding structural metadata data type + * @property {string} componentType the batch table's component type + * @return {string} The corresponding structural metadata data type * * @private */ diff --git a/packages/engine/Source/Scene/parseBoundingVolumeSemantics.js b/packages/engine/Source/Scene/parseBoundingVolumeSemantics.js index d649b6ac2da2..d83935c4377e 100644 --- a/packages/engine/Source/Scene/parseBoundingVolumeSemantics.js +++ b/packages/engine/Source/Scene/parseBoundingVolumeSemantics.js @@ -14,7 +14,7 @@ import defined from "../Core/defined.js"; * @see {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/Metadata/Semantics|3D Metadata Semantic Reference} for the various bounding volumes and minimum/maximum heights. * * @param {TileMetadata} tileMetadata The metadata object for looking up values by semantic. In practice, this will typically be a {@link ImplicitMetadataView} - * @return {Object} An object containing a tile property and a content property. These contain the bounding volume, and any minimum or maximum height. + * @return {object} An object containing a tile property and a content property. These contain the bounding volume, and any minimum or maximum height. * * @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. @@ -47,9 +47,9 @@ function parseBoundingVolumeSemantics(tileMetadata) { * is the prefix. e.g. TILE_BOUNDING_BOX and * CONTENT_BOUNDING_BOX have the same memory layout. * - * @param {String} prefix Either "TILE" or "CONTENT" + * @param {string} prefix Either "TILE" or "CONTENT" * @param {TileMetadata} tileMetadata The tileMetadata for looking up values - * @return {Object} An object representing the JSON description of the tile metadata + * @return {object} An object representing the JSON description of the tile metadata * @private */ function parseBoundingVolume(prefix, tileMetadata) { @@ -93,9 +93,9 @@ function parseBoundingVolume(prefix, tileMetadata) { * quadtree bounds for implicit tiling. This works for both * TILE_MINIMUM_HEIGHT and CONTENT_MINIMUM_HEIGHT * - * @param {String} prefix Either "TILE" or "CONTENT" + * @param {string} prefix Either "TILE" or "CONTENT" * @param {TileMetadata} tileMetadata The tileMetadata for looking up values - * @return {Number} The minimum height + * @return {number} The minimum height * @private */ function parseMinimumHeight(prefix, tileMetadata) { @@ -108,9 +108,9 @@ function parseMinimumHeight(prefix, tileMetadata) { * quadtree bounds for implicit tiling. This works for both * TILE_MAXIMUM_HEIGHT and CONTENT_MAXIMUM_HEIGHT * - * @param {String} prefix Either "TILE" or "CONTENT" + * @param {string} prefix Either "TILE" or "CONTENT" * @param {TileMetadata} tileMetadata The tileMetadata for looking up values - * @return {Number} The maximum height + * @return {number} The maximum height * @private */ function parseMaximumHeight(prefix, tileMetadata) { diff --git a/packages/engine/Source/Scene/parseFeatureMetadataLegacy.js b/packages/engine/Source/Scene/parseFeatureMetadataLegacy.js index d522a9a121b8..481ed2b0606b 100644 --- a/packages/engine/Source/Scene/parseFeatureMetadataLegacy.js +++ b/packages/engine/Source/Scene/parseFeatureMetadataLegacy.js @@ -11,11 +11,11 @@ import MetadataTable from "./MetadataTable.js"; * Parse the EXT_feature_metadata glTF extension to create a * structural metadata object. * - * @param {Object} options Object with the following properties: - * @param {Object} options.extension The extension JSON object. + * @param {object} options Object with the following properties: + * @param {object} options.extension The extension JSON object. * @param {MetadataSchema} options.schema The parsed schema. - * @param {Object.} [options.bufferViews] An object mapping bufferView IDs to Uint8Array objects. - * @param {Object.} [options.textures] An object mapping texture IDs to {@link Texture} objects. + * @param {Object} [options.bufferViews] An object mapping bufferView IDs to Uint8Array objects. + * @param {Object} [options.textures] An object mapping texture IDs to {@link Texture} objects. * @return {StructuralMetadata} A structural metadata object * @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. diff --git a/packages/engine/Source/Scene/parseStructuralMetadata.js b/packages/engine/Source/Scene/parseStructuralMetadata.js index f3af672d3b59..1e401fe7c277 100644 --- a/packages/engine/Source/Scene/parseStructuralMetadata.js +++ b/packages/engine/Source/Scene/parseStructuralMetadata.js @@ -11,11 +11,11 @@ import MetadataTable from "./MetadataTable.js"; * Parse the EXT_structural_metadata glTF extension to create a * structural metadata object. * - * @param {Object} options Object with the following properties: - * @param {Object} options.extension The extension JSON object. + * @param {object} options Object with the following properties: + * @param {object} options.extension The extension JSON object. * @param {MetadataSchema} options.schema The parsed schema. - * @param {Object.} [options.bufferViews] An object mapping bufferView IDs to Uint8Array objects. - * @param {Object.} [options.textures] An object mapping texture IDs to {@link Texture} objects. + * @param {Object} [options.bufferViews] An object mapping bufferView IDs to Uint8Array objects. + * @param {Object} [options.textures] An object mapping texture IDs to {@link Texture} objects. * @return {StructuralMetadata} A structural metadata object * @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. diff --git a/packages/engine/Source/Scene/preprocess3DTileContent.js b/packages/engine/Source/Scene/preprocess3DTileContent.js index ec8f44b84d43..8bb8f76d5c20 100644 --- a/packages/engine/Source/Scene/preprocess3DTileContent.js +++ b/packages/engine/Source/Scene/preprocess3DTileContent.js @@ -9,10 +9,10 @@ import Cesium3DTileContentType from "./Cesium3DTileContentType.js"; * {@link Cesium3DTileContentType} and the payload. The payload is either * binary or JSON depending on the content type. * - * @typedef {Object} PreprocessedContent + * @typedef {object} PreprocessedContent * @property {Cesium3DTileContentType} contentType The type of the content * @property {Uint8Array} [binaryPayload] For binary files, the payload is returned as a typed array with byteOffset of 0 - * @property {Object} [jsonPayload] For JSON files, the results are returned as a JSON object. + * @property {object} [jsonPayload] For JSON files, the results are returned as a JSON object. * @private */ diff --git a/packages/engine/Source/Scene/processVoxelProperties.js b/packages/engine/Source/Scene/processVoxelProperties.js index 46dc60fd6136..edd6ed80e9bd 100644 --- a/packages/engine/Source/Scene/processVoxelProperties.js +++ b/packages/engine/Source/Scene/processVoxelProperties.js @@ -355,7 +355,7 @@ function processVoxelProperties(renderResources, primitive) { * @function * * @param {MetadataType} type The {@link MetadataType}. - * @returns {String} The GLSL type. + * @returns {string} The GLSL type. * * @private */ @@ -377,7 +377,7 @@ function getGlslType(type) { * @function * * @param {MetadataType} type The {@link MetadataType}. - * @returns {String} The GLSL swizzle. + * @returns {string} The GLSL swizzle. * * @private */ @@ -399,7 +399,7 @@ function getGlslTextureSwizzle(type) { * @function * * @param {MetadataType} type The {@link MetadataType}. - * @returns {String} The GLSL type. + * @returns {string} The GLSL type. * * @private */ @@ -421,8 +421,8 @@ function getGlslPartialDerivativeType(type) { * * @function * - * @param {Number} number The number to convert. - * @returns {String} The number as floating point in GLSL. + * @param {number} number The number to convert. + * @returns {string} The number as floating point in GLSL. * * @private */ @@ -440,8 +440,8 @@ function getGlslNumberAsFloat(number) { * @function * * @param {MetadataType} type - * @param {Number} index - * @returns {String} + * @param {number} index + * @returns {string} * * @private */ diff --git a/packages/engine/Source/Widget/CesiumWidget.js b/packages/engine/Source/Widget/CesiumWidget.js index f76a92486cac..dc40aad99cf4 100644 --- a/packages/engine/Source/Widget/CesiumWidget.js +++ b/packages/engine/Source/Widget/CesiumWidget.js @@ -120,33 +120,33 @@ function configureCameraFrustum(widget) { * @alias CesiumWidget * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. - * @param {Object} [options] Object with the following properties: + * @param {Element|string} container The DOM element or ID that will contain the widget. + * @param {object} [options] Object with the following properties: * @param {Clock} [options.clock=new Clock()] The clock to use to control current time. * @param {ImageryProvider | false} [options.imageryProvider=createWorldImagery()] The imagery provider to serve as the base layer. If set to false, no imagery provider will be added. * @param {TerrainProvider} [options.terrainProvider=new EllipsoidTerrainProvider] The terrain provider. * @param {SkyBox| false} [options.skyBox] The skybox used to render the stars. When undefined, the default stars are used. If set to false, no skyBox, Sun, or Moon will be added. * @param {SkyAtmosphere | false} [options.skyAtmosphere] Blue sky, and the glow around the Earth's limb. Set to false to turn it off. * @param {SceneMode} [options.sceneMode=SceneMode.SCENE3D] The initial scene mode. - * @param {Boolean} [options.scene3DOnly=false] When true, each geometry instance will only be rendered in 3D to save GPU memory. - * @param {Boolean} [options.orderIndependentTranslucency=true] If true and the configuration supports it, use order independent translucency. + * @param {boolean} [options.scene3DOnly=false] When true, each geometry instance will only be rendered in 3D to save GPU memory. + * @param {boolean} [options.orderIndependentTranslucency=true] If true and the configuration supports it, use order independent translucency. * @param {MapProjection} [options.mapProjection=new GeographicProjection()] The map projection to use in 2D and Columbus View modes. * @param {Globe | false} [options.globe=new Globe(mapProjection.ellipsoid)] The globe to use in the scene. If set to false, no globe will be added. - * @param {Boolean} [options.useDefaultRenderLoop=true] True if this widget should control the render loop, false otherwise. - * @param {Boolean} [options.useBrowserRecommendedResolution=true] If true, render at the browser's recommended resolution and ignore window.devicePixelRatio. - * @param {Number} [options.targetFrameRate] The target frame rate when using the default render loop. - * @param {Boolean} [options.showRenderLoopErrors=true] If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs. + * @param {boolean} [options.useDefaultRenderLoop=true] True if this widget should control the render loop, false otherwise. + * @param {boolean} [options.useBrowserRecommendedResolution=true] If true, render at the browser's recommended resolution and ignore window.devicePixelRatio. + * @param {number} [options.targetFrameRate] The target frame rate when using the default render loop. + * @param {boolean} [options.showRenderLoopErrors=true] If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs. * @param {ContextOptions} [options.contextOptions] Context and WebGL creation properties passed to {@link Scene}. - * @param {Element|String} [options.creditContainer] The DOM element or ID that will contain the {@link CreditDisplay}. If not specified, the credits are added + * @param {Element|string} [options.creditContainer] The DOM element or ID that will contain the {@link CreditDisplay}. If not specified, the credits are added * to the bottom of the widget itself. - * @param {Element|String} [options.creditViewport] The DOM element or ID that will contain the credit pop up created by the {@link CreditDisplay}. If not specified, it will appear over the widget itself. - * @param {Boolean} [options.shadows=false] Determines if shadows are cast by light sources. + * @param {Element|string} [options.creditViewport] The DOM element or ID that will contain the credit pop up created by the {@link CreditDisplay}. If not specified, it will appear over the widget itself. + * @param {boolean} [options.shadows=false] Determines if shadows are cast by light sources. * @param {ShadowMode} [options.terrainShadows=ShadowMode.RECEIVE_ONLY] Determines if the terrain casts or receives shadows from light sources. * @param {MapMode2D} [options.mapMode2D=MapMode2D.INFINITE_SCROLL] Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. - * @param {Boolean} [options.blurActiveElementOnCanvasFocus=true] If true, the active element will blur when the viewer's canvas is clicked. Setting this to false is useful for cases when the canvas is clicked only for retrieving position or an entity data without actually meaning to set the canvas to be the active element. - * @param {Boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. - * @param {Number} [options.maximumRenderTimeChange=0.0] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. - * @param {Number} [options.msaaSamples=1] If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. + * @param {boolean} [options.blurActiveElementOnCanvasFocus=true] If true, the active element will blur when the viewer's canvas is clicked. Setting this to false is useful for cases when the canvas is clicked only for retrieving position or an entity data without actually meaning to set the canvas to be the active element. + * @param {boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. + * @param {number} [options.maximumRenderTimeChange=0.0] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. + * @param {number} [options.msaaSamples=1] If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. * * @exception {DeveloperError} Element with id "container" does not exist in the document. * @@ -538,7 +538,7 @@ Object.defineProperties(CesiumWidget.prototype, { * than the underlying requestAnimationFrame implementation will have no effect. * @memberof CesiumWidget.prototype * - * @type {Number} + * @type {number} */ targetFrameRate: { get: function () { @@ -568,7 +568,7 @@ Object.defineProperties(CesiumWidget.prototype, { * after the error. * @memberof CesiumWidget.prototype * - * @type {Boolean} + * @type {boolean} */ useDefaultRenderLoop: { get: function () { @@ -593,7 +593,7 @@ Object.defineProperties(CesiumWidget.prototype, { * it to 2.0 will cause the scene to be rendered at 1280x960 and then scaled down. * @memberof CesiumWidget.prototype * - * @type {Number} + * @type {number} * @default 1.0 */ resolutionScale: { @@ -622,7 +622,7 @@ Object.defineProperties(CesiumWidget.prototype, { * this flag is true or false. * @memberof CesiumWidget.prototype * - * @type {Boolean} + * @type {boolean} * @default true */ useBrowserRecommendedResolution: { @@ -644,9 +644,9 @@ Object.defineProperties(CesiumWidget.prototype, { * when a render loop error occurs, if showRenderLoopErrors was not false when the * widget was constructed. * - * @param {String} title The title to be displayed on the error panel. This string is interpreted as text. - * @param {String} [message] A helpful, user-facing message to display prior to the detailed error information. This string is interpreted as HTML. - * @param {String} [error] The error to be displayed on the error panel. This string is formatted using {@link formatError} and then displayed as text. + * @param {string} title The title to be displayed on the error panel. This string is interpreted as text. + * @param {string} [message] A helpful, user-facing message to display prior to the detailed error information. This string is interpreted as HTML. + * @param {string} [error] The error to be displayed on the error panel. This string is formatted using {@link formatError} and then displayed as text. */ CesiumWidget.prototype.showErrorPanel = function (title, message, error) { const element = this._element; @@ -748,7 +748,7 @@ CesiumWidget.prototype.showErrorPanel = function (title, message, error) { }; /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ CesiumWidget.prototype.isDestroyed = function () { return false; diff --git a/packages/engine/Source/Workers/cesiumWorkerBootstrapper.js b/packages/engine/Source/Workers/cesiumWorkerBootstrapper.js index 2aaadd725d29..505a4b99b033 100644 --- a/packages/engine/Source/Workers/cesiumWorkerBootstrapper.js +++ b/packages/engine/Source/Workers/cesiumWorkerBootstrapper.js @@ -200,8 +200,8 @@ var requirejs, require, define; /** * Constructs an error with a pointer to an URL with more information. - * @param {String} id the error ID that maps to an ID on a web page. - * @param {String} msg human readable error. + * @param {string} id the error ID that maps to an ID on a web page. + * @param {string} msg human readable error. * @param {Error} [err] the original error, if there is one. * @param {RequireModules} requireModules The modules required but not found. * @private @@ -307,12 +307,12 @@ var requirejs, require, define; * @private * Given a relative module name, like ./something, normalize it to * a real name that can be mapped to a path. - * @param {String} name the relative name - * @param {String} baseName a real name that the name arg is relative + * @param {string} name the relative name + * @param {string} baseName a real name that the name arg is relative * to. - * @param {Boolean} applyMap apply the map config to the value. Should + * @param {boolean} applyMap apply the map config to the value. Should * only be done if this normalization is for a dependency ID. - * @returns {String} normalized name + * @returns {string} normalized name */ function normalize(name, baseName, applyMap) { var pkgMain, @@ -464,15 +464,15 @@ var requirejs, require, define; * name, and path. If parentModuleMap is provided it will * also normalize the name via require.normalize() * - * @param {String} name the module name - * @param {String} [parentModuleMap] parent module map + * @param {string} name the module name + * @param {string} [parentModuleMap] parent module map * for the module name, used to resolve relative names. - * @param {Boolean} isNormalized: is the ID already normalized. + * @param {boolean} isNormalized: is the ID already normalized. * This is true if this call is done for a define() module ID. - * @param {Boolean} applyMap: apply the map config to the ID. + * @param {boolean} applyMap: apply the map config to the ID. * Should only be true if this map is for a dependency. * @private - * @returns {Object} + * @returns {object} */ function makeModuleMap(name, parentModuleMap, isNormalized, applyMap) { var url, @@ -1341,7 +1341,7 @@ var requirejs, require, define; * and then removes the event listeners on the node. * @param {Event} evt * @private - * @returns {Object} + * @returns {object} */ function getScriptData(evt) { //Using currentTarget instead of target for Firefox 2.0's sake. Not @@ -1400,7 +1400,7 @@ var requirejs, require, define; /** * @private * Set a configuration for the context. - * @param {Object} cfg config object to integrate. + * @param {object} cfg config object to integrate. */ configure: function (cfg) { //Make sure the baseUrl ends in a slash. @@ -1695,7 +1695,7 @@ var requirejs, require, define; * Internal method used by environment adapters to complete a load event. * A load event could be a script load or just a load pass from a synchronous * load call. - * @param {String} moduleName the name of the module to potentially complete. + * @param {string} moduleName the name of the module to potentially complete. * @private */ completeLoad: function (moduleName) { @@ -2031,9 +2031,9 @@ var requirejs, require, define; * Make this a separate function to allow other environments * to override it. * - * @param {Object} context the require context to find state. - * @param {String} moduleName the name of the module. - * @param {Object} url the URL to the module. + * @param {object} context the require context to find state. + * @param {string} moduleName the name of the module. + * @param {object} url the URL to the module. */ req.load = function (context, moduleName, url) { var config = (context && context.config) || {}, @@ -2278,7 +2278,7 @@ var requirejs, require, define; * Executes the text. Normally just uses eval, but can be modified * to use a better, environment-specific call. Only used for transpiling * loader plugins, not for plain JS modules. - * @param {String} text the text to execute/evaluate. + * @param {string} text the text to execute/evaluate. */ req.exec = function (text) { /*jslint evil: true */ diff --git a/packages/engine/Source/WorkersES6/createTaskProcessorWorker.js b/packages/engine/Source/WorkersES6/createTaskProcessorWorker.js index 723214f6722a..93f201dd4d18 100644 --- a/packages/engine/Source/WorkersES6/createTaskProcessorWorker.js +++ b/packages/engine/Source/WorkersES6/createTaskProcessorWorker.js @@ -100,10 +100,10 @@ function createTaskProcessorWorker(workerFunction) { * A function that performs a calculation in a Web Worker. * @callback createTaskProcessorWorker.WorkerFunction * - * @param {Object} parameters Parameters to the calculation. + * @param {object} parameters Parameters to the calculation. * @param {Array} transferableObjects An array that should be filled with references to objects inside * the result that should be transferred back to the main document instead of copied. - * @returns {Object} The result of the calculation. + * @returns {object} The result of the calculation. * * @example * function calculate(parameters, transferableObjects) { @@ -124,6 +124,6 @@ function createTaskProcessorWorker(workerFunction) { * specifically, task ID management and posting a response message containing the result. * @callback createTaskProcessorWorker.TaskProcessorWorkerFunction * - * @param {Object} event The onmessage event object. + * @param {object} event The onmessage event object. */ export default createTaskProcessorWorker; diff --git a/packages/engine/Specs/Core/requestAnimationFrameSpec.js b/packages/engine/Specs/Core/requestAnimationFrameSpec.js deleted file mode 100644 index 9519495c4e7d..000000000000 --- a/packages/engine/Specs/Core/requestAnimationFrameSpec.js +++ /dev/null @@ -1,50 +0,0 @@ -import { cancelAnimationFrame, requestAnimationFrame } from "../../index.js"; - -describe("Core/requestAnimationFrame", function () { - it("calls the callback", function () { - const promise = new Promise(requestAnimationFrame); - return promise.then(function (requestId) { - expect(requestId).toBeDefined(); - }); - }); - - it("provides a timestamp that increases each frame", function () { - return new Promise((resolve) => { - const callbackTimestamps = []; - - function callback(timestamp) { - callbackTimestamps.push(timestamp); - - if (callbackTimestamps.length < 3) { - requestAnimationFrame(callback); - } else { - expect(callbackTimestamps[0]).toBeLessThanOrEqual( - callbackTimestamps[1] - ); - expect(callbackTimestamps[1]).toBeLessThanOrEqual( - callbackTimestamps[2] - ); - resolve(); - } - } - - requestAnimationFrame(callback); - }); - }); - - it("can cancel a callback", function () { - return new Promise((resolve) => { - const shouldNotBeCalled = jasmine.createSpy("shouldNotBeCalled"); - - const requestID = requestAnimationFrame(shouldNotBeCalled); - cancelAnimationFrame(requestID); - - // schedule and wait for another callback - requestAnimationFrame(function () { - // make sure cancelled callback didn't run - expect(shouldNotBeCalled).not.toHaveBeenCalled(); - resolve(); - }); - }); - }); -}); diff --git a/packages/engine/Specs/Scene/ImageryLayerCollectionSpec.js b/packages/engine/Specs/Scene/ImageryLayerCollectionSpec.js index e0a90dfc689e..a1c4c2d8a638 100644 --- a/packages/engine/Specs/Scene/ImageryLayerCollectionSpec.js +++ b/packages/engine/Specs/Scene/ImageryLayerCollectionSpec.js @@ -266,7 +266,7 @@ describe( * * @param {Ray} ray The ray to test for intersection. * @param {Scene} scene The scene. - * @return {Promise.} + * @return {Promise} * * @private * diff --git a/packages/engine/Specs/Scene/ImplicitTileCoordinatesSpec.js b/packages/engine/Specs/Scene/ImplicitTileCoordinatesSpec.js index 59389097a5f8..30d5c1e04f83 100644 --- a/packages/engine/Specs/Scene/ImplicitTileCoordinatesSpec.js +++ b/packages/engine/Specs/Scene/ImplicitTileCoordinatesSpec.js @@ -7,10 +7,10 @@ import { describe("Scene/ImplicitTileCoordinates", function () { /** * Helper function for creating quadtree implicit tile coordinates - * @param {Number} level - * @param {Number} x - * @param {Number} y - * @param {Number} [subtreeLevels=2] + * @param {number} level + * @param {number} x + * @param {number} y + * @param {number} [subtreeLevels=2] * @returns {ImplicitTileCoordinates} */ function quadtreeCoordinates(level, x, y, subtreeLevels) { @@ -25,11 +25,11 @@ describe("Scene/ImplicitTileCoordinates", function () { /** * Helper function for creating octree implicit tile coordinates - * @param {Number} level - * @param {Number} x - * @param {Number} y - * @param {Number} z - * @param {Number} [subtreeLevels=2] + * @param {number} level + * @param {number} x + * @param {number} y + * @param {number} z + * @param {number} [subtreeLevels=2] * @returns {ImplicitTileCoordinates} */ function octreeCoordinates(level, x, y, z, subtreeLevels) { diff --git a/packages/widgets/Source/Animation/Animation.js b/packages/widgets/Source/Animation/Animation.js index 3e1b2293eb83..5d2990993a0b 100644 --- a/packages/widgets/Source/Animation/Animation.js +++ b/packages/widgets/Source/Animation/Animation.js @@ -409,7 +409,7 @@ SvgButton.prototype.setTooltip = function (tooltip) { * @alias Animation * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {AnimationViewModel} viewModel The view model used by this widget. * * @exception {DeveloperError} Element with id "container" does not exist in the document. @@ -736,7 +736,7 @@ Object.defineProperties(Animation.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ Animation.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/Animation/AnimationViewModel.js b/packages/widgets/Source/Animation/AnimationViewModel.js index 76364d3b2fc0..864b0bc51e6f 100644 --- a/packages/widgets/Source/Animation/AnimationViewModel.js +++ b/packages/widgets/Source/Animation/AnimationViewModel.js @@ -116,7 +116,7 @@ function AnimationViewModel(clockViewModel) { /** * Gets or sets whether the shuttle ring is currently being dragged. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.shuttleRingDragging = false; @@ -125,7 +125,7 @@ function AnimationViewModel(clockViewModel) { * Gets or sets whether dragging the shuttle ring should cause the multiplier * to snap to the defined tick values rather than interpolating between them. * This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.snapToTicks = false; @@ -144,7 +144,7 @@ function AnimationViewModel(clockViewModel) { /** * Gets the string representation of the current time. This property is observable. - * @type {String} + * @type {string} */ this.timeLabel = undefined; knockout.defineProperty(this, "timeLabel", function () { @@ -153,7 +153,7 @@ function AnimationViewModel(clockViewModel) { /** * Gets the string representation of the current date. This property is observable. - * @type {String} + * @type {string} */ this.dateLabel = undefined; knockout.defineProperty(this, "dateLabel", function () { @@ -162,7 +162,7 @@ function AnimationViewModel(clockViewModel) { /** * Gets the string representation of the current multiplier. This property is observable. - * @type {String} + * @type {string} */ this.multiplierLabel = undefined; knockout.defineProperty(this, "multiplierLabel", function () { @@ -184,7 +184,7 @@ function AnimationViewModel(clockViewModel) { /** * Gets or sets the current shuttle ring angle. This property is observable. - * @type {Number} + * @type {number} */ this.shuttleRingAngle = undefined; knockout.defineProperty(this, "shuttleRingAngle", { @@ -393,7 +393,7 @@ AnimationViewModel.defaultDateFormatter = function (date, viewModel) { /** * Gets or sets the default array of known clock multipliers associated with new instances of the shuttle ring. - * @type {Number[]} + * @type {number[]} */ AnimationViewModel.defaultTicks = [ // @@ -457,7 +457,7 @@ AnimationViewModel.defaultTimeFormatter = function (date, viewModel) { /** * Gets a copy of the array of positive known clock multipliers to associate with the shuttle ring. * - * @returns {Number[]} The array of known clock multipliers associated with the shuttle ring. + * @returns {number[]} The array of known clock multipliers associated with the shuttle ring. */ AnimationViewModel.prototype.getShuttleRingTicks = function () { return this._sortedFilteredPositiveTicks.slice(0); @@ -470,7 +470,7 @@ AnimationViewModel.prototype.getShuttleRingTicks = function () { * to when a single click is made. The values need not be in order, as they will be sorted * automatically, and duplicate values will be removed. * - * @param {Number[]} positiveTicks The list of known positive clock multipliers to associate with the shuttle ring. + * @param {number[]} positiveTicks The list of known positive clock multipliers to associate with the shuttle ring. */ AnimationViewModel.prototype.setShuttleRingTicks = function (positiveTicks) { //>>includeStart('debug', pragmas.debug); @@ -648,7 +648,7 @@ AnimationViewModel._realtimeShuttleRingAngle = realtimeShuttleRingAngle; * * @param {JulianDate} date The date to be formatted * @param {AnimationViewModel} viewModel The AnimationViewModel instance requesting formatting. - * @returns {String} The string representation of the calendar date portion of the provided date. + * @returns {string} The string representation of the calendar date portion of the provided date. */ /** @@ -657,6 +657,6 @@ AnimationViewModel._realtimeShuttleRingAngle = realtimeShuttleRingAngle; * * @param {JulianDate} date The date to be formatted * @param {AnimationViewModel} viewModel The AnimationViewModel instance requesting formatting. - * @returns {String} The string representation of the time portion of the provided date. + * @returns {string} The string representation of the time portion of the provided date. */ export default AnimationViewModel; diff --git a/packages/widgets/Source/BaseLayerPicker/BaseLayerPicker.js b/packages/widgets/Source/BaseLayerPicker/BaseLayerPicker.js index efae36d6ac9b..80d145593e40 100644 --- a/packages/widgets/Source/BaseLayerPicker/BaseLayerPicker.js +++ b/packages/widgets/Source/BaseLayerPicker/BaseLayerPicker.js @@ -24,8 +24,8 @@ import BaseLayerPickerViewModel from "./BaseLayerPickerViewModel.js"; * @alias BaseLayerPicker * @constructor * - * @param {Element|String} container The parent HTML container node or ID for this widget. - * @param {Object} options Object with the following properties: + * @param {Element|string} container The parent HTML container node or ID for this widget. + * @param {object} options Object with the following properties: * @param {Globe} options.globe The Globe to use. * @param {ProviderViewModel[]} [options.imageryProviderViewModels=[]] The array of ProviderViewModel instances to use for imagery. * @param {ProviderViewModel} [options.selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available imagery layer is used. @@ -282,7 +282,7 @@ Object.defineProperties(BaseLayerPicker.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ BaseLayerPicker.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/BaseLayerPicker/BaseLayerPickerViewModel.js b/packages/widgets/Source/BaseLayerPicker/BaseLayerPickerViewModel.js index fbb4c6fad45a..220b1af4217c 100644 --- a/packages/widgets/Source/BaseLayerPicker/BaseLayerPickerViewModel.js +++ b/packages/widgets/Source/BaseLayerPicker/BaseLayerPickerViewModel.js @@ -12,7 +12,7 @@ import createCommand from "../createCommand.js"; * @alias BaseLayerPickerViewModel * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Globe} options.globe The Globe to use. * @param {ProviderViewModel[]} [options.imageryProviderViewModels=[]] The array of ProviderViewModel instances to use for imagery. * @param {ProviderViewModel} [options.selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available imagery layer is used. @@ -59,7 +59,7 @@ function BaseLayerPickerViewModel(options) { /** * Gets or sets whether the imagery selection drop-down is currently visible. - * @type {Boolean} + * @type {boolean} * @default false */ this.dropDownVisible = false; @@ -134,7 +134,7 @@ function BaseLayerPickerViewModel(options) { /** * Gets the button tooltip. This property is observable. - * @type {String} + * @type {string} */ this.buttonTooltip = undefined; knockout.defineProperty(this, "buttonTooltip", function () { @@ -158,7 +158,7 @@ function BaseLayerPickerViewModel(options) { /** * Gets the button background image. This property is observable. - * @type {String} + * @type {string} */ this.buttonImageUrl = undefined; knockout.defineProperty(this, "buttonImageUrl", function () { diff --git a/packages/widgets/Source/BaseLayerPicker/ProviderViewModel.js b/packages/widgets/Source/BaseLayerPicker/ProviderViewModel.js index 8e480dc4a621..5d8178cfb6d1 100644 --- a/packages/widgets/Source/BaseLayerPicker/ProviderViewModel.js +++ b/packages/widgets/Source/BaseLayerPicker/ProviderViewModel.js @@ -8,11 +8,11 @@ import createCommand from "../createCommand.js"; * @alias ProviderViewModel * @constructor * - * @param {Object} options The object containing all parameters. - * @param {String} options.name The name of the layer. - * @param {String} options.tooltip The tooltip to show when the item is moused over. - * @param {String} options.iconUrl An icon representing the layer. - * @param {String} [options.category] A category for the layer. + * @param {object} options The object containing all parameters. + * @param {string} options.name The name of the layer. + * @param {string} options.tooltip The tooltip to show when the item is moused over. + * @param {string} options.iconUrl An icon representing the layer. + * @param {string} [options.category] A category for the layer. * @param {ProviderViewModel.CreationFunction|Command} options.creationFunction A function or Command * that creates one or more providers which will be added to the globe when this item is selected. * @@ -45,19 +45,19 @@ function ProviderViewModel(options) { /** * Gets the display name. This property is observable. - * @type {String} + * @type {string} */ this.name = options.name; /** * Gets the tooltip. This property is observable. - * @type {String} + * @type {string} */ this.tooltip = options.tooltip; /** * Gets the icon. This property is observable. - * @type {String} + * @type {string} */ this.iconUrl = options.iconUrl; @@ -83,7 +83,7 @@ Object.defineProperties(ProviderViewModel.prototype, { /** * Gets the category - * @type {String} + * @type {string} * @memberof ProviderViewModel.prototype * @readonly */ diff --git a/packages/widgets/Source/Cesium3DTilesInspector/Cesium3DTilesInspector.js b/packages/widgets/Source/Cesium3DTilesInspector/Cesium3DTilesInspector.js index 41733257ff75..a88bb400ae96 100644 --- a/packages/widgets/Source/Cesium3DTilesInspector/Cesium3DTilesInspector.js +++ b/packages/widgets/Source/Cesium3DTilesInspector/Cesium3DTilesInspector.js @@ -9,7 +9,7 @@ import Cesium3DTilesInspectorViewModel from "./Cesium3DTilesInspectorViewModel.j * @alias Cesium3DTilesInspector * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {Scene} scene the Scene instance to use. */ function Cesium3DTilesInspector(container, scene) { @@ -360,7 +360,7 @@ Object.defineProperties(Cesium3DTilesInspector.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ Cesium3DTilesInspector.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/Cesium3DTilesInspector/Cesium3DTilesInspectorViewModel.js b/packages/widgets/Source/Cesium3DTilesInspector/Cesium3DTilesInspectorViewModel.js index 80027edd9843..60c337fc9b7d 100644 --- a/packages/widgets/Source/Cesium3DTilesInspector/Cesium3DTilesInspectorViewModel.js +++ b/packages/widgets/Source/Cesium3DTilesInspector/Cesium3DTilesInspectorViewModel.js @@ -192,7 +192,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to enable performance display. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.performance = false; @@ -200,7 +200,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show statistics. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default true */ this.showStatistics = true; @@ -208,7 +208,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show pick statistics. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default true */ this.showPickStatistics = true; @@ -217,7 +217,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { * Gets or sets the flag to show resource cache statistics. This property is * observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.showResourceCacheStatistics = false; @@ -225,7 +225,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show the inspector. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default true */ this.inspectorVisible = true; @@ -233,7 +233,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show the tileset section. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.tilesetVisible = false; @@ -241,7 +241,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show the display section. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.displayVisible = false; @@ -249,7 +249,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show the update section. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.updateVisible = false; @@ -257,7 +257,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show the logging section. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.loggingVisible = false; @@ -265,7 +265,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show the style section. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.styleVisible = false; @@ -273,7 +273,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show the tile info section. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.tileDebugLabelsVisible = false; @@ -281,7 +281,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show the optimization info section. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false; */ this.optimizationVisible = false; @@ -289,7 +289,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the JSON for the tileset style. This property is observable. * - * @type {String} + * @type {string} * @default '{}' */ this.styleString = "{}"; @@ -297,7 +297,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the JSON for the tileset enableDebugWireframe attribute. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.hasEnabledWireframe = false; @@ -333,7 +333,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { this._properties = knockout.observable({}); /** * Gets the names of the properties in the tileset. This property is observable. - * @type {String[]} + * @type {string[]} * @readonly */ this.properties = []; @@ -363,7 +363,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to enable dynamic screen space error. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.dynamicScreenSpaceError = false; @@ -444,7 +444,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to enable picking. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default true */ this.picking = true; @@ -465,7 +465,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to colorize tiles. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.colorize = false; @@ -486,7 +486,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to draw with wireframe. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.wireframe = false; @@ -507,7 +507,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show bounding volumes. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.showBoundingVolumes = false; @@ -528,7 +528,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show content volumes. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.showContentBoundingVolumes = false; @@ -549,7 +549,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show request volumes. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.showRequestVolumes = false; @@ -571,7 +571,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to suspend updates. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.freezeFrame = false; @@ -591,7 +591,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show debug labels only for the currently picked tile. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.showOnlyPickedTileDebugLabel = false; @@ -612,7 +612,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show tile geometric error. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.showGeometricError = false; @@ -633,7 +633,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Displays the number of commands, points, triangles and features used per tile. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.showRenderingStatistics = false; @@ -654,7 +654,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Displays the memory used per tile. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.showMemoryUsage = false; @@ -675,7 +675,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to show the tile url. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.showUrl = false; @@ -698,7 +698,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the maximum screen space error. This property is observable. * - * @type {Number} + * @type {number} * @default 16 */ this.maximumScreenSpaceError = 16; @@ -721,7 +721,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the dynamic screen space error density. This property is observable. * - * @type {Number} + * @type {number} * @default 0.00278 */ this.dynamicScreenSpaceErrorDensity = 0.00278; @@ -731,7 +731,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { * This allows the slider to be exponential because values tend to be closer to 0 than 1. * This property is observable. * - * @type {Number} + * @type {number} * @default 0.00278 */ this.dynamicScreenSpaceErrorDensitySliderValue = undefined; @@ -762,7 +762,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the dynamic screen space error factor. This property is observable. * - * @type {Number} + * @type {number} * @default 4.0 */ this.dynamicScreenSpaceErrorFactor = 4.0; @@ -801,7 +801,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to enable point cloud shading. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.pointCloudShading = false; @@ -824,7 +824,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the geometric error scale. This property is observable. * - * @type {Number} + * @type {number} * @default 1.0 */ this.geometricErrorScale = 1.0; @@ -848,7 +848,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the maximum attenuation. This property is observable. * - * @type {Number} + * @type {number} * @default 0 */ this.maximumAttenuation = 0; @@ -872,7 +872,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the base resolution. This property is observable. * - * @type {Number} + * @type {number} * @default 0 */ this.baseResolution = 0; @@ -892,7 +892,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to enable eye dome lighting. This property is observable. * - * @type {Boolean} + * @type {boolean} * @default false */ this.eyeDomeLighting = false; @@ -915,7 +915,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the eye dome lighting strength. This property is observable. * - * @type {Number} + * @type {number} * @default 1.0 */ this.eyeDomeLightingStrength = 1.0; @@ -938,7 +938,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the eye dome lighting radius. This property is observable. * - * @type {Number} + * @type {number} * @default 1.0 */ this.eyeDomeLightingRadius = 1.0; @@ -946,7 +946,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the pick state * - * @type {Boolean} + * @type {boolean} * @default false */ this.pickActive = false; @@ -966,7 +966,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag to determine if level of detail skipping should be applied during the traversal. * This property is observable. - * @type {Boolean} + * @type {boolean} * @default true */ this.skipLevelOfDetail = true; @@ -988,7 +988,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { }); /** * Gets or sets the multiplier defining the minimum screen space error to skip. This property is observable. - * @type {Number} + * @type {number} * @default 16 */ this.skipScreenSpaceErrorFactor = 16; @@ -1010,7 +1010,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { }); /** * Gets or sets the screen space error that must be reached before skipping levels of detail. This property is observable. - * @type {Number} + * @type {number} * @default 1024 */ this.baseScreenSpaceError = 1024; @@ -1032,7 +1032,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { }); /** * Gets or sets the constant defining the minimum number of levels to skip when loading tiles. This property is observable. - * @type {Number} + * @type {number} * @default 1 */ this.skipLevels = 1; @@ -1052,7 +1052,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag which, when true, only tiles that meet the maximum screen space error will ever be downloaded. * This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.immediatelyLoadDesiredLevelOfDetail = false; @@ -1072,7 +1072,7 @@ function Cesium3DTilesInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the flag which determines whether siblings of visible tiles are always downloaded during traversal. * This property is observable - * @type {Boolean} + * @type {boolean} * @default false */ this.loadSiblings = false; @@ -1150,7 +1150,7 @@ Object.defineProperties(Cesium3DTilesInspectorViewModel.prototype, { /** * Gets the statistics text. This property is observable. * @memberof Cesium3DTilesInspectorViewModel.prototype - * @type {String} + * @type {string} * @readonly */ statisticsText: { @@ -1161,7 +1161,7 @@ Object.defineProperties(Cesium3DTilesInspectorViewModel.prototype, { /** * Gets the pick statistics text. This property is observable. * @memberof Cesium3DTilesInspectorViewModel.prototype - * @type {String} + * @type {string} * @readonly */ pickStatisticsText: { @@ -1173,7 +1173,7 @@ Object.defineProperties(Cesium3DTilesInspectorViewModel.prototype, { /** * Gets the resource cache statistics text. This property is observable. * @memberof Cesium3DTilesInspectorViewModel.prototype - * @type {String} + * @type {string} * @readonly */ resourceCacheStatisticsText: { @@ -1197,7 +1197,7 @@ Object.defineProperties(Cesium3DTilesInspectorViewModel.prototype, { /** * Gets the editor error message * @memberof Cesium3DTilesInspectorViewModel.prototype - * @type {String} + * @type {string} * @readonly */ editorError: { @@ -1569,7 +1569,7 @@ Cesium3DTilesInspectorViewModel.prototype._update = function () { }; /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ Cesium3DTilesInspectorViewModel.prototype.isDestroyed = function () { return false; @@ -1596,8 +1596,8 @@ Cesium3DTilesInspectorViewModel.prototype.destroy = function () { * * @function * @param {Cesium3DTileset} tileset The tileset - * @param {Boolean} isPick Whether this is getting the statistics for the pick pass - * @returns {String} The formatted statistics + * @param {boolean} isPick Whether this is getting the statistics for the pick pass + * @returns {string} The formatted statistics */ Cesium3DTilesInspectorViewModel.getStatistics = getStatistics; export default Cesium3DTilesInspectorViewModel; diff --git a/packages/widgets/Source/CesiumInspector/CesiumInspector.js b/packages/widgets/Source/CesiumInspector/CesiumInspector.js index 9152cfd3a8d2..54129b654178 100644 --- a/packages/widgets/Source/CesiumInspector/CesiumInspector.js +++ b/packages/widgets/Source/CesiumInspector/CesiumInspector.js @@ -14,7 +14,7 @@ import CesiumInspectorViewModel from "./CesiumInspectorViewModel.js"; * @alias CesiumInspector * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {Scene} scene The Scene instance to use. * * @demo {@link https://sandcastle.cesium.com/index.html?src=Cesium%20Inspector.html|Cesium Sandcastle Cesium Inspector Demo} @@ -303,7 +303,7 @@ Object.defineProperties(CesiumInspector.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ CesiumInspector.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/CesiumInspector/CesiumInspectorViewModel.js b/packages/widgets/Source/CesiumInspector/CesiumInspectorViewModel.js index 70d59afed3d3..25eb458a661d 100644 --- a/packages/widgets/Source/CesiumInspector/CesiumInspectorViewModel.js +++ b/packages/widgets/Source/CesiumInspector/CesiumInspectorViewModel.js @@ -90,77 +90,77 @@ function CesiumInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the show frustums state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.frustums = false; /** * Gets or sets the show frustum planes state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.frustumPlanes = false; /** * Gets or sets the show performance display state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.performance = false; /** * Gets or sets the shader cache text. This property is observable. - * @type {String} + * @type {string} * @default '' */ this.shaderCacheText = ""; /** * Gets or sets the show primitive bounding sphere state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.primitiveBoundingSphere = false; /** * Gets or sets the show primitive reference frame state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.primitiveReferenceFrame = false; /** * Gets or sets the filter primitive state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.filterPrimitive = false; /** * Gets or sets the show tile bounding sphere state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.tileBoundingSphere = false; /** * Gets or sets the filter tile state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.filterTile = false; /** * Gets or sets the show wireframe state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.wireframe = false; /** * Gets or sets the index of the depth frustum to display. This property is observable. - * @type {Number} + * @type {number} * @default 1 */ this.depthFrustum = 1; @@ -168,91 +168,91 @@ function CesiumInspectorViewModel(scene, performanceContainer) { /** * Gets or sets the suspend updates state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.suspendUpdates = false; /** * Gets or sets the show tile coordinates state. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.tileCoordinates = false; /** * Gets or sets the frustum statistic text. This property is observable. - * @type {String} + * @type {string} * @default '' */ this.frustumStatisticText = false; /** * Gets or sets the selected tile information text. This property is observable. - * @type {String} + * @type {string} * @default '' */ this.tileText = ""; /** * Gets if a primitive has been selected. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.hasPickedPrimitive = false; /** * Gets if a tile has been selected. This property is observable - * @type {Boolean} + * @type {boolean} * @default false */ this.hasPickedTile = false; /** * Gets if the picking primitive command is active. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.pickPrimitiveActive = false; /** * Gets if the picking tile command is active. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.pickTileActive = false; /** * Gets or sets if the cesium inspector drop down is visible. This property is observable. - * @type {Boolean} + * @type {boolean} * @default true */ this.dropDownVisible = true; /** * Gets or sets if the general section is visible. This property is observable. - * @type {Boolean} + * @type {boolean} * @default true */ this.generalVisible = true; /** * Gets or sets if the primitive section is visible. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.primitivesVisible = false; /** * Gets or sets if the terrain section is visible. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.terrainVisible = false; /** * Gets or sets the index of the depth frustum text. This property is observable. - * @type {String} + * @type {string} * @default '' */ this.depthFrustumText = ""; @@ -948,7 +948,7 @@ CesiumInspectorViewModel.prototype._update = function () { }; /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ CesiumInspectorViewModel.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/ClockViewModel.js b/packages/widgets/Source/ClockViewModel.js index b6f056857258..01a7e7e821a3 100644 --- a/packages/widgets/Source/ClockViewModel.js +++ b/packages/widgets/Source/ClockViewModel.js @@ -76,7 +76,7 @@ function ClockViewModel(clock) { * Gets or sets the clock multiplier. * See {@link Clock#multiplier}. * This property is observable. - * @type {Number} + * @type {number} */ this.multiplier = knockout.observable(clock.multiplier); this.multiplier.subscribe(function (value) { @@ -112,7 +112,7 @@ function ClockViewModel(clock) { * Gets or sets whether the clock can animate. * See {@link Clock#canAnimate}. * This property is observable. - * @type {Boolean} + * @type {boolean} */ this.canAnimate = knockout.observable(clock.canAnimate); this.canAnimate.subscribe(function (value) { @@ -124,7 +124,7 @@ function ClockViewModel(clock) { * Gets or sets whether the clock should animate. * See {@link Clock#shouldAnimate}. * This property is observable. - * @type {Boolean} + * @type {boolean} */ this.shouldAnimate = knockout.observable(clock.shouldAnimate); this.shouldAnimate.subscribe(function (value) { @@ -178,7 +178,7 @@ ClockViewModel.prototype.synchronize = function () { }; /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ ClockViewModel.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/Command.js b/packages/widgets/Source/Command.js index 9a41c4fc4c18..67b235125d12 100644 --- a/packages/widgets/Source/Command.js +++ b/packages/widgets/Source/Command.js @@ -14,7 +14,7 @@ import { DeveloperError } from "@cesium/engine"; function Command() { /** * Gets whether this command can currently be executed. This property is observable. - * @type {Boolean} + * @type {boolean} * @default undefined */ this.canExecute = undefined; diff --git a/packages/widgets/Source/FullscreenButton/FullscreenButton.js b/packages/widgets/Source/FullscreenButton/FullscreenButton.js index 28c720d0c11b..4dd5a677ae76 100644 --- a/packages/widgets/Source/FullscreenButton/FullscreenButton.js +++ b/packages/widgets/Source/FullscreenButton/FullscreenButton.js @@ -18,8 +18,8 @@ const exitFullScreenPath = * @alias FullscreenButton * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. - * @param {Element|String} [fullscreenElement=document.body] The element or id to be placed into fullscreen mode. + * @param {Element|string} container The DOM element or ID that will contain the widget. + * @param {Element|string} [fullscreenElement=document.body] The element or id to be placed into fullscreen mode. * * @exception {DeveloperError} Element with id "container" does not exist in the document. * @@ -87,7 +87,7 @@ Object.defineProperties(FullscreenButton.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ FullscreenButton.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/FullscreenButton/FullscreenButtonViewModel.js b/packages/widgets/Source/FullscreenButton/FullscreenButtonViewModel.js index 7456f140f5b3..15e01ec5ba1f 100644 --- a/packages/widgets/Source/FullscreenButton/FullscreenButtonViewModel.js +++ b/packages/widgets/Source/FullscreenButton/FullscreenButtonViewModel.js @@ -14,8 +14,8 @@ import createCommand from "../createCommand.js"; * @alias FullscreenButtonViewModel * @constructor * - * @param {Element|String} [fullscreenElement=document.body] The element or id to be placed into fullscreen mode. - * @param {Element|String} [container] The DOM element or ID that will contain the widget. + * @param {Element|string} [fullscreenElement=document.body] The element or id to be placed into fullscreen mode. + * @param {Element|string} [container] The DOM element or ID that will contain the widget. */ function FullscreenButtonViewModel(fullscreenElement, container) { if (!defined(container)) { @@ -33,7 +33,7 @@ function FullscreenButtonViewModel(fullscreenElement, container) { /** * Gets whether or not fullscreen mode is active. This property is observable. * - * @type {Boolean} + * @type {boolean} */ this.isFullscreen = undefined; knockout.defineProperty(this, "isFullscreen", { @@ -45,7 +45,7 @@ function FullscreenButtonViewModel(fullscreenElement, container) { /** * Gets or sets whether or not fullscreen functionality should be enabled. This property is observable. * - * @type {Boolean} + * @type {boolean} * @see Fullscreen.enabled */ this.isFullscreenEnabled = undefined; @@ -61,7 +61,7 @@ function FullscreenButtonViewModel(fullscreenElement, container) { /** * Gets the tooltip. This property is observable. * - * @type {String} + * @type {string} */ this.tooltip = undefined; knockout.defineProperty(this, "tooltip", function () { @@ -128,7 +128,7 @@ Object.defineProperties(FullscreenButtonViewModel.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ FullscreenButtonViewModel.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/Geocoder/Geocoder.js b/packages/widgets/Source/Geocoder/Geocoder.js index 8ab416a9c949..f6ab8080ea31 100644 --- a/packages/widgets/Source/Geocoder/Geocoder.js +++ b/packages/widgets/Source/Geocoder/Geocoder.js @@ -20,12 +20,12 @@ const stopSearchPath = * @alias Geocoder * @constructor * - * @param {Object} options Object with the following properties: - * @param {Element|String} options.container The DOM element or ID that will contain the widget. + * @param {object} options Object with the following properties: + * @param {Element|string} options.container The DOM element or ID that will contain the widget. * @param {Scene} options.scene The Scene instance to use. * @param {GeocoderService[]} [options.geocoderServices] The geocoder services to be used - * @param {Boolean} [options.autoComplete = true] True if the geocoder should query as the user types to autocomplete - * @param {Number} [options.flightDuration=1.5] The duration of the camera flight to an entered location, in seconds. + * @param {boolean} [options.autoComplete = true] True if the geocoder should query as the user types to autocomplete + * @param {number} [options.flightDuration=1.5] The duration of the camera flight to an entered location, in seconds. * @param {Geocoder.DestinationFoundFunction} [options.destinationFound=GeocoderViewModel.flyToDestination] A callback function that is called after a successful geocode. If not supplied, the default behavior is to fly the camera to the result destination. */ function Geocoder(options) { @@ -193,7 +193,7 @@ Object.defineProperties(Geocoder.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ Geocoder.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/Geocoder/GeocoderViewModel.js b/packages/widgets/Source/Geocoder/GeocoderViewModel.js index 61a22235a6f3..23cdc521cfd1 100644 --- a/packages/widgets/Source/Geocoder/GeocoderViewModel.js +++ b/packages/widgets/Source/Geocoder/GeocoderViewModel.js @@ -24,12 +24,12 @@ const DEFAULT_HEIGHT = 1000; * @alias GeocoderViewModel * @constructor * - * @param {Object} options Object with the following properties: + * @param {object} options Object with the following properties: * @param {Scene} options.scene The Scene instance to use. * @param {GeocoderService[]} [options.geocoderServices] Geocoder services to use for geocoding queries. * If more than one are supplied, suggestions will be gathered for the geocoders that support it, * and if no suggestion is selected the result from the first geocoder service wil be used. - * @param {Number} [options.flightDuration] The duration of the camera flight to an entered location, in seconds. + * @param {number} [options.flightDuration] The duration of the camera flight to an entered location, in seconds. * @param {Geocoder.DestinationFoundFunction} [options.destinationFound=GeocoderViewModel.flyToDestination] A callback function that is called after a successful geocode. If not supplied, the default behavior is to fly the camera to the result destination. */ function GeocoderViewModel(options) { @@ -144,14 +144,14 @@ function GeocoderViewModel(options) { /** * Gets or sets a value indicating if this instance should always show its text input field. * - * @type {Boolean} + * @type {boolean} * @default false */ this.keepExpanded = false; /** * True if the geocoder should query as the user types to autocomplete - * @type {Boolean} + * @type {boolean} * @default true */ this.autoComplete = defaultValue(options.autocomplete, true); @@ -185,7 +185,7 @@ function GeocoderViewModel(options) { /** * Gets a value indicating whether a search is currently in progress. This property is observable. * - * @type {Boolean} + * @type {boolean} */ this.isSearchInProgress = undefined; knockout.defineProperty(this, "isSearchInProgress", { @@ -198,7 +198,7 @@ function GeocoderViewModel(options) { * Gets or sets the text to search for. The text can be an address, or longitude, latitude, * and optional height, where longitude and latitude are in degrees and height is in meters. * - * @type {String} + * @type {string} */ this.searchText = undefined; knockout.defineProperty(this, "searchText", { @@ -224,7 +224,7 @@ function GeocoderViewModel(options) { * A value of zero causes the camera to instantly switch to the geocoding location. * The duration will be computed based on the distance when undefined. * - * @type {Number|undefined} + * @type {number|undefined} * @default undefined */ this.flightDuration = undefined; @@ -285,7 +285,7 @@ Object.defineProperties(GeocoderViewModel.prototype, { * Gets the currently selected geocoder search suggestion * @memberof GeocoderViewModel.prototype * - * @type {Object} + * @type {object} */ selectedSuggestion: { get: function () { diff --git a/packages/widgets/Source/HomeButton/HomeButton.js b/packages/widgets/Source/HomeButton/HomeButton.js index 63836aa8815f..342a7d8ab932 100644 --- a/packages/widgets/Source/HomeButton/HomeButton.js +++ b/packages/widgets/Source/HomeButton/HomeButton.js @@ -13,9 +13,9 @@ import HomeButtonViewModel from "./HomeButtonViewModel.js"; * @alias HomeButton * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {Scene} scene The Scene instance to use. - * @param {Number} [duration] The time, in seconds, it takes to complete the camera flight home. + * @param {number} [duration] The time, in seconds, it takes to complete the camera flight home. */ function HomeButton(container, scene, duration) { //>>includeStart('debug', pragmas.debug); @@ -78,7 +78,7 @@ Object.defineProperties(HomeButton.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ HomeButton.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/HomeButton/HomeButtonViewModel.js b/packages/widgets/Source/HomeButton/HomeButtonViewModel.js index b1688ca05d5b..ba030c366078 100644 --- a/packages/widgets/Source/HomeButton/HomeButtonViewModel.js +++ b/packages/widgets/Source/HomeButton/HomeButtonViewModel.js @@ -8,7 +8,7 @@ import createCommand from "../createCommand.js"; * @constructor * * @param {Scene} scene The scene instance to use. - * @param {Number} [duration] The duration of the camera flight in seconds. + * @param {number} [duration] The duration of the camera flight in seconds. */ function HomeButtonViewModel(scene, duration) { //>>includeStart('debug', pragmas.debug); @@ -28,7 +28,7 @@ function HomeButtonViewModel(scene, duration) { /** * Gets or sets the tooltip. This property is observable. * - * @type {String} + * @type {string} */ this.tooltip = "View Home"; @@ -66,7 +66,7 @@ Object.defineProperties(HomeButtonViewModel.prototype, { * The duration will be computed based on the distance when undefined. * @memberof HomeButtonViewModel.prototype * - * @type {Number|undefined} + * @type {number|undefined} */ duration: { get: function () { diff --git a/packages/widgets/Source/InfoBox/InfoBox.js b/packages/widgets/Source/InfoBox/InfoBox.js index e865ba9615a3..82dda94f90c8 100644 --- a/packages/widgets/Source/InfoBox/InfoBox.js +++ b/packages/widgets/Source/InfoBox/InfoBox.js @@ -16,7 +16,7 @@ import InfoBoxViewModel from "./InfoBoxViewModel.js"; * @alias InfoBox * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * * @exception {DeveloperError} Element with id "container" does not exist in the document. */ @@ -185,7 +185,7 @@ Object.defineProperties(InfoBox.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ InfoBox.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/InfoBox/InfoBoxViewModel.js b/packages/widgets/Source/InfoBox/InfoBoxViewModel.js index f78a97a0e093..21603e73e896 100644 --- a/packages/widgets/Source/InfoBox/InfoBoxViewModel.js +++ b/packages/widgets/Source/InfoBox/InfoBoxViewModel.js @@ -17,37 +17,37 @@ function InfoBoxViewModel() { /** * Gets or sets the maximum height of the info box in pixels. This property is observable. - * @type {Number} + * @type {number} */ this.maxHeight = 500; /** * Gets or sets whether the camera tracking icon is enabled. - * @type {Boolean} + * @type {boolean} */ this.enableCamera = false; /** * Gets or sets the status of current camera tracking of the selected object. - * @type {Boolean} + * @type {boolean} */ this.isCameraTracking = false; /** * Gets or sets the visibility of the info box. - * @type {Boolean} + * @type {boolean} */ this.showInfo = false; /** * Gets or sets the title text in the info box. - * @type {String} + * @type {string} */ this.titleText = ""; /** * Gets or sets the description HTML for the info box. - * @type {String} + * @type {string} */ this.description = ""; @@ -65,7 +65,7 @@ function InfoBoxViewModel() { /** * Gets the SVG path of the camera icon, which can change to be "crossed out" or not. - * @type {String} + * @type {string} */ this.cameraIconPath = undefined; knockout.defineProperty(this, "cameraIconPath", { @@ -85,8 +85,8 @@ function InfoBoxViewModel() { /** * Gets the maximum height of sections within the info box, minus an offset, in CSS-ready form. - * @param {Number} offset The offset in pixels. - * @returns {String} + * @param {number} offset The offset in pixels. + * @returns {string} */ InfoBoxViewModel.prototype.maxHeightOffset = function (offset) { return `${this.maxHeight - offset}px`; diff --git a/packages/widgets/Source/InspectorShared.js b/packages/widgets/Source/InspectorShared.js index f503a1cb935d..25e4d1326b85 100644 --- a/packages/widgets/Source/InspectorShared.js +++ b/packages/widgets/Source/InspectorShared.js @@ -8,9 +8,9 @@ const InspectorShared = {}; /** * Creates a checkbox component - * @param {String} labelText The text to display in the checkbox label - * @param {String} checkedBinding The name of the variable used for checked binding - * @param {String} [enableBinding] The name of the variable used for enable binding + * @param {string} labelText The text to display in the checkbox label + * @param {string} checkedBinding The name of the variable used for checked binding + * @param {string} [enableBinding] The name of the variable used for enable binding * @return {Element} */ InspectorShared.createCheckbox = function ( @@ -41,9 +41,9 @@ InspectorShared.createCheckbox = function ( /** * Creates a section element * @param {Element} panel The parent element - * @param {String} headerText The text to display at the top of the section - * @param {String} sectionVisibleBinding The name of the variable used for visible binding - * @param {String} toggleSectionVisibilityBinding The name of the function used to toggle visibility + * @param {string} headerText The text to display at the top of the section + * @param {string} sectionVisibleBinding The name of the variable used for visible binding + * @param {string} toggleSectionVisibilityBinding The name of the function used to toggle visibility * @return {Element} */ InspectorShared.createSection = function ( @@ -86,12 +86,12 @@ InspectorShared.createSection = function ( /** * Creates a range input - * @param {String} rangeText The text to display - * @param {String} sliderValueBinding The name of the variable used for slider value binding - * @param {Number} min The minimum value - * @param {Number} max The maximum value - * @param {Number} [step] The step size. Defaults to "any". - * @param {String} [inputValueBinding] The name of the variable used for input value binding + * @param {string} rangeText The text to display + * @param {string} sliderValueBinding The name of the variable used for slider value binding + * @param {number} min The minimum value + * @param {number} max The maximum value + * @param {number} [step] The step size. Defaults to "any". + * @param {string} [inputValueBinding] The name of the variable used for input value binding * @return {Element} */ InspectorShared.createRangeInput = function ( @@ -138,9 +138,9 @@ InspectorShared.createRangeInput = function ( /** * Creates a button component - * @param {String} buttonText The button text - * @param {String} clickedBinding The name of the variable used for clicked binding - * @param {String} [activeBinding] The name of the variable used for active binding + * @param {string} buttonText The button text + * @param {string} clickedBinding The name of the variable used for clicked binding + * @param {string} [activeBinding] The name of the variable used for active binding * @return {Element} */ InspectorShared.createButton = function ( diff --git a/packages/widgets/Source/NavigationHelpButton/NavigationHelpButton.js b/packages/widgets/Source/NavigationHelpButton/NavigationHelpButton.js index e86471f60e22..05b7573eb54d 100644 --- a/packages/widgets/Source/NavigationHelpButton/NavigationHelpButton.js +++ b/packages/widgets/Source/NavigationHelpButton/NavigationHelpButton.js @@ -17,9 +17,9 @@ import NavigationHelpButtonViewModel from "./NavigationHelpButtonViewModel.js"; * @alias NavigationHelpButton * @constructor * - * @param {Object} options Object with the following properties: - * @param {Element|String} options.container The DOM element or ID that will contain the widget. - * @param {Boolean} [options.instructionsInitiallyVisible=false] True if the navigation instructions should initially be visible; otherwise, false. + * @param {object} options Object with the following properties: + * @param {Element|string} options.container The DOM element or ID that will contain the widget. + * @param {boolean} [options.instructionsInitiallyVisible=false] True if the navigation instructions should initially be visible; otherwise, false. * * @exception {DeveloperError} Element with id "container" does not exist in the document. * @@ -249,7 +249,7 @@ Object.defineProperties(NavigationHelpButton.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ NavigationHelpButton.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/NavigationHelpButton/NavigationHelpButtonViewModel.js b/packages/widgets/Source/NavigationHelpButton/NavigationHelpButtonViewModel.js index 32d89d744b46..804eef307748 100644 --- a/packages/widgets/Source/NavigationHelpButton/NavigationHelpButtonViewModel.js +++ b/packages/widgets/Source/NavigationHelpButton/NavigationHelpButtonViewModel.js @@ -9,7 +9,7 @@ import createCommand from "../createCommand.js"; function NavigationHelpButtonViewModel() { /** * Gets or sets whether the instructions are currently shown. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.showInstructions = false; @@ -30,7 +30,7 @@ function NavigationHelpButtonViewModel() { /** * Gets or sets the tooltip. This property is observable. * - * @type {String} + * @type {string} */ this.tooltip = "Navigation Instructions"; diff --git a/packages/widgets/Source/PerformanceWatchdog/PerformanceWatchdog.js b/packages/widgets/Source/PerformanceWatchdog/PerformanceWatchdog.js index 046bb84bffce..085bb0ebb89d 100644 --- a/packages/widgets/Source/PerformanceWatchdog/PerformanceWatchdog.js +++ b/packages/widgets/Source/PerformanceWatchdog/PerformanceWatchdog.js @@ -13,10 +13,10 @@ import PerformanceWatchdogViewModel from "./PerformanceWatchdogViewModel.js"; * @alias PerformanceWatchdog * @constructor * - * @param {Object} [options] Object with the following properties: - * @param {Element|String} options.container The DOM element or ID that will contain the widget. + * @param {object} [options] Object with the following properties: + * @param {Element|string} options.container The DOM element or ID that will contain the widget. * @param {Scene} options.scene The {@link Scene} for which to monitor performance. - * @param {String} [options.lowFrameRateMessage='This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.'] The + * @param {string} [options.lowFrameRateMessage='This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.'] The * message to display when a low frame rate is detected. The message is interpeted as HTML, so make sure * it comes from a trusted source so that your application is not vulnerable to cross-site scripting attacks. */ @@ -87,7 +87,7 @@ Object.defineProperties(PerformanceWatchdog.prototype, { /** * @memberof PerformanceWatchdog - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ PerformanceWatchdog.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/PerformanceWatchdog/PerformanceWatchdogViewModel.js b/packages/widgets/Source/PerformanceWatchdog/PerformanceWatchdogViewModel.js index 3a47f583ad69..5f0fd411344b 100644 --- a/packages/widgets/Source/PerformanceWatchdog/PerformanceWatchdogViewModel.js +++ b/packages/widgets/Source/PerformanceWatchdog/PerformanceWatchdogViewModel.js @@ -14,9 +14,9 @@ import createCommand from "../createCommand.js"; * @alias PerformanceWatchdogViewModel * @constructor * - * @param {Object} [options] Object with the following properties: + * @param {object} [options] Object with the following properties: * @param {Scene} options.scene The Scene instance for which to monitor performance. - * @param {String} [options.lowFrameRateMessage='This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.'] The + * @param {string} [options.lowFrameRateMessage='This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.'] The * message to display when a low frame rate is detected. The message is interpeted as HTML, so make sure * it comes from a trusted source so that your application is not vulnerable to cross-site scripting attacks. */ @@ -31,7 +31,7 @@ function PerformanceWatchdogViewModel(options) { /** * Gets or sets the message to display when a low frame rate is detected. This string will be interpreted as HTML. - * @type {String} + * @type {string} */ this.lowFrameRateMessage = defaultValue( options.lowFrameRateMessage, @@ -41,13 +41,13 @@ function PerformanceWatchdogViewModel(options) { /** * Gets or sets a value indicating whether the low frame rate message has previously been dismissed by the user. If it has * been dismissed, the message will not be redisplayed, no matter the frame rate. - * @type {Boolean} + * @type {boolean} */ this.lowFrameRateMessageDismissed = false; /** * Gets or sets a value indicating whether the low frame rate message is currently being displayed. - * @type {Boolean} + * @type {boolean} */ this.showingLowFrameRateMessage = false; diff --git a/packages/widgets/Source/ProjectionPicker/ProjectionPicker.js b/packages/widgets/Source/ProjectionPicker/ProjectionPicker.js index b421fc1e2493..d1cc1dee8cae 100644 --- a/packages/widgets/Source/ProjectionPicker/ProjectionPicker.js +++ b/packages/widgets/Source/ProjectionPicker/ProjectionPicker.js @@ -19,7 +19,7 @@ const orthographicPath = * @alias ProjectionPicker * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {Scene} scene The Scene instance to use. * * @exception {DeveloperError} Element with id "container" does not exist in the document. @@ -149,7 +149,7 @@ Object.defineProperties(ProjectionPicker.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ ProjectionPicker.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/ProjectionPicker/ProjectionPickerViewModel.js b/packages/widgets/Source/ProjectionPicker/ProjectionPickerViewModel.js index d772112e71fe..bf51b586a9af 100644 --- a/packages/widgets/Source/ProjectionPicker/ProjectionPickerViewModel.js +++ b/packages/widgets/Source/ProjectionPicker/ProjectionPickerViewModel.js @@ -29,28 +29,28 @@ function ProjectionPickerViewModel(scene) { /** * Gets or sets whether the button drop-down is currently visible. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.dropDownVisible = false; /** * Gets or sets the perspective projection tooltip. This property is observable. - * @type {String} + * @type {string} * @default 'Perspective Projection' */ this.tooltipPerspective = "Perspective Projection"; /** * Gets or sets the orthographic projection tooltip. This property is observable. - * @type {String} + * @type {string} * @default 'Orthographic Projection' */ this.tooltipOrthographic = "Orthographic Projection"; /** * Gets the currently active tooltip. This property is observable. - * @type {String} + * @type {string} */ this.selectedTooltip = undefined; @@ -187,7 +187,7 @@ Object.defineProperties(ProjectionPickerViewModel.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ ProjectionPickerViewModel.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/SceneModePicker/SceneModePicker.js b/packages/widgets/Source/SceneModePicker/SceneModePicker.js index 48c412c0e23a..3ab0c6465ef9 100644 --- a/packages/widgets/Source/SceneModePicker/SceneModePicker.js +++ b/packages/widgets/Source/SceneModePicker/SceneModePicker.js @@ -31,9 +31,9 @@ const columbusViewPath = * @alias SceneModePicker * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {Scene} scene The Scene instance to use. - * @param {Number} [duration=2.0] The time, in seconds, it takes for the scene to transition. + * @param {number} [duration=2.0] The time, in seconds, it takes for the scene to transition. * * @exception {DeveloperError} Element with id "container" does not exist in the document. * @@ -180,7 +180,7 @@ Object.defineProperties(SceneModePicker.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ SceneModePicker.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/SceneModePicker/SceneModePickerViewModel.js b/packages/widgets/Source/SceneModePicker/SceneModePickerViewModel.js index b4b3ce6deee4..33884b8902ff 100644 --- a/packages/widgets/Source/SceneModePicker/SceneModePickerViewModel.js +++ b/packages/widgets/Source/SceneModePicker/SceneModePickerViewModel.js @@ -15,7 +15,7 @@ import createCommand from "../createCommand.js"; * @constructor * * @param {Scene} scene The Scene to morph - * @param {Number} [duration=2.0] The duration of scene morph animations, in seconds + * @param {number} [duration=2.0] The duration of scene morph animations, in seconds */ function SceneModePickerViewModel(scene, duration) { //>>includeStart('debug', pragmas.debug); @@ -46,28 +46,28 @@ function SceneModePickerViewModel(scene, duration) { /** * Gets or sets whether the button drop-down is currently visible. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.dropDownVisible = false; /** * Gets or sets the 2D tooltip. This property is observable. - * @type {String} + * @type {string} * @default '2D' */ this.tooltip2D = "2D"; /** * Gets or sets the 3D tooltip. This property is observable. - * @type {String} + * @type {string} * @default '3D' */ this.tooltip3D = "3D"; /** * Gets or sets the Columbus View tooltip. This property is observable. - * @type {String} + * @type {string} * @default 'Columbus View' */ this.tooltipColumbusView = "Columbus View"; @@ -82,7 +82,7 @@ function SceneModePickerViewModel(scene, duration) { /** * Gets the currently active tooltip. This property is observable. - * @type {String} + * @type {string} */ this.selectedTooltip = undefined; knockout.defineProperty(this, "selectedTooltip", function () { @@ -132,7 +132,7 @@ Object.defineProperties(SceneModePickerViewModel.prototype, { * Gets or sets the the duration of scene mode transition animations in seconds. * A value of zero causes the scene to instantly change modes. * @memberof SceneModePickerViewModel.prototype - * @type {Number} + * @type {number} */ duration: { get: function () { @@ -199,7 +199,7 @@ Object.defineProperties(SceneModePickerViewModel.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ SceneModePickerViewModel.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/SelectionIndicator/SelectionIndicator.js b/packages/widgets/Source/SelectionIndicator/SelectionIndicator.js index aa5b659cec41..53c2ee83f9bf 100644 --- a/packages/widgets/Source/SelectionIndicator/SelectionIndicator.js +++ b/packages/widgets/Source/SelectionIndicator/SelectionIndicator.js @@ -13,7 +13,7 @@ import SelectionIndicatorViewModel from "./SelectionIndicatorViewModel.js"; * @alias SelectionIndicator * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {Scene} scene The Scene instance to use. * * @exception {DeveloperError} Element with id "container" does not exist in the document. @@ -97,7 +97,7 @@ Object.defineProperties(SelectionIndicator.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ SelectionIndicator.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/SelectionIndicator/SelectionIndicatorViewModel.js b/packages/widgets/Source/SelectionIndicator/SelectionIndicatorViewModel.js index 40897f2f1e79..5a382440feee 100644 --- a/packages/widgets/Source/SelectionIndicator/SelectionIndicatorViewModel.js +++ b/packages/widgets/Source/SelectionIndicator/SelectionIndicatorViewModel.js @@ -55,7 +55,7 @@ function SelectionIndicatorViewModel( /** * Gets or sets the visibility of the selection indicator. - * @type {Boolean} + * @type {boolean} */ this.showSelection = false; @@ -70,7 +70,7 @@ function SelectionIndicatorViewModel( /** * Gets the visibility of the position indicator. This can be false even if an * object is selected, when the selected object has no position. - * @type {Boolean} + * @type {boolean} */ this.isVisible = undefined; knockout.defineProperty(this, "isVisible", { diff --git a/packages/widgets/Source/Timeline/Timeline.js b/packages/widgets/Source/Timeline/Timeline.js index ad36cf36f96a..581bb7a33731 100644 --- a/packages/widgets/Source/Timeline/Timeline.js +++ b/packages/widgets/Source/Timeline/Timeline.js @@ -204,7 +204,7 @@ Timeline.prototype.removeEventListener = function (type, listener, useCapture) { }; /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ Timeline.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/ToggleButtonViewModel.js b/packages/widgets/Source/ToggleButtonViewModel.js index 73f589f60047..b8f339a16e5c 100644 --- a/packages/widgets/Source/ToggleButtonViewModel.js +++ b/packages/widgets/Source/ToggleButtonViewModel.js @@ -7,9 +7,9 @@ import knockout from "./ThirdParty/knockout.js"; * @constructor * * @param {Command} command The command which will be executed when the button is toggled. - * @param {Object} [options] Object with the following properties: - * @param {Boolean} [options.toggled=false] A boolean indicating whether the button should be initially toggled. - * @param {String} [options.tooltip=''] A string containing the button's tooltip. + * @param {object} [options] Object with the following properties: + * @param {boolean} [options.toggled=false] A boolean indicating whether the button should be initially toggled. + * @param {string} [options.tooltip=''] A string containing the button's tooltip. */ function ToggleButtonViewModel(command, options) { //>>includeStart('debug', pragmas.debug); @@ -24,14 +24,14 @@ function ToggleButtonViewModel(command, options) { /** * Gets or sets whether the button is currently toggled. This property is observable. - * @type {Boolean} + * @type {boolean} * @default false */ this.toggled = defaultValue(options.toggled, false); /** * Gets or sets the button's tooltip. This property is observable. - * @type {String} + * @type {string} * @default '' */ this.tooltip = defaultValue(options.tooltip, ""); diff --git a/packages/widgets/Source/VRButton/VRButton.js b/packages/widgets/Source/VRButton/VRButton.js index 5712068ace67..0c22bf11d8b4 100644 --- a/packages/widgets/Source/VRButton/VRButton.js +++ b/packages/widgets/Source/VRButton/VRButton.js @@ -18,9 +18,9 @@ const exitVRPath = * @alias VRButton * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {Scene} scene The scene. - * @param {Element|String} [vrElement=document.body] The element or id to be placed into vr mode. + * @param {Element|string} [vrElement=document.body] The element or id to be placed into vr mode. * * @exception {DeveloperError} Element with id "container" does not exist in the document. */ @@ -90,7 +90,7 @@ Object.defineProperties(VRButton.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ VRButton.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/VRButton/VRButtonViewModel.js b/packages/widgets/Source/VRButton/VRButtonViewModel.js index 456cae1be46c..1f5697fbb39e 100644 --- a/packages/widgets/Source/VRButton/VRButtonViewModel.js +++ b/packages/widgets/Source/VRButton/VRButtonViewModel.js @@ -77,7 +77,7 @@ function toggleVR(viewModel, scene, isVRMode, isOrthographic) { * @constructor * * @param {Scene} scene The scene. - * @param {Element|String} [vrElement=document.body] The element or id to be placed into VR mode. + * @param {Element|string} [vrElement=document.body] The element or id to be placed into VR mode. */ function VRButtonViewModel(scene, vrElement) { //>>includeStart('debug', pragmas.debug); @@ -94,7 +94,7 @@ function VRButtonViewModel(scene, vrElement) { /** * Gets whether or not VR mode is active. * - * @type {Boolean} + * @type {boolean} */ this.isVRMode = undefined; knockout.defineProperty(this, "isVRMode", { @@ -106,7 +106,7 @@ function VRButtonViewModel(scene, vrElement) { /** * Gets or sets whether or not VR functionality should be enabled. * - * @type {Boolean} + * @type {boolean} * @see Fullscreen.enabled */ this.isVREnabled = undefined; @@ -122,7 +122,7 @@ function VRButtonViewModel(scene, vrElement) { /** * Gets the tooltip. This property is observable. * - * @type {String} + * @type {string} */ this.tooltip = undefined; knockout.defineProperty(this, "tooltip", function () { @@ -207,7 +207,7 @@ Object.defineProperties(VRButtonViewModel.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ VRButtonViewModel.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/Viewer/Viewer.js b/packages/widgets/Source/Viewer/Viewer.js index 554f484ea047..780af46acb34 100644 --- a/packages/widgets/Source/Viewer/Viewer.js +++ b/packages/widgets/Source/Viewer/Viewer.js @@ -290,24 +290,24 @@ function enableVRUI(viewer, enabled) { } /** - * @typedef {Object} Viewer.ConstructorOptions + * @typedef {object} Viewer.ConstructorOptions * * Initialization options for the Viewer constructor * - * @property {Boolean} [animation=true] If set to false, the Animation widget will not be created. - * @property {Boolean} [baseLayerPicker=true] If set to false, the BaseLayerPicker widget will not be created. - * @property {Boolean} [fullscreenButton=true] If set to false, the FullscreenButton widget will not be created. - * @property {Boolean} [vrButton=false] If set to true, the VRButton widget will be created. - * @property {Boolean|GeocoderService[]} [geocoder=true] If set to false, the Geocoder widget will not be created. - * @property {Boolean} [homeButton=true] If set to false, the HomeButton widget will not be created. - * @property {Boolean} [infoBox=true] If set to false, the InfoBox widget will not be created. - * @property {Boolean} [sceneModePicker=true] If set to false, the SceneModePicker widget will not be created. - * @property {Boolean} [selectionIndicator=true] If set to false, the SelectionIndicator widget will not be created. - * @property {Boolean} [timeline=true] If set to false, the Timeline widget will not be created. - * @property {Boolean} [navigationHelpButton=true] If set to false, the navigation help button will not be created. - * @property {Boolean} [navigationInstructionsInitiallyVisible=true] True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button. - * @property {Boolean} [scene3DOnly=false] When true, each geometry instance will only be rendered in 3D to save GPU memory. - * @property {Boolean} [shouldAnimate=false] true if the clock should attempt to advance simulation time by default, false otherwise. This option takes precedence over setting {@link Viewer#clockViewModel}. + * @property {boolean} [animation=true] If set to false, the Animation widget will not be created. + * @property {boolean} [baseLayerPicker=true] If set to false, the BaseLayerPicker widget will not be created. + * @property {boolean} [fullscreenButton=true] If set to false, the FullscreenButton widget will not be created. + * @property {boolean} [vrButton=false] If set to true, the VRButton widget will be created. + * @property {boolean|GeocoderService[]} [geocoder=true] If set to false, the Geocoder widget will not be created. + * @property {boolean} [homeButton=true] If set to false, the HomeButton widget will not be created. + * @property {boolean} [infoBox=true] If set to false, the InfoBox widget will not be created. + * @property {boolean} [sceneModePicker=true] If set to false, the SceneModePicker widget will not be created. + * @property {boolean} [selectionIndicator=true] If set to false, the SelectionIndicator widget will not be created. + * @property {boolean} [timeline=true] If set to false, the Timeline widget will not be created. + * @property {boolean} [navigationHelpButton=true] If set to false, the navigation help button will not be created. + * @property {boolean} [navigationInstructionsInitiallyVisible=true] True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button. + * @property {boolean} [scene3DOnly=false] When true, each geometry instance will only be rendered in 3D to save GPU memory. + * @property {boolean} [shouldAnimate=false] true if the clock should attempt to advance simulation time by default, false otherwise. This option takes precedence over setting {@link Viewer#clockViewModel}. * @property {ClockViewModel} [clockViewModel=new ClockViewModel(clock)] The clock view model to use to control current time. * @property {ProviderViewModel} [selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available base layer is used. This value is only valid if `baseLayerPicker` is set to true. * @property {ProviderViewModel[]} [imageryProviderViewModels=createDefaultImageryProviderViewModels()] The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true. @@ -317,30 +317,30 @@ function enableVRUI(viewer, enabled) { * @property {TerrainProvider} [terrainProvider=new EllipsoidTerrainProvider()] The terrain provider to use * @property {SkyBox|false} [skyBox] The skybox used to render the stars. When undefined, the default stars are used. If set to false, no skyBox, Sun, or Moon will be added. * @property {SkyAtmosphere|false} [skyAtmosphere] Blue sky, and the glow around the Earth's limb. Set to false to turn it off. - * @property {Element|String} [fullscreenElement=document.body] The element or id to be placed into fullscreen mode when the full screen button is pressed. - * @property {Boolean} [useDefaultRenderLoop=true] True if this widget should control the render loop, false otherwise. - * @property {Number} [targetFrameRate] The target frame rate when using the default render loop. - * @property {Boolean} [showRenderLoopErrors=true] If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs. - * @property {Boolean} [useBrowserRecommendedResolution=true] If true, render at the browser's recommended resolution and ignore window.devicePixelRatio. - * @property {Boolean} [automaticallyTrackDataSourceClocks=true] If true, this widget will automatically track the clock settings of newly added DataSources, updating if the DataSource's clock changes. Set this to false if you want to configure the clock independently. + * @property {Element|string} [fullscreenElement=document.body] The element or id to be placed into fullscreen mode when the full screen button is pressed. + * @property {boolean} [useDefaultRenderLoop=true] True if this widget should control the render loop, false otherwise. + * @property {number} [targetFrameRate] The target frame rate when using the default render loop. + * @property {boolean} [showRenderLoopErrors=true] If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs. + * @property {boolean} [useBrowserRecommendedResolution=true] If true, render at the browser's recommended resolution and ignore window.devicePixelRatio. + * @property {boolean} [automaticallyTrackDataSourceClocks=true] If true, this widget will automatically track the clock settings of newly added DataSources, updating if the DataSource's clock changes. Set this to false if you want to configure the clock independently. * @property {ContextOptions} [contextOptions] Context and WebGL creation properties passed to {@link Scene}. * @property {SceneMode} [sceneMode=SceneMode.SCENE3D] The initial scene mode. * @property {MapProjection} [mapProjection=new GeographicProjection()] The map projection to use in 2D and Columbus View modes. * @property {Globe|false} [globe=new Globe(mapProjection.ellipsoid)] The globe to use in the scene. If set to false, no globe will be added. - * @property {Boolean} [orderIndependentTranslucency=true] If true and the configuration supports it, use order independent translucency. - * @property {Element|String} [creditContainer] The DOM element or ID that will contain the {@link CreditDisplay}. If not specified, the credits are added to the bottom of the widget itself. - * @property {Element|String} [creditViewport] The DOM element or ID that will contain the credit pop up created by the {@link CreditDisplay}. If not specified, it will appear over the widget itself. + * @property {boolean} [orderIndependentTranslucency=true] If true and the configuration supports it, use order independent translucency. + * @property {Element|string} [creditContainer] The DOM element or ID that will contain the {@link CreditDisplay}. If not specified, the credits are added to the bottom of the widget itself. + * @property {Element|string} [creditViewport] The DOM element or ID that will contain the credit pop up created by the {@link CreditDisplay}. If not specified, it will appear over the widget itself. * @property {DataSourceCollection} [dataSources=new DataSourceCollection()] The collection of data sources visualized by the widget. If this parameter is provided, * the instance is assumed to be owned by the caller and will not be destroyed when the viewer is destroyed. - * @property {Boolean} [shadows=false] Determines if shadows are cast by light sources. + * @property {boolean} [shadows=false] Determines if shadows are cast by light sources. * @property {ShadowMode} [terrainShadows=ShadowMode.RECEIVE_ONLY] Determines if the terrain casts or receives shadows from light sources. * @property {MapMode2D} [mapMode2D=MapMode2D.INFINITE_SCROLL] Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. - * @property {Boolean} [projectionPicker=false] If set to true, the ProjectionPicker widget will be created. - * @property {Boolean} [blurActiveElementOnCanvasFocus=true] If true, the active element will blur when the viewer's canvas is clicked. Setting this to false is useful for cases when the canvas is clicked only for retrieving position or an entity data without actually meaning to set the canvas to be the active element. - * @property {Boolean} [requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling reduces the CPU/GPU usage of your application and uses less battery on mobile, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. - * @property {Number} [maximumRenderTimeChange=0.0] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. - * @property {Number} [depthPlaneEllipsoidOffset=0.0] Adjust the DepthPlane to address rendering artefacts below ellipsoid zero elevation. - * @property {Number} [msaaSamples=1] If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. + * @property {boolean} [projectionPicker=false] If set to true, the ProjectionPicker widget will be created. + * @property {boolean} [blurActiveElementOnCanvasFocus=true] If true, the active element will blur when the viewer's canvas is clicked. Setting this to false is useful for cases when the canvas is clicked only for retrieving position or an entity data without actually meaning to set the canvas to be the active element. + * @property {boolean} [requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling reduces the CPU/GPU usage of your application and uses less battery on mobile, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. + * @property {number} [maximumRenderTimeChange=0.0] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See {@link https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/|Improving Performance with Explicit Rendering}. + * @property {number} [depthPlaneEllipsoidOffset=0.0] Adjust the DepthPlane to address rendering artefacts below ellipsoid zero elevation. + * @property {number} [msaaSamples=1] If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. */ /** @@ -350,7 +350,7 @@ function enableVRUI(viewer, enabled) { * @alias Viewer * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {Viewer.ConstructorOptions} [options] Object describing initialization options * * @exception {DeveloperError} Element with id "container" does not exist in the document. @@ -1178,7 +1178,7 @@ Object.defineProperties(Viewer.prototype, { /** * Determines if shadows are cast by light sources. * @memberof Viewer.prototype - * @type {Boolean} + * @type {boolean} */ shadows: { get: function () { @@ -1312,7 +1312,7 @@ Object.defineProperties(Viewer.prototype, { * than the underlying requestAnimationFrame implementation will have no effect. * @memberof Viewer.prototype * - * @type {Number} + * @type {number} */ targetFrameRate: { get: function () { @@ -1335,7 +1335,7 @@ Object.defineProperties(Viewer.prototype, { * after the error. * @memberof Viewer.prototype * - * @type {Boolean} + * @type {boolean} */ useDefaultRenderLoop: { get: function () { @@ -1355,7 +1355,7 @@ Object.defineProperties(Viewer.prototype, { * it to 2.0 will cause the scene to be rendered at 1280x960 and then scaled down. * @memberof Viewer.prototype * - * @type {Number} + * @type {number} * @default 1.0 */ resolutionScale: { @@ -1376,7 +1376,7 @@ Object.defineProperties(Viewer.prototype, { * this flag is true or false. * @memberof Viewer.prototype * - * @type {Boolean} + * @type {boolean} * @default true */ useBrowserRecommendedResolution: { @@ -1396,7 +1396,7 @@ Object.defineProperties(Viewer.prototype, { * * @memberof Viewer.prototype * - * @type {Boolean} + * @type {boolean} */ allowDataSourcesToSuspendAnimation: { get: function () { @@ -1533,7 +1533,7 @@ Object.defineProperties(Viewer.prototype, { * to the provided viewer instance. * * @param {Viewer.ViewerMixin} mixin The Viewer mixin to add to this instance. - * @param {Object} [options] The options object to be passed to the mixin function. + * @param {object} [options] The options object to be passed to the mixin function. * * @see viewerDragDropMixin */ @@ -1668,7 +1668,7 @@ Viewer.prototype.render = function () { }; /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ Viewer.prototype.isDestroyed = function () { return false; @@ -2029,9 +2029,9 @@ Viewer.prototype._onDataSourceRemoved = function ( * target will be the range. The heading will be determined from the offset. If the heading cannot be * determined from the offset, the heading will be north.

    * - * @param {Entity|Entity[]|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|Promise.} target The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types. + * @param {Entity|Entity[]|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|Promise} target The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types. * @param {HeadingPitchRange} [offset] The offset from the center of the entity in the local east-north-up reference frame. - * @returns {Promise.} A Promise that resolves to true if the zoom was successful or false if the target is not currently visualized in the scene or the zoom was cancelled. + * @returns {Promise} A Promise that resolves to true if the zoom was successful or false if the target is not currently visualized in the scene or the zoom was cancelled. */ Viewer.prototype.zoomTo = function (target, offset) { const options = { @@ -2055,12 +2055,12 @@ Viewer.prototype.zoomTo = function (target, offset) { * target will be the range. The heading will be determined from the offset. If the heading cannot be * determined from the offset, the heading will be north.

    * - * @param {Entity|Entity[]|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|Promise.} target The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types. - * @param {Object} [options] Object with the following properties: - * @param {Number} [options.duration=3.0] The duration of the flight in seconds. - * @param {Number} [options.maximumHeight] The maximum height at the peak of the flight. + * @param {Entity|Entity[]|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud|Promise} target The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types. + * @param {object} [options] Object with the following properties: + * @param {number} [options.duration=3.0] The duration of the flight in seconds. + * @param {number} [options.maximumHeight] The maximum height at the peak of the flight. * @param {HeadingPitchRange} [options.offset] The offset from the target in the local east-north-up reference frame centered at the target. - * @returns {Promise.} A Promise that resolves to true if the flight was successful or false if the target is not currently visualized in the scene or the flight was cancelled. //TODO: Cleanup entity mentions + * @returns {Promise} A Promise that resolves to true if the flight was successful or false if the target is not currently visualized in the scene or the flight was cancelled. //TODO: Cleanup entity mentions */ Viewer.prototype.flyTo = function (target, options) { return zoomToOrFly(this, target, options, true); @@ -2409,7 +2409,7 @@ function updateTrackedEntity(viewer) { * A function that augments a Viewer instance with additional functionality. * @callback Viewer.ViewerMixin * @param {Viewer} viewer The viewer instance. - * @param {Object} options Options object to be passed to the mixin function. + * @param {object} options Options object to be passed to the mixin function. * * @see Viewer#extend */ diff --git a/packages/widgets/Source/Viewer/viewerDragDropMixin.js b/packages/widgets/Source/Viewer/viewerDragDropMixin.js index 03430c497945..24f6b896f50c 100644 --- a/packages/widgets/Source/Viewer/viewerDragDropMixin.js +++ b/packages/widgets/Source/Viewer/viewerDragDropMixin.js @@ -17,11 +17,11 @@ import { * @function viewerDragDropMixin * @param {Viewer} viewer The viewer instance. - * @param {Object} [options] Object with the following properties: - * @param {Element|String} [options.dropTarget=viewer.container] The DOM element which will serve as the drop target. - * @param {Boolean} [options.clearOnDrop=true] When true, dropping files will clear all existing data sources first, when false, new data sources will be loaded after the existing ones. - * @param {Boolean} [options.flyToOnDrop=true] When true, dropping files will fly to the data source once it is loaded. - * @param {Boolean} [options.clampToGround=true] When true, datasources are clamped to the ground. + * @param {object} [options] Object with the following properties: + * @param {Element|string} [options.dropTarget=viewer.container] The DOM element which will serve as the drop target. + * @param {boolean} [options.clearOnDrop=true] When true, dropping files will clear all existing data sources first, when false, new data sources will be loaded after the existing ones. + * @param {boolean} [options.flyToOnDrop=true] When true, dropping files will fly to the data source once it is loaded. + * @param {boolean} [options.clampToGround=true] When true, datasources are clamped to the ground. * @param {Proxy} [options.proxy] The proxy to be used for KML network links. * * @exception {DeveloperError} Element with id does not exist in the document. @@ -138,7 +138,7 @@ function viewerDragDropMixin(viewer, options) { /** * Gets or sets a value indicating if existing data sources should be cleared before adding the newly dropped sources. * @memberof viewerDragDropMixin.prototype - * @type {Boolean} + * @type {boolean} */ clearOnDrop: { get: function () { @@ -152,7 +152,7 @@ function viewerDragDropMixin(viewer, options) { /** * Gets or sets a value indicating if the camera should fly to the data source after it is loaded. * @memberof viewerDragDropMixin.prototype - * @type {Boolean} + * @type {boolean} */ flyToOnDrop: { get: function () { @@ -180,7 +180,7 @@ function viewerDragDropMixin(viewer, options) { /** * Gets or sets a value indicating if the datasources should be clamped to the ground * @memberof viewerDragDropMixin.prototype - * @type {Boolean} + * @type {boolean} */ clampToGround: { get: function () { diff --git a/packages/widgets/Source/Viewer/viewerPerformanceWatchdogMixin.js b/packages/widgets/Source/Viewer/viewerPerformanceWatchdogMixin.js index fcf97afb719c..accaf51a8d55 100644 --- a/packages/widgets/Source/Viewer/viewerPerformanceWatchdogMixin.js +++ b/packages/widgets/Source/Viewer/viewerPerformanceWatchdogMixin.js @@ -8,8 +8,8 @@ import PerformanceWatchdog from "../PerformanceWatchdog/PerformanceWatchdog.js"; * @function * * @param {Viewer} viewer The viewer instance. - * @param {Object} [options] An object with properties. - * @param {String} [options.lowFrameRateMessage='This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.'] The + * @param {object} [options] An object with properties. + * @param {string} [options.lowFrameRateMessage='This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.'] The * message to display when a low frame rate is detected. The message is interpeted as HTML, so make sure * it comes from a trusted source so that your application is not vulnerable to cross-site scripting attacks. * diff --git a/packages/widgets/Source/VoxelInspector/VoxelInspector.js b/packages/widgets/Source/VoxelInspector/VoxelInspector.js index eded9c631099..26871cfbe81e 100644 --- a/packages/widgets/Source/VoxelInspector/VoxelInspector.js +++ b/packages/widgets/Source/VoxelInspector/VoxelInspector.js @@ -17,7 +17,7 @@ import VoxelInspectorViewModel from "./VoxelInspectorViewModel.js"; * @alias VoxelInspector * @constructor * - * @param {Element|String} container The DOM element or ID that will contain the widget. + * @param {Element|string} container The DOM element or ID that will contain the widget. * @param {Scene} scene the Scene instance to use. */ function VoxelInspector(container, scene) { @@ -337,7 +337,7 @@ Object.defineProperties(VoxelInspector.prototype, { }); /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ VoxelInspector.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/VoxelInspector/VoxelInspectorViewModel.js b/packages/widgets/Source/VoxelInspector/VoxelInspectorViewModel.js index f19d46ed623a..af391c97aad7 100644 --- a/packages/widgets/Source/VoxelInspector/VoxelInspectorViewModel.js +++ b/packages/widgets/Source/VoxelInspector/VoxelInspectorViewModel.js @@ -852,7 +852,7 @@ VoxelInspectorViewModel.prototype.shaderEditorKeyPress = function ( }; /** - * @returns {Boolean} true if the object has been destroyed, false otherwise. + * @returns {boolean} true if the object has been destroyed, false otherwise. */ VoxelInspectorViewModel.prototype.isDestroyed = function () { return false; diff --git a/packages/widgets/Source/createCommand.js b/packages/widgets/Source/createCommand.js index 6533384165ca..305905a3c9c3 100644 --- a/packages/widgets/Source/createCommand.js +++ b/packages/widgets/Source/createCommand.js @@ -12,7 +12,7 @@ import knockout from "./ThirdParty/knockout.js"; * @function * * @param {Function} func The function to execute. - * @param {Boolean} [canExecute=true] A boolean indicating whether the function can currently be executed. + * @param {boolean} [canExecute=true] A boolean indicating whether the function can currently be executed. */ function createCommand(func, canExecute) { //>>includeStart('debug', pragmas.debug); diff --git a/packages/widgets/Source/subscribeAndEvaluate.js b/packages/widgets/Source/subscribeAndEvaluate.js index 8eef11675275..510615498a98 100644 --- a/packages/widgets/Source/subscribeAndEvaluate.js +++ b/packages/widgets/Source/subscribeAndEvaluate.js @@ -8,11 +8,11 @@ import knockout from "./ThirdParty/knockout.js"; * * @function subscribeAndEvaluate * - * @param {Object} owner The object containing the observable property. - * @param {String} observablePropertyName The name of the observable property. + * @param {object} owner The object containing the observable property. + * @param {string} observablePropertyName The name of the observable property. * @param {Function} callback The callback function. - * @param {Object} [target] The value of this in the callback function. - * @param {String} [event='change'] The name of the event to receive notification for. + * @param {object} [target] The value of this in the callback function. + * @param {string} [event='change'] The name of the event to receive notification for. * @returns The subscription object from Knockout which can be used to dispose the subscription later. */ function subscribeAndEvaluate(