add option to hide or show alternative routes (#6100)

Author: Zayankovsky

libnavui-androidauto/CHANGELOG.md

@@ -5,6 +5,7 @@ Mapbox welcomes participation and contributions from everyone.
 ## Unreleased
 #### Features
 #### Bug fixes and improvements
+- Added an option to hide or show alternative routes during route preview and active guidance. [#6100](https://github.com/mapbox/mapbox-navigation-android/pull/6100)
 
 ## androidauto-v0.5.0 - Jul 22, 2022
 ### Changelog

libnavui-androidauto/src/main/java/com/mapbox/androidauto/car/MainCarContext.kt

@@ -14,6 +14,7 @@ import com.mapbox.search.SearchEngine
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.flow.MutableStateFlow
 
 @OptIn(MapboxExperimental::class)
 class MainCarContext(
@@ -37,6 +38,8 @@ class MainCarContext(
         MapboxManeuverApi(distanceFormatter)
     }
 
+    val routeAlternativesEnabled = MutableStateFlow(value = true)
+
     fun getJobControl(): JobControl {
         val supervisorJob = SupervisorJob()
         val scope = CoroutineScope(supervisorJob + Dispatchers.Main)

libnavui-androidauto/src/main/java/com/mapbox/androidauto/car/navigation/speedlimit/CarSpeedLimitRenderer.kt

@@ -65,6 +65,7 @@ class CarSpeedLimitRenderer(
         logAndroidAuto("CarSpeedLimitRenderer carMapSurface detached")
         mainCarContext.mapboxNavigation.unregisterLocationObserver(locationObserver)
         speedLimitWidget?.let { mapboxCarMapSurface.mapSurface.removeWidget(it) }
+        speedLimitWidget = null
     }
 
     override fun onVisibleAreaChanged(visibleArea: Rect, edgeInsets: EdgeInsets) {

libnavui-androidauto/src/main/java/com/mapbox/androidauto/car/preview/CarRouteLine.kt

@@ -3,6 +3,7 @@ package com.mapbox.androidauto.car.preview
 import com.mapbox.androidauto.car.MainCarContext
 import com.mapbox.androidauto.car.internal.extensions.getStyle
 import com.mapbox.androidauto.car.internal.extensions.handleStyleOnAttached
+import com.mapbox.androidauto.car.internal.extensions.handleStyleOnDetached
 import com.mapbox.androidauto.car.routes.NavigationRoutesProvider
 import com.mapbox.androidauto.car.routes.RoutesListener
 import com.mapbox.androidauto.car.routes.RoutesProvider
@@ -25,6 +26,12 @@ import com.mapbox.navigation.ui.maps.route.line.model.MapboxRouteLineOptions
 import com.mapbox.navigation.ui.maps.route.line.model.NavigationRouteLine
 import com.mapbox.navigation.ui.maps.route.line.model.RouteLineColorResources
 import com.mapbox.navigation.ui.maps.route.line.model.RouteLineResources
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.MainScope
+import kotlinx.coroutines.cancel
+import kotlinx.coroutines.cancelChildren
+import kotlinx.coroutines.flow.collect
+import kotlinx.coroutines.launch
 
 /**
  * This class is to simplify the interaction with [MapboxRouteLineApi], [MapboxRouteArrowView]
@@ -53,6 +60,8 @@ class CarRouteLine internal constructor(
     private lateinit var routeArrowApi: MapboxRouteArrowApi
     private lateinit var routeArrowView: MapboxRouteArrowView
 
+    private var styleScope: CoroutineScope? = null
+
     private val onPositionChangedListener = OnIndicatorPositionChangedListener { point ->
         val result = routeLineApi.updateTraveledRouteLine(point)
         mainCarContext.mapboxCarMap.carMapSurface?.getStyle()?.let {
@@ -98,6 +107,7 @@ class CarRouteLine internal constructor(
     override fun onAttached(mapboxCarMapSurface: MapboxCarMapSurface) {
         logAndroidAuto("CarRouteLine carMapSurface loaded $mapboxCarMapSurface")
         val locationPlugin = mapboxCarMapSurface.mapSurface.location
+        val scope = MainScope().also { styleScope = it }
         styleLoadedListener = mapboxCarMapSurface.handleStyleOnAttached { style ->
             val routeLineOptions = getMapboxRouteLineOptions(style)
             routeLineView = MapboxRouteLineView(routeLineOptions)
@@ -114,15 +124,29 @@ class CarRouteLine internal constructor(
             locationPlugin.addOnIndicatorPositionChangedListener(onPositionChangedListener)
             mainCarContext.mapboxNavigation.registerRouteProgressObserver(routeProgressObserver)
             routesProvider.registerRoutesListener(routesListener)
+
+            scope.coroutineContext.cancelChildren()
+            scope.launch {
+                mainCarContext.routeAlternativesEnabled.collect { enabled ->
+                    if (enabled) {
+                        routeLineView.showAlternativeRoutes(style)
+                    } else {
+                        routeLineView.hideAlternativeRoutes(style)
+                    }
+                }
+            }
         }
     }
 
     override fun onDetached(mapboxCarMapSurface: MapboxCarMapSurface) {
         logAndroidAuto("CarRouteLine carMapSurface detached $mapboxCarMapSurface")
         val mapSurface = mapboxCarMapSurface.mapSurface
+        mapboxCarMapSurface.handleStyleOnDetached(styleLoadedListener)
         mapSurface.location.removeOnIndicatorPositionChangedListener(onPositionChangedListener)
         mainCarContext.mapboxNavigation.unregisterRouteProgressObserver(routeProgressObserver)
         routesProvider.unregisterRoutesListener(routesListener)
+        styleScope?.cancel()
+        styleScope = null
     }
 
     private fun getMapboxRouteLineOptions(style: Style): MapboxRouteLineOptions {

libnavui-androidauto/src/main/java/com/mapbox/androidauto/car/routes/NavigationRoutesProvider.kt

@@ -18,7 +18,7 @@ internal class NavigationRoutesProvider(private val mapboxNavigation: MapboxNavi
     private data class RoutesObserverAdapter(val listener: RoutesListener) : RoutesObserver {
 
         override fun onRoutesChanged(result: RoutesUpdatedResult) {
-            listener.onRoutesChanged(result.navigationRoutes.take(1))
+            listener.onRoutesChanged(result.navigationRoutes)
         }
     }
 }