Class Route
The base class for routes.
Namespace: Holoride.ElasticSDK
Assembly: Holoride.ElasticSDK.Library.Runtime.dll
Syntax
[Serializable]
[HelpURL("http://localhost:8080/api/Holoride.ElasticSDK.Route.html")]
public class Route : ScriptableObjectProperties
DefaultSpeed
Declaration
public float DefaultSpeed { get; set; }Property Value
| Type | Description |
|---|---|
| float |
GeoCoordinates
Gets the geo coordinates of the route geometry obtained by the navigation API.
Declaration
public IReadOnlyList<GeoCoordinate> GeoCoordinates { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<GeoCoordinate> |
IsValid
Declaration
public bool IsValid { get; }Property Value
| Type | Description |
|---|---|
| bool |
Maneuvers
Gets the maneuver data along the route obtained by the navigation API.
Declaration
public IReadOnlyList<Maneuver> Maneuvers { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<Maneuver> |
MinimumImportCoordinateDistance
Declaration
public float MinimumImportCoordinateDistance { get; set; }Property Value
| Type | Description |
|---|---|
| float |
Speeds
Gets the speed data along the route obtained by the navigation API.
Declaration
public IReadOnlyList<float> Speeds { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<float> |
SpeedSegments
Gets the route speed intervals.
Declaration
public IReadOnlyList<SpeedSegment> SpeedSegments { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<SpeedSegment> |
TravelDistance
Gets the list of travel distances in meters for the current route.
Declaration
public IReadOnlyList<double> TravelDistance { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<double> |
TravelTimes
Gets the list of travel times in seconds for the current route.
Declaration
public IReadOnlyList<double> TravelTimes { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<double> |
Methods
GetSplineWithDefaultPivot()
Computes the spline with the pivot set to the first GeoCoordinate of this route.
Declaration
public Spline GetSplineWithDefaultPivot()Returns
| Type | Description |
|---|---|
| Spline | The spline of the route with the pivot set to the first location. |
GetSplineWithPivot(GeoCoordinate)
Computes the spline of this route given a custom pivot.
To obtain the spline of the route for its own pivot, use Spline.
Declaration
public Spline GetSplineWithPivot(GeoCoordinate pivot)Parameters
| Type | Name | Description |
|---|---|---|
| GeoCoordinate | pivot | The pivot relative to which to get the spline. |
Returns
| Type | Description |
|---|---|
| Spline | The route's spline, or null if the route is empty. |
Reset()
Declaration
public void Reset()TryChange(IReadOnlyList<GeoCoordinate>, IReadOnlyList<float>, IReadOnlyList<Maneuver>, IReadOnlyList<double>, IReadOnlyList<double>, bool)
Changes the current route.
Declaration
public bool TryChange(IReadOnlyList<GeoCoordinate> geoCoordinates, IReadOnlyList<float> speeds, IReadOnlyList<Maneuver> maneuvers, IReadOnlyList<double> distancesToDestination, IReadOnlyList<double> timesToDestination, bool zeroAltitude)Parameters
| Type | Name | Description |
|---|---|---|
| IReadOnlyList<GeoCoordinate> | geoCoordinates | The GeoCoordinates the route is defined by. |
| IReadOnlyList<float> | speeds | A list of speed values with the same length as geoCoordinates. |
| IReadOnlyList<Maneuver> | maneuvers | A arbitrarily long list of maneuvers. |
| IReadOnlyList<double> | distancesToDestination | An optional list with the route distance to the destination for each GeoCoordinate. |
| IReadOnlyList<double> | timesToDestination | A list with estimated time to destination for each GeoCoordinate. |
| bool | zeroAltitude | States whether all altitude values should be set to zero. |
Returns
| Type | Description |
|---|---|
| bool |
Events
OnRouteChanged
The event that gets fired when a route update has finished.
Declaration
public event Action OnRouteChangedEvent Type
| Type | Description |
|---|---|
| Action |