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 the likeliest position is off-road, but there are also 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 the likeliest position is off-road and there are no on-road candidates on the horizon.

Horizon position can be extracted from the result HorizonResult of the call HorizonEngine.generateHorizon with a preregistered set of HorizonOptionsused as an argument.

Lifecycle


                    
                    
                    init(pathID:offset:isOnRoad:location:)

Initializes instance of HorizonPosition.

Declaration

Swift

public init(pathID: Int, offset: Measurement<UnitLength>, isOnRoad: Bool, location: GeoLocation)

Public

pathID
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
Offset from the start of the path to this position.
Declaration
Swift

public let offset: Measurement<UnitLength>
isOnRoad
Flag to indicate whether the position is on-road: true if on-road, false otherwise.
Declaration
Swift

public let isOnRoad: Bool
location
Geographical location associated with this position.
Declaration
Swift

public let location: GeoLocation