Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 | 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 251x 1x 63x 63x 1x 63x 125x 353x 1x 29x 123x 1x 1x 254x 253x 253x 253x 253x 253x 38x 38x 253x 253x 1x 252x 252x 252x 252x 252x 252x 252x 250x 250x 1x 251x 251x 251x 251x 251x 251x 1x 40x 40x 10x 30x 1x 29x 1x 1x 1x | import Check from "../Core/Check.js";
import clone from "../Core/clone.js";
import Frozen from "../Core/Frozen.js";
import defined from "../Core/defined.js";
import Event from "../Core/Event.js";
import IonResource from "../Core/IonResource.js";
import RuntimeError from "../Core/RuntimeError.js";
import IonImageryProviderFactory from "./IonImageryProviderFactory.js";
/**
* @typedef {object} IonImageryProvider.ConstructorOptions
*
* Initialization options for the TileMapServiceImageryProvider constructor
*
* @property {string} [accessToken=Ion.defaultAccessToken] The access token to use.
* @property {string|Resource} [server=Ion.defaultServer] The resource to the Cesium ion API server.
*/
/**
* <div class="notice">
* To construct a IonImageryProvider, call {@link IonImageryProvider.fromAssetId}. Do not call the constructor directly.
* </div>
*
* Provides tiled imagery using the Cesium ion REST API.
*
* @alias IonImageryProvider
* @constructor
*
* @param {IonImageryProvider.ConstructorOptions} [options] Object describing initialization options
*
* @example
* const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
* viewer.imageryLayers.add(imageryLayer);
*
* @see IonImageryProvider.fromAssetId
*/
function IonImageryProvider(options) {
options = options ?? Frozen.EMPTY_OBJECT;
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;
this._tileCredits = undefined;
this._errorEvent = new Event();
}
Object.defineProperties(IonImageryProvider.prototype, {
/**
* Gets the rectangle, in radians, of the imagery provided by the instance.
* @memberof IonImageryProvider.prototype
* @type {Rectangle}
* @readonly
*/
rectangle: {
get: function () {
return this._imageryProvider.rectangle;
},
},
/**
* Gets the width of each tile, in pixels.
* @memberof IonImageryProvider.prototype
* @type {number}
* @readonly
*/
tileWidth: {
get: function () {
return this._imageryProvider.tileWidth;
},
},
/**
* Gets the height of each tile, in pixels.
* @memberof IonImageryProvider.prototype
* @type {number}
* @readonly
*/
tileHeight: {
get: function () {
return this._imageryProvider.tileHeight;
},
},
/**
* Gets the maximum level-of-detail that can be requested.
* @memberof IonImageryProvider.prototype
* @type {number|undefined}
* @readonly
*/
maximumLevel: {
get: function () {
return this._imageryProvider.maximumLevel;
},
},
/**
* Gets the minimum level-of-detail that can be requested. Generally,
* a minimum level should only be used when the rectangle of the imagery is small
* enough that the number of tiles at the minimum level is small. An imagery
* provider with more than a few tiles at the minimum level will lead to
* rendering problems.
* @memberof IonImageryProvider.prototype
* @type {number}
* @readonly
*/
minimumLevel: {
get: function () {
return this._imageryProvider.minimumLevel;
},
},
/**
* Gets the tiling scheme used by the provider.
* @memberof IonImageryProvider.prototype
* @type {TilingScheme}
* @readonly
*/
tilingScheme: {
get: function () {
return this._imageryProvider.tilingScheme;
},
},
/**
* 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.
* @memberof IonImageryProvider.prototype
* @type {TileDiscardPolicy}
* @readonly
*/
tileDiscardPolicy: {
get: function () {
return this._imageryProvider.tileDiscardPolicy;
},
},
/**
* Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing
* to the event, you will be notified of the error and can potentially recover from it. Event listeners
* are passed an instance of {@link TileProviderError}.
* @memberof IonImageryProvider.prototype
* @type {Event}
* @readonly
*/
errorEvent: {
get: function () {
return this._errorEvent;
},
},
/**
* Gets the credit to display when this imagery provider is active. Typically this is used to credit
* the source of the imagery.
* @memberof IonImageryProvider.prototype
* @type {Credit}
* @readonly
*/
credit: {
get: function () {
return this._imageryProvider.credit;
},
},
/**
* Gets a value indicating whether or not the images provided by this imagery provider
* include an alpha channel. If this property is false, an alpha channel, if present, will
* be ignored. If this property is true, any images without an alpha channel will be treated
* as if their alpha is 1.0 everywhere. When this property is false, memory usage
* and texture upload time are reduced.
* @memberof IonImageryProvider.prototype
* @type {boolean}
* @readonly
*/
hasAlphaChannel: {
get: function () {
return this._imageryProvider.hasAlphaChannel;
},
},
/**
* Gets the proxy used by this provider.
* @memberof IonImageryProvider.prototype
* @type {Proxy}
* @readonly
* @default undefined
*/
proxy: {
get: function () {
return undefined;
},
},
});
/**
* Creates a provider for tiled imagery using the Cesium ion REST API.
*
* @param {number} assetId An ion imagery asset ID.
* @param {IonImageryProvider.ConstructorOptions} [options] Object describing initialization options.
* @returns {Promise<IonImageryProvider>} A promise which resolves to the created IonImageryProvider.
*
* @example
* const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
* viewer.imageryLayers.add(imageryLayer);
*
* @exception {RuntimeError} Cesium ion assetId is not an imagery asset
* @exception {RuntimeError} Unrecognized Cesium ion imagery type
*/
IonImageryProvider.fromAssetId = async function (assetId, options) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.number("assetId", assetId);
//>>includeEnd('debug');
options = options ?? Frozen.EMPTY_OBJECT;
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;
}
let endpoint = await promise;
if (endpoint.type !== "IMAGERY") {
throw new RuntimeError(
`Cesium ion asset ${assetId} is not an imagery asset.`,
);
}
const externalType = endpoint.externalType;
let factory = IonImageryProviderFactory.defaultFactoryCallback;
// Make a copy before editing since this object reference is cached;
endpoint = clone(endpoint, true);
endpoint.options = endpoint.options ?? {};
const url = endpoint.options?.url;
delete options.url;
if (defined(externalType)) {
factory = IonImageryProviderFactory[externalType];
if (!defined(factory)) {
throw new RuntimeError(
`Unrecognized Cesium ion imagery type: ${externalType}`,
);
}
}
const imageryProvider = await factory(url, endpoint, endpointResource);
const provider = new IonImageryProvider(options);
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._tileCredits = IonResource.getCreditsFromEndpoint(
endpoint,
endpointResource,
);
provider._imageryProvider = imageryProvider;
return provider;
};
/**
* Gets the credits to be displayed when a given tile is displayed.
* @function
*
* @param {number} x The tile X coordinate.
* @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.
*/
IonImageryProvider.prototype.getTileCredits = function (x, y, level) {
const innerCredits = this._imageryProvider.getTileCredits(x, y, level);
if (!defined(innerCredits)) {
return this._tileCredits;
}
return this._tileCredits.concat(innerCredits);
};
/**
* Requests the image for a given tile.
* @function
*
* @param {number} x The tile X coordinate.
* @param {number} y The tile Y coordinate.
* @param {number} level The tile level.
* @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.
*/
IonImageryProvider.prototype.requestImage = function (x, y, level, request) {
return this._imageryProvider.requestImage(x, y, level, request);
};
/**
* Asynchronously determines what features, if any, are located at a given longitude and latitude within
* a tile. This function is optional, so it may not exist on all ImageryProviders.
*
* @function
*
* @param {number} x The tile X coordinate.
* @param {number} y The tile Y coordinate.
* @param {number} level The tile level.
* @param {number} longitude The longitude at which to pick features.
* @param {number} latitude The latitude at which to pick features.
* @return {Promise<ImageryLayerFeatureInfo[]>|undefined} A promise for the picked features that will resolve when the asynchronous
* picking completes. The resolved value is an array of {@link ImageryLayerFeatureInfo}
* instances. The array may be empty if no features are found at the given location.
* It may also be undefined if picking is not supported.
*/
IonImageryProvider.prototype.pickFeatures = function (
x,
y,
level,
longitude,
latitude,
) {
return this._imageryProvider.pickFeatures(x, y, level, longitude, latitude);
};
//exposed for testing
IonImageryProvider._endpointCache = {};
export default IonImageryProvider;
|