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

HorizonOptions

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

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.

Constructors

HorizonOptions

fun HorizonOptions( elementTypes: List<HorizonElementType>, mainPathSearchOptions: MainPathOptions, subPathSearchOptions: List<SubPathOptions>, numberOfPaths: Int)

Creates a horizon subscription configuration.

Properties

elementTypes

val elementTypes: List<HorizonElementType>

Types of horizon element of interest.

mainPathSearchOptions

val mainPathSearchOptions: MainPathOptions

Search options for the main path.

numberOfPaths

val numberOfPaths: Int

Maximum number of paths the client can receive.

subPathSearchOptions

val subPathSearchOptions: List<SubPathOptions>

Search options for sub-path levels. The container element at index i encodes search options for path level i + 1. The horizon will be extended to the deepest sub-path level, as specified by the search options for sub-path levels.