/
createTileMapServiceImageryProvider.js
292 lines (265 loc) · 13.9 KB
/
createTileMapServiceImageryProvider.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
define([
'../Core/Cartesian2',
'../Core/Cartographic',
'../Core/defaultValue',
'../Core/defined',
'../Core/DeveloperError',
'../Core/GeographicProjection',
'../Core/GeographicTilingScheme',
'../Core/Rectangle',
'../Core/Resource',
'../Core/RuntimeError',
'../Core/TileProviderError',
'../Core/WebMercatorTilingScheme',
'../ThirdParty/when',
'./UrlTemplateImageryProvider'
], function(
Cartesian2,
Cartographic,
defaultValue,
defined,
DeveloperError,
GeographicProjection,
GeographicTilingScheme,
Rectangle,
Resource,
RuntimeError,
TileProviderError,
WebMercatorTilingScheme,
when,
UrlTemplateImageryProvider) {
'use strict';
/**
* Creates a {@link UrlTemplateImageryProvider} instance that provides tiled imagery as generated by
* {@link http://www.maptiler.org/|MapTiler}, {@link http://www.klokan.cz/projects/gdal2tiles/|GDAL2Tiles}, etc.
*
* @exports createTileMapServiceImageryProvider
*
* @param {Object} [options] Object with the following properties:
* @param {Resource|String|Promise<Resource>|Promise<String>} [options.url='.'] Path to image tiles on server.
* @param {String} [options.fileExtension='png'] The file extension for images on the server.
* @param {Credit|String} [options.credit=''] A credit for the data source, which is displayed on the canvas.
* @param {Number} [options.minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying
* this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely
* to result in rendering problems.
* @param {Number} [options.maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
* @param {Rectangle} [options.rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image.
* @param {TilingScheme} [options.tilingScheme] The tiling scheme specifying how the ellipsoidal
* surface is broken into tiles. If this parameter is not provided, a {@link WebMercatorTilingScheme}
* is used.
* @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.
* @param {Number} [options.tileWidth=256] Pixel width of image tiles.
* @param {Number} [options.tileHeight=256] Pixel height of image tiles.
* @param {Boolean} [options.flipXY] Older versions of gdal2tiles.py flipped X and Y values in tilemapresource.xml.
* Specifying this option will do the same, allowing for loading of these incorrect tilesets.
* @returns {UrlTemplateImageryProvider} The imagery provider.
*
* @see ArcGisMapServerImageryProvider
* @see BingMapsImageryProvider
* @see GoogleEarthEnterpriseMapsProvider
* @see createOpenStreetMapImageryProvider
* @see SingleTileImageryProvider
* @see WebMapServiceImageryProvider
* @see WebMapTileServiceImageryProvider
* @see UrlTemplateImageryProvider
*
* @see {@link http://www.maptiler.org/|MapTiler}
* @see {@link http://www.klokan.cz/projects/gdal2tiles/|GDAL2Tiles}
* @see {@link http://www.w3.org/TR/cors/|Cross-Origin Resource Sharing}
*
* @example
* var tms = Cesium.createTileMapServiceImageryProvider({
* url : '../images/cesium_maptiler/Cesium_Logo_Color',
* fileExtension: 'png',
* maximumLevel: 4,
* rectangle: new Cesium.Rectangle(
* Cesium.Math.toRadians(-120.0),
* Cesium.Math.toRadians(20.0),
* Cesium.Math.toRadians(-60.0),
* Cesium.Math.toRadians(40.0))
* });
*/
function createTileMapServiceImageryProvider(options) {
options = defaultValue(options, {});
//>>includeStart('debug', pragmas.debug);
if (!defined(options.url)) {
throw new DeveloperError('options.url is required.');
}
//>>includeEnd('debug');
var deferred = when.defer();
var imageryProvider = new UrlTemplateImageryProvider(deferred.promise);
var metadataError;
var resource;
var xmlResource;
when(options.url)
.then(function(url) {
resource = Resource.createIfNeeded(url);
resource.appendForwardSlash();
xmlResource = resource.getDerivedResource({
url: 'tilemapresource.xml'
});
requestMetadata();
})
.otherwise(function(e) {
deferred.reject(e);
});
function metadataSuccess(xml) {
var tileFormatRegex = /tileformat/i;
var tileSetRegex = /tileset/i;
var tileSetsRegex = /tilesets/i;
var bboxRegex = /boundingbox/i;
var format, bbox, tilesets;
var tilesetsList = []; //list of TileSets
// Allowing options properties (already copied to that) to override XML values
// Iterate XML Document nodes for properties
var nodeList = xml.childNodes[0].childNodes;
for (var i = 0; i < nodeList.length; i++){
if (tileFormatRegex.test(nodeList.item(i).nodeName)) {
format = nodeList.item(i);
} else if (tileSetsRegex.test(nodeList.item(i).nodeName)) {
tilesets = nodeList.item(i); // Node list of TileSets
var tileSetNodes = nodeList.item(i).childNodes;
// Iterate the nodes to find all TileSets
for(var j = 0; j < tileSetNodes.length; j++) {
if (tileSetRegex.test(tileSetNodes.item(j).nodeName)) {
// Add them to tilesets list
tilesetsList.push(tileSetNodes.item(j));
}
}
} else if (bboxRegex.test(nodeList.item(i).nodeName)) {
bbox = nodeList.item(i);
}
}
var message;
if (!defined(tilesets) || !defined(bbox)) {
message = 'Unable to find expected tilesets or bbox attributes in ' + xmlResource.url + '.';
metadataError = TileProviderError.handleError(metadataError, imageryProvider, imageryProvider.errorEvent, message, undefined, undefined, undefined, requestMetadata);
if(!metadataError.retry) {
deferred.reject(new RuntimeError(message));
}
return;
}
var fileExtension = defaultValue(options.fileExtension, format.getAttribute('extension'));
var tileWidth = defaultValue(options.tileWidth, parseInt(format.getAttribute('width'), 10));
var tileHeight = defaultValue(options.tileHeight, parseInt(format.getAttribute('height'), 10));
var minimumLevel = defaultValue(options.minimumLevel, parseInt(tilesetsList[0].getAttribute('order'), 10));
var maximumLevel = defaultValue(options.maximumLevel, parseInt(tilesetsList[tilesetsList.length - 1].getAttribute('order'), 10));
var tilingSchemeName = tilesets.getAttribute('profile');
var tilingScheme = options.tilingScheme;
if (!defined(tilingScheme)) {
if (tilingSchemeName === 'geodetic' || tilingSchemeName === 'global-geodetic') {
tilingScheme = new GeographicTilingScheme({ ellipsoid : options.ellipsoid });
} else if (tilingSchemeName === 'mercator' || tilingSchemeName === 'global-mercator') {
tilingScheme = new WebMercatorTilingScheme({ ellipsoid : options.ellipsoid });
} else {
message = xmlResource.url + 'specifies an unsupported profile attribute, ' + tilingSchemeName + '.';
metadataError = TileProviderError.handleError(metadataError, imageryProvider, imageryProvider.errorEvent, message, undefined, undefined, undefined, requestMetadata);
if(!metadataError.retry) {
deferred.reject(new RuntimeError(message));
}
return;
}
}
// rectangle handling
var rectangle = Rectangle.clone(options.rectangle);
if (!defined(rectangle)) {
var sw;
var ne;
var swXY;
var neXY;
// In older versions of gdal x and y values were flipped, which is why we check for an option to flip
// the values here as well. Unfortunately there is no way to autodetect whether flipping is needed.
var flipXY = defaultValue(options.flipXY, false);
if (flipXY) {
swXY = new Cartesian2(parseFloat(bbox.getAttribute('miny')), parseFloat(bbox.getAttribute('minx')));
neXY = new Cartesian2(parseFloat(bbox.getAttribute('maxy')), parseFloat(bbox.getAttribute('maxx')));
} else {
swXY = new Cartesian2(parseFloat(bbox.getAttribute('minx')), parseFloat(bbox.getAttribute('miny')));
neXY = new Cartesian2(parseFloat(bbox.getAttribute('maxx')), parseFloat(bbox.getAttribute('maxy')));
}
// Determine based on the profile attribute if this tileset was generated by gdal2tiles.py, which
// uses 'mercator' and 'geodetic' profiles, or by a tool compliant with the TMS standard, which is
// 'global-mercator' and 'global-geodetic' profiles. In the gdal2Tiles case, X and Y are always in
// geodetic degrees.
var isGdal2tiles = tilingSchemeName === 'geodetic' || tilingSchemeName === 'mercator';
if (tilingScheme.projection instanceof GeographicProjection || isGdal2tiles) {
sw = Cartographic.fromDegrees(swXY.x, swXY.y);
ne = Cartographic.fromDegrees(neXY.x, neXY.y);
} else {
var projection = tilingScheme.projection;
sw = projection.unproject(swXY);
ne = projection.unproject(neXY);
}
rectangle = new Rectangle(sw.longitude, sw.latitude, ne.longitude, ne.latitude);
}
// The rectangle must not be outside the bounds allowed by the tiling scheme.
if (rectangle.west < tilingScheme.rectangle.west) {
rectangle.west = tilingScheme.rectangle.west;
}
if (rectangle.east > tilingScheme.rectangle.east) {
rectangle.east = tilingScheme.rectangle.east;
}
if (rectangle.south < tilingScheme.rectangle.south) {
rectangle.south = tilingScheme.rectangle.south;
}
if (rectangle.north > tilingScheme.rectangle.north) {
rectangle.north = tilingScheme.rectangle.north;
}
// Check the number of tiles at the minimum level. If it's more than four,
// try requesting the lower levels anyway, because starting at the higher minimum
// level will cause too many tiles to be downloaded and rendered.
var swTile = tilingScheme.positionToTileXY(Rectangle.southwest(rectangle), minimumLevel);
var neTile = tilingScheme.positionToTileXY(Rectangle.northeast(rectangle), minimumLevel);
var tileCount = (Math.abs(neTile.x - swTile.x) + 1) * (Math.abs(neTile.y - swTile.y) + 1);
if (tileCount > 4) {
minimumLevel = 0;
}
var templateResource = resource.getDerivedResource({
url: '{z}/{x}/{reverseY}.' + fileExtension
});
deferred.resolve({
url : templateResource,
tilingScheme : tilingScheme,
rectangle : rectangle,
tileWidth : tileWidth,
tileHeight : tileHeight,
minimumLevel : minimumLevel,
maximumLevel : maximumLevel,
tileDiscardPolicy : options.tileDiscardPolicy,
credit: options.credit
});
}
function metadataFailure(error) {
// Can't load XML, still allow options and defaults
var fileExtension = defaultValue(options.fileExtension, 'png');
var tileWidth = defaultValue(options.tileWidth, 256);
var tileHeight = defaultValue(options.tileHeight, 256);
var minimumLevel = defaultValue(options.minimumLevel, 0);
var maximumLevel = options.maximumLevel;
var tilingScheme = defined(options.tilingScheme) ? options.tilingScheme : new WebMercatorTilingScheme({ ellipsoid : options.ellipsoid });
var rectangle = defaultValue(options.rectangle, tilingScheme.rectangle);
var templateResource = resource.getDerivedResource({
url: '{z}/{x}/{reverseY}.' + fileExtension
});
deferred.resolve({
url : templateResource,
tilingScheme : tilingScheme,
rectangle : rectangle,
tileWidth : tileWidth,
tileHeight : tileHeight,
minimumLevel : minimumLevel,
maximumLevel : maximumLevel,
tileDiscardPolicy : options.tileDiscardPolicy,
credit: options.credit
});
}
function requestMetadata() {
// Try to load remaining parameters from XML
xmlResource.fetchXML().then(metadataSuccess).otherwise(metadataFailure);
}
return imageryProvider;
}
return createTileMapServiceImageryProvider;
});