Support altitude interpolation in location component. - MAPSAND-291 (#1478)

* Interpolate altitude in Point, improve performance of navigation simulator.

* Add change log.

* Add altitude to DefaultLocationProvider.

* Update changelog.

* Clean up.

* Check if altitude exists before interpolating.

* Address review comment.

* Fix test.

Author: pengdev

CHANGELOG.md

@@ -8,6 +8,10 @@ Mapbox welcomes participation and contributions from everyone.
 ## Dependencies
 * Bump telemetry to [v8.1.4](https://github.com/mapbox/mapbox-events-android/releases/tag/telem-8.1.4-core-5.0.2). ([#1484](https://github.com/mapbox/mapbox-maps-android/pull/1484))
 
+#main
+## Bug fixes 🐞
+* Support altitude interpolation in location component, and pass through GPS altitude information from the DefaultLocationProvider. ([1478](https://github.com/mapbox/mapbox-maps-android/pull/1478))
+
 # 10.7.0-beta.1 June 29, 2022
 ## Breaking changes ⚠️
 * Remove deprecated `FollowPuckViewportStateOptions.animationDurationMs` from experimental viewport plugin. ([1421](https://github.com/mapbox/mapbox-maps-android/pull/1421))

app/src/main/java/com/mapbox/maps/testapp/utils/NavigationSimulator.kt

@@ -25,9 +25,6 @@ import com.mapbox.maps.plugin.viewport.data.OverviewViewportStateOptions
 import com.mapbox.maps.plugin.viewport.data.ViewportOptions
 import com.mapbox.maps.plugin.viewport.viewport
 import com.mapbox.maps.testapp.R
-import com.mapbox.turf.TurfConstants
-import com.mapbox.turf.TurfMeasurement
-import com.mapbox.turf.TurfMisc
 
 /**
  * Simulate a navigation route with pre-defined route as LineString.
@@ -47,8 +44,6 @@ class NavigationSimulator(
   private lateinit var routeLayer: LineLayer
   private lateinit var casingLayer: LineLayer
   private val handler = Handler(Looper.getMainLooper())
-  private val totalRouteLength = TurfMeasurement.length(routePoints, TurfConstants.UNIT_CENTIMETERS)
-  private val routeStartPoint = routePoints.coordinates().first()
   private val viewportPlugin = mapView.viewport
   private val followPuckViewportState =
     viewportPlugin.makeFollowPuckViewportState(FollowPuckViewportStateOptions.Builder().build())
@@ -338,12 +333,10 @@ class NavigationSimulator(
   }
 
   override fun onIndicatorPositionChanged(point: Point) {
-    val progress = TurfMeasurement.length(
-      TurfMisc.lineSlice(routeStartPoint, point, routePoints),
-      TurfConstants.UNIT_CENTIMETERS
-    ) / totalRouteLength
-    routeLayer.lineTrimOffset(listOf(0.0, progress))
-    casingLayer.lineTrimOffset(listOf(0.0, progress))
+    // use altitude to pass through interpolated progress data, reduce the overhead to
+    // calculate the progress on each frame.
+    routeLayer.lineTrimOffset(listOf(0.0, point.altitude()))
+    casingLayer.lineTrimOffset(listOf(0.0, point.altitude()))
   }
 
   fun onDestroy() {

app/src/main/java/com/mapbox/maps/testapp/utils/SimulateRouteLocationProvider.kt

@@ -6,7 +6,9 @@ import com.mapbox.geojson.LineString
 import com.mapbox.geojson.Point
 import com.mapbox.maps.plugin.locationcomponent.LocationConsumer
 import com.mapbox.maps.plugin.locationcomponent.LocationProvider
+import com.mapbox.turf.TurfConstants
 import com.mapbox.turf.TurfMeasurement
+import com.mapbox.turf.TurfMisc
 import java.util.concurrent.*
 
 /**
@@ -17,6 +19,8 @@ class SimulateRouteLocationProvider(
   val route: LineString,
   private val handler: Handler = Handler(Looper.getMainLooper())
 ) : LocationProvider {
+  private val totalRouteLength = TurfMeasurement.length(route, TurfConstants.UNIT_CENTIMETERS)
+  private val routeStartPoint = route.coordinates().first()
   private val locationConsumers = CopyOnWriteArraySet<LocationConsumer>()
   private var isFakeLocationEmitting = false
   override fun registerLocationConsumer(locationConsumer: LocationConsumer) {
@@ -44,7 +48,7 @@ class SimulateRouteLocationProvider(
     handler.postDelayed(
       {
         if (iterator.hasNext()) {
-          val point = iterator.next()
+          val point = iterator.next().insertProgressInfo()
           val bearing = TurfMeasurement.bearing(lastLocation, point)
           lastLocation = point
           lastBearing = bearing
@@ -61,6 +65,17 @@ class SimulateRouteLocationProvider(
     )
   }
 
+  // use altitude of Point to pass through progress data, and use internal animator to interpolate
+  // the progress, thus reduce the overhead to calculate the progress on each frame.
+  private fun Point.insertProgressInfo() = Point.fromLngLat(
+    longitude(),
+    latitude(),
+    TurfMeasurement.length(
+      TurfMisc.lineSlice(routeStartPoint, this, route),
+      TurfConstants.UNIT_CENTIMETERS
+    ) / totalRouteLength
+  )
+
   private companion object {
     const val LOCATION_UPDATE_INTERVAL_MS = 1000L
   }

plugin-locationcomponent/src/main/java/com/mapbox/maps/plugin/locationcomponent/DefaultLocationProvider.kt

@@ -79,8 +79,14 @@ class DefaultLocationProvider @VisibleForTesting(otherwise = PRIVATE) internal c
   }
 
   private fun notifyLocationUpdates(location: Location) {
+    val locationPoint = if (location.hasAltitude()) {
+      Point.fromLngLat(location.longitude, location.latitude, location.altitude)
+    } else {
+      Point.fromLngLat(location.longitude, location.latitude)
+    }
+
     locationConsumers.forEach { consumer ->
-      consumer.onLocationUpdated(Point.fromLngLat(location.longitude, location.latitude))
+      consumer.onLocationUpdated(locationPoint)
       if (currentPuckBearingSource == PuckBearingSource.COURSE) {
         consumer.onBearingUpdated(location.bearing.toDouble())
       }

plugin-locationcomponent/src/main/java/com/mapbox/maps/plugin/locationcomponent/animators/Evaluators.kt

@@ -8,10 +8,17 @@ internal object Evaluators {
    * Type evaluator for Point data
    */
   val POINT = TypeEvaluator<Point> { fraction, startValue, endValue ->
-    Point.fromLngLat(
-      startValue.longitude() + fraction * (endValue.longitude() - startValue.longitude()),
-      startValue.latitude() + fraction * (endValue.latitude() - startValue.latitude())
-    )
+    val longitude = startValue.longitude() + fraction * (endValue.longitude() - startValue.longitude())
+    val latitude = startValue.latitude() + fraction * (endValue.latitude() - startValue.latitude())
+    if (startValue.hasAltitude() && endValue.hasAltitude()) {
+      Point.fromLngLat(
+        longitude,
+        latitude,
+        startValue.altitude() + fraction * (endValue.altitude() - startValue.altitude()),
+      )
+    } else {
+      Point.fromLngLat(longitude, latitude)
+    }
   }
 
   /**

plugin-locationcomponent/src/test/java/com/mapbox/maps/plugin/locationcomponent/DefaultLocationProviderTest.kt

@@ -175,8 +175,10 @@ class DefaultLocationProviderTest {
     val locationEngineResult = mockk<LocationEngineResult>(relaxed = true)
     val location = mockk<Location>(relaxed = true)
     every { locationEngineResult.lastLocation } returns location
+    every { location.hasAltitude() } returns true
     every { location.longitude } returns 12.0
     every { location.latitude } returns 34.0
+    every { location.altitude } returns 10.0
     every { location.bearing } returns 90.0f
 
     defaultLocationProvider.registerLocationConsumer(locationConsumer1)
@@ -189,9 +191,9 @@ class DefaultLocationProviderTest {
       )
     }
     locationEngineCallbackSlot.captured.onSuccess(locationEngineResult)
-    verify { locationConsumer1.onLocationUpdated(Point.fromLngLat(12.0, 34.0)) }
+    verify { locationConsumer1.onLocationUpdated(Point.fromLngLat(12.0, 34.0, 10.0)) }
     verify { locationConsumer1.onBearingUpdated(90.0) }
-    verify { locationConsumer2.onLocationUpdated(Point.fromLngLat(12.0, 34.0)) }
+    verify { locationConsumer2.onLocationUpdated(Point.fromLngLat(12.0, 34.0, 10.0)) }
     verify { locationConsumer2.onBearingUpdated(90.0) }
   }
 
@@ -201,8 +203,10 @@ class DefaultLocationProviderTest {
     val locationEngineResult = mockk<LocationEngineResult>(relaxed = true)
     val location = mockk<Location>(relaxed = true)
     every { locationEngineResult.lastLocation } returns location
+    every { location.hasAltitude() } returns true
     every { location.longitude } returns 12.0
     every { location.latitude } returns 34.0
+    every { location.altitude } returns 10.0
     every { location.bearing } returns 90.0f
 
     defaultLocationProvider.registerLocationConsumer(locationConsumer1)
@@ -215,9 +219,9 @@ class DefaultLocationProviderTest {
       )
     }
     locationEngineCallbackSlot.captured.onSuccess(locationEngineResult)
-    verify { locationConsumer1.onLocationUpdated(Point.fromLngLat(12.0, 34.0)) }
+    verify { locationConsumer1.onLocationUpdated(Point.fromLngLat(12.0, 34.0, 10.0)) }
     verify(exactly = 0) { locationConsumer1.onBearingUpdated(90.0) }
-    verify { locationConsumer2.onLocationUpdated(Point.fromLngLat(12.0, 34.0)) }
+    verify { locationConsumer2.onLocationUpdated(Point.fromLngLat(12.0, 34.0, 10.0)) }
     verify(exactly = 0) { locationConsumer2.onBearingUpdated(90.0) }
     defaultLocationProvider.locationCompassListener.onCompassChanged(90.0f)
     verify { locationConsumer1.onBearingUpdated(90.0) }

plugin-locationcomponent/src/test/java/com/mapbox/maps/plugin/locationcomponent/LocationIndicatorLayerWrapperTest.kt

@@ -162,8 +162,8 @@ class LocationIndicatorLayerWrapperTest {
     layer.updateStyle(newStyle)
     val radius = 1.0
     layer.accuracyRadius(radius)
-    verify(exactly = 0) { style.setStyleLayerProperty(INDICATOR_LAYER_ID, "accuracy-radius", Value.valueOf(radius)) }
-    verify(exactly = 1) { newStyle.setStyleLayerProperty(INDICATOR_LAYER_ID, "accuracy-radius", Value.valueOf(radius)) }
+    verify(exactly = 0) { style.setStyleLayerProperty(INDICATOR_LAYER_ID, "accuracy-radius", any()) }
+    verify(exactly = 1) { newStyle.setStyleLayerProperty(INDICATOR_LAYER_ID, "accuracy-radius", any()) }
   }
 
   companion object {