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

Package-level declarations

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

Types

ExplicitDistancePolicy

class ExplicitDistancePolicy(val searchDistance: PathSearchDistance) : PathSearchDistancePolicy

Policy that defines a search distance for the main path.

HorizonEngine

interface HorizonEngine : AutoCloseable

Interface to a Virtual Horizon engine.

HorizonOptions

class HorizonOptions(val elementTypes: List<HorizonElementType>, val mainPathSearchOptions: MainPathSearchOptions = MainPathSearchOptions(), val subPathSearchOptions: List<SubPathSearchOptions> = listOf(), val numberOfPaths: Int = DEFAULT_NUMBER_OF_PATHS)

Horizon configuration options.

HorizonResult

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

Output of the horizon engine, consisting of:

MainPathSearchOptions

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

class PathSearchDistance(val maxHorizonLength: Distance)

Horizon path search distance configuration.

PathSearchDistancePolicy

interface PathSearchDistancePolicy

Interface to the path search policy.

RouteLengthPolicy

object RouteLengthPolicy : PathSearchDistancePolicy

Policy that binds the horizon path to the entire route.

SubPathSearchOptions

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.