RouteOffset (API Reference)
Class RouteOffset
Represents a specific location along the route.
A RouteOffset is a location on the route defined by the section index and the distance in meters from the start of that section to the specified location on the route.
An offset in meters indicates the distance that needs to be traveled to reach a specific location along the route, such as a railway crossing.
For the latter case, the location of a railway crossing can be retrieved from RouteRailwayCrossing.coordinates.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionRouteOffset(int sectionIndex, double offsetInMeters) Creates a new instance. -
Method Summary
-
Field Details
-
sectionIndex
public int sectionIndexIndex of the corresponding route
Section. The start of the section indicates the start of the offset. -
offsetInMeters
public double offsetInMetersOffset from the start of the indexed
Sectionto the specified location along the route. The maximum possible offset is limited by the length of the section and cannot exceed it.
-
-
Constructor Details
-
RouteOffset
public RouteOffset(int sectionIndex, double offsetInMeters) Creates a new instance.
- Parameters:
sectionIndex-Index of the corresponding route
Section. The start of the section indicates the start of the offset.offsetInMeters-Offset from the start of the indexed
Sectionto the specified location along the route. The maximum possible offset is limited by the length of the section and cannot exceed it.
-