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

elementsAhead

fun elementsAhead(position: HorizonPosition, distanceAhead: Distance): List<HorizonElement>

Returns the horizon elements that are ahead of the given position on the path to which the position belongs, within the given distance. Elements of the same type are provided in increasing order of the start offset and end offset.

Important: This is a Public Preview API. It may be changed or removed at any time.

Return

List of horizon elements ahead of the given position on the path to which the position belongs, within the given distance. The list is empty if the position does not have a valid path id or there is no path in the snapshot with the same id as the one stored in the position.

Parameters

position

Horizon positionHorizonPosition.

distanceAhead

Distance ahead of the specified position.

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

Returns the horizon elements of the given types that are ahead of the given position on the path to which the position belongs, within the given distance. Elements of the same type are provided in increasing order of the start offset and end offset.

Important: This is a Public Preview API. It may be changed or removed at any time.

Return

List of horizon elements of the given types ahead of the given position on the path to which the position belongs, within the given distance. The list is empty if the position does not have a valid path id or there is no path in the snapshot with the same id as the one stored in the position.

Parameters

position

Horizon position HorizonPosition.

distanceAhead

Distance ahead of the specified position.

types

Types of horizon elements.

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

Returns the horizon elements of the given type that are ahead of the given position on the path to which the position belongs, within the given distance. The elements are provided in increasing order of the start offset and end offset.

Important: This is a Public Preview API. It may be changed or removed at any time.

Return

List of horizon elements of the given type ahead of the given position on the path to which the position belongs, within the given distance. The list is empty if the position does not have a valid path id or there is no path in the snapshot with the same id as the one stored in the position.

Parameters

position

Horizon positionHorizonPosition.

distanceAhead

Distance ahead of the specified position.

type

Type of horizon elements.