Add orientation provider by jgillich · Pull Request #737 · maplibre/maplibre-compose

jgillich · 2026-01-05T21:10:37Z

Continuation of #712

New orientation provider returns device orientation
rememberUserLocationState will return orientation if orientationProvider is provided
Updated demos to display orientation
Renamed location bearing to course
Added measurement types (value+accuracy) for location members
LocationPuck accepts BearingMeasurement to support both course and orientation
Use spatialk/units for location provider minDistance

TODO:

~~GMS Demo crashes when you hit close~~
~~FusedOrientationProvider emits much more frequently than the provided MinUpdateInterval - should we .sample? I wonder if FusedLocationProvider does this too~~
iOS

* New orientation provider returns device orientation * rememberUserLocationState will return orientation if orientationProvider is provided * Updated demos to display orientation * Renamed location bearing to course * Added measurement types (value+accuracy) for location members * LocationPuck accepts BearingMeasurement to support both course and orientation * Use spatialk/units for location provider minDistance

sargunv · 2026-01-07T00:35:47Z

Thanks again for working on this! Will hold off on reviewing as it's in draft mode, but feel free to @ me anytime when you'd like a review

jgillich · 2026-01-11T21:14:08Z

...aplibre-compose-gms/src/androidMain/kotlin/org/maplibre/compose/gms/FusedLocationProvider.kt

            object : LocationCallback() {
              override fun onLocationResult(result: LocationResult) {
-                result.locations.forEach { trySendBlocking(it.asMapLibreLocation()).getOrThrow() }
+                result.locations.forEach { trySend(it.asMapLibreLocation()) }


This had the potential to throw a CancellationException (ForgottenCoroutineScopeException) if values are sent after cancellation. As far as I know, there are only two failure scenarios, either the channel is closed or the channel is not being collected and the buffer exceeds capacity, neither of which justify throwing.

Seems reasonable

jgillich · 2026-01-11T22:06:36Z

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/UserLocationState.kt

 public fun rememberUserLocationState(
  locationProvider: LocationProvider,
+  orientationProvider: OrientationProvider? = null,
+  samplePeriod: Duration? = 1.seconds,


I added a sampling period here to avoid doubling recompositions when orientationProvider is used. It is up to the user to sync up all the periods, potential pitfall if they miss this one. Not sure if it would be better to remove the default value entirely

I think a better solution would be to add a

val samplePeriod: Duration

to the *Provider interfaces. The you can just use the max of those for the flow.sample call (or the code I suggest below).

But after thinking about it, I'm actually not sure what you're trying to avoid here. The trivial solution (a second collectAsStateWithLifecycle) shouldn't lead to unnecessary recompositions, assuming you want a recomposition every time either location or orientation changes. That recomposition should also just affect the composables that read location or orientation from the returned UserLocationState, i.e. normally just LocationPuck.

If you have location at 1s and orientation at 1s, your UI will recompose every 0.5s on average. That is unnecessary for most apps. In my navigation app, I have a bunch of effects that respond to location changes, and keeping energy usage as low as possible is important to me. Although it is possible that this ordeal of combine/sample uses more energy than not doing it at all, so I'll see about optimizing it

If you really want to reduce energy consumption, I would tune the parameters of the location/orientation providers so they emit fewer or less accurate updates in the first place. The most expensive part (in terms of energy) is definitely reading and processing the sensor values.

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/OrientationProvider.kt

jgillich · 2026-02-01T21:01:50Z

This is ready for review btw @sargunv (and @kodebach in case you want to)

kodebach

I think making UserLocationState a parameter of LocationPuck was actually a mistake and we should fix that. The new bearing parameter would defeat the point of passing location as a state object anyway.

kodebach · 2026-02-02T15:08:08Z

...aplibre-compose-gms/src/androidMain/kotlin/org/maplibre/compose/gms/FusedLocationProvider.kt

            object : LocationCallback() {
              override fun onLocationResult(result: LocationResult) {
-                result.locations.forEach { trySendBlocking(it.asMapLibreLocation()).getOrThrow() }
+                result.locations.forEach { trySend(it.asMapLibreLocation()) }


Seems reasonable

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/LocationPuck.kt

kodebach · 2026-02-02T15:22:38Z

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/LocationPuck.kt

  accuracyThreshold: Float = 50f,
  colors: LocationPuckColors = LocationPuckColors(),
  sizes: LocationPuckSizes = LocationPuckSizes(),
  showBearing: Boolean = true,


We don't need showBearing anymore, if bearing is a separate parameter. Instead of showBearing = false you can just pass bearing = null now.

Two reasons for this:

We also have showBearingAccuracy: Boolean, for consistency's sake it would be odd to turn off one via null and the other via false. We could remove both of these flags and only show them unless null, but:

We may, at some point in the future, want to indicate that bearing is unknown rather than disabled

...plibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/LocationTrackingEffect.kt

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/OrientationProvider.kt

kodebach · 2026-02-02T15:37:42Z

lib/maplibre-compose/src/iosMain/kotlin/org/maplibre/compose/location/IosOrientationProvider.kt

+public actual fun rememberDefaultOrientationProvider(
+  updateInterval: Duration
+): OrientationProvider {
+  TODO()


On iOS (compass) orientation is also provided through CLLocationManager (https://developer.apple.com/documentation/corelocation/getting-heading-and-course-information).

I think we can just make IosLocationProvider implement both LocationProvider and OrientationProvider and add enableLocation/enableOrientation constructor parameters. Alternatively, you can also duplicate the whole class.

kodebach

This time for the correct commit

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/LocationPuck.kt

...plibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/LocationTrackingEffect.kt

kodebach · 2026-02-02T16:27:57Z

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/UserLocationState.kt

 public fun rememberUserLocationState(
  locationProvider: LocationProvider,
+  orientationProvider: OrientationProvider? = null,
+  samplePeriod: Duration? = 1.seconds,


I think a better solution would be to add a

val samplePeriod: Duration

to the *Provider interfaces. The you can just use the max of those for the flow.sample call (or the code I suggest below).

But after thinking about it, I'm actually not sure what you're trying to avoid here. The trivial solution (a second collectAsStateWithLifecycle) shouldn't lead to unnecessary recompositions, assuming you want a recomposition every time either location or orientation changes. That recomposition should also just affect the composables that read location or orientation from the returned UserLocationState, i.e. normally just LocationPuck.

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/UserLocationState.kt

…e/location/LocationPuck.kt Co-authored-by: Klemens Böswirth <23529132+kodebach@users.noreply.github.com>

Co-authored-by: Klemens Böswirth <23529132+kodebach@users.noreply.github.com>

kodebach

LGTM now

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/UserLocationState.kt

jgillich · 2026-02-02T20:11:38Z

Actions is broken again. Dammit Github, get it together 🤦‍♂️

…cyBearing extension

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/UserLocationState.kt

jgillich added 2 commits January 5, 2026 22:02

fix ios location (maybe), rename measurement value field to value

5e3d353

tweaks

17b2f46

jgillich commented Jan 11, 2026

View reviewed changes

jgillich added 3 commits January 11, 2026 22:22

simpler LocationPuck api

dd00f17

ios fix

4d9f665

rememberUserLocationState samplePeriod parameter

21a8a2c

jgillich commented Jan 11, 2026

View reviewed changes

jgillich added 2 commits January 11, 2026 23:34

update LocationTrackingEffect

f6b06fd

tweak

1673e01

jgillich marked this pull request as ready for review January 11, 2026 23:11

jgillich requested a review from sargunv January 11, 2026 23:11

jgillich commented Jan 11, 2026

View reviewed changes

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/OrientationProvider.kt Show resolved Hide resolved

fix sensor degrees, update demo

5ed75bc

kodebach mentioned this pull request Jan 25, 2026

Location layer #638

Merged

kodebach suggested changes Feb 2, 2026

View reviewed changes

use NullOrientationProvider instead of nullable OrientationProvider

975a397

kodebach suggested changes Feb 2, 2026

View reviewed changes

jgillich and others added 4 commits February 2, 2026 18:16

Update lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compos…

8172bff

…e/location/LocationPuck.kt Co-authored-by: Klemens Böswirth <23529132+kodebach@users.noreply.github.com>

infinity degrees

f1dc784

optimized rememberUserLocationState

5e3bbfb

Co-authored-by: Klemens Böswirth <23529132+kodebach@users.noreply.github.com>

value

3e2dcce

kodebach approved these changes Feb 2, 2026

View reviewed changes

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/UserLocationState.kt Outdated Show resolved Hide resolved

jgillich added 2 commits February 2, 2026 21:58

replace .value with subscriber

c3c5917

move measurements to Measurements.kt, add UserLocationState.minAccura…

c5b969c

…cyBearing extension

jgillich force-pushed the orientation branch from 9b871ff to c5b969c Compare February 3, 2026 10:44

kodebach reviewed Feb 3, 2026

View reviewed changes

lib/maplibre-compose/src/commonMain/kotlin/org/maplibre/compose/location/UserLocationState.kt Outdated Show resolved Hide resolved

jgillich added 3 commits February 3, 2026 12:59

minAccuracyBearing -> mostAccurateBearing

ec86988

basic location docs

4d9402b

add location page to menu

c9aef7b

Uh oh!

Conversation

jgillich commented Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sargunv commented Jan 7, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jgillich commented Feb 1, 2026

Uh oh!

kodebach left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kodebach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kodebach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jgillich commented Feb 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jgillich commented Jan 5, 2026 •

edited

Loading