Add static loadJson method to Cesium3DTileset #5685
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…pulate any prototypical assets. Added tests for Cesium3DTileset.loadJson method
|
Thanks @jason-crow! @lilleyse will be the best person to review this. It might take a bit as we are focused on prepping for SIGGRAPH next week. |
lilleyse
reviewed
Aug 11, 2017
Specs/Scene/Cesium3DTilesetSpec.js
Outdated
| Cesium3DTileset.loadJson = function(tilesetUrl) | ||
| { | ||
| return originalLoadJson(path); | ||
| } |
There was a problem hiding this comment.
Fix formatting:
Cesium3DTileset.loadJson = function(tilesetUrl) {
return originalLoadJson(path);
}
Source/Scene/Cesium3DTileset.js
Outdated
| @@ -1049,6 +1049,14 @@ define([ | |||
| }); | |||
|
|
|||
| /** | |||
| * Provides a hook to override the method used to request the tileset json | |||
| * useful when fetching tilesets from remote servers | |||
| */ | |||
There was a problem hiding this comment.
Add @param and @returns to the documentation.
|
Updated for the 2 changes you recommended. Should be ready to look at again. |
lilleyse
reviewed
Aug 11, 2017
Source/Scene/Cesium3DTileset.js
Outdated
| @@ -1049,6 +1049,16 @@ define([ | |||
| }); | |||
|
|
|||
| /** | |||
| * Provides a hook to override the method used to request the tileset json | |||
| * useful when fetching tilesets from remote servers | |||
| * @param {String} tilesetUrl, the url of the json file to be fetched | |||
There was a problem hiding this comment.
Remove comma and capitalize the
lilleyse
reviewed
Aug 11, 2017
Source/Scene/Cesium3DTileset.js
Outdated
| * Provides a hook to override the method used to request the tileset json | ||
| * useful when fetching tilesets from remote servers | ||
| * @param {String} tilesetUrl, the url of the json file to be fetched | ||
| * @returns {Promise<Object>} A promise that resolves with the fetched json data |
There was a problem hiding this comment.
I believe this needs to be Promise.<Object>
|
Done |
|
Thanks @jason-crow |
|
Thanks again @jason-crow! @lilleyse should you update CHANGES.md in master? |
|
Yes, added here: cce2392 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds a hook to Cesium's Cesium3DTileset's method for requesting the tileset json. The purpose of this is to make it easier to extend or decorate the method a tileset uses to fetch its json. For instance this facilitates fetching json's from remote servers that may require changing the base url or providing authentication headers. These are use cases that are essential to Bimium's use cases for creating tilesets with the Cesium library.
It doesn't seem necessary at the moment to also provide a hook for the TileContent request for the binary file, since this specific type of request is marked by Cesium.RequestType.TILES3D, it is already easily overridden without any specific hooks provided.
I provided 2 tests cases, the first just tests that Cesium3DTileset.loadJson by default loads json, the second test is more applicable to my use case for creating it. It tests to ensure the Cesium3DTileset.loadJson is used in the constructor for fetching the tileset json, as this is the assumption that makes decorating/extending it useful. To prove this it override the loadJson function and replaces the passed url which is invalid in the test with a valid one and tests whether the readyPromise resolves successfully to prove that overriding this method is useful for altering the method for fetching the tileset's json.