NAVAND-5657 support immediate bearing updates for location puck animation

GitOrigin-RevId: a4e27cccc56f428cacf6ce906369305dbbbc5bbc

Author: vadzim-vys

changelog/unreleased/features/9181.md

@@ -0,0 +1 @@
+- Added support of immediate update of location puck bearing in [NavigationLocationProvider] in case of overlapping key points.

ui-maps/src/main/java/com/mapbox/navigation/ui/maps/internal/location/ConstantVelocityInterpolator.kt

@@ -21,10 +21,8 @@ class ConstantVelocityInterpolator(
         var total = 0.0
         keyPoints.fold(startPoint) { prevPoint, point ->
             val d = distance(prevPoint, point)
-            if (0.0 < d) {
-                distances.add(d)
-                total += d
-            }
+            distances.add(d)
+            total += d
             point
         }
 

…ernal/location/PuckAnimationEvaluator.kt …on/PuckAnimationEvaluatorInterpolator.ktui-maps/src/main/java/com/mapbox/navigation/ui/maps/internal/location/PuckAnimationEvaluator.kt renamed to ui-maps/src/main/java/com/mapbox/navigation/ui/maps/internal/location/PuckAnimationEvaluatorInterpolator.kt ui-maps/src/main/java/com/mapbox/navigation/ui/maps/internal/location/PuckAnimationEvaluator.kt renamed to ui-maps/src/main/java/com/mapbox/navigation/ui/maps/internal/location/PuckAnimationEvaluatorInterpolator.kt

@@ -2,18 +2,13 @@ package com.mapbox.navigation.ui.maps.internal.location
 
 import android.animation.TimeInterpolator
 import android.animation.TypeEvaluator
-import android.animation.ValueAnimator
 import com.mapbox.geojson.Point
 
 /**
  * A time and value interpolator for puck's animator. It uses [ConstantVelocityInterpolator] to
  * animate at constant velocity between key points.
- *
- * Use [PuckAnimationEvaluator.installIn] to install it in [ValueAnimator].
- * Use [PuckAnimationEvaluator.reset] to reset TimeInterpolator values for re-use with
- * next ValueAnimator.
  */
-internal class PuckAnimationEvaluator(
+internal class PuckAnimationEvaluatorInterpolator(
     private val keyPoints: Array<Point>,
 ) : TimeInterpolator, TypeEvaluator<Point> {
 
@@ -30,22 +25,6 @@ internal class PuckAnimationEvaluator(
         return POINT.evaluate(fraction, startValue, endValue)
     }
 
-    /**
-     * Reset TimeInterpolator values for re-use with next ValueAnimator.
-     */
-    fun reset() {
-        interpolator = null
-    }
-
-    /**
-     * Set this evaluator as [animator] TimeInterpolator and TypeEvaluator.
-     */
-    fun installIn(animator: ValueAnimator) {
-        reset()
-        animator.interpolator = this
-        animator.setEvaluator(this)
-    }
-
     companion object {
         private val POINT = TypeEvaluator<Point> { fraction, startValue, endValue ->
             Point.fromLngLat(

ui-maps/src/main/java/com/mapbox/navigation/ui/maps/location/NavigationLocationProvider.kt

@@ -11,7 +11,7 @@ import com.mapbox.maps.plugin.locationcomponent.LocationProvider
 import com.mapbox.maps.plugin.locationcomponent.OnIndicatorPositionChangedListener
 import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.core.trip.session.LocationObserver
-import com.mapbox.navigation.ui.maps.internal.location.PuckAnimationEvaluator
+import com.mapbox.navigation.ui.maps.internal.location.PuckAnimationEvaluatorInterpolator
 import com.mapbox.navigation.utils.internal.ifNonNull
 import java.util.concurrent.CopyOnWriteArraySet
 
@@ -158,25 +158,26 @@ class NavigationLocationProvider : LocationProvider {
             listOf(location.bearing)
         }.filterNotNull().toDoubleArray()
 
+        val puckAnimationEvaluatorInterpolator = PuckAnimationEvaluatorInterpolator(latLngUpdates)
         this.onLocationUpdated(
             location = latLngUpdates,
-            options = locationAnimatorOptions(latLngUpdates, latLngTransitionOptions),
+            options = {
+                this.duration = LocationComponentConstants.DEFAULT_INTERVAL_MILLIS
+                this.interpolator = puckAnimationEvaluatorInterpolator
+                this.setEvaluator(puckAnimationEvaluatorInterpolator)
+                latLngTransitionOptions?.also { this.apply(it) }
+            },
         )
         if (bearingUpdates.isNotEmpty()) {
-            this.onBearingUpdated(bearing = bearingUpdates, options = bearingTransitionOptions)
-        }
-    }
-
-    private fun locationAnimatorOptions(
-        keyPoints: Array<Point>,
-        clientOptions: (ValueAnimator.() -> Unit)?,
-    ): (ValueAnimator.() -> Unit) {
-        val evaluator = PuckAnimationEvaluator(keyPoints)
-        return {
-            // TODO: Remove setDuration once patched in MapsSDK https://github.com/mapbox/mapbox-maps-android/issues/1446
-            duration = LocationComponentConstants.DEFAULT_INTERVAL_MILLIS
-            evaluator.installIn(this)
-            clientOptions?.also { apply(it) }
+            this.onBearingUpdated(
+                bearing = bearingUpdates,
+                options = {
+                    // keeping animation frames in sync between bearing and position animation
+                    this.interpolator = puckAnimationEvaluatorInterpolator
+                    this.duration = LocationComponentConstants.DEFAULT_INTERVAL_MILLIS
+                    bearingTransitionOptions?.also { this.apply(it) }
+                },
+            )
         }
     }
 }

ui-maps/src/test/java/com/mapbox/navigation/ui/maps/internal/location/ConstantVelocityInterpolatorTest.kt

@@ -29,22 +29,38 @@ class ConstantVelocityInterpolatorTest {
         }
     }
 
+    /**
+     * [android.animation.ValueAnimator] allocates equal time for each value transition, consider
+     * default animation timeline:
+     *   |----------------|----------------|----------------|          // animation progress from 0.0 to 1.0
+     * 0.0, 0.1        0.5, 0.5          0.5, 0.5          1.0, 1.0   // location value
+     * 1/3 of the animation time, location will be 0.5 in that case.
+     * Desired timeline for constant velocity in that case is:
+     *   |------------------------|-------------------------|
+     * 0.0, 0.1                0.5, 0.5                 1.0, 1.0
+     * I.e. when animation completed on 25%, location should be (0.25, 0.25) as on the
+     * timeline bellow instead of (0.5, 0.5) as on the timeline above.
+     *
+     * To achieve desired animation timeline, we need to interpolate(remap) animation progress from:
+     * 0.25 to 1/(3*2)
+     * 0.499 (i.e. ~ 1/2) to 0.32 (i.e. ~1/3)
+     * etc
+     * so that it pointed to the right location on the top timeline.
+     */
     @Test
-    fun `should not use keypoints that are at ZERO distance from previous point`() {
+    fun `0 distance key points interpolated to happen immediate`() {
         val p0 = Point.fromLngLat(0.0, 0.0)
         val keyPoints = arrayOf(
             Point.fromLngLat(0.5, 0.5),
             Point.fromLngLat(0.5, 0.5),
             Point.fromLngLat(1.0, 1.0),
         )
-
         val sut = ConstantVelocityInterpolator(p0, keyPoints)
 
-        val path = calculatePathValues(p0, *keyPoints)
-        assertEquals(keyPoints.size - 1, path.size)
-        path.forEach { (outTime, inTime) ->
-            assertEquals(outTime, sut.getInterpolation(inTime))
-        }
+        assertEquals(0.166f, sut.getInterpolation(0.25f), 0.001f)
+        assertEquals(0.329f, sut.getInterpolation(0.499f), 0.01f)
+        assertEquals(0.667f, sut.getInterpolation(0.501f), 0.01f)
+        assertEquals(0.833f, sut.getInterpolation(0.75f), 0.01f)
     }
 
     @Test
@@ -100,10 +116,8 @@ class ConstantVelocityInterpolatorTest {
         var totalDistance = 0.0
         points.fold(p0) { a, b ->
             val d = distance(a, b)
-            if (0 < d) {
-                distances.add(d)
-                totalDistance += d
-            }
+            distances.add(d)
+            totalDistance += d
             b
         }
 

ui-maps/src/test/java/com/mapbox/navigation/ui/maps/location/NavigationLocationProviderTest.kt

@@ -77,7 +77,7 @@ class NavigationLocationProviderTest {
         verify(exactly = 1) { consumer.onLocationUpdated(*expectedPoints, options = any()) }
         val expectedBearings = doubleArrayOf(location.bearing!!)
         verify(exactly = 1) {
-            consumer.onBearingUpdated(*expectedBearings, options = bearingOptions)
+            consumer.onBearingUpdated(*expectedBearings, options = any())
         }
     }
 
@@ -141,7 +141,7 @@ class NavigationLocationProviderTest {
             location.bearing!!,
         )
         verify(exactly = 1) {
-            consumer.onBearingUpdated(*expectedBearings, options = bearingOptions)
+            consumer.onBearingUpdated(*expectedBearings, options = any())
         }
     }
 
@@ -169,6 +169,7 @@ class NavigationLocationProviderTest {
         }
         val bearingAnimator: ValueAnimator = mockk {
             every { setDuration(any()) } returns this
+            every { setInterpolator(any()) } returns Unit
         }
         every { consumer.onBearingUpdated(*anyDoubleVararg(), options = captureLambda()) } answers {
             lambda<(ValueAnimator.() -> Unit)>().captured.invoke(bearingAnimator)