@cesium/engine 2.0.0 → 2.2.0

package/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
  */
@@ -520,6 +520,7 @@ function selectTilesForRendering(primitive, frameState) {
   let i;
   const tileProvider = primitive._tileProvider;
   if (!defined(primitive._levelZeroTiles)) {
+    // ready is deprecated. This is here for backwards compatibility
     if (tileProvider.ready) {
       const tilingScheme = tileProvider.tilingScheme;
       primitive._levelZeroTiles = QuadtreeTile.createLevelZeroTiles(
@@ -704,7 +705,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.
  */
@@ -1387,6 +1388,7 @@ const scratchPosition = new Cartesian3();
 const scratchArray = [];
 
 function updateHeights(primitive, frameState) {
+  // ready is deprecated. This is here for backwards compatibility.
   if (!primitive.tileProvider.ready) {
     return;
   }

package/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
    * <code>START</code> or <code>LOADING</code>.
    * @memberof QuadtreeTile.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   needsLoading: {
     get: function () {
@@ -386,7 +386,7 @@ Object.defineProperties(QuadtreeTile.prototype, {
    * <code>eligibleForUnloading</code> property, the value of that property is returned.
    * Otherwise, this property returns true.
    * @memberof QuadtreeTile.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   eligibleForUnloading: {
     get: function () {

package/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 = {

package/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,15 +45,15 @@ Object.defineProperties(QuadtreeTileProvider.prototype, {
   /**
    * Gets a value indicating whether or not the provider is ready for use.
    * @memberof QuadtreeTileProvider.prototype
-   * @type {Boolean}
+   * @type {boolean}
+   * @deprecated
    */
   ready: {
     get: DeveloperError.throwInstantiationError,
   },
 
   /**
-   * Gets the tiling scheme used by the provider.  This property should
-   * not be accessed before {@link QuadtreeTileProvider#ready} returns true.
+   * Gets the tiling scheme used by the provider.
    * @memberof QuadtreeTileProvider.prototype
    * @type {TilingScheme}
    */
@@ -112,24 +112,22 @@ QuadtreeTileProvider.prototype.endUpdate =
   DeveloperError.throwInstantiationError;
 
 /**
- * Gets the maximum geometric error allowed in a tile at a given level, in meters.  This function should not be
- * called before {@link QuadtreeTileProvider#ready} returns true.
+ * Gets the maximum geometric error allowed in a tile at a given level, in meters.
  *
  * @see QuadtreeTileProvider#computeDefaultLevelZeroMaximumGeometricError
  *
  * @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;
 
 /**
  * Loads, or continues loading, a given tile.  This function will continue to be called
- * until {@link QuadtreeTile#state} is no longer {@link QuadtreeTileLoadState#LOADING}.  This function should
- * not be called before {@link QuadtreeTileProvider#ready} returns true.
+ * until {@link QuadtreeTile#state} is no longer {@link QuadtreeTileLoadState#LOADING}.
  *
  * @memberof QuadtreeTileProvider
  * @function
@@ -137,8 +135,6 @@ QuadtreeTileProvider.prototype.getLevelMaximumGeometricError =
  * @param {Context} context The rendering context.
  * @param {FrameState} frameState The frame state.
  * @param {QuadtreeTile} tile The tile to load.
- *
- * @exception {DeveloperError} <code>loadTile</code> must not be called before the tile provider is ready.
  */
 QuadtreeTileProvider.prototype.loadTile =
   DeveloperError.throwInstantiationError;
@@ -184,7 +180,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 +193,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
  */