RegionElement

class RegionElement(val id: Int, val pathId: Int, val startOffset: Distance, val endOffset: Distance, val country: String, val subCountry: String) : HorizonElement

Horizon element that contains data about a region.

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

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

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

Constructors

constructor(id: Int, pathId: Int, startOffset: Distance, endOffset: Distance, country: String, subCountry: String)

Name of the country. Empty string if no country is assigned to the corresponding part of the path.

open override val endOffset: Distance

End offset on the horizon path.

open override val id: Int

Identifier of this element.

open override val pathId: Int

Identifier of the horizon path to which this element belongs.

open override val startOffset: Distance

Start offset on the horizon path.

Name of the state/province/region. Empty string if no sub-country is assigned to the corresponding part of the path.

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

open override fun hashCode(): Int

open override fun toString(): String