ElectronicHorizonOptions
public struct ElectronicHorizonOptions
Defines options for emitting Notification.Name.electronicHorizonDidUpdatePosition
, Notification.Name.electronicHorizonDidEnterRoadObject
, and Notification.Name.electronicHorizonDidExitRoadObject
notifications while a RouteController
or PassiveLocationManager
is active.
Note
The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of the level of use of the feature.-
The minimum length of the electronic horizon ahead of the current position, measured in meters.
Declaration
Swift
public let length: CLLocationDistance
-
The number of levels of branches by which to expand the horizon.
A value of 0 results in only the most probable path (MPP). A value of 1 adds paths branching out directly from the MPP, a value of 2 adds paths branching out from those paths, and so on. Only 0, 1, and 2 are usable in terms of performance.
Declaration
Swift
public let expansionLevel: UInt
-
Minimum length of side branches, measured in meters.
Declaration
Swift
public let branchLength: CLLocationDistance
-
minimum time which should pass between consecutive navigation statuses to update electronic horizon (seconds) if null we update electronic horizon on each navigation status
Declaration
Swift
public let minimumTimeIntervalBetweenUpdates: TimeInterval?
-
Declaration
Swift
public init(length: CLLocationDistance, expansionLevel: UInt, branchLength: CLLocationDistance, minTimeDeltaBetweenUpdates: TimeInterval?)