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

SafetyLocationElement

class SafetyLocationElement(val id: Int, val pathId: Int, val startOffset: Distance, val endOffset: Distance, val safetyLocationId: SafetyLocationId, val startPosition: GeoPoint, val endPosition: GeoPoint = startPosition, val boundingBox: GeoBoundingBox, val type: SafetyLocationType, val speedLimit: Speed?, val recommendedWarningDistance: Distance?, val isZone: Boolean) : HorizonElement

Horizon element that contains data about a safety location.

To receive such elements in the horizon snapshot, specify SafetyLocationElementType in the horizon options that you register with the horizon engine:

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

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

Constructors

SafetyLocationElement

constructor(id: Int, pathId: Int, startOffset: Distance, endOffset: Distance, safetyLocationId: SafetyLocationId, startPosition: GeoPoint, endPosition: GeoPoint = startPosition, boundingBox: GeoBoundingBox, type: SafetyLocationType, speedLimit: Speed?, recommendedWarningDistance: Distance?, isZone: Boolean)

Properties

val boundingBox: GeoBoundingBox

Bounding box that encompasses the safety location.

open override val endOffset: Distance

End offset on the horizon path.

val endPosition: GeoPoint

End coordinate of the safety location.

open override val id: Int

Identifier of this element.

val isZone: Boolean

True if the safety location is a zone (i.e., if the start point and the end point correspond to different locations). False otherwise.

open override val pathId: Int

Identifier of the horizon path to which this element belongs.

recommendedWarningDistance

val recommendedWarningDistance: Distance?

Recommended warning distance. Null if not available.

safetyLocationId

val safetyLocationId: SafetyLocationId

Unique identifier of the safety location.

val speedLimit: Speed?

Maximum speed allowed for the safety location. Null if not available.

open override val startOffset: Distance

Start offset on the horizon path.

val startPosition: GeoPoint

Start coordinate of the safety location.

val type: SafetyLocationType

Safety location type.

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String