-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
ArcGISTiledElevationTerrainProvider.js
691 lines (614 loc) · 20 KB
/
ArcGISTiledElevationTerrainProvider.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
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
import when from "../ThirdParty/when.js";
import Cartesian2 from "./Cartesian2.js";
import Credit from "./Credit.js";
import defaultValue from "./defaultValue.js";
import defined from "./defined.js";
import DeveloperError from "./DeveloperError.js";
import Ellipsoid from "./Ellipsoid.js";
import Event from "./Event.js";
import GeographicTilingScheme from "./GeographicTilingScheme.js";
import HeightmapEncoding from "./HeightmapEncoding.js";
import HeightmapTerrainData from "./HeightmapTerrainData.js";
import Rectangle from "./Rectangle.js";
import Request from "./Request.js";
import RequestState from "./RequestState.js";
import RequestType from "./RequestType.js";
import Resource from "./Resource.js";
import RuntimeError from "./RuntimeError.js";
import TerrainProvider from "./TerrainProvider.js";
import TileAvailability from "./TileAvailability.js";
import TileProviderError from "./TileProviderError.js";
import WebMercatorTilingScheme from "./WebMercatorTilingScheme.js";
var ALL_CHILDREN = 15;
/**
* A {@link TerrainProvider} that produces terrain geometry by tessellating height maps
* retrieved from Elevation Tiles of an an ArcGIS ImageService.
*
* @alias ArcGISTiledElevationTerrainProvider
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Resource|String|Promise<Resource>|Promise<String>} options.url The URL of the ArcGIS ImageServer service.
* @param {String} [options.token] The authorization token to use to connect to the service.
* @param {Ellipsoid} [options.ellipsoid] The ellipsoid. If the tilingScheme is specified,
* this parameter is ignored and the tiling scheme's ellipsoid is used instead.
* If neither parameter is specified, the WGS84 ellipsoid is used.
*
* @example
* var terrainProvider = new Cesium.ArcGISTiledElevationTerrainProvider({
* url : 'https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer',
* token : 'KED1aF_I4UzXOHy3BnhwyBHU4l5oY6rO6walkmHoYqGp4XyIWUd5YZUC1ZrLAzvV40pR6gBXQayh0eFA8m6vPg..'
* });
* viewer.terrainProvider = terrainProvider;
*
* @see TerrainProvider
*/
function ArcGISTiledElevationTerrainProvider(options) {
//>>includeStart('debug', pragmas.debug);
if (!defined(options) || !defined(options.url)) {
throw new DeveloperError("options.url is required.");
}
//>>includeEnd('debug');
this._resource = undefined;
this._credit = undefined;
this._tilingScheme = undefined;
this._levelZeroMaximumGeometricError = undefined;
this._maxLevel = undefined;
this._terrainDataStructure = undefined;
this._ready = false;
this._width = undefined;
this._height = undefined;
this._encoding = undefined;
var token = options.token;
this._hasAvailability = false;
this._tilesAvailable = undefined;
this._tilesAvailablityLoaded = undefined;
this._availableCache = {};
var that = this;
var ellipsoid = defaultValue(options.ellipsoid, Ellipsoid.WGS84);
this._readyPromise = when(options.url)
.then(function (url) {
var resource = Resource.createIfNeeded(url);
resource.appendForwardSlash();
if (defined(token)) {
resource = resource.getDerivedResource({
queryParameters: {
token: token,
},
});
}
that._resource = resource;
var metadataResource = resource.getDerivedResource({
queryParameters: {
f: "pjson",
},
});
return metadataResource.fetchJson();
})
.then(function (metadata) {
var copyrightText = metadata.copyrightText;
if (defined(copyrightText)) {
that._credit = new Credit(copyrightText);
}
var spatialReference = metadata.spatialReference;
var wkid = defaultValue(
spatialReference.latestWkid,
spatialReference.wkid
);
var extent = metadata.extent;
var tilingSchemeOptions = {
ellipsoid: ellipsoid,
};
if (wkid === 4326) {
tilingSchemeOptions.rectangle = Rectangle.fromDegrees(
extent.xmin,
extent.ymin,
extent.xmax,
extent.ymax
);
that._tilingScheme = new GeographicTilingScheme(tilingSchemeOptions);
} else if (wkid === 3857) {
tilingSchemeOptions.rectangleSouthwestInMeters = new Cartesian2(
extent.xmin,
extent.ymin
);
tilingSchemeOptions.rectangleNortheastInMeters = new Cartesian2(
extent.xmax,
extent.ymax
);
that._tilingScheme = new WebMercatorTilingScheme(tilingSchemeOptions);
} else {
return when.reject(new RuntimeError("Invalid spatial reference"));
}
var tileInfo = metadata.tileInfo;
if (!defined(tileInfo)) {
return when.reject(new RuntimeError("tileInfo is required"));
}
that._width = tileInfo.rows + 1;
that._height = tileInfo.cols + 1;
that._encoding =
tileInfo.format === "LERC"
? HeightmapEncoding.LERC
: HeightmapEncoding.NONE;
that._lodCount = tileInfo.lods.length - 1;
var hasAvailability = (that._hasAvailability =
metadata.capabilities.indexOf("Tilemap") !== -1);
if (hasAvailability) {
that._tilesAvailable = new TileAvailability(
that._tilingScheme,
that._lodCount
);
that._tilesAvailable.addAvailableTileRange(
0,
0,
0,
that._tilingScheme.getNumberOfXTilesAtLevel(0),
that._tilingScheme.getNumberOfYTilesAtLevel(0)
);
that._tilesAvailablityLoaded = new TileAvailability(
that._tilingScheme,
that._lodCount
);
}
that._levelZeroMaximumGeometricError = TerrainProvider.getEstimatedLevelZeroGeometricErrorForAHeightmap(
that._tilingScheme.ellipsoid,
that._width,
that._tilingScheme.getNumberOfXTilesAtLevel(0)
);
if (metadata.bandCount > 1) {
console.log(
"ArcGISTiledElevationTerrainProvider: Terrain data has more than 1 band. Using the first one."
);
}
that._terrainDataStructure = {
elementMultiplier: 1.0,
lowestEncodedHeight: metadata.minValues[0],
highestEncodedHeight: metadata.maxValues[0],
};
that._ready = true;
return true;
})
.otherwise(function (error) {
var message =
"An error occurred while accessing " + that._resource.url + ".";
TileProviderError.handleError(undefined, that, that._errorEvent, message);
return when.reject(error);
});
this._errorEvent = new Event();
}
Object.defineProperties(ArcGISTiledElevationTerrainProvider.prototype, {
/**
* Gets an event that is raised when the terrain 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 ArcGISTiledElevationTerrainProvider.prototype
* @type {Event}
*/
errorEvent: {
get: function () {
return this._errorEvent;
},
},
/**
* Gets the credit to display when this terrain provider is active. Typically this is used to credit
* the source of the terrain. This function should not be called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true.
* @memberof ArcGISTiledElevationTerrainProvider.prototype
* @type {Credit}
*/
credit: {
get: function () {
//>>includeStart('debug', pragmas.debug);
if (!this.ready) {
throw new DeveloperError(
"credit must not be called before ready returns true."
);
}
//>>includeEnd('debug');
return this._credit;
},
},
/**
* Gets the tiling scheme used by this provider. This function should
* not be called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true.
* @memberof ArcGISTiledElevationTerrainProvider.prototype
* @type {GeographicTilingScheme}
*/
tilingScheme: {
get: function () {
//>>includeStart('debug', pragmas.debug);
if (!this.ready) {
throw new DeveloperError(
"tilingScheme must not be called before ready returns true."
);
}
//>>includeEnd('debug');
return this._tilingScheme;
},
},
/**
* Gets a value indicating whether or not the provider is ready for use.
* @memberof ArcGISTiledElevationTerrainProvider.prototype
* @type {Boolean}
*/
ready: {
get: function () {
return this._ready;
},
},
/**
* Gets a promise that resolves to true when the provider is ready for use.
* @memberof ArcGISTiledElevationTerrainProvider.prototype
* @type {Promise.<Boolean>}
* @readonly
*/
readyPromise: {
get: function () {
return this._readyPromise;
},
},
/**
* Gets a value indicating whether or not the provider includes a water mask. The water mask
* indicates which areas of the globe are water rather than land, so they can be rendered
* as a reflective surface with animated waves. This function should not be
* called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true.
* @memberof ArcGISTiledElevationTerrainProvider.prototype
* @type {Boolean}
*/
hasWaterMask: {
get: function () {
return false;
},
},
/**
* Gets a value indicating whether or not the requested tiles include vertex normals.
* This function should not be called before {@link ArcGISTiledElevationTerrainProvider#ready} returns true.
* @memberof ArcGISTiledElevationTerrainProvider.prototype
* @type {Boolean}
*/
hasVertexNormals: {
get: function () {
return false;
},
},
/**
* Gets an object that can be used to determine availability of terrain from this provider, such as
* at points and in rectangles. This function should not be called before
* {@link TerrainProvider#ready} returns true. This property may be undefined if availability
* information is not available.
* @memberof ArcGISTiledElevationTerrainProvider.prototype
* @type {TileAvailability}
*/
availability: {
get: function () {
return undefined;
},
},
});
/**
* Requests the geometry for a given tile. This function should not be called before
* {@link ArcGISTiledElevationTerrainProvider#ready} returns true. The result includes terrain
* data and indicates that all child tiles are available.
*
* @param {Number} x The X coordinate of the tile for which to request geometry.
* @param {Number} y The Y coordinate of the tile for which to request geometry.
* @param {Number} level The level of the tile for which to request geometry.
* @param {Request} [request] The request object. Intended for internal use only.
* @returns {Promise.<TerrainData>|undefined} A promise for the requested geometry. If this method
* returns undefined instead of a promise, it is an indication that too many requests are already
* pending and the request will be retried later.
*/
ArcGISTiledElevationTerrainProvider.prototype.requestTileGeometry = function (
x,
y,
level,
request
) {
//>>includeStart('debug', pragmas.debug)
if (!this._ready) {
throw new DeveloperError(
"requestTileGeometry must not be called before the terrain provider is ready."
);
}
//>>includeEnd('debug');
var tileResource = this._resource.getDerivedResource({
url: "tile/" + level + "/" + y + "/" + x,
request: request,
});
var hasAvailability = this._hasAvailability;
var availabilityPromise = when.resolve(true);
var availabilityRequest;
if (
hasAvailability &&
!defined(isTileAvailable(this, level + 1, x * 2, y * 2))
) {
// We need to load child availability
var availabilityResult = requestAvailability(this, level + 1, x * 2, y * 2);
availabilityPromise = availabilityResult.promise;
availabilityRequest = availabilityResult.request;
}
var promise = tileResource.fetchArrayBuffer();
if (!defined(promise) || !defined(availabilityPromise)) {
return undefined;
}
var that = this;
var tilesAvailable = this._tilesAvailable;
return when
.join(promise, availabilityPromise)
.then(function (result) {
return new HeightmapTerrainData({
buffer: result[0],
width: that._width,
height: that._height,
childTileMask: hasAvailability
? tilesAvailable.computeChildMaskForTile(level, x, y)
: ALL_CHILDREN,
structure: that._terrainDataStructure,
encoding: that._encoding,
});
})
.otherwise(function (error) {
if (
defined(availabilityRequest) &&
availabilityRequest.state === RequestState.CANCELLED
) {
request.cancel();
// Don't reject the promise till the request is actually cancelled
// Otherwise it will think the request failed, but it didn't.
return request.deferred.promise.always(function () {
request.state = RequestState.CANCELLED;
return when.reject(error);
});
}
return when.reject(error);
});
};
function isTileAvailable(that, level, x, y) {
if (!that._hasAvailability) {
return undefined;
}
var tilesAvailablityLoaded = that._tilesAvailablityLoaded;
var tilesAvailable = that._tilesAvailable;
if (level > that._lodCount) {
return false;
}
// Check if tiles are known to be available
if (tilesAvailable.isTileAvailable(level, x, y)) {
return true;
}
// or to not be available
if (tilesAvailablityLoaded.isTileAvailable(level, x, y)) {
return false;
}
return undefined;
}
/**
* Gets the maximum geometric error allowed in a tile at a given level.
*
* @param {Number} level The tile level for which to get the maximum geometric error.
* @returns {Number} The maximum geometric error.
*/
ArcGISTiledElevationTerrainProvider.prototype.getLevelMaximumGeometricError = function (
level
) {
//>>includeStart('debug', pragmas.debug);
if (!this.ready) {
throw new DeveloperError(
"getLevelMaximumGeometricError must not be called before ready returns true."
);
}
//>>includeEnd('debug');
return this._levelZeroMaximumGeometricError / (1 << level);
};
/**
* Determines whether data for a tile is available to be loaded.
*
* @param {Number} x The X coordinate of the tile for which to request geometry.
* @param {Number} y The Y coordinate of the tile for which to request geometry.
* @param {Number} level The level of the tile for which to request geometry.
* @returns {Boolean} Undefined if not supported, otherwise true or false.
*/
ArcGISTiledElevationTerrainProvider.prototype.getTileDataAvailable = function (
x,
y,
level
) {
if (!this._hasAvailability) {
return undefined;
}
var result = isTileAvailable(this, level, x, y);
if (defined(result)) {
return result;
}
requestAvailability(this, level, x, y);
return undefined;
};
/**
* Makes sure we load availability data for a tile
*
* @param {Number} x The X coordinate of the tile for which to request geometry.
* @param {Number} y The Y coordinate of the tile for which to request geometry.
* @param {Number} level The level of the tile for which to request geometry.
* @returns {undefined|Promise<void>} Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded
*/
ArcGISTiledElevationTerrainProvider.prototype.loadTileDataAvailability = function (
x,
y,
level
) {
return undefined;
};
function findRange(origin, width, height, data) {
var endCol = width - 1;
var endRow = height - 1;
var value = data[origin.y * width + origin.x];
var endingIndices = [];
var range = {
startX: origin.x,
startY: origin.y,
endX: 0,
endY: 0,
};
var corner = new Cartesian2(origin.x + 1, origin.y + 1);
var doneX = false;
var doneY = false;
while (!(doneX && doneY)) {
// We want to use the original value when checking Y,
// so get it before it possibly gets incremented
var endX = corner.x;
// If we no longer move in the Y direction we need to check the corner tile in X pass
var endY = doneY ? corner.y + 1 : corner.y;
// Check X range
if (!doneX) {
for (var y = origin.y; y < endY; ++y) {
if (data[y * width + corner.x] !== value) {
doneX = true;
break;
}
}
if (doneX) {
endingIndices.push(new Cartesian2(corner.x, origin.y));
// Use the last good column so we can continue with Y
--corner.x;
--endX;
range.endX = corner.x;
} else if (corner.x === endCol) {
range.endX = corner.x;
doneX = true;
} else {
++corner.x;
}
}
// Check Y range - The corner tile is checked here
if (!doneY) {
var col = corner.y * width;
for (var x = origin.x; x <= endX; ++x) {
if (data[col + x] !== value) {
doneY = true;
break;
}
}
if (doneY) {
endingIndices.push(new Cartesian2(origin.x, corner.y));
// Use the last good row so we can continue with X
--corner.y;
range.endY = corner.y;
} else if (corner.y === endRow) {
range.endY = corner.y;
doneY = true;
} else {
++corner.y;
}
}
}
return {
endingIndices: endingIndices,
range: range,
value: value,
};
}
function computeAvailability(x, y, width, height, data) {
var ranges = [];
var singleValue = data.every(function (val) {
return val === data[0];
});
if (singleValue) {
if (data[0] === 1) {
ranges.push({
startX: x,
startY: y,
endX: x + width - 1,
endY: y + height - 1,
});
}
return ranges;
}
var positions = [new Cartesian2(0, 0)];
while (positions.length > 0) {
var origin = positions.pop();
var result = findRange(origin, width, height, data);
if (result.value === 1) {
// Convert range into the array into global tile coordinates
var range = result.range;
range.startX += x;
range.endX += x;
range.startY += y;
range.endY += y;
ranges.push(range);
}
var endingIndices = result.endingIndices;
if (endingIndices.length > 0) {
positions = positions.concat(endingIndices);
}
}
return ranges;
}
function requestAvailability(that, level, x, y) {
if (!that._hasAvailability) {
return {};
}
// Fetch 128x128 availability list, so we make the minimum amount of requests
var xOffset = Math.floor(x / 128) * 128;
var yOffset = Math.floor(y / 128) * 128;
var dim = Math.min(1 << level, 128);
var url =
"tilemap/" + level + "/" + yOffset + "/" + xOffset + "/" + dim + "/" + dim;
var availableCache = that._availableCache;
if (defined(availableCache[url])) {
return availableCache[url];
}
var request = new Request({
throttle: false,
throttleByServer: true,
type: RequestType.TERRAIN,
});
var tilemapResource = that._resource.getDerivedResource({
url: url,
request: request,
});
var promise = tilemapResource.fetchJson();
if (!defined(promise)) {
return {};
}
promise = promise.then(function (result) {
var available = computeAvailability(
xOffset,
yOffset,
dim,
dim,
result.data
);
// Mark whole area as having availability loaded
that._tilesAvailablityLoaded.addAvailableTileRange(
xOffset,
yOffset,
xOffset + dim,
yOffset + dim
);
var tilesAvailable = that._tilesAvailable;
for (var i = 0; i < available.length; ++i) {
var range = available[i];
tilesAvailable.addAvailableTileRange(
level,
range.startX,
range.startY,
range.endX,
range.endY
);
}
// Conveniently return availability of original tile
return isTileAvailable(that, level, x, y);
});
availableCache[url] = {
promise: promise,
request: request,
};
promise = promise.always(function (result) {
delete availableCache[url];
return result;
});
return {
promise: promise,
request: request,
};
}
export default ArcGISTiledElevationTerrainProvider;