@cesium/engine 2.4.1 → 3.0.0

package/Source/Scene/IonImageryProvider.js

@@ -1,7 +1,6 @@
 import Check from "../Core/Check.js";
 import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
-import deprecationWarning from "../Core/deprecationWarning.js";
 import Event from "../Core/Event.js";
 import IonResource from "../Core/IonResource.js";
 import RuntimeError from "../Core/RuntimeError.js";
@@ -15,26 +14,8 @@ import UrlTemplateImageryProvider from "./UrlTemplateImageryProvider.js";
 import WebMapServiceImageryProvider from "./WebMapServiceImageryProvider.js";
 import WebMapTileServiceImageryProvider from "./WebMapTileServiceImageryProvider.js";
 
-function createFactory(Type) {
-  return function (options) {
-    return new Type(options);
-  };
-}
-
 // These values are the list of supported external imagery
 // assets in the Cesium ion beta. They are subject to change.
-const ImageryProviderMapping = {
-  ARCGIS_MAPSERVER: createFactory(ArcGisMapServerImageryProvider),
-  BING: createFactory(BingMapsImageryProvider),
-  GOOGLE_EARTH: createFactory(GoogleEarthEnterpriseMapsProvider),
-  MAPBOX: createFactory(MapboxImageryProvider),
-  SINGLE_TILE: createFactory(SingleTileImageryProvider),
-  TMS: createFactory(TileMapServiceImageryProvider),
-  URL_TEMPLATE: createFactory(UrlTemplateImageryProvider),
-  WMS: createFactory(WebMapServiceImageryProvider),
-  WMTS: createFactory(WebMapTileServiceImageryProvider),
-};
-
 const ImageryProviderAsyncMapping = {
   ARCGIS_MAPSERVER: ArcGisMapServerImageryProvider.fromUrl,
   BING: async (url, options) => {
@@ -78,7 +59,6 @@ const ImageryProviderAsyncMapping = {
  *
  * Initialization options for the TileMapServiceImageryProvider constructor
  *
- * @property {number} [assetId] An ion imagery asset ID. Deprecated.
  * @property {string} [accessToken=Ion.defaultAccessToken] The access token to use.
  * @property {string|Resource} [server=Ion.defaultServer] The resource to the Cesium ion API server.
  */
@@ -93,7 +73,7 @@ const ImageryProviderAsyncMapping = {
  * @alias IonImageryProvider
  * @constructor
  *
- * @param {IonImageryProvider.ConstructorOptions} options Object describing initialization options
+ * @param {IonImageryProvider.ConstructorOptions} [options] Object describing initialization options
  *
  * @example
  * const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
@@ -115,56 +95,11 @@ function IonImageryProvider(options) {
   this._defaultMinificationFilter = undefined;
   this._defaultMagnificationFilter = undefined;
 
-  this._ready = false;
   this._tileCredits = undefined;
   this._errorEvent = new Event();
-
-  const assetId = options.assetId;
-  if (defined(assetId)) {
-    deprecationWarning(
-      "IonImageryProvider options.assetId",
-      "options.assetId was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use IonImageryProvider.fromAssetId instead."
-    );
-
-    IonImageryProvider._initialize(this, assetId, options);
-  }
 }
 
 Object.defineProperties(IonImageryProvider.prototype, {
-  /**
-   * Gets a value indicating whether or not the provider is ready for use.
-   * @memberof IonImageryProvider.prototype
-   * @type {boolean}
-   * @readonly
-   * @deprecated
-   */
-  ready: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.ready",
-        "IonImageryProvider.ready was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use IonImageryProvider.fromAssetId instead."
-      );
-      return this._ready;
-    },
-  },
-
-  /**
-   * Gets a promise that resolves to true when the provider is ready for use.
-   * @memberof IonImageryProvider.prototype
-   * @type {Promise<boolean>}
-   * @readonly
-   * @deprecated
-   */
-  readyPromise: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.readyPromise",
-        "IonImageryProvider.readyPromise was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use IonImageryProvider.fromAssetId instead."
-      );
-      return this._readyPromise;
-    },
-  },
-
   /**
    * Gets the rectangle, in radians, of the imagery provided by the instance.
    * @memberof IonImageryProvider.prototype
@@ -310,309 +245,8 @@ Object.defineProperties(IonImageryProvider.prototype, {
       return undefined;
     },
   },
-
-  /**
-   * The default alpha blending value of this provider, with 0.0 representing fully transparent and
-   * 1.0 representing fully opaque.
-   * @memberof IonImageryProvider.prototype
-   * @type {Number|undefined}
-   * @deprecated
-   */
-  defaultAlpha: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultAlpha",
-        "IonImageryProvider.defaultAlpha was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.alpha instead."
-      );
-      return this._defaultAlpha;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultAlpha",
-        "IonImageryProvider.defaultAlpha was deprecated in CesiumJS 1.104.  It will be removed 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 IonImageryProvider.prototype
-   * @type {Number|undefined}
-   * @deprecated
-   */
-  defaultNightAlpha: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultNightAlpha",
-        "IonImageryProvider.defaultNightAlpha was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.nightAlpha instead."
-      );
-      return this.defaultNightAlpha;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultNightAlpha",
-        "IonImageryProvider.defaultNightAlpha was deprecated in CesiumJS 1.104.  It will be removed 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 IonImageryProvider.prototype
-   * @type {Number|undefined}
-   * @deprecated
-   */
-  defaultDayAlpha: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultDayAlpha",
-        "IonImageryProvider.defaultDayAlpha was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.dayAlpha instead."
-      );
-      return this._defaultDayAlpha;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultDayAlpha",
-        "IonImageryProvider.defaultDayAlpha was deprecated in CesiumJS 1.104.  It will be removed 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 IonImageryProvider.prototype
-   * @type {Number|undefined}
-   * @deprecated
-   */
-  defaultBrightness: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultBrightness",
-        "IonImageryProvider.defaultBrightness was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.brightness instead."
-      );
-      return this._defaultBrightness;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultBrightness",
-        "IonImageryProvider.defaultBrightness was deprecated in CesiumJS 1.104.  It will be removed 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 IonImageryProvider.prototype
-   * @type {Number|undefined}
-   * @deprecated
-   */
-  defaultContrast: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultContrast",
-        "IonImageryProvider.defaultContrast was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.contrast instead."
-      );
-      return this._defaultContrast;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultContrast",
-        "IonImageryProvider.defaultContrast was deprecated in CesiumJS 1.104.  It will be removed 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 IonImageryProvider.prototype
-   * @type {Number|undefined}
-   * @deprecated
-   */
-  defaultHue: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultHue",
-        "IonImageryProvider.defaultHue was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.hue instead."
-      );
-      return this._defaultHue;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultHue",
-        "IonImageryProvider.defaultHue was deprecated in CesiumJS 1.104.  It will be removed 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 IonImageryProvider.prototype
-   * @type {Number|undefined}
-   * @deprecated
-   */
-  defaultSaturation: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultSaturation",
-        "IonImageryProvider.defaultSaturation was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.saturation instead."
-      );
-      return this._defaultSaturation;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultSaturation",
-        "IonImageryProvider.defaultSaturation was deprecated in CesiumJS 1.104.  It will be removed 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 IonImageryProvider.prototype
-   * @type {Number|undefined}
-   * @deprecated
-   */
-  defaultGamma: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultGamma",
-        "IonImageryProvider.defaultGamma was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.gamma instead."
-      );
-      return this._defaultGamma;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultGamma",
-        "IonImageryProvider.defaultGamma was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.gamma instead."
-      );
-      this._defaultGamma = value;
-    },
-  },
-
-  /**
-   * The default texture minification filter to apply to this provider.
-   * @memberof IonImageryProvider.prototype
-   * @type {TextureMinificationFilter}
-   * @deprecated
-   */
-  defaultMinificationFilter: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultMinificationFilter",
-        "IonImageryProvider.defaultMinificationFilter was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.minificationFilter instead."
-      );
-      return this._defaultMinificationFilter;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultMinificationFilter",
-        "IonImageryProvider.defaultMinificationFilter was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.minificationFilter instead."
-      );
-      this._defaultMinificationFilter = value;
-    },
-  },
-
-  /**
-   * The default texture magnification filter to apply to this provider.
-   * @memberof IonImageryProvider.prototype
-   * @type {TextureMagnificationFilter}
-   * @deprecated
-   */
-  defaultMagnificationFilter: {
-    get: function () {
-      deprecationWarning(
-        "IonImageryProvider.defaultMagnificationFilter",
-        "IonImageryProvider.defaultMagnificationFilter was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.magnificationFilter instead."
-      );
-      return this._defaultMagnificationFilter;
-    },
-    set: function (value) {
-      deprecationWarning(
-        "IonImageryProvider.defaultMagnificationFilter",
-        "IonImageryProvider.defaultMagnificationFilter was deprecated in CesiumJS 1.104.  It will be removed in CesiumJS 1.107.  Use ImageryLayer.magnificationFilter instead."
-      );
-      this._defaultMagnificationFilter = value;
-    },
-  },
 });
 
-// This is here for backwards compatibility
-IonImageryProvider._initialize = function (provider, assetId, options) {
-  const endpointResource = IonResource._createEndpointResource(
-    assetId,
-    options
-  );
-
-  // A simple cache to avoid making repeated requests to ion for endpoints we've
-  // already retrieved. This exists mainly to support Bing caching to reduce
-  // world imagery sessions, but provides a small boost of performance in general
-  // if constantly reloading assets
-  const cacheKey = assetId.toString() + options.accessToken + options.server;
-  let promise = IonImageryProvider._endpointCache[cacheKey];
-  if (!defined(promise)) {
-    promise = endpointResource.fetchJson();
-    IonImageryProvider._endpointCache[cacheKey] = promise;
-  }
-
-  provider._readyPromise = promise.then(function (endpoint) {
-    if (endpoint.type !== "IMAGERY") {
-      return Promise.reject(
-        new RuntimeError(`Cesium ion asset ${assetId} is not an imagery asset.`)
-      );
-    }
-
-    let imageryProvider;
-    const externalType = endpoint.externalType;
-    if (!defined(externalType)) {
-      imageryProvider = new TileMapServiceImageryProvider({
-        url: new IonResource(endpoint, endpointResource),
-      });
-    } else {
-      const factory = ImageryProviderMapping[externalType];
-
-      if (!defined(factory)) {
-        return Promise.reject(
-          new RuntimeError(
-            `Unrecognized Cesium ion imagery type: ${externalType}`
-          )
-        );
-      }
-      imageryProvider = factory(endpoint.options);
-    }
-
-    provider._tileCredits = IonResource.getCreditsFromEndpoint(
-      endpoint,
-      endpointResource
-    );
-
-    imageryProvider.errorEvent.addEventListener(function (tileProviderError) {
-      //Propagate the errorEvent but set the provider to this instance instead
-      //of the inner instance.
-      tileProviderError.provider = provider;
-      provider._errorEvent.raiseEvent(tileProviderError);
-    });
-
-    provider._imageryProvider = imageryProvider;
-    // readyPromise is deprecated. This is here for backwards compatibility
-    return Promise.resolve(imageryProvider._readyPromise).then(function () {
-      provider._ready = true;
-      return true;
-    });
-  });
-};
-
 /**
  * Creates a provider for tiled imagery using the Cesium ion REST API.
  *
@@ -692,8 +326,6 @@ IonImageryProvider.fromAssetId = async function (assetId, options) {
   );
 
   provider._imageryProvider = imageryProvider;
-  provider._ready = true;
-  provider._readyPromise = Promise.resolve(true);
 
   return provider;
 };