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.

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. (null if there is no parent path).

geometry

Path geometry.

elements

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

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

Constructors

Link copied to clipboard
fun HorizonPath(    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.

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

Link copied to clipboard
val geometry: List<PathGeometry>
Link copied to clipboard
val offsetOnParentPath: Distance?
Link copied to clipboard
val parentPathId: Int
Link copied to clipboard
val pathId: Int