@cesium/engine 1.1.0 → 2.1.0

package/Source/Scene/BatchTableHierarchy.js

@@ -12,8 +12,8 @@ import RuntimeError from "../Core/RuntimeError.js";
 /**
  * Object for handling the <code>3DTILES_batch_table_hierarchy</code> extension
  *
- * @param {Object} options Object with the following properties:
- * @param {Object} options.extension The <code>3DTILES_batch_table_hierarchy</code> extension object.
+ * @param {object} options Object with the following properties:
+ * @param {object} options.extension The <code>3DTILES_batch_table_hierarchy</code> extension object.
  * @param {Uint8Array} [options.binaryBody] The binary body of the batch table
  *
  * @alias BatchTableHierarchy
@@ -56,7 +56,7 @@ Object.defineProperties(BatchTableHierarchy.prototype, {
  * <code>3DTILES_batch_table_hierarchy</code> 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 <code>undefined</code> 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} <code>true</code> if the property was set, <code>false</code> otherwise.
+ * @returns {boolean} <code>true</code> if the property was set, <code>false</code> otherwise.
  *
  * @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} <code>true</code> if the feature belongs to the class given by className, or <code>false</code> otherwise
+ * @param {number} batchId The batch ID of the feature
+ * @param {string} className The name of the class
+ * @return {boolean} <code>true</code> if the feature belongs to the class given by className, or <code>false</code> 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];

package/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 <code>true</code> if the feature should be shown, <code>false</code> otherwise
+ * @param {number} batchId the ID of the feature
+ * @param {boolean} show <code>true</code> if the feature should be shown, <code>false</code> 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 <code>true</code> if the feature should be shown, <code>false</code> otherwise
+ * @param {boolean} show <code>true</code> if the feature should be shown, <code>false</code> 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} <code>true</code> if the feature is shown, or <code>false</code> otherwise
+ * @param {number} batchId the ID of the feature
+ * @return {boolean} <code>true</code> if the feature is shown, or <code>false</code> 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) {
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  * </p>
  *
- * @returns {Boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see BatchTexture#destroy
  * @private

package/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 <code>2.0</code>.
    * </div>
    * @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. <code>true</code> 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, {
    * </p>
    *
    * @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.
  * </p>
  *
- * @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} <code>true</code> if the billboards are equal; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if the billboards are equal; otherwise, <code>false</code>.
  */
 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<HTMLImageElement|HTMLCanvasElement>} The image, or a promise that will resolve to an image.
  */
 export default Billboard;

package/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.
    * </p>
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @default false
    */
@@ -268,7 +268,7 @@ function BillboardCollection(options) {
    * Draws the texture atlas for this BillboardCollection as a fullscreen quad.
    * </p>
    *
-   * @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 <code>add</code> 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} <code>true</code> if the billboard was removed; <code>false</code> if the billboard was not found in the collection.
+ * @returns {boolean} <code>true</code> if the billboard was removed; <code>false</code> if the billboard was not found in the collection.
  *
  * @performance Calling <code>remove</code> is expected constant time.  However, the collection's vertex buffer
  * is rewritten - an <code>O(n)</code> 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
@@ -1789,10 +1789,10 @@ function updateBoundingVolume(collection, frameState, boundingVolume) {
 function createDebugCommand(billboardCollection, context) {
   const fs =
     "uniform sampler2D billboard_texture; \n" +
-    "varying vec2 v_textureCoordinates; \n" +
+    "in vec2 v_textureCoordinates; \n" +
     "void main() \n" +
     "{ \n" +
-    "    gl_FragColor = texture2D(billboard_texture, v_textureCoordinates); \n" +
+    "    out_FragColor = texture(billboard_texture, v_textureCoordinates); \n" +
     "} \n";
 
   const drawCommand = context.createViewportQuadCommand(fs, {
@@ -2373,7 +2373,7 @@ BillboardCollection.prototype.update = function (frameState) {
  * If this object was destroyed, it should not be used; calling any function other than
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  *
- * @returns {Boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
  *
  * @see BillboardCollection#destroy
  */