com.tomtom.sdk.navigation:navigation-engines/com.tomtom.sdk.navigation.horizon/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 options. For information on how to manage horizon options see HorizonEngine.registerHorizonOptions and optionsHorizonOptions.

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

Parameters

pathId

Identifier of this path.

parentPathId

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

offsetOnParentPath

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

geometry

Path geometry.

elements

Horizon elements that belong to the path. Mapped to horizon element types.

Constructors

Link copied to clipboard
constructor(pathId: Int, parentPathId: Int, offsetOnParentPath: Distance?, geometry: List<PathGeometry>, elements: Map<HorizonElementType, List<HorizonElement>>)

Functions

Link copied to clipboard
fun getElements(): List<HorizonElement>

Returns all the horizon elements that belong to this path. Elements of the same type are provided in increasing order of the start and end offsets.

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

Returns all the horizon elements of the specified type that belong to this path. The elements are provided in increasing order of the start offset and end offset.

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

Returns all the horizon elements of the specified types that belong to this path. Elements of the same type are provided in increasing order of the start offset and end offset.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val pathId: Int