Online Maps v3
Loading...
Searching...
No Matches
OnlineMapsBingMapsElevation Class Reference

Use the Elevations API to get elevation information for a set of locations, polyline or area on the Earth.
https://msdn.microsoft.com/en-us/library/jj158961.aspx. More...

Inheritance diagram for OnlineMapsBingMapsElevation:
OnlineMapsTextWebService OnlineMapsWebServiceAPI

Static Public Member Functions

static OnlineMapsBingMapsElevation GetElevationByPoints (string key, IEnumerable points, Heights heights=Heights.sealevel, Output output=Output.json)
 Get the elevations for each set of coordinates.
 
static OnlineMapsBingMapsElevation GetElevationByPolyline (string key, IEnumerable points, int samples, Heights heights=Heights.sealevel, Output output=Output.json)
 A polyline path is computed from the coordinates, and then elevation values at both endpoints and equally-spaced locations along the polyline are returned.
 
static OnlineMapsBingMapsElevation GetElevationByBounds (string key, double leftLongitude, double topLatitude, double rightLongitude, double bottomLatitude, int rows, int cols, Heights heights=Heights.sealevel, Output output=Output.json)
 The rectangular area defined by the four bounding box coordinates is divided into rows and columns.
The edges of the bounding box account for two of the rows and two of the columns.
Elevations are returned for the vertices of the grid created by the rows and columns.
 
static OnlineMapsBingMapsElevation GetSeaLevel (string key, IEnumerable points, Output output=Output.json)
 This request returns the offset in meters of the geoid model (heights=sealevel) from the ellipsoid model (heights=ellipsoid) at each location (difference = geoid_sealevel - ellipsoid_sealevel).
 
static OnlineMapsBingMapsElevationResult GetResult (string response, Output outputType)
 Converts the response string to response object.
 
static bool ParseElevationArray (string response, Output outputType, ref Array array)
 Fast way get the elevation values without parsing JSON or XML.
 

Additional Inherited Members

- Public Member Functions inherited from OnlineMapsWebServiceAPI
void Destroy ()
 Destroys the current request to webservice.
 
OnlineMapsWWW GetWWW ()
 Get request instance.
 
- Public Attributes inherited from OnlineMapsTextWebService
Action< string > OnComplete
 Event that occurs when a response is received from webservice.
 
new Action< OnlineMapsTextWebServiceOnFailed
 Event that occurs when an error response is received from webservice.
 
new Action< OnlineMapsTextWebServiceOnFinish
 This event is occurs after other events, before disposing the request.
 
new Action< OnlineMapsTextWebServiceOnSuccess
 Event that occurs when a success response is received from webservice.
 
- Public Attributes inherited from OnlineMapsWebServiceAPI
Action< OnlineMapsWebServiceAPIOnFailed
 Event that occurs when an error response is received from webservice.
 
Action< OnlineMapsWebServiceAPIOnFinish
 Event that occurs after OnComplete, when the response from webservice processed.
 
Action< OnlineMapsWebServiceAPIOnDispose
 Event that occurs when the current request instance is disposed.
 
Action< OnlineMapsWebServiceAPIOnSuccess
 Event that occurs when a success response is received from webservice.
 
object customData
 In this variable you can put any data that you need to work with requests.
 
- Protected Member Functions inherited from OnlineMapsTextWebService
void OnRequestComplete (OnlineMapsWWW www)
 Checks whether the response from webservice.
 
- Protected Attributes inherited from OnlineMapsTextWebService
string _response
 Response string.
 
- Properties inherited from OnlineMapsTextWebService
string response [get]
 Gets a response from webservice.
 
- Properties inherited from OnlineMapsWebServiceAPI
OnlineMapsQueryStatus status [get]
 Gets the current status of the request to webservice.
 

Detailed Description

Use the Elevations API to get elevation information for a set of locations, polyline or area on the Earth.
https://msdn.microsoft.com/en-us/library/jj158961.aspx.

Member Function Documentation

◆ GetElevationByBounds()

static OnlineMapsBingMapsElevation OnlineMapsBingMapsElevation.GetElevationByBounds ( string key,
double leftLongitude,
double topLatitude,
double rightLongitude,
double bottomLatitude,
int rows,
int cols,
Heights heights = Heights::sealevel,
Output output = Output::json )
static

The rectangular area defined by the four bounding box coordinates is divided into rows and columns.
The edges of the bounding box account for two of the rows and two of the columns.
Elevations are returned for the vertices of the grid created by the rows and columns.

Parameters
keyA Bing Maps Key.
leftLongitudeLeft longitude
topLatitudeTop latitude
rightLongitudeRight longitude
bottomLatitudeBottom latitude
rowsNumber of rows to use to divide the bounding box area into a grid.
colsNumber of columns to use to divide the bounding box area into a grid.
heightsSpecifies which sea level model to use to calculate elevation.
outputOutput format: JSON or XML
Returns
Instance of request.

◆ GetElevationByPoints()

static OnlineMapsBingMapsElevation OnlineMapsBingMapsElevation.GetElevationByPoints ( string key,
IEnumerable points,
Heights heights = Heights::sealevel,
Output output = Output::json )
static

Get the elevations for each set of coordinates.

Parameters
keyA Bing Maps Key.
pointsA set of coordinates on the Earth to use in elevation calculations.
IEnumerable values can be float, double or Vector2.
heightsSpecifies which sea level model to use to calculate elevation.
outputOutput format: JSON or XML
Returns
Instance of request.

◆ GetElevationByPolyline()

static OnlineMapsBingMapsElevation OnlineMapsBingMapsElevation.GetElevationByPolyline ( string key,
IEnumerable points,
int samples,
Heights heights = Heights::sealevel,
Output output = Output::json )
static

A polyline path is computed from the coordinates, and then elevation values at both endpoints and equally-spaced locations along the polyline are returned.

Parameters
keyA Bing Maps Key.
pointsA set of coordinates on the Earth to use in elevation calculations.
IEnumerable values can be float, double or Vector2.
samplesSpecifies the number of equally-spaced elevation values to provide along a polyline path.
heightsSpecifies which sea level model to use to calculate elevation.
outputOutput format: JSON or XML
Returns
Instance of request.

◆ GetResult()

static OnlineMapsBingMapsElevationResult OnlineMapsBingMapsElevation.GetResult ( string response,
Output outputType )
static

Converts the response string to response object.

Parameters
responseResponse string
outputTypeFormat of response string (JSON or XML)
Returns
Response object

◆ GetSeaLevel()

static OnlineMapsBingMapsElevation OnlineMapsBingMapsElevation.GetSeaLevel ( string key,
IEnumerable points,
Output output = Output::json )
static

This request returns the offset in meters of the geoid model (heights=sealevel) from the ellipsoid model (heights=ellipsoid) at each location (difference = geoid_sealevel - ellipsoid_sealevel).

Parameters
keyA Bing Maps Key.
pointsA set of coordinates on the Earth to use in elevation calculations.
IEnumerable values can be float, double or Vector2.
outputOutput format: JSON or XML
Returns
Instance of request.

◆ ParseElevationArray()

static bool OnlineMapsBingMapsElevation.ParseElevationArray ( string response,
Output outputType,
ref Array array )
static

Fast way get the elevation values without parsing JSON or XML.

Parameters
responseResponse string
outputTypeFormat of response string (JSON or XML)
arrayReference to an array where the values will be stored.
Supports one-dimensional and two-dimensional arrays.
Returns
TRUE - success, FALSE - failed.