@cesium/engine 2.0.0 → 2.2.0

package/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";
  *                  <tr><td>2</td><td>4</td><td>Northeast</td></tr>
  *                  <tr><td>3</td><td>8</td><td>Northwest</td></tr>
  *                 </table>
- * @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.<TerrainMesh>|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<TerrainMesh>|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.<HeightmapTerrainData>|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<HeightmapTerrainData>|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;

package/Source/Core/GoogleEarthEnterpriseTerrainProvider.js

@@ -1,7 +1,8 @@
+import Check from "./Check.js";
 import Credit from "./Credit.js";
 import defaultValue from "./defaultValue.js";
 import defined from "./defined.js";
-import DeveloperError from "./DeveloperError.js";
+import deprecationWarning from "./deprecationWarning.js";
 import Event from "./Event.js";
 import GeographicTilingScheme from "./GeographicTilingScheme.js";
 import GoogleEarthEnterpriseMetadata from "./GoogleEarthEnterpriseMetadata.js";
@@ -67,46 +68,42 @@ TerrainCache.prototype.tidy = function () {
 };
 
 /**
+ * @typedef {Object} GoogleEarthEnterpriseTerrainProvider.ConstructorOptions
+ *
+ * Initialization options for GoogleEarthEnterpriseTerrainProvider constructor
+ *
+ * @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 {Resource|string} [url] The url of the Google Earth Enterprise server hosting the imagery. Deprecated.
+ * @property {GoogleEarthEnterpriseMetadata} [metadata] A metadata object that can be used to share metadata requests with a GoogleEarthEnterpriseImageryProvider. Deprecated.
+ */
+
+/**
+ * <div class="notice">
+ * To construct a GoogleEarthEnterpriseTerrainProvider, call {@link  GoogleEarthEnterpriseTerrainProvider.fromMetadata}. Do not call the constructor directly.
+ * </div>
+ *
  * Provides tiled terrain using the Google Earth Enterprise REST API.
  *
  * @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 {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 {GoogleEarthEnterpriseTerrainProvider.ConstructorOptions} options An object describing initialization options
  *
+ * @see GoogleEarthEnterpriseTerrainProvider.fromMetadata
+ * @see GoogleEarthEnterpriseMetadata.fromUrl
  * @see GoogleEarthEnterpriseImageryProvider
  * @see CesiumTerrainProvider
  *
  * @example
- * const geeMetadata = new GoogleEarthEnterpriseMetadata('http://www.example.com');
- * const gee = new Cesium.GoogleEarthEnterpriseTerrainProvider({
- *     metadata : geeMetadata
- * });
+ * const geeMetadata = await GoogleEarthEnterpriseMetadata.fromUrl("http://www.example.com");
+ * const gee = Cesium.GoogleEarthEnterpriseTerrainProvider.fromMetadata(geeMetadata);
  *
  * @see {@link http://www.w3.org/TR/cors/|Cross-Origin Resource Sharing}
  */
 function GoogleEarthEnterpriseTerrainProvider(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
 
-  //>>includeStart('debug', pragmas.debug);
-  if (!(defined(options.url) || defined(options.metadata))) {
-    throw new DeveloperError("options.url or options.metadata is required.");
-  }
-  //>>includeEnd('debug');
-
-  let metadata;
-  if (defined(options.metadata)) {
-    metadata = options.metadata;
-  } else {
-    const resource = Resource.createIfNeeded(options.url);
-    metadata = new GoogleEarthEnterpriseMetadata(resource);
-  }
-
-  this._metadata = metadata;
   this._tilingScheme = new GeographicTilingScheme({
     numberOfLevelZeroTilesX: 2,
     numberOfLevelZeroTilesY: 2,
@@ -133,16 +130,32 @@ function GoogleEarthEnterpriseTerrainProvider(options) {
   this._terrainRequests = {};
 
   this._errorEvent = new Event();
-
   this._ready = false;
-  const that = this;
-  let metadataError;
-  this._readyPromise = metadata.readyPromise
-    .then(function (result) {
-      if (!metadata.terrainPresent) {
-        const e = new RuntimeError(
-          `The server ${metadata.url} doesn't have terrain`
-        );
+
+  if (defined(options.url)) {
+    deprecationWarning(
+      "GoogleEarthEnterpriseTerrainProvider options.url",
+      "options.url was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use GoogleEarthEnterpriseTerrainProvider.fromMetadata instead."
+    );
+    const resource = Resource.createIfNeeded(options.url);
+    const that = this;
+    let metadataError;
+    this._readyPromise = GoogleEarthEnterpriseMetadata.fromUrl(resource)
+      .then((metadata) => {
+        if (!metadata.terrainPresent) {
+          const e = new RuntimeError(
+            `The server ${metadata.url} doesn't have terrain`
+          );
+
+          return Promise.reject(e);
+        }
+
+        TileProviderError.reportSuccess(metadataError);
+        that._metadata = metadata;
+        that._ready = true;
+        return true;
+      })
+      .catch((e) => {
         metadataError = TileProviderError.reportError(
           metadataError,
           that,
@@ -153,33 +166,36 @@ function GoogleEarthEnterpriseTerrainProvider(options) {
           undefined,
           e
         );
-        return Promise.reject(e);
-      }
 
-      TileProviderError.reportSuccess(metadataError);
-      that._ready = result;
-      return result;
-    })
-    .catch(function (e) {
-      metadataError = TileProviderError.reportError(
-        metadataError,
-        that,
-        that._errorEvent,
-        e.message,
-        undefined,
-        undefined,
-        undefined,
-        e
-      );
-      return Promise.reject(e);
-    });
+        throw e;
+      });
+  } else if (defined(options.metadata)) {
+    deprecationWarning(
+      "GoogleEarthEnterpriseTerrainProvider options.metadata",
+      "options.metadata was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use GoogleEarthEnterpriseTerrainProvider.fromMetadata instead."
+    );
+    const metadata = options.metadata;
+    this._metadata = metadata;
+    const that = this;
+    this._readyPromise = Promise.resolve(this._metadata._readyPromise).then(
+      () => {
+        if (!metadata.terrainPresent) {
+          throw new RuntimeError(
+            `The server ${metadata.url} doesn't have terrain`
+          );
+        }
+
+        that._ready = true;
+      }
+    );
+  }
 }
 
 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: {
@@ -201,22 +217,13 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, {
   },
 
   /**
-   * Gets the tiling scheme used by this provider.  This function should
-   * not be called before {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true.
+   * Gets the tiling scheme used by this provider.
    * @memberof GoogleEarthEnterpriseTerrainProvider.prototype
    * @type {TilingScheme}
    * @readonly
    */
   tilingScheme: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "tilingScheme must not be called before the imagery provider is ready."
-        );
-      }
-      //>>includeEnd('debug');
-
       return this._tilingScheme;
     },
   },
@@ -238,11 +245,16 @@ 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
+   * @deprecated
    */
   ready: {
     get: function () {
+      deprecationWarning(
+        "GoogleEarthEnterpriseTerrainProvider.ready",
+        "GoogleEarthEnterpriseTerrainProvider.ready was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107."
+      );
       return this._ready;
     },
   },
@@ -250,18 +262,23 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, {
   /**
    * Gets a promise that resolves to true when the provider is ready for use.
    * @memberof GoogleEarthEnterpriseTerrainProvider.prototype
-   * @type {Promise.<Boolean>}
+   * @type {Promise<boolean>}
    * @readonly
+   * @deprecated
    */
   readyPromise: {
     get: function () {
+      deprecationWarning(
+        "GoogleEarthEnterpriseTerrainProvider.readyPromise",
+        "GoogleEarthEnterpriseTerrainProvider.readyPromise was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107."
+      );
       return this._readyPromise;
     },
   },
 
   /**
    * Gets the credit to display when this terrain provider is active.  Typically this is used to credit
-   * the source of the terrain.  This function should not be called before {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true.
+   * the source of the terrain.
    * @memberof GoogleEarthEnterpriseTerrainProvider.prototype
    * @type {Credit}
    * @readonly
@@ -275,10 +292,9 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, {
   /**
    * Gets a value indicating whether or not the provider includes a water mask.  The water mask
    * indicates which areas of the globe are water rather than land, so they can be rendered
-   * as a reflective surface with animated waves.  This function should not be
-   * called before {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true.
+   * as a reflective surface with animated waves.
    * @memberof GoogleEarthEnterpriseTerrainProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   hasWaterMask: {
@@ -289,9 +305,8 @@ 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: {
@@ -302,8 +317,7 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, {
 
   /**
    * Gets an object that can be used to determine availability of terrain from this provider, such as
-   * at points and in rectangles.  This function should not be called before
-   * {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true.  This property may be undefined if availability
+   * at points and in rectangles. This property may be undefined if availability
    * information is not available.
    * @memberof GoogleEarthEnterpriseTerrainProvider.prototype
    * @type {TileAvailability}
@@ -316,6 +330,41 @@ Object.defineProperties(GoogleEarthEnterpriseTerrainProvider.prototype, {
   },
 });
 
+/**
+ * Creates a GoogleEarthTerrainProvider from GoogleEarthEnterpriseMetadata
+ *
+ * @param {GoogleEarthEnterpriseMetadata} metadata A metadata object that can be used to share metadata requests with a GoogleEarthEnterpriseImageryProvider.
+ * @param {GoogleEarthEnterpriseTerrainProvider.ConstructorOptions} options An object describing initialization options
+ * @returns {GoogleEarthEnterpriseTerrainProvider}
+ *
+ * @see GoogleEarthEnterpriseMetadata.fromUrl
+ *
+ * @exception {RuntimeError} metadata does not specify terrain
+ *
+ * @example
+ * const geeMetadata = await GoogleEarthEnterpriseMetadata.fromUrl("http://www.example.com");
+ * const gee = Cesium.GoogleEarthEnterpriseTerrainProvider.fromMetadata(geeMetadata);
+ */
+GoogleEarthEnterpriseTerrainProvider.fromMetadata = function (
+  metadata,
+  options
+) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.defined("metadata", metadata);
+  //>>includeEnd('debug');
+
+  if (!metadata.terrainPresent) {
+    throw new RuntimeError(`The server ${metadata.url} doesn't have terrain`);
+  }
+
+  const provider = new GoogleEarthEnterpriseTerrainProvider(options);
+  provider._metadata = metadata;
+  provider._readyPromise = Promise.resolve(true);
+  provider._ready = true;
+
+  return provider;
+};
+
 const taskProcessor = new TaskProcessor("decodeGoogleEarthEnterprisePacket");
 
 // If the tile has its own terrain, then you can just use its child bitmask. If it was requested using it's parent
@@ -338,20 +387,16 @@ function computeChildMask(quadKey, info, metadata) {
 }
 
 /**
- * Requests the geometry for a given tile.  This function should not be called before
- * {@link GoogleEarthEnterpriseTerrainProvider#ready} returns true.  The result must include terrain data and
+ * Requests the geometry for a given tile.   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.<TerrainData>|undefined} A promise for the requested geometry.  If this method
+ * @returns {Promise<TerrainData>|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.
- *
- * @exception {DeveloperError} This function must not be called before {@link GoogleEarthEnterpriseTerrainProvider#ready}
- *            returns true.
  */
 GoogleEarthEnterpriseTerrainProvider.prototype.requestTileGeometry = function (
   x,
@@ -359,14 +404,6 @@ GoogleEarthEnterpriseTerrainProvider.prototype.requestTileGeometry = function (
   level,
   request
 ) {
-  //>>includeStart('debug', pragmas.debug)
-  if (!this._ready) {
-    throw new DeveloperError(
-      "requestTileGeometry must not be called before the terrain provider is ready."
-    );
-  }
-  //>>includeEnd('debug');
-
   const quadKey = GoogleEarthEnterpriseMetadata.tileXYToQuadKey(x, y, level);
   const terrainCache = this._terrainCache;
   const metadata = this._metadata;
@@ -546,8 +583,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 +595,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 +652,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 (

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

package/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;
 }