@cesium/engine 2.1.0 → 2.3.0

package/Source/Scene/WebMapTileServiceImageryProvider.js

@@ -2,6 +2,7 @@ import combine from "../Core/combine.js";
 import Credit from "../Core/Credit.js";
 import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
+import deprecationWarning from "../Core/deprecationWarning.js";
 import DeveloperError from "../Core/DeveloperError.js";
 import Event from "../Core/Event.js";
 import Rectangle from "../Core/Rectangle.js";
@@ -136,91 +137,16 @@ function WebMapTileServiceImageryProvider(options) {
   }
   //>>includeEnd('debug');
 
-  /**
-   * The default alpha blending value of this provider, with 0.0 representing fully transparent and
-   * 1.0 representing fully opaque.
-   *
-   * @type {number|undefined}
-   * @default undefined
-   */
-  this.defaultAlpha = undefined;
-
-  /**
-   * 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}
-   * @default undefined
-   */
-  this.defaultNightAlpha = undefined;
-
-  /**
-   * 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}
-   * @default undefined
-   */
-  this.defaultDayAlpha = undefined;
-
-  /**
-   * 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}
-   * @default undefined
-   */
-  this.defaultBrightness = undefined;
-
-  /**
-   * 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}
-   * @default undefined
-   */
-  this.defaultContrast = undefined;
-
-  /**
-   * The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
-   *
-   * @type {number|undefined}
-   * @default undefined
-   */
-  this.defaultHue = undefined;
-
-  /**
-   * 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}
-   * @default undefined
-   */
-  this.defaultSaturation = undefined;
-
-  /**
-   * The default gamma correction to apply to this provider.  1.0 uses the unmodified imagery color.
-   *
-   * @type {number|undefined}
-   * @default undefined
-   */
-  this.defaultGamma = undefined;
-
-  /**
-   * The default texture minification filter to apply to this provider.
-   *
-   * @type {TextureMinificationFilter}
-   * @default undefined
-   */
-  this.defaultMinificationFilter = undefined;
-
-  /**
-   * The default texture magnification filter to apply to this provider.
-   *
-   * @type {TextureMagnificationFilter}
-   * @default undefined
-   */
-  this.defaultMagnificationFilter = undefined;
+  this._defaultAlpha = undefined;
+  this._defaultNightAlpha = undefined;
+  this._defaultDayAlpha = undefined;
+  this._defaultBrightness = undefined;
+  this._defaultContrast = undefined;
+  this._defaultHue = undefined;
+  this._defaultSaturation = undefined;
+  this._defaultGamma = undefined;
+  this._defaultMinificationFilter = undefined;
+  this._defaultMagnificationFilter = undefined;
 
   const resource = Resource.createIfNeeded(options.url);
 
@@ -287,6 +213,7 @@ function WebMapTileServiceImageryProvider(options) {
   }
 
   this._readyPromise = Promise.resolve(true);
+  this._ready = true;
 
   // Check the number of tiles at the minimum level.  If it's more than four,
   // throw an exception, because starting at the higher minimum
@@ -412,8 +339,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.
+   * Gets the width of each tile, in pixels.
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {number}
    * @readonly
@@ -425,8 +351,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.
+   * Gets the height of each tile, in pixels.
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {number}
    * @readonly
@@ -438,8 +363,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.
+   * Gets the maximum level-of-detail that can be requested.
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {number|undefined}
    * @readonly
@@ -451,8 +375,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.
+   * Gets the minimum level-of-detail that can be requested.
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {number}
    * @readonly
@@ -464,8 +387,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, {
   },
 
   /**
-   * Gets the tiling scheme used by this provider.  This function should
-   * not be called before {@link WebMapTileServiceImageryProvider#ready} returns true.
+   * Gets the tiling scheme used by this provider.
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {TilingScheme}
    * @readonly
@@ -477,8 +399,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, {
   },
 
   /**
-   * Gets the rectangle, in radians, of the imagery provided by this instance.  This function should
-   * not be called before {@link WebMapTileServiceImageryProvider#ready} returns true.
+   * Gets the rectangle, in radians, of the imagery provided by this instance.
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {Rectangle}
    * @readonly
@@ -492,8 +413,7 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, {
   /**
    * Gets the tile discard policy.  If not undefined, the discard policy is responsible
    * for filtering out "missing" tiles via its shouldDiscardImage function.  If this function
-   * returns undefined, no tiles are filtered.  This function should
-   * not be called before {@link WebMapTileServiceImageryProvider#ready} returns true.
+   * returns undefined, no tiles are filtered.
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {TileDiscardPolicy}
    * @readonly
@@ -535,9 +455,16 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, {
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {boolean}
    * @readonly
+   * @deprecated
    */
   ready: {
-    value: true,
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.ready",
+        "WebMapTileServiceImageryProvider.ready was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107."
+      );
+      return true;
+    },
   },
 
   /**
@@ -545,16 +472,21 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, {
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {Promise<boolean>}
    * @readonly
+   * @deprecated
    */
   readyPromise: {
     get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.readyPromise",
+        "WebMapTileServiceImageryProvider.readyPromise was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107."
+      );
       return this._readyPromise;
     },
   },
 
   /**
    * Gets the credit to display when this imagery provider is active.  Typically this is used to credit
-   * the source of the imagery.  This function should not be called before {@link WebMapTileServiceImageryProvider#ready} returns true.
+   * the source of the imagery.
    * @memberof WebMapTileServiceImageryProvider.prototype
    * @type {Credit}
    * @readonly
@@ -626,6 +558,242 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, {
       }
     },
   },
+
+  /**
+   * The default alpha blending value of this provider, with 0.0 representing fully transparent and
+   * 1.0 representing fully opaque.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultAlpha: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultAlpha",
+        "WebMapTileServiceImageryProvider.defaultAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.alpha instead."
+      );
+      return this._defaultAlpha;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultAlpha",
+        "WebMapTileServiceImageryProvider.defaultAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.alpha instead."
+      );
+      this._defaultAlpha = value;
+    },
+  },
+
+  /**
+   * 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.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultNightAlpha: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultNightAlpha",
+        "WebMapTileServiceImageryProvider.defaultNightAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.nightAlpha instead."
+      );
+      return this._defaultNightAlpha;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultNightAlpha",
+        "WebMapTileServiceImageryProvider.defaultNightAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.nightAlpha instead."
+      );
+      this._defaultNightAlpha = value;
+    },
+  },
+
+  /**
+   * 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.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultDayAlpha: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultDayAlpha",
+        "WebMapTileServiceImageryProvider.defaultDayAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.dayAlpha instead."
+      );
+      return this._defaultDayAlpha;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultDayAlpha",
+        "WebMapTileServiceImageryProvider.defaultDayAlpha was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.dayAlpha instead."
+      );
+      this._defaultDayAlpha = value;
+    },
+  },
+
+  /**
+   * 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.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultBrightness: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultBrightness",
+        "WebMapTileServiceImageryProvider.defaultBrightness was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.brightness instead."
+      );
+      return this._defaultBrightness;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultBrightness",
+        "WebMapTileServiceImageryProvider.defaultBrightness was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.brightness instead."
+      );
+      this._defaultBrightness = value;
+    },
+  },
+
+  /**
+   * 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.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultContrast: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultContrast",
+        "WebMapTileServiceImageryProvider.defaultContrast was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.contrast instead."
+      );
+      return this._defaultContrast;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultContrast",
+        "WebMapTileServiceImageryProvider.defaultContrast was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.contrast instead."
+      );
+      this._defaultContrast = value;
+    },
+  },
+
+  /**
+   * The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultHue: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultHue",
+        "WebMapTileServiceImageryProvider.defaultHue was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.hue instead."
+      );
+      return this._defaultHue;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultHue",
+        "WebMapTileServiceImageryProvider.defaultHue was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.hue instead."
+      );
+      this._defaultHue = value;
+    },
+  },
+
+  /**
+   * 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.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultSaturation: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultSaturation",
+        "WebMapTileServiceImageryProvider.defaultSaturation was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.saturation instead."
+      );
+      return this._defaultSaturation;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultSaturation",
+        "WebMapTileServiceImageryProvider.defaultSaturation was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.saturation instead."
+      );
+      this._defaultSaturation = value;
+    },
+  },
+
+  /**
+   * The default gamma correction to apply to this provider.  1.0 uses the unmodified imagery color.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {Number|undefined}
+   * @deprecated
+   */
+  defaultGamma: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultGamma",
+        "WebMapTileServiceImageryProvider.defaultGamma was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.gamma instead."
+      );
+      return this._defaultGamma;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultGamma",
+        "WebMapTileServiceImageryProvider.defaultGamma was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.gamma instead."
+      );
+      this._defaultGamma = value;
+    },
+  },
+
+  /**
+   * The default texture minification filter to apply to this provider.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {TextureMinificationFilter}
+   * @deprecated
+   */
+  defaultMinificationFilter: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultMinificationFilter",
+        "WebMapTileServiceImageryProvider.defaultMinificationFilter was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.minificationFilter instead."
+      );
+      return this._defaultMinificationFilter;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultMinificationFilter",
+        "WebMapTileServiceImageryProvider.defaultMinificationFilter was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.minificationFilter instead."
+      );
+      this._defaultMinificationFilter = value;
+    },
+  },
+
+  /**
+   * The default texture magnification filter to apply to this provider.
+   * @memberof WebMapTileServiceImageryProvider.prototype
+   * @type {TextureMagnificationFilter}
+   * @deprecated
+   */
+  defaultMagnificationFilter: {
+    get: function () {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultMagnificationFilter",
+        "WebMapTileServiceImageryProvider.defaultMagnificationFilter was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.magnificationFilter instead."
+      );
+      return this._defaultMagnificationFilter;
+    },
+    set: function (value) {
+      deprecationWarning(
+        "WebMapTileServiceImageryProvider.defaultMagnificationFilter",
+        "WebMapTileServiceImageryProvider.defaultMagnificationFilter was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use ImageryLayer.magnificationFilter instead."
+      );
+      this._defaultMagnificationFilter = value;
+    },
+  },
 });
 
 /**
@@ -635,8 +803,6 @@ Object.defineProperties(WebMapTileServiceImageryProvider.prototype, {
  * @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} <code>getTileCredits</code> must not be called before the imagery provider is ready.
  */
 WebMapTileServiceImageryProvider.prototype.getTileCredits = function (
   x,
@@ -647,8 +813,7 @@ WebMapTileServiceImageryProvider.prototype.getTileCredits = function (
 };
 
 /**
- * Requests the image for a given tile.  This function should
- * not be called before {@link WebMapTileServiceImageryProvider#ready} returns true.
+ * Requests the image for a given tile.
  *
  * @param {number} x The tile X coordinate.
  * @param {number} y The tile Y coordinate.
@@ -656,8 +821,6 @@ WebMapTileServiceImageryProvider.prototype.getTileCredits = function (
  * @param {Request} [request] The request object. Intended for internal use only.
  * @returns {Promise<ImageryTypes>|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} <code>requestImage</code> must not be called before the imagery provider is ready.
  */
 WebMapTileServiceImageryProvider.prototype.requestImage = function (
   x,

package/Source/Scene/computeFlyToLocationForRectangle.js

@@ -10,11 +10,11 @@ import SceneMode from "./SceneMode.js";
  * @param {Rectangle} rectangle The rectangle being zoomed to.
  * @param {Scene} scene The scene being used.
  *
- * @returns {Cartographic} The optimal location to place the camera so that the entire rectangle is in view.
+ * @returns {Promise<Cartographic>} The optimal location to place the camera so that the entire rectangle is in view.
  *
  * @private
  */
-function computeFlyToLocationForRectangle(rectangle, scene) {
+async function computeFlyToLocationForRectangle(rectangle, scene) {
   const terrainProvider = scene.terrainProvider;
   const mapProjection = scene.mapProjection;
   const ellipsoid = mapProjection.ellipsoid;
@@ -28,49 +28,45 @@ function computeFlyToLocationForRectangle(rectangle, scene) {
   }
 
   if (!defined(terrainProvider)) {
-    return Promise.resolve(positionWithoutTerrain);
+    return positionWithoutTerrain;
   }
 
-  return terrainProvider.readyPromise.then(function () {
-    const availability = terrainProvider.availability;
+  // readyPromise has been deprecated; This is here for backwards compatibility
+  await terrainProvider._readyPromise;
+  const availability = terrainProvider.availability;
 
-    if (!defined(availability) || scene.mode === SceneMode.SCENE2D) {
-      return positionWithoutTerrain;
-    }
+  if (!defined(availability) || scene.mode === SceneMode.SCENE2D) {
+    return positionWithoutTerrain;
+  }
 
-    const cartographics = [
-      Rectangle.center(rectangle),
-      Rectangle.southeast(rectangle),
-      Rectangle.southwest(rectangle),
-      Rectangle.northeast(rectangle),
-      Rectangle.northwest(rectangle),
-    ];
+  const cartographics = [
+    Rectangle.center(rectangle),
+    Rectangle.southeast(rectangle),
+    Rectangle.southwest(rectangle),
+    Rectangle.northeast(rectangle),
+    Rectangle.northwest(rectangle),
+  ];
 
-    return computeFlyToLocationForRectangle
-      ._sampleTerrainMostDetailed(terrainProvider, cartographics)
-      .then(function (positionsOnTerrain) {
-        let heightFound = false;
-        const maxHeight = positionsOnTerrain.reduce(function (
-          currentMax,
-          item
-        ) {
-          if (!defined(item.height)) {
-            return currentMax;
-          }
-          heightFound = true;
-          return Math.max(item.height, currentMax);
-        },
-        -Number.MAX_VALUE);
+  const positionsOnTerrain = await computeFlyToLocationForRectangle._sampleTerrainMostDetailed(
+    terrainProvider,
+    cartographics
+  );
 
-        const finalPosition = positionWithoutTerrain;
+  let heightFound = false;
+  const maxHeight = positionsOnTerrain.reduce(function (currentMax, item) {
+    if (!defined(item.height)) {
+      return currentMax;
+    }
+    heightFound = true;
+    return Math.max(item.height, currentMax);
+  }, -Number.MAX_VALUE);
 
-        if (heightFound) {
-          finalPosition.height += maxHeight;
-        }
+  const finalPosition = positionWithoutTerrain;
+  if (heightFound) {
+    finalPosition.height += maxHeight;
+  }
 
-        return finalPosition;
-      });
-  });
+  return finalPosition;
 }
 
 //Exposed for testing.

package/Source/Scene/createOsmBuildings.js

@@ -2,6 +2,7 @@ import Color from "../Core/Color.js";
 import combine from "../Core/combine.js";
 import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
+import deprecationWarning from "../Core/deprecationWarning.js";
 import IonResource from "../Core/IonResource.js";
 import Cesium3DTileset from "./Cesium3DTileset.js";
 import Cesium3DTileStyle from "./Cesium3DTileStyle.js";
@@ -49,6 +50,11 @@ import Cesium3DTileStyle from "./Cesium3DTileStyle.js";
  * }));
  */
 function createOsmBuildings(options) {
+  deprecationWarning(
+    "createOsmBuildings",
+    "createOsmBuildings was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use createOsmBuildingsAsync instead."
+  );
+
   options = combine(options, {
     url: IonResource.fromAssetId(96188),
   });

package/Source/Scene/createOsmBuildingsAsync.js

@@ -0,0 +1,82 @@
+import Color from "../Core/Color.js";
+import defaultValue from "../Core/defaultValue.js";
+import defined from "../Core/defined.js";
+import Cesium3DTileset from "./Cesium3DTileset.js";
+import Cesium3DTileStyle from "./Cesium3DTileStyle.js";
+
+/**
+ * Creates a {@link Cesium3DTileset} instance for the
+ * {@link https://cesium.com/content/cesium-osm-buildings/|Cesium OSM Buildings}
+ * tileset.
+ *
+ * @function
+ *
+ * @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 <code>options.style</code> is specified.
+ * @param {Cesium3DTileStyle} [options.style] The style to use with the tileset. If not
+ *        specified, a default style is used which gives each building or building part a
+ *        color inferred from its OpenStreetMap <code>tags</code>. If no color can be inferred,
+ *        <code>options.defaultColor</code> 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,
+ *        outlines are displayed. When false, outlines are not displayed.
+ * @returns {Promise<Cesium3DTileset>}
+ *
+ * @see Ion
+ *
+ * @example
+ * // Create Cesium OSM Buildings with default styling
+ * const viewer = new Cesium.Viewer("cesiumContainer");
+ * try {
+ *   const tileset = await Cesium.createOsmBuildingsAsync();
+ *   viewer.scene.primitives.add(tileset));
+ * } catch (error) {
+ *   console.log(`Error creating tileset: ${error}`);
+ * }
+ *
+ * @example
+ * // Create Cesium OSM Buildings with a custom style highlighting
+ * // schools and hospitals.
+ * const viewer = new Cesium.Viewer("cesiumContainer");
+ * try {
+ *   const tileset = await Cesium.createOsmBuildingsAsync({
+ *     style: new Cesium.Cesium3DTileStyle({
+ *       color: {
+ *         conditions: [
+ *           ["${feature['building']} === 'hospital'", "color('#0000FF')"],
+ *           ["${feature['building']} === 'school'", "color('#00FF00')"],
+ *           [true, "color('#ffffff')"]
+ *         ]
+ *       }
+ *     })
+ *   });
+ *   viewer.scene.primitives.add(tileset));
+ * } catch (error) {
+ *   console.log(`Error creating tileset: ${error}`);
+ * }
+ */
+async function createOsmBuildingsAsync(options) {
+  const tileset = await Cesium3DTileset.fromIonAssetId(96188, options);
+
+  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+
+  let style = options.style;
+
+  if (!defined(style)) {
+    const color = defaultValue(
+      options.defaultColor,
+      Color.WHITE
+    ).toCssColorString();
+    style = new Cesium3DTileStyle({
+      color: `Boolean(\${feature['cesium#color']}) ? color(\${feature['cesium#color']}) : ${color}`,
+    });
+  }
+
+  tileset.style = style;
+
+  return tileset;
+}
+
+export default createOsmBuildingsAsync;