navigation:engine/com.tomtom.sdk.navigation.vehiclehorizon/HorizonSnapshot

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.

Constructors

HorizonSnapshot

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

Creates a horizon snapshot.

Functions

distanceTo

fun distanceTo(element: HorizonElement): Distance?

Returns the tree distance to the given horizon element.

elementsAhead

fun elementsAhead(distanceAhead: Distance): List<HorizonElement>

Returns the elements ahead of the vehicle on the main path, within the given distance.

fun elementsAhead(distanceAhead: Distance, type: HorizonElementType): List<HorizonElement>

Returns the elements of the given type that are ahead of the vehicle on the main path, within the given distance.

fun elementsAhead(distanceAhead: Distance, types: List<HorizonElementType>): List<HorizonElement>

Returns the elements of the given types that are ahead of the vehicle on the main path, within the given distance.

mainPath

fun mainPath(): HorizonPath?

Returns the main horizon path. The main path is the path on which the vehicle is located.

subPaths

fun subPaths(): List<HorizonPath>

Returns the list of horizon sub-paths. A sub-path is any path that is not the main path. The main path is the path on which the vehicle is located.

Properties

paths

val paths: List<HorizonPath>

The list of horizon paths, consisting of the main path and zero or more sub-paths. The main path is the path on which the vehicle is located. A sub-path is any path in the horizon snapshot that is not the main path.

positions

val positions: List<HorizonPosition>

The list of horizon positions ordered by decreasing likelihood of match. The first position is the best map-matched position. If the first position is off-road, there may be other on-road positions following it that indicate possible places for the vehicle on the roads around it, but the vehicle is still considered to be driving off-road.