HorizonPosition

public struct HorizonPosition

The best map-matched position on the horizon. It can be either on-road or off-road. If off-road, it can be either:

  • the likeliest on-road position on the horizon, but flagged as off-road, if there are on-road candidates. The user can extract horizon elements to facilitate the decision to join the road.
  • or an off-road position with an invalid path id and an unmatched raw location, if there are no on-road candidates on the horizon.

Important

This is a Public Preview API. It may be changed or removed at any time.

Public

  • Identifier of the path that this position belongs to, or 0 if this position does not belong to any path, i.e., it is an off-road position, and there are no other on-road position candidates.

    Declaration

    Swift

    public let pathID: Int

  • Offset from the start of the path to this position.

    Declaration

    Swift

    public let offset: Measurement<UnitLength>

  • Flag to indicate whether the position is on-road: true if on-road, false otherwise.

    Declaration

    Swift

    public let isOnRoad: Bool

  • Geographical location associated with this position.

    Declaration

    Swift

    public let location: GeoLocation