@cesium/engine 2.0.0 → 2.2.0

package/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,

package/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.<String, Array>} 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<string, Array>} 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 <code>undefined</code> 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

package/Source/Scene/KeyframeNode.js

@@ -12,7 +12,7 @@ const LoadState = Object.freeze({
  * @constructor
  *
  * @param {SpatialNode} spatialNode
- * @param {Number} keyframe
+ * @param {number} keyframe
  *
  * @private
  */

package/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 <code>2.0</code>.
    * </div>
    * @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} <code>true</code> if the labels are equal; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if the labels are equal; otherwise, <code>false</code>.
  */
 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
  * <code>isDestroyed</code> 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) {

package/Source/Scene/LabelCollection.js

@@ -226,6 +226,7 @@ function rebindAllGlyphs(labelCollection, label) {
           radius: SDFSettings.RADIUS,
         });
 
+        // Context is originally created in writeTextToCanvas()
         const ctx = canvas.getContext("2d");
         const canvasWidth = canvas.width;
         const canvasHeight = canvas.height;
@@ -557,14 +558,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 +623,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 +667,7 @@ function LabelCollection(options) {
    * Draws the bounding sphere for each draw command in the primitive.
    * </p>
    *
-   * @type {Boolean}
+   * @type {boolean}
    *
    * @default false
    */
@@ -695,7 +696,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 +709,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 <code>add</code> is expected constant time.  However, the collection's vertex buffer
@@ -769,7 +770,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} <code>true</code> if the label was removed; <code>false</code> if the label was not found in the collection.
+ * @returns {boolean} <code>true</code> if the label was removed; <code>false</code> if the label 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
@@ -831,7 +832,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 +848,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 +958,7 @@ LabelCollection.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} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  *
  * @see LabelCollection#destroy
  */

package/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,

package/Source/Scene/Light.js

@@ -24,7 +24,7 @@ Object.defineProperties(Light.prototype, {
   /**
    * The intensity controls the strength of the light. <code>intensity</code> has a minimum value of 0.0 and no maximum value.
    * @memberof Light.prototype
-   * @type {Number}
+   * @type {number}
    */
   intensity: {
     get: DeveloperError.throwInstantiationError,

package/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,