-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
IonImageryProvider.js
394 lines (362 loc) · 12.4 KB
/
IonImageryProvider.js
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
import Check from "../Core/Check.js";
import defaultValue from "../Core/defaultValue.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 ArcGisMapServerImageryProvider from "./ArcGisMapServerImageryProvider.js";
import BingMapsImageryProvider from "./BingMapsImageryProvider.js";
import TileMapServiceImageryProvider from "./TileMapServiceImageryProvider.js";
import GoogleEarthEnterpriseMapsProvider from "./GoogleEarthEnterpriseMapsProvider.js";
import MapboxImageryProvider from "./MapboxImageryProvider.js";
import SingleTileImageryProvider from "./SingleTileImageryProvider.js";
import UrlTemplateImageryProvider from "./UrlTemplateImageryProvider.js";
import WebMapServiceImageryProvider from "./WebMapServiceImageryProvider.js";
import WebMapTileServiceImageryProvider from "./WebMapTileServiceImageryProvider.js";
// These values are the list of supported external imagery
// assets in the Cesium ion beta. They are subject to change.
const ImageryProviderAsyncMapping = {
ARCGIS_MAPSERVER: ArcGisMapServerImageryProvider.fromUrl,
BING: async (url, options) => {
return BingMapsImageryProvider.fromUrl(url, options);
},
GOOGLE_EARTH: async (url, options) => {
const channel = options.channel;
delete options.channel;
return GoogleEarthEnterpriseMapsProvider.fromUrl(url, channel, options);
},
MAPBOX: (url, options) => {
return new MapboxImageryProvider({
url: url,
...options,
});
},
SINGLE_TILE: SingleTileImageryProvider.fromUrl,
TMS: TileMapServiceImageryProvider.fromUrl,
URL_TEMPLATE: (url, options) => {
return new UrlTemplateImageryProvider({
url: url,
...options,
});
},
WMS: (url, options) => {
return new WebMapServiceImageryProvider({
url: url,
...options,
});
},
WMTS: (url, options) => {
return new WebMapTileServiceImageryProvider({
url: url,
...options,
});
},
};
/**
* @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 = defaultValue(options, defaultValue.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 = defaultValue(options, defaultValue.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;
}
const endpoint = await promise;
if (endpoint.type !== "IMAGERY") {
throw new RuntimeError(
`Cesium ion asset ${assetId} is not an imagery asset.`
);
}
let imageryProvider;
const externalType = endpoint.externalType;
if (!defined(externalType)) {
imageryProvider = await TileMapServiceImageryProvider.fromUrl(
new IonResource(endpoint, endpointResource)
);
} else {
const factory = ImageryProviderAsyncMapping[externalType];
if (!defined(factory)) {
throw new RuntimeError(
`Unrecognized Cesium ion imagery type: ${externalType}`
);
}
// Make a copy before editing since this object reference is cached;
const options = { ...endpoint.options };
const url = options.url;
delete options.url;
imageryProvider = await factory(url, options);
}
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;