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

Returns a route between two or more locations using Open Route Service Directions for a selected profile and its settings as JSON.
https://openrouteservice.org/dev/#/api-docs/v2/directions/{profile}/post. More...

Inheritance diagram for OnlineMapsOpenRouteServiceDirections:
OnlineMapsTextWebService OnlineMapsWebServiceAPI

Classes

class  AlternativeRoutes
 Specifies whether alternative routes are computed, and parameters for the algorithm determining suitable alternatives. More...
 
class  Options
 Advanced options. More...
 
class  Params
 Parameters of a request. More...
 
class  RoundTrip
 Options to be applied on round trip routes. More...
 

Public Types

enum  Profile
 Specifies the route profile.
 

Static Public Member Functions

static OnlineMapsOpenRouteServiceDirections Find (OnlineMapsVector2d origin, OnlineMapsVector2d destination, Params p=null)
 Search a route between two locations using Open Route Service Directions for a selected profile.
 
static OnlineMapsOpenRouteServiceDirections Find (double fromLng, double fromLat, double toLng, double toLat, Params p=null)
 Search a route between two locations using Open Route Service Directions for a selected profile.
 
static OnlineMapsOpenRouteServiceDirections Find (double[] coordinates, Params p=null)
 Search a route between two or more locations using Open Route Service Directions for a selected profile.
 
static OnlineMapsOpenRouteServiceDirectionResult GetResults (string response)
 Convert a response string into result object.
 

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

Returns a route between two or more locations using Open Route Service Directions for a selected profile and its settings as JSON.
https://openrouteservice.org/dev/#/api-docs/v2/directions/{profile}/post.

Member Function Documentation

◆ Find() [1/3]

static OnlineMapsOpenRouteServiceDirections OnlineMapsOpenRouteServiceDirections.Find ( double fromLng,
double fromLat,
double toLng,
double toLat,
Params p = null )
static

Search a route between two locations using Open Route Service Directions for a selected profile.

Parameters
fromLngLongitude of an origin point
fromLatLatitude of an origin point
toLngLongitude fo a destination point
toLatLatitude of a destination point
pParameters of a request
Returns
Instance of a request

◆ Find() [2/3]

static OnlineMapsOpenRouteServiceDirections OnlineMapsOpenRouteServiceDirections.Find ( double[] coordinates,
Params p = null )
static

Search a route between two or more locations using Open Route Service Directions for a selected profile.

Parameters
coordinatesCoordinates of locations [lng, lat, lng, lat...]
pParameters of a request
Returns
Instance of a request

◆ Find() [3/3]

static OnlineMapsOpenRouteServiceDirections OnlineMapsOpenRouteServiceDirections.Find ( OnlineMapsVector2d origin,
OnlineMapsVector2d destination,
Params p = null )
static

Search a route between two locations using Open Route Service Directions for a selected profile.

Parameters
originOrigin
destinationDestination
pParameters of a request
Returns
Instance of a request

◆ GetResults()

static OnlineMapsOpenRouteServiceDirectionResult OnlineMapsOpenRouteServiceDirections.GetResults ( string response)
static

Convert a response string into result object.

Parameters
responseResponse string
Returns
Result object