com.tomtom.sdk.navigation:navigation/com.tomtom.sdk.navigation.horizon.elements.safetylocation/SafetyLocationElement

SafetyLocationElement

class SafetyLocationElement(val id: Int, val pathId: Int, val startOffset: Distance, val endOffset: Distance, val safetyLocation: SafetyLocation) : HorizonElement

Horizon element that contains data about a safety location.

To receive such elements in the horizon snapshot, specify SafetyLocationElementType in the horizon options. Use the factory method buildHorizonOptions to build horizon options with the desired element types instead of calling the constructor directly:

val horizonOptions = buildHorizonOptions(
    elementTypes = listOf(SafetyLocationElementType, ...),
    ...
)

Constructors

SafetyLocationElement

constructor(id: Int, pathId: Int, startOffset: Distance, endOffset: Distance, safetyLocation: SafetyLocation)

Properties

endOffset

open override val endOffset: Distance

End offset on the horizon path. If a zone safety location stretches beyond the end of the horizon, the SDK only provides data for the part of the zone within the horizon length. As the horizon is extended ahead of the vehicle while the vehicle moves along the zone safety location, the end offset of the safety location element is updated accordingly.