public struct 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.

  • Index of the corresponding route Section. The start of the section indicates the start of the offset.

    Declaration

    Swift

    public var sectionIndex: Int32

  • Offset from the start of the indexed Section to the specified location along the route. The maximum possible offset is limited by the length of the section and cannot exceed it.

    Declaration

    Swift

    public var offsetInMeters: Double

  • Creates a new instance.

    Declaration

    Swift

    public init(sectionIndex: Int32, offsetInMeters: Double)