Improve geocoder #4723
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1, user-scalable=no"> | ||
| <meta name="description" content="Cluster labels, billboards and points."> | ||
| <meta name="cesium-sandcastle-labels" content="Tutorials,Showcases"> | ||
| <title>Cesium Demo</title> | ||
| <script type="text/javascript" src="../Sandcastle-header.js"></script> | ||
| <script type="text/javascript" src="../../../ThirdParty/requirejs-2.1.20/require.js"></script> | ||
| <script type="text/javascript"> | ||
| require.config({ | ||
| baseUrl : '../../../Source', | ||
| waitSeconds : 60 | ||
| }); | ||
| </script> | ||
| </head> | ||
| <body class="sandcastle-loading" data-sandcastle-bucket="bucket-requirejs.html"> | ||
| <style> | ||
| @import url(../templates/bucket.css); | ||
| #toolbar { | ||
| background: rgba(42, 42, 42, 0.8); | ||
| padding: 4px; | ||
| border-radius: 4px; | ||
| } | ||
| #toolbar input { | ||
| vertical-align: middle; | ||
| padding-top: 2px; | ||
| padding-bottom: 2px; | ||
| } | ||
| </style> | ||
| <div id="cesiumContainer" class="fullSize"></div> | ||
| <div id="loadingOverlay"><h1>Loading...</h1></div> | ||
| <script id="cesium_sandcastle_script"> | ||
| function startup(Cesium) { | ||
| 'use strict'; | ||
| //Sandcastle_Begin | ||
|
|
||
| /** | ||
| * This class is an example of a custom geocoder. It provides geocoding through the OpenStreetMap Nominatim service. | ||
| * @alias OpenStreetMapNominatimGeocoder | ||
| * @constructor | ||
| */ | ||
| function OpenStreetMapNominatimGeocoder() { | ||
| } | ||
|
|
||
| /** | ||
| * The function called to geocode using this geocoder service. | ||
| * | ||
| * @param {String} input The query to be sent to the geocoder service | ||
| * @returns {Promise<GeocoderResult[]>} | ||
| */ | ||
| OpenStreetMapNominatimGeocoder.prototype.geocode = function (input) { | ||
| var endpoint = 'http://nominatim.openstreetmap.org/search?'; | ||
| var query = 'format=json&q=' + input; | ||
| var requestString = endpoint + query; | ||
| return Cesium.loadJson(requestString) | ||
| .then(function (results) { | ||
| var bboxDegrees; | ||
| return results.map(function (resultObject) { | ||
| bboxDegrees = resultObject.boundingbox; | ||
| return { | ||
| displayName: resultObject.display_name, | ||
| destination: Cesium.Rectangle.fromDegrees( | ||
| bboxDegrees[2], | ||
| bboxDegrees[0], | ||
| bboxDegrees[3], | ||
| bboxDegrees[1] | ||
| ) | ||
| }; | ||
| }); | ||
| }); | ||
| }; | ||
|
|
||
| var viewer = new Cesium.Viewer('cesiumContainer', { | ||
| geocoder: new OpenStreetMapNominatimGeocoder() | ||
| }); | ||
|
|
||
| //Sandcastle_End | ||
| Sandcastle.finishedLoading(); | ||
| } | ||
| if (typeof Cesium !== "undefined") { | ||
| startup(Cesium); | ||
| } else if (typeof require === "function") { | ||
| require(["Cesium"], startup); | ||
| } | ||
| </script> | ||
| </body> | ||
| </html> |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /*global define*/ | ||
| define([ | ||
| './BingMapsApi', | ||
| './defaultValue', | ||
| './defined', | ||
| './defineProperties', | ||
| './DeveloperError', | ||
| './loadJsonp', | ||
| './Rectangle' | ||
| ], function( | ||
| BingMapsApi, | ||
| defaultValue, | ||
| defined, | ||
| defineProperties, | ||
| DeveloperError, | ||
| loadJsonp, | ||
| Rectangle) { | ||
| 'use strict'; | ||
|
|
||
| var url = 'https://dev.virtualearth.net/REST/v1/Locations'; | ||
|
|
||
| /** | ||
| * Provides geocoding through Bing Maps. | ||
| * @alias BingMapsGeocoderService | ||
| * @constructor | ||
| * | ||
|
|
||
| * @param {Object} options Object with the following properties: | ||
| * @param {String} [key] A key to use with the Bing Maps geocoding service | ||
| * @param {Boolean} autoComplete Indicates whether this service shall be used to fetch auto-complete suggestions | ||
| */ | ||
| function BingMapsGeocoderService(options) { | ||
| options = defaultValue(options, defaultValue.EMPTY_OBJECT); | ||
| this._url = 'https://dev.virtualearth.net/REST/v1/Locations'; | ||
|
There was a problem hiding this comment. Should this be There was a problem hiding this comment. I'm not sure it should be possible to supply a different URL, because then it's not really the same geocoder service anymore |
||
| this._key = BingMapsApi.getKey(options.key); | ||
| } | ||
|
|
||
| defineProperties(BingMapsGeocoderService.prototype, { | ||
| /** | ||
| * The URL endpoint for the Bing geocoder service | ||
| * @type {String} | ||
|
There was a problem hiding this comment. This and below need to be marked |
||
| * @memberof {BingMapsGeocoderService.prototype} | ||
| * @readonly | ||
| */ | ||
| url : { | ||
| get : function () { | ||
| return this._url; | ||
| } | ||
| }, | ||
|
|
||
| /** | ||
| * The key for the Bing geocoder service | ||
| * @type {String} | ||
| * @memberof {BingMapsGeocoderService.prototype} | ||
| * @readonly | ||
| */ | ||
| key : { | ||
| get : function () { | ||
| return this._key; | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| /** | ||
| * @function | ||
| * | ||
| * @param {String} query The query to be sent to the geocoder service | ||
| * @returns {Promise<GeocoderResult[]>} | ||
| */ | ||
| BingMapsGeocoderService.prototype.geocode = function(query) { | ||
| //>>includeStart('debug', pragmas.debug); | ||
| if (!defined(query)) { | ||
| throw new DeveloperError('query must be defined'); | ||
| } | ||
| //>>includeEnd('debug'); | ||
|
|
||
|
There was a problem hiding this comment. Is there a reason we don't check that query is defined and throw a |
||
| var key = this.key; | ||
| var promise = loadJsonp(url, { | ||
| parameters : { | ||
| query : query, | ||
| key : key | ||
| }, | ||
| callbackParameterName : 'jsonp' | ||
| }); | ||
|
|
||
| return promise.then(function(result) { | ||
| if (result.resourceSets.length === 0) { | ||
| return []; | ||
| } | ||
|
|
||
| var results = result.resourceSets[0].resources; | ||
|
|
||
| return results.map(function (resource) { | ||
| var bbox = resource.bbox; | ||
| var south = bbox[0]; | ||
| var west = bbox[1]; | ||
| var north = bbox[2]; | ||
| var east = bbox[3]; | ||
| return { | ||
| displayName: resource.name, | ||
| destination: Rectangle.fromDegrees(west, south, east, north) | ||
| }; | ||
| }); | ||
| }); | ||
| }; | ||
|
|
||
| return BingMapsGeocoderService; | ||
| }); | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| /*global define*/ | ||
| define([ | ||
| './Cartesian3', | ||
| './defaultValue', | ||
| './defineProperties', | ||
| './defined', | ||
| './DeveloperError', | ||
| '../ThirdParty/when' | ||
| ], function( | ||
| Cartesian3, | ||
| defaultValue, | ||
| defineProperties, | ||
| defined, | ||
| DeveloperError, | ||
| when) { | ||
| 'use strict'; | ||
|
|
||
| /** | ||
| * Geocodes queries containing longitude and latitude coordinates and an optional height. | ||
| * Query format: `longitude latitude (height)` with longitude/latitude in degrees and height in meters. | ||
| * | ||
| * @alias CartographicGeocoderService | ||
| * @constructor | ||
| */ | ||
| function CartographicGeocoderService() { | ||
| } | ||
|
|
||
| /** | ||
| * @function | ||
| * | ||
| * @param {String} query The query to be sent to the geocoder service | ||
| * @returns {Promise<GeocoderResult[]>} | ||
| */ | ||
| CartographicGeocoderService.prototype.geocode = function(query) { | ||
| //>>includeStart('debug', pragmas.debug); | ||
| if (!defined(query)) { | ||
| throw new DeveloperError('query must be defined'); | ||
| } | ||
| //>>includeEnd('debug'); | ||
|
|
||
| try { | ||
|
There was a problem hiding this comment. Sorry if this has been covered, but what part of this try block can cause an exception? |
||
| var splitQuery = query.match(/[^\s,\n]+/g); | ||
| if ((splitQuery.length === 2) || (splitQuery.length === 3)) { | ||
| var longitude = +splitQuery[0]; | ||
| var latitude = +splitQuery[1]; | ||
| var height = (splitQuery.length === 3) ? +splitQuery[2] : 300.0; | ||
|
|
||
| if (!isNaN(longitude) && !isNaN(latitude) && !isNaN(height)) { | ||
| var result = { | ||
| displayName: query, | ||
| destination: Cartesian3.fromDegrees(longitude, latitude, height) | ||
| }; | ||
| return when.resolve([result]); | ||
| } | ||
| } | ||
| return when.resolve([]); | ||
| } catch (e) { | ||
| when.reject(e); | ||
| } | ||
| }; | ||
|
|
||
| return CartographicGeocoderService; | ||
| }); | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /*global define*/ | ||
| define([ | ||
| './defineProperties', | ||
| './DeveloperError' | ||
| ], function( | ||
| defineProperties, | ||
| DeveloperError) { | ||
| 'use strict'; | ||
|
|
||
| /** | ||
| * @typedef {Object} GeocoderResult | ||
| * @property {String} displayName The display name for a location | ||
| * @property {Rectangle|Cartesian3} destination The bounding box for a location | ||
| */ | ||
|
|
||
| /** | ||
| * Provides geocoding through an external service. This type describes an interface and | ||
| * is not intended to be used. | ||
| * @alias GeocoderService | ||
| * @constructor | ||
| * | ||
| * @see BingMapsGeocoderService | ||
| */ | ||
| function GeocoderService() { | ||
| } | ||
|
|
||
| /** | ||
| * @function | ||
| * | ||
| * @param {String} query The query to be sent to the geocoder service | ||
| * @returns {Promise<GeocoderResult[]>} | ||
| */ | ||
| GeocoderService.prototype.geocode = DeveloperError.throwInstantiationError; | ||
|
|
||
| return GeocoderService; | ||
| }); |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Merge in master and move this to 1.30.