Web map tile service imagery provider

[adamdavidcole]

Created function createWebTileServiceImageryProvider which utilizes the generic UrlTemplateImageryProvider
@pjcozzi @TiffanyLu

[adamdavidcole]

I get strange behavior when I use this imagery provider. For instance in http://localhost:8080/Apps/Sandcastle/index.html?src=Imagery%20Layers%20Manipulation.html&label=Beginner changing the dropdown to USGS and unchecking all the options except tile coordinates and then zooming past 6 levels causes problems.
However, I get the same results with the current implementation of Web map tile service imagery provider (which can be seen by following the same steps here: http://cesiumjs.org/Cesium/Apps/Sandcastle/index.html?src=Imagery%20Layers%20Manipulation.html&label=Beginner)

Let me know if you have an idea why this is the case.

Still to do in this pull request is to finish the deprecation process for Web map tile service imagery provider.

Thanks!
Adam

[pjcozzi]

Let me know if you have an idea why this is the case.

This could just be an issue with the data the service is returning, not the request Cesium is making. I am not 100% sure though. Can you please submit a separate issue about it?

[pjcozzi]

Did you mean to remove this?

[pjcozzi]

Still to do in this pull request is to finish the deprecation process for Web map tile service imagery provider.

Put a task list in the top comment of this pull request to manage what is left like in #3225 for example.

[pjcozzi]

Part of #2814.

@kring in #2814, you said implementing WebMapTileServiceImageryProvider with UrlTemplateImageryProvider may be complicated. This looks straightforward. Are we missing something?

[pjcozzi]

Did you run the tests? There are several failures:

Never open a pull request with failing tests unless part of the pull request comment is asking for help on why they are failing.

[adamdavidcole]

In my recent update, I fixed the way the urlTemplate is constructed and completed the deprecation process for WebMapTileServiceImageryProvider. I listed it for deprecation in 1.19, does that sound right? When tested by hand, the map imagery shows up as expected (aka. the same way it shows up on cesiumjs.org currently).

After these changes I'm still failing 5 tests in the spec, mostly the result of two separate problems. The first is that two tests expect to access the format by using 'provider.format' (seen here: https://github.com/tiffanylu/cesium/blob/webMapTileServiceImageryProvider/Specs/Scene/createWebMapTileServiceImageryProviderSpec.js#L223 and https://github.com/tiffanylu/cesium/blob/webMapTileServiceImageryProvider/Specs/Scene/createWebMapTileServiceImageryProviderSpec.js#L254). I believe that this issue should be resolved by removing those two line from the spec code.

Another two tests fail because WebMapTileServiceImageryProvider provides an option for passing tileMatrixLabels which map labels to strings. As a result tests like this fail:
Expected '1' to equal 'second'." As of now I do not think there is any way to set up labels in UrlTemplateImageryProvider. One option here is to remove providing labels as an option for createWebTileServiceImageryProvider.

Finally, the last test which fails is this: Expected function 'getTileCredits' to exist on WebMapTileServiceImageryProvider because it should implement interface ImageryProvider. I can't figure out why this fails because UrlTemplateImageryProvider does define the function getTileCredits: https://github.com/tiffanylu/cesium/blob/webMapTileServiceImageryProvider/Source/Scene/UrlTemplateImageryProvider.js#L447.

Please let me know what you think I should do to solve these testing issues.

Thanks!

[pjcozzi]

@adamdavidcole can you merge in master. There is probably a trivial conflict in CHANGES.md.

[pjcozzi]

I listed it for deprecation in 1.19, does that sound right?

Yes

[pjcozzi]

The first is that two tests expect to access the format by using 'provider.format' (seen here: https://github.com/tiffanylu/cesium/blob/webMapTileServiceImageryProvider/Specs/Scene/createWebMapTileServiceImageryProviderSpec.js#L223 and https://github.com/tiffanylu/cesium/blob/webMapTileServiceImageryProvider/Specs/Scene/createWebMapTileServiceImageryProviderSpec.js#L254). I believe that this issue should be resolved by removing those two line from the spec code.

This is fine since it is a breaking change; createWebMapTileServiceImageryProvider returns a UrlTemplateImageProvider, which does not have this property.

However, please make sure that the KVP requests that use the format still work, e.g., https://github.com/tiffanylu/cesium/blob/webMapTileServiceImageryProvider/Source/Scene/WebMapTileServiceImageryProvider.js#L201

[pjcozzi]

Another two tests fail because WebMapTileServiceImageryProvider provides an option for passing tileMatrixLabels which map labels to strings. As a result tests like this fail:
Expected '1' to equal 'second'." As of now I do not think there is any way to set up labels in UrlTemplateImageryProvider. One option here is to remove providing labels as an option for createWebTileServiceImageryProvider.

I think you need to add support to UrlTemplateImageryProvider for this in one form or another, e.g., see https://github.com/AnalyticalGraphicsInc/cesium/blob/master/Source/Scene/WebMapTileServiceImageryProvider.js#L167

[pjcozzi]

Finally, the last test which fails is this: Expected function 'getTileCredits' to exist on WebMapTileServiceImageryProvider because it should implement interface ImageryProvider. I can't figure out why this fails because UrlTemplateImageryProvider does define the function getTileCredits: https://github.com/tiffanylu/cesium/blob/webMapTileServiceImageryProvider/Source/Scene/UrlTemplateImageryProvider.js#L447.

Replace this test with a test like this: https://github.com/tiffanylu/cesium/blob/webMapTileServiceImageryProvider/Specs/Scene/createOpenStreetMapImageryProviderSpec.js#L34

[pjcozzi]

@adamdavidcole thanks for your initial work on this; we're going to hold off for now. Hope you are having a great summer and thanks again for all your past contributions to Cesium!