Using regular puck for IDLE and OVERVIEW camera mode. LocationPuckOptions navigation state pucks for the FOLLOWING mode.

Author: tomaszrybakiewicz

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/internal/extensions/NavigationViewContextEx.kt

@@ -7,6 +7,7 @@ import androidx.activity.ComponentActivity
 import androidx.annotation.Px
 import androidx.constraintlayout.widget.Guideline
 import com.mapbox.maps.MapView
+import com.mapbox.maps.plugin.locationcomponent.location
 import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
 import com.mapbox.navigation.dropin.EmptyBinder
@@ -35,8 +36,12 @@ import com.mapbox.navigation.dropin.roadname.RoadNameCoordinator
 import com.mapbox.navigation.dropin.speedlimit.SpeedLimitCoordinator
 import com.mapbox.navigation.dropin.tripprogress.TripProgressBinder
 import com.mapbox.navigation.dropin.tripsession.TripSessionComponent
+import com.mapbox.navigation.ui.app.internal.camera.TargetCameraMode
+import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
 import com.mapbox.navigation.ui.maps.internal.ui.BuildingHighlightComponent
+import com.mapbox.navigation.ui.maps.internal.ui.LocationPuckComponent
 import kotlinx.coroutines.flow.combine
+import kotlinx.coroutines.flow.distinctUntilChanged
 
 internal fun NavigationViewContext.poiNameComponent(
     viewGroup: ViewGroup
@@ -219,6 +224,32 @@ internal fun NavigationViewContext.buildingHighlightComponent(
         }
     }
 
+internal fun NavigationViewContext.locationPuckComponent(
+    mapView: MapView
+): MapboxNavigationObserver {
+    val puckFlow = combine(
+        store.select { it.navigation },
+        store.select { it.camera.cameraMode },
+        styles.locationPuckOptions
+    ) { navigationState, cameraMode, options ->
+        if (cameraMode == TargetCameraMode.Following) {
+            when (navigationState) {
+                NavigationState.FreeDrive -> options.freeDrivePuck
+                NavigationState.DestinationPreview -> options.destinationPreviewPuck
+                NavigationState.RoutePreview -> options.routePreviewPuck
+                NavigationState.ActiveNavigation -> options.activeNavigationPuck
+                NavigationState.Arrival -> options.arrivalPuck
+            }
+        } else {
+            options.idlePuck
+        }
+    }.distinctUntilChanged()
+
+    return reloadOnChange(puckFlow) { puck ->
+        LocationPuckComponent(mapView.location, puck, locationProvider)
+    }
+}
+
 internal fun NavigationViewContext.analyticsComponent() =
     AnalyticsComponent()
 

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/map/MapViewBinder.kt

@@ -3,14 +3,13 @@ package com.mapbox.navigation.dropin.map
 import android.content.Context
 import android.view.ViewGroup
 import com.mapbox.maps.MapView
-import com.mapbox.maps.plugin.locationcomponent.LocationComponentPlugin
-import com.mapbox.maps.plugin.locationcomponent.location
 import com.mapbox.navigation.core.internal.extensions.navigationListOf
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
 import com.mapbox.navigation.dropin.camera.CameraComponent
 import com.mapbox.navigation.dropin.camera.CameraLayoutObserver
 import com.mapbox.navigation.dropin.databinding.MapboxNavigationViewLayoutBinding
 import com.mapbox.navigation.dropin.internal.extensions.buildingHighlightComponent
+import com.mapbox.navigation.dropin.internal.extensions.locationPuckComponent
 import com.mapbox.navigation.dropin.internal.extensions.reloadOnChange
 import com.mapbox.navigation.dropin.map.geocoding.GeocodingComponent
 import com.mapbox.navigation.dropin.map.logo.LogoAttributionComponent
@@ -22,11 +21,8 @@ import com.mapbox.navigation.dropin.navigationview.NavigationViewContext
 import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
 import com.mapbox.navigation.ui.base.lifecycle.UIBinder
 import com.mapbox.navigation.ui.maps.internal.ui.LocationComponent
-import com.mapbox.navigation.ui.maps.internal.ui.LocationPuckComponent
 import com.mapbox.navigation.ui.maps.internal.ui.RouteArrowComponent
 import com.mapbox.navigation.ui.maps.internal.ui.RouteLineComponent
-import com.mapbox.navigation.ui.maps.location.NavigationLocationProvider
-import com.mapbox.navigation.ui.maps.puck.LocationPuckOptions
 import com.mapbox.navigation.ui.maps.route.arrow.model.RouteArrowOptions
 import com.mapbox.navigation.ui.maps.route.line.model.MapboxRouteLineOptions
 
@@ -73,17 +69,7 @@ abstract class MapViewBinder : UIBinder {
         return navigationListOf(
             CameraLayoutObserver(store, mapView, navigationViewBinding),
             LocationComponent(context.locationProvider),
-            reloadOnChange(
-                navigationState,
-                context.styles.locationPuckOptions
-            ) { navState, _ ->
-                locationPuckComponent(
-                    navState,
-                    mapView.location,
-                    context.locationProvider,
-                    context.styles.locationPuckOptions.value
-                )
-            },
+            context.locationPuckComponent(mapView),
             LogoAttributionComponent(mapView, context.systemBarsInsets),
             reloadOnChange(
                 context.mapStyleLoader.loadedMapStyle,
@@ -125,51 +111,6 @@ abstract class MapViewBinder : UIBinder {
             RouteLineComponentContractImpl(context.store, context.mapClickBehavior)
         })
 
-    private fun locationPuckComponent(
-        navigationState: NavigationState,
-        location: LocationComponentPlugin,
-        provider: NavigationLocationProvider,
-        options: LocationPuckOptions
-    ): LocationPuckComponent {
-        return when (navigationState) {
-            NavigationState.FreeDrive -> {
-                LocationPuckComponent(
-                    location,
-                    options.freeDrivePuck,
-                    provider,
-                )
-            }
-            NavigationState.DestinationPreview -> {
-                LocationPuckComponent(
-                    location,
-                    options.destinationPreviewPuck,
-                    provider,
-                )
-            }
-            NavigationState.RoutePreview -> {
-                LocationPuckComponent(
-                    location,
-                    options.routePreviewPuck,
-                    provider,
-                )
-            }
-            NavigationState.ActiveNavigation -> {
-                LocationPuckComponent(
-                    location,
-                    options.activeNavigationPuck,
-                    provider,
-                )
-            }
-            NavigationState.Arrival -> {
-                LocationPuckComponent(
-                    location,
-                    options.arrivalPuck,
-                    provider,
-                )
-            }
-        }
-    }
-
     private fun longPressMapComponent(navigationState: NavigationState, mapView: MapView) =
         when (navigationState) {
             NavigationState.FreeDrive,

libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/map/MapViewBinderTest.kt

@@ -36,6 +36,7 @@ import com.mapbox.navigation.dropin.util.TestStore
 import com.mapbox.navigation.dropin.util.TestingUtil.findComponent
 import com.mapbox.navigation.testing.LoggingFrontendTestRule
 import com.mapbox.navigation.testing.MainCoroutineRule
+import com.mapbox.navigation.ui.app.internal.camera.TargetCameraMode
 import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
 import com.mapbox.navigation.ui.maps.building.model.MapboxBuildingHighlightOptions
 import com.mapbox.navigation.ui.maps.internal.ui.BuildingHighlightComponent
@@ -165,7 +166,7 @@ class MapViewBinderTest {
         navContext.applyStyleCustomization {
             locationPuckOptions = LocationPuckOptions
                 .Builder(ctx)
-                .freeDrivePuck(
+                .defaultPuck(
                     LocationPuck2D(
                         bearingImage = ctx.getDrawable(android.R.drawable.arrow_down_float)
                     )
@@ -180,7 +181,24 @@ class MapViewBinderTest {
     }
 
     @Test
-    fun `bind should reload LocationPuckComponent on navigation state change`() {
+    @Suppress("MaxLineLength")
+    fun `bind should reload LocationPuckComponent on navigation state change when camera mode is Following`() {
+        store.updateState {
+            it.copy(
+                navigation = NavigationState.DestinationPreview,
+                camera = it.camera.copy(cameraMode = TargetCameraMode.Following)
+            )
+        }
+        navContext.applyStyleCustomization {
+            locationPuckOptions = LocationPuckOptions
+                .Builder(ctx)
+                .routePreviewPuck(
+                    LocationPuck2D(
+                        bearingImage = ctx.getDrawable(android.R.drawable.arrow_down_float)
+                    )
+                )
+                .build()
+        }
         val components = sut.bind(FrameLayout(ctx))
         components.onAttached(mapboxNavigation)
 
@@ -193,6 +211,23 @@ class MapViewBinderTest {
         assertNotEquals(secondComponent, firstComponent)
     }
 
+    @Test
+    fun `bind should reload LocationPuckComponent on camera mode change`() {
+        store.updateState { it.copy(camera = it.camera.copy(cameraMode = TargetCameraMode.Idle)) }
+        val components = sut.bind(FrameLayout(ctx))
+        components.onAttached(mapboxNavigation)
+
+        val firstComponent = components.findComponent { it is LocationPuckComponent }
+        store.updateState {
+            it.copy(camera = it.camera.copy(cameraMode = TargetCameraMode.Following))
+        }
+        val secondComponent = components.findComponent { it is LocationPuckComponent }
+
+        assertNotNull(firstComponent)
+        assertNotNull(secondComponent)
+        assertNotEquals(secondComponent, firstComponent)
+    }
+
     @Test
     fun `bind should return and bind LogoAttributionComponent`() {
         val components = sut.bind(FrameLayout(ctx))

libnavui-maps/api/current.txt

@@ -747,13 +747,15 @@ package com.mapbox.navigation.ui.maps.puck {
     method public android.content.Context getContext();
     method public com.mapbox.maps.plugin.LocationPuck getDestinationPreviewPuck();
     method public com.mapbox.maps.plugin.LocationPuck getFreeDrivePuck();
+    method public com.mapbox.maps.plugin.LocationPuck getIdlePuck();
     method public com.mapbox.maps.plugin.LocationPuck getRoutePreviewPuck();
     method public com.mapbox.navigation.ui.maps.puck.LocationPuckOptions.Builder toBuilder();
     property public final com.mapbox.maps.plugin.LocationPuck activeNavigationPuck;
     property public final com.mapbox.maps.plugin.LocationPuck arrivalPuck;
     property public final android.content.Context context;
     property public final com.mapbox.maps.plugin.LocationPuck destinationPreviewPuck;
     property public final com.mapbox.maps.plugin.LocationPuck freeDrivePuck;
+    property public final com.mapbox.maps.plugin.LocationPuck idlePuck;
     property public final com.mapbox.maps.plugin.LocationPuck routePreviewPuck;
   }
 
@@ -765,6 +767,7 @@ package com.mapbox.navigation.ui.maps.puck {
     method public com.mapbox.navigation.ui.maps.puck.LocationPuckOptions.Builder defaultPuck(com.mapbox.maps.plugin.LocationPuck defaultPuck);
     method public com.mapbox.navigation.ui.maps.puck.LocationPuckOptions.Builder destinationPreviewPuck(com.mapbox.maps.plugin.LocationPuck destinationPreviewPuck);
     method public com.mapbox.navigation.ui.maps.puck.LocationPuckOptions.Builder freeDrivePuck(com.mapbox.maps.plugin.LocationPuck freeDrivePuck);
+    method public com.mapbox.navigation.ui.maps.puck.LocationPuckOptions.Builder idlePuck(com.mapbox.maps.plugin.LocationPuck idlePuck);
     method public com.mapbox.navigation.ui.maps.puck.LocationPuckOptions.Builder routePreviewPuck(com.mapbox.maps.plugin.LocationPuck routePreviewPuck);
     field public static final com.mapbox.navigation.ui.maps.puck.LocationPuckOptions.Builder.Companion Companion;
   }