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

HorizonPath

class HorizonPath( val pathId: Int, val parentPathId: Int, val offsetOnParentPath: Distance?, val geometry: List<PathGeometry>, elements: Map<HorizonElementType, List<HorizonElement>>)

Path in the horizon. The length of the path as well as which types of horizon elements it contains are determined by the horizon subscription options.

Constructors

fun HorizonPath( pathId: Int, parentPathId: Int, offsetOnParentPath: Distance?, geometry: List<PathGeometry>, elements: Map<HorizonElementType, List<HorizonElement>>)

Creates a horizon path.

Functions

fun getElements(): List<HorizonElement>

Returns all the horizon elements that belong to this path.

fun getElements(type: HorizonElementType): List<HorizonElement>

Returns all the horizon elements of the specified type that belong to this path.

fun getElements(types: List<HorizonElementType>): List<HorizonElement>

Returns all the horizon elements of the specified types that belong to this path.

Properties

val geometry: List<PathGeometry>

Path geometry.

offsetOnParentPath

val offsetOnParentPath: Distance?

Offset on the parent path of the stub where this path starts. (null if there is no parent path).

val parentPathId: Int

Identifier of the parent path (0 if there is no parent path).

val pathId: Int

Identifier of this path.