/
GoogleEarthEnterpriseImageryProvider.js
620 lines (563 loc) · 23.3 KB
/
GoogleEarthEnterpriseImageryProvider.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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
define([
'../Core/Credit',
'../Core/decodeGoogleEarthEnterpriseData',
'../Core/defaultValue',
'../Core/defined',
'../Core/defineProperties',
'../Core/DeveloperError',
'../Core/Event',
'../Core/GeographicTilingScheme',
'../Core/GoogleEarthEnterpriseMetadata',
'../Core/loadArrayBuffer',
'../Core/loadImageFromTypedArray',
'../Core/Math',
'../Core/Rectangle',
'../Core/Request',
'../Core/RequestType',
'../Core/RuntimeError',
'../Core/TileProviderError',
'../ThirdParty/protobuf-minimal',
'../ThirdParty/when'
], function(
Credit,
decodeGoogleEarthEnterpriseData,
defaultValue,
defined,
defineProperties,
DeveloperError,
Event,
GeographicTilingScheme,
GoogleEarthEnterpriseMetadata,
loadArrayBuffer,
loadImageFromTypedArray,
CesiumMath,
Rectangle,
Request,
RequestType,
RuntimeError,
TileProviderError,
protobuf,
when) {
'use strict';
function GoogleEarthEnterpriseDiscardPolicy() {
this._image = new Image();
}
/**
* Determines if the discard policy is ready to process images.
* @returns {Boolean} True if the discard policy is ready to process images; otherwise, false.
*/
GoogleEarthEnterpriseDiscardPolicy.prototype.isReady = function() {
return true;
};
/**
* Given a tile image, decide whether to discard that image.
*
* @param {Image} image An image to test.
* @returns {Boolean} True if the image should be discarded; otherwise, false.
*/
GoogleEarthEnterpriseDiscardPolicy.prototype.shouldDiscardImage = function(image) {
return (image === this._image);
};
/**
* Provides tiled imagery using the Google Earth Enterprise REST API.
*
* Notes: This provider is for use with the 3D Earth API of Google Earth Enterprise,
* {@link GoogleEarthEnterpriseMapsProvider} should be used with 2D Maps API.
*
* @alias GoogleEarthEnterpriseImageryProvider
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {String} options.url The url of the Google Earth Enterprise server hosting the imagery.
* @param {GoogleEarthEnterpriseMetadata} options.metadata A metadata object that can be used to share metadata requests with a GoogleEarthEnterpriseTerrainProvider.
* @param {Proxy} [options.proxy] A proxy to use for requests. This object is
* expected to have a getURL function which returns the proxied URL, if needed.
* @param {Ellipsoid} [options.ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used.
* @param {TileDiscardPolicy} [options.tileDiscardPolicy] The policy that determines if a tile
* is invalid and should be discarded. If this value is not specified, a default
* is to discard tiles that fail to download.
* @param {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas.
*
* @see GoogleEarthEnterpriseTerrainProvider
* @see ArcGisMapServerImageryProvider
* @see GoogleEarthEnterpriseMapsProvider
* @see createOpenStreetMapImageryProvider
* @see SingleTileImageryProvider
* @see createTileMapServiceImageryProvider
* @see WebMapServiceImageryProvider
* @see WebMapTileServiceImageryProvider
* @see UrlTemplateImageryProvider
*
*
* @example
* var geeMetadata = new GoogleEarthEnterpriseMetadata('http://www.earthenterprise.org/3d');
* var gee = new Cesium.GoogleEarthEnterpriseImageryProvider({
* metadata : geeMetadata
* });
*
* @see {@link http://www.w3.org/TR/cors/|Cross-Origin Resource Sharing}
*/
function GoogleEarthEnterpriseImageryProvider(options) {
options = defaultValue(options, defaultValue.EMPTY_OBJECT);
//>>includeStart('debug', pragmas.debug);
if (!(defined(options.url) || defined(options.metadata))) {
throw new DeveloperError('options.url or options.metadata is required.');
}
//>>includeEnd('debug');
var metadata;
if (defined(options.metadata)) {
metadata = this._metadata = options.metadata;
} else {
metadata = this._metadata = new GoogleEarthEnterpriseMetadata({
url : options.url,
proxy : options.proxy
});
}
this._tileDiscardPolicy = options.tileDiscardPolicy;
this._proxy = defaultValue(options.proxy, this._metadata.proxy);
this._tilingScheme = new GeographicTilingScheme({
numberOfLevelZeroTilesX : 2,
numberOfLevelZeroTilesY : 2,
rectangle : new Rectangle(-CesiumMath.PI, -CesiumMath.PI, CesiumMath.PI, CesiumMath.PI),
ellipsoid : options.ellipsoid
});
var credit = options.credit;
if (typeof credit === 'string') {
credit = new Credit(credit);
}
this._credit = credit;
this._tileWidth = 256;
this._tileHeight = 256;
this._maximumLevel = 23;
// Install the default tile discard policy if none has been supplied.
if (!defined(this._tileDiscardPolicy)) {
this._tileDiscardPolicy = new GoogleEarthEnterpriseDiscardPolicy();
}
this._errorEvent = new Event();
this._ready = false;
var that = this;
var metadataError;
this._readyPromise = metadata.readyPromise
.then(function(result) {
if (!metadata.imageryPresent) {
var e = new RuntimeError('The server ' + metadata.url + ' doesn\'t have imagery');
metadataError = TileProviderError.handleError(metadataError, that, that._errorEvent, e.message, undefined, undefined, undefined, e);
return when.reject(e);
}
TileProviderError.handleSuccess(metadataError);
that._ready = result;
return result;
})
.otherwise(function(e) {
metadataError = TileProviderError.handleError(metadataError, that, that._errorEvent, e.message, undefined, undefined, undefined, e);
return when.reject(e);
});
}
defineProperties(GoogleEarthEnterpriseImageryProvider.prototype, {
/**
* Gets the name of the Google Earth Enterprise server url hosting the imagery.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {String}
* @readonly
*/
url : {
get : function() {
return this._metadata.url;
}
},
/**
* Gets the proxy used by this provider.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Proxy}
* @readonly
*/
proxy : {
get : function() {
return this._proxy;
}
},
/**
* Gets the width of each tile, in pixels. This function should
* not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Number}
* @readonly
*/
tileWidth : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('tileWidth must not be called before the imagery provider is ready.');
}
//>>includeEnd('debug');
return this._tileWidth;
}
},
/**
* Gets the height of each tile, in pixels. This function should
* not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Number}
* @readonly
*/
tileHeight : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('tileHeight must not be called before the imagery provider is ready.');
}
//>>includeEnd('debug');
return this._tileHeight;
}
},
/**
* Gets the maximum level-of-detail that can be requested. This function should
* not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Number}
* @readonly
*/
maximumLevel : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('maximumLevel must not be called before the imagery provider is ready.');
}
//>>includeEnd('debug');
return this._maximumLevel;
}
},
/**
* Gets the minimum level-of-detail that can be requested. This function should
* not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Number}
* @readonly
*/
minimumLevel : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('minimumLevel must not be called before the imagery provider is ready.');
}
//>>includeEnd('debug');
return 0;
}
},
/**
* Gets the tiling scheme used by this provider. This function should
* not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {TilingScheme}
* @readonly
*/
tilingScheme : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('tilingScheme must not be called before the imagery provider is ready.');
}
//>>includeEnd('debug');
return this._tilingScheme;
}
},
/**
* Gets the rectangle, in radians, of the imagery provided by this instance. This function should
* not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Rectangle}
* @readonly
*/
rectangle : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('rectangle must not be called before the imagery provider is ready.');
}
//>>includeEnd('debug');
return this._tilingScheme.rectangle;
}
},
/**
* 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 GoogleEarthEnterpriseImageryProvider#ready} returns true.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {TileDiscardPolicy}
* @readonly
*/
tileDiscardPolicy : {
get : function() {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('tileDiscardPolicy must not be called before the imagery provider is ready.');
}
//>>includeEnd('debug');
return this._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 GoogleEarthEnterpriseImageryProvider.prototype
* @type {Event}
* @readonly
*/
errorEvent : {
get : function() {
return this._errorEvent;
}
},
/**
* Gets a value indicating whether or not the provider is ready for use.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Boolean}
* @readonly
*/
ready : {
get : function() {
return this._ready;
}
},
/**
* Gets a promise that resolves to true when the provider is ready for use.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Promise.<Boolean>}
* @readonly
*/
readyPromise : {
get : function() {
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 GoogleEarthEnterpriseImageryProvider#ready} returns true.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Credit}
* @readonly
*/
credit : {
get : function() {
return this._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. Setting this property to false reduces memory usage
* and texture upload time.
* @memberof GoogleEarthEnterpriseImageryProvider.prototype
* @type {Boolean}
* @readonly
*/
hasAlphaChannel : {
get : function() {
return false;
}
}
});
/**
* Gets the credits to be displayed when a given tile is displayed.
*
* @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.
*
* @exception {DeveloperError} <code>getTileCredits</code> must not be called before the imagery provider is ready.
*/
GoogleEarthEnterpriseImageryProvider.prototype.getTileCredits = function(x, y, level) {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('getTileCredits must not be called before the imagery provider is ready.');
}
//>>includeEnd('debug');
var metadata = this._metadata;
var info = metadata.getTileInformation(x, y, level);
if (defined(info)) {
var credit = metadata.providers[info.imageryProvider];
if (defined(credit)) {
return [credit];
}
}
return undefined;
};
/**
* Requests the image for a given tile. This function should
* not be called before {@link GoogleEarthEnterpriseImageryProvider#ready} returns true.
*
* @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.<Image|Canvas>|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. The resolved image may be either an
* Image or a Canvas DOM object.
*
* @exception {DeveloperError} <code>requestImage</code> must not be called before the imagery provider is ready.
*/
GoogleEarthEnterpriseImageryProvider.prototype.requestImage = function(x, y, level, request) {
//>>includeStart('debug', pragmas.debug);
if (!this._ready) {
throw new DeveloperError('requestImage must not be called before the imagery provider is ready.');
}
//>>includeEnd('debug');
var invalidImage = this._tileDiscardPolicy._image; // Empty image or undefined depending on discard policy
var metadata = this._metadata;
var quadKey = GoogleEarthEnterpriseMetadata.tileXYToQuadKey(x, y, level);
var info = metadata.getTileInformation(x, y, level);
if (!defined(info)) {
if (metadata.isValid(quadKey)) {
var metadataRequest = new Request({
throttle : request.throttle,
throttleByServer : request.throttleByServer,
type : request.type,
priorityFunction : request.priorityFunction
});
metadata.populateSubtree(x, y, level, metadataRequest);
return undefined; // No metadata so return undefined so we can be loaded later
}
return invalidImage; // Image doesn't exist
}
if (!info.hasImagery()) {
// Already have info and there isn't any imagery here
return invalidImage;
}
// Load the
var url = buildImageUrl(this, info, x, y, level);
var promise = loadArrayBuffer(url, undefined, request);
if (!defined(promise)) {
return undefined; // Throttled
}
return promise
.then(function(image) {
decodeGoogleEarthEnterpriseData(metadata.key, image);
var a = new Uint8Array(image);
var type;
var protoImagery = metadata.protoImagery;
if (!defined(protoImagery) || !protoImagery) {
type = getImageType(a);
}
if (!defined(type) && (!defined(protoImagery) || protoImagery)) {
var message = decodeEarthImageryPacket(a);
type = message.imageType;
a = message.imageData;
}
if (!defined(type) || !defined(a)) {
return invalidImage;
}
return loadImageFromTypedArray(a, type);
});
};
/**
* Picking features is not currently supported by this imagery provider, so this function simply returns
* undefined.
*
* @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.
*/
GoogleEarthEnterpriseImageryProvider.prototype.pickFeatures = function(x, y, level, longitude, latitude) {
return undefined;
};
//
// Functions to handle imagery packets
//
function buildImageUrl(imageryProvider, info, x, y, level) {
var quadKey = GoogleEarthEnterpriseMetadata.tileXYToQuadKey(x, y, level);
var version = info.imageryVersion;
version = (defined(version) && version > 0) ? version : 1;
var imageUrl = imageryProvider.url + 'flatfile?f1-0' + quadKey + '-i.' + version.toString();
var proxy = imageryProvider._proxy;
if (defined(proxy)) {
imageUrl = proxy.getURL(imageUrl);
}
return imageUrl;
}
// Detects if a Uint8Array is a JPEG or PNG
function getImageType(image) {
var jpeg = 'JFIF';
if (image[6] === jpeg.charCodeAt(0) && image[7] === jpeg.charCodeAt(1) &&
image[8] === jpeg.charCodeAt(2) && image[9] === jpeg.charCodeAt(3)) {
return 'image/jpeg';
}
var png = 'PNG';
if (image[1] === png.charCodeAt(0) && image[2] === png.charCodeAt(1) && image[3] === png.charCodeAt(2)) {
return 'image/png';
}
return undefined;
}
// Decodes an Imagery protobuf into the message
// Partially generated with the help of protobuf.js static generator
function decodeEarthImageryPacket(data) {
var reader = protobuf.Reader.create(data);
var end = reader.len;
var message = {};
while (reader.pos < end) {
var tag = reader.uint32();
switch (tag >>> 3) {
case 1:
message.imageType = reader.uint32();
break;
case 2:
message.imageData = reader.bytes();
break;
case 3:
message.alphaType = reader.uint32();
break;
case 4:
message.imageAlpha = reader.bytes();
break;
case 5:
var copyrightIds = message.copyrightIds;
if (!defined(copyrightIds)) {
copyrightIds = message.copyrightIds = [];
}
if ((tag & 7) === 2) {
var end2 = reader.uint32() + reader.pos;
while (reader.pos < end2) {
copyrightIds.push(reader.uint32());
}
} else {
copyrightIds.push(reader.uint32());
}
break;
default:
reader.skipType(tag & 7);
break;
}
}
var imageType = message.imageType;
if (defined(imageType)) {
switch (imageType) {
case 0:
message.imageType = 'image/jpeg';
break;
case 4:
message.imageType = 'image/png';
break;
default:
throw new RuntimeError('GoogleEarthEnterpriseImageryProvider: Unsupported image type.');
}
}
var alphaType = message.alphaType;
if (defined(alphaType) && alphaType !== 0) {
console.log('GoogleEarthEnterpriseImageryProvider: External alpha not supported.');
delete message.alphaType;
delete message.imageAlpha;
}
return message;
}
return GoogleEarthEnterpriseImageryProvider;
});