location/org.maplibre.compose.location/HeadingReference

HeadingReference

@Serializable(with = HeadingReferenceSerializer::class)

sealed interface HeadingReference(source)

North reference for a HeadingMeasurement bearing.

Serializes as its name, such as TrueNorth, and keeps a name that this version does not define.

Values may be added in minor releases; use an else branch when matching.

Inheritors

TrueOrMagneticNorth

Types

data object MagneticNorth : HeadingReference

Magnetic north.

data object TrueNorth : HeadingReference

Geographic true north.

TrueOrMagneticNorth

data object TrueOrMagneticNorth : HeadingReference

True north when the platform has magnetic declination, and magnetic north otherwise.