com.tomtom.sdk.navigation:navigation/com.tomtom.sdk.navigation.horizon.elements.poi/PoiElement2

PoiElement2

class PoiElement2(val id: Int, val pathId: Int, val startOffset: Distance, val endOffset: Distance, val place: Place, val accessType: PoiElement2.AccessType) : HorizonElement

Horizon element that contains data about a Place of a Point of Interest.

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

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

Constructors

PoiElement2

constructor(id: Int, pathId: Int, startOffset: Distance, endOffset: Distance, place: Place, accessType: PoiElement2.AccessType)

Types

AccessType

@JvmInline

value class AccessType

Describes the access type of this POI place.

Properties

accessType

val accessType: PoiElement2.AccessType

Access type of the POI Place data.

endOffset

open override val endOffset: Distance

End offset on the horizon path.

open override val id: Int

Identifier of this element.

pathId

open override val pathId: Int

Identifier of the horizon path to which this element belongs.

place

val place: Place

This property contains specific information about the POI place. Use place.coordinate to get the POI location, place.id to get the POI ID, and place.details to retrieve additional details about the POI.

startOffset

open override val startOffset: Distance

Start offset on the horizon path.

Functions

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String