HorizonOptions

constructor(elementTypes: List<HorizonElementType>, mainPathSearchOptions: MainPathSearchOptions, subPathSearchOptions: List<SubPathSearchOptions> = listOf(), numberOfPaths: Int = DEFAULT_NUMBER_OF_PATHS, minDistanceAhead: Distance = DEFAULT_MIN_DISTANCE_AHEAD)

Parameters

elementTypes

Types of horizon elements of interest.

mainPathSearchOptions

Search options for the main path.

subPathSearchOptions

Search options for sub-paths, specified per path level. The list element at index i encodes search options for path level i + 1. The horizon is extended to the deepest path level, as determined by this parameter. The default value is an empty list.

numberOfPaths

Maximum number of paths the client can receive. The default value is DEFAULT_NUMBER_OF_PATHS.

minDistanceAhead

The minimum length of the horizon ahead for which a horizon snapshot update is triggered. If the distance between the vehicle and the end of the horizon snapshot since the last snapshot update is less than this value, the client will receive a new horizon snapshot. If the explicit distance policy is used for the main path, a value for the minimum distance ahead that is greater than the main path search distance will result in the snapshot being updated on every tick. To trigger update of the horizon snapshot on every tick, regardless of the search distance policy used for the main path, define this parameter to Int.MAX_VALUE in meters.