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

Package-level declarations

HorizonEngine: Provides access to a Virtual Horizon engine, which supplies location context data extending beyond the driver's visible horizon. Returns HorizonResult.

Types

ExplicitDistancePolicy

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

class ExplicitDistancePolicy(val searchDistance: PathSearchDistance) : PathSearchDistancePolicy

Policy that defines a search distance for the main path.

HorizonEngine

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

interface HorizonEngine : AutoCloseable

Interface to a Virtual Horizon engine.

HorizonOptions

class HorizonOptions(val elementTypes: List<HorizonElementType>, @RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP]) val mainPathSearchOptions: MainPathSearchOptions = MainPathSearchOptions(), @RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP]) val subPathSearchOptions: List<SubPathSearchOptions> = listOf(), @RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP]) val numberOfPaths: Int = DEFAULT_NUMBER_OF_PATHS)

Horizon configuration options.

HorizonPath

class HorizonPath(val pathId: Int, val parentPathId: Int, val offsetOnParentPath: Distance?, val geometry: List<PathGeometryElement>, 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 set of horizon options for which horizon data was generated. For information on how to manage horizon options see HorizonEngine.registerHorizonOptions and HorizonEngine.unregisterHorizonOptions.

HorizonPosition

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

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

HorizonResult

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

class HorizonResult(val options: HorizonOptions, val snapshot: HorizonSnapshot, val position: HorizonPosition)

Output of the horizon engine, consisting of:

HorizonSnapshot

class HorizonSnapshot(val paths: List<HorizonPath>, val state: HorizonSnapshotState, mainPathId: Int?)

Snapshot of the horizon provided by the horizon engine for a set of registered horizon options. These options define the extent of the paths on the horizon and which map attributes are collected for those paths.

HorizonSnapshotState

class HorizonSnapshotState constructor(@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP]) val updateCounter: Int)

State of the horizon snapshot that the horizon engine generates based on a set of registered options.

MainPathSearchOptions

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

class MainPathSearchOptions(val searchTime: Duration = DEFAULT_MAIN_PATH_SEARCH_TIME, val searchDistancePolicy: PathSearchDistancePolicy = ExplicitDistancePolicy( searchDistance = PathSearchDistance( maxHorizonLength = DEFAULT_MAIN_PATH_MAX_HORIZON_LENGTH, ), ))

Horizon search options for the main path.

PathSearchDistance

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

class PathSearchDistance(val maxHorizonLength: Distance)

Horizon path search distance configuration.

PathSearchDistancePolicy

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

interface PathSearchDistancePolicy

Interface to the path search policy.

RouteLengthPolicy

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

object ~~RouteLengthPolicy~~ : PathSearchDistancePolicy

Policy that binds the horizon path to the entire route.

SubPathSearchOptions

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

class SubPathSearchOptions(val searchTime: Duration = DEFAULT_SUB_PATH_SEARCH_TIME, val searchDistance: PathSearchDistance = PathSearchDistance( maxHorizonLength = DEFAULT_SUB_PATH_MAX_HORIZON_LENGTH, ))

Horizon search options for a sub-path level.

Functions

buildHorizonOptions

fun buildHorizonOptions(elementTypes: List<HorizonElementType>): HorizonOptions

Creates an instance of HorizonOptions for subscribing to horizon data with the given element types of interest.