navigation:engine/com.tomtom.sdk.navigation.horizon

Package-level declarations

Types

data class ExplicitDistancePolicy(val distance: Distance) : PathSearchDistancePolicy

Main path search distance policy that specifies an explicit search distance. When this search policy is enabled, the horizon engine only searches within a subscription-specified distance when extending the main path. It does not search along the entire route.

HorizonEngine

interface HorizonEngine : AutoCloseable

Defines the interface to the horizon engine. The horizon engine generates vehicle horizon data based on previously registered horizon subscription options, which define the length of the horizon paths and what map data is collected for these paths. The client of the horizon engine can register multiple sets of horizon subscription options and request the engine to provide horizon data for all or some of these sets of options. The client of the engine can also update the subscription by registering a new set of subscription options or unregistering a previously registered set.

HorizonOptions

data class HorizonOptions(val elementTypes: List<HorizonElementType>, val mainPathSearchOptions: MainPathOptions, val subPathSearchOptions: List<SubPathOptions> = listOf(), val numberOfPaths: Int = 1)

Horizon subscription configuration. The client uses subscription options to define the extent of the paths in the horizon and the map attributes that are collected for these paths. A subscription configuration consists of search options, such as the path search distance and the path search time, as well as a set of types of horizon elements that the client is interested in. The search distance and time determine the length of the horizon paths. The set of horizon element types determines which map attributes will be collected for those paths.

HorizonPath

class HorizonPath(val pathId: Int, val parentPathId: Int, val offsetOnParentPath: Distance?, val geometry: List<PathGeometry>, elements: Map<HorizonElementType, List<HorizonElement>>)

Path in the horizon. The length of the path as well as which types of horizon elements it contains are determined by the horizon subscription options.

HorizonPosition

data class HorizonPosition(val pathId: Int, val offset: Distance, val isOnRoad: Boolean, val location: GeoLocation)

Current position in the horizon.

HorizonResult

data class HorizonResult(val options: HorizonOptions, val snapshot: HorizonSnapshot)

Output of the horizon engine, consisting of one horizon snapshot per each set of previously registered horizon subscription options.

HorizonSnapshot

class HorizonSnapshot(val paths: List<HorizonPath>, val positions: List<HorizonPosition>)

Snapshot of the horizon provided by the horizon engine, based on a set of previously registered horizon subscription options. Subscription options define the extent of the paths in the horizon as well as which map attributes are collected for those paths.

MainPathOptions

data class MainPathOptions(val searchTime: Duration? = null, val searchDistancePolicy: PathSearchDistancePolicy? = null)

Horizon search options for the main path. Search options, such as the search distance and the search time, define the extent of the paths in the horizon.

PathSearchDistancePolicy

interface PathSearchDistancePolicy

Interface to the path search policy. The path search policy specifies whether the horizon engine must search along the entire route or within a user-defined distance.

RouteLengthPolicy

object RouteLengthPolicy : PathSearchDistancePolicy

Main path search distance policy that is based on the route length. When this policy is enabled, the horizon engine searches along the entire route when extending the main path.

SubPathOptions

data class SubPathOptions(val searchTime: Duration? = null, val searchDistance: Distance? = null)

Horizon search options for a sub-path level. Search options, such as the search distance and the search time, define the extent of the paths in the horizon.