[Drop-In UI] NAVAND-634: introduce compass (#6395)

Author: dzinad

CHANGELOG.md

@@ -13,6 +13,8 @@ Mapbox welcomes participation and contributions from everyone.
 - Fixed an issue with restricted road visualization on the route line that occurred during route refreshes. [#6399](https://github.com/mapbox/mapbox-navigation-android/pull/6399)
 - Improved precision of restricted sections visualization, especially for long routes. [#6399](https://github.com/mapbox/mapbox-navigation-android/pull/6399)
 - Fixed a rare issue where alternative route would not be vanished until deviation point for `MapboxRouteLineApi#setNavigationRoutes(routes, metadata)` when the route's geometry contained duplicate points. [#6399](https://github.com/mapbox/mapbox-navigation-android/pull/6399)
+- Introduced `ViewStyleCutomization.compassButtonParams` property to configure compass. [#6395](https://github.com/mapbox/mapbox-navigation-android/pull/6395)
+- Introduced `MapboxExtendableButtonParams.enabled` property to enable/disable a button. [#6395](https://github.com/mapbox/mapbox-navigation-android/pull/6395)
 
 ## Mapbox Navigation SDK 2.9.0-alpha.4 - 30 September, 2022
 ### Changelog

libnavui-dropin/api/current.txt

@@ -7,9 +7,12 @@ package com.mapbox.navigation.dropin {
   }
 
   public final class MapboxExtendableButtonParams {
+    ctor public MapboxExtendableButtonParams(@StyleRes int style, android.widget.LinearLayout.LayoutParams layoutParams, boolean enabled = true);
     ctor public MapboxExtendableButtonParams(@StyleRes int style, android.widget.LinearLayout.LayoutParams layoutParams);
+    method public boolean getEnabled();
     method public android.widget.LinearLayout.LayoutParams getLayoutParams();
     method public int getStyle();
+    property public final boolean enabled;
     property public final android.widget.LinearLayout.LayoutParams layoutParams;
     property public final int style;
   }
@@ -168,6 +171,7 @@ package com.mapbox.navigation.dropin {
     method public Integer? getArrivalTextAppearance();
     method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams? getAudioGuidanceButtonParams();
     method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams? getCameraModeButtonParams();
+    method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams? getCompassButtonParams();
     method public com.mapbox.maps.plugin.annotation.generated.PointAnnotationOptions? getDestinationMarkerAnnotationOptions();
     method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams? getEndNavigationButtonParams();
     method public Integer? getInfoPanelBackground();
@@ -189,6 +193,7 @@ package com.mapbox.navigation.dropin {
     method public void setArrivalTextAppearance(Integer?);
     method public void setAudioGuidanceButtonParams(com.mapbox.navigation.dropin.MapboxExtendableButtonParams?);
     method public void setCameraModeButtonParams(com.mapbox.navigation.dropin.MapboxExtendableButtonParams?);
+    method public void setCompassButtonParams(com.mapbox.navigation.dropin.MapboxExtendableButtonParams?);
     method public void setDestinationMarkerAnnotationOptions(com.mapbox.maps.plugin.annotation.generated.PointAnnotationOptions?);
     method public void setEndNavigationButtonParams(com.mapbox.navigation.dropin.MapboxExtendableButtonParams?);
     method public void setInfoPanelBackground(Integer?);
@@ -210,6 +215,7 @@ package com.mapbox.navigation.dropin {
     property public final Integer? arrivalTextAppearance;
     property public final com.mapbox.navigation.dropin.MapboxExtendableButtonParams? audioGuidanceButtonParams;
     property public final com.mapbox.navigation.dropin.MapboxExtendableButtonParams? cameraModeButtonParams;
+    property public final com.mapbox.navigation.dropin.MapboxExtendableButtonParams? compassButtonParams;
     property public final com.mapbox.maps.plugin.annotation.generated.PointAnnotationOptions? destinationMarkerAnnotationOptions;
     property public final com.mapbox.navigation.dropin.MapboxExtendableButtonParams? endNavigationButtonParams;
     property public final Integer? infoPanelBackground;
@@ -235,6 +241,7 @@ package com.mapbox.navigation.dropin {
     method @StyleRes public int defaultArrivalTextAppearance();
     method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams defaultAudioGuidanceButtonParams(android.content.Context context);
     method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams defaultCameraModeButtonParams(android.content.Context context);
+    method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams defaultCompassButtonParams(android.content.Context context);
     method public com.mapbox.maps.plugin.annotation.generated.PointAnnotationOptions defaultDestinationMarkerAnnotationOptions(android.content.Context context);
     method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams defaultEndNavigationButtonParams(android.content.Context context);
     method @DrawableRes public int defaultInfoPanelBackground();

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

@@ -8,12 +8,15 @@ import androidx.annotation.StyleRes
  *
  * @param style style res of a button.
  * @param layoutParams layout params of a button.
+ * @param enabled `true` if the button should be enabled, `false` otherwise
  */
-class MapboxExtendableButtonParams(
+class MapboxExtendableButtonParams @JvmOverloads constructor(
     @StyleRes
     val style: Int,
     val layoutParams: LinearLayout.LayoutParams,
+    val enabled: Boolean = true
 ) {
+
     /**
      * Regenerate whenever a change is made
      */
@@ -25,6 +28,7 @@ class MapboxExtendableButtonParams(
 
         if (style != other.style) return false
         if (layoutParams != other.layoutParams) return false
+        if (enabled != other.enabled) return false
 
         return true
     }
@@ -35,6 +39,7 @@ class MapboxExtendableButtonParams(
     override fun hashCode(): Int {
         var result = style
         result = 31 * result + layoutParams.hashCode()
+        result = 31 * result + enabled.hashCode()
         return result
     }
 
@@ -44,7 +49,8 @@ class MapboxExtendableButtonParams(
     override fun toString(): String {
         return "MapboxExtendableButtonParams(" +
             "style=$style, " +
-            "layoutParams=$layoutParams" +
+            "layoutParams=$layoutParams, " +
+            "enabled=$enabled" +
             ")"
     }
 }

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

@@ -179,6 +179,12 @@ class ViewStyleCustomization {
      */
     var mapScalebarParams: MapboxMapScalebarParams? = null
 
+    /**
+     * Map compass params.
+     * Use [defaultCompassButtonParams] to reset to default.
+     */
+    var compassButtonParams: MapboxExtendableButtonParams? = null
+
     companion object {
         /**
          * Default info panel peek height in pixels.
@@ -392,6 +398,19 @@ class ViewStyleCustomization {
         fun defaultMapScalebarParams(context: Context): MapboxMapScalebarParams =
             MapboxMapScalebarParams.Builder(context).build()
 
+        /**
+         * Default map compass [MapboxExtendableButtonParams] parameters.
+         */
+        fun defaultCompassButtonParams(context: Context): MapboxExtendableButtonParams =
+            MapboxExtendableButtonParams(
+                R.style.DropInStyleCompassButton,
+                context.defaultLayoutParams().apply {
+                    topMargin = context.defaultSpacing()
+                    bottomMargin = context.defaultSpacing()
+                },
+                false
+            )
+
         private fun Context.defaultSpacing() =
             resources.getDimensionPixelSize(R.dimen.mapbox_actionList_spacing)
 

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/actionbutton/ActionButtonBinder.kt

@@ -7,6 +7,7 @@ import android.view.View
 import android.view.ViewGroup
 import android.widget.LinearLayout
 import androidx.lifecycle.viewModelScope
+import com.mapbox.maps.MapView
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.internal.extensions.navigationListOf
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
@@ -23,6 +24,7 @@ import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
 import com.mapbox.navigation.ui.base.lifecycle.UIBinder
 import com.mapbox.navigation.ui.base.view.MapboxExtendableButton
 import com.mapbox.navigation.ui.maps.internal.ui.CameraModeButtonComponent
+import com.mapbox.navigation.ui.maps.internal.ui.CompassButtonComponent
 import com.mapbox.navigation.ui.maps.internal.ui.RecenterButtonComponent
 import com.mapbox.navigation.ui.maps.view.MapboxCameraModeButton
 import com.mapbox.navigation.ui.voice.internal.ui.AudioComponentContract
@@ -37,6 +39,7 @@ internal class ActionButtonBinder(
     private val customButtons: List<ActionButtonDescription>
 ) : UIBinder {
 
+    private var compassButton: MapboxExtendableButton? = null
     private var audioButton: MapboxAudioGuidanceButton? = null
     private var recenterButton: MapboxExtendableButton? = null
     private var cameraButton: MapboxCameraModeButton? = null
@@ -49,6 +52,12 @@ internal class ActionButtonBinder(
 
         val store = context.store
         return navigationListOf(
+            reloadOnChange(
+                context.styles.compassButtonParams,
+                context.mapViewOwner.mapViews
+            ) { params, mapView ->
+                compassButtonComponent(binding, params, mapView)
+            },
             reloadOnChange(context.styles.cameraModeButtonParams) { params ->
                 cameraModeButtonComponent(binding, params, store)
             },
@@ -84,6 +93,22 @@ internal class ActionButtonBinder(
             .forEach { it.view.setMargins(top = spacing, bottom = spacing) }
     }
 
+    private fun compassButtonComponent(
+        binding: MapboxActionButtonsLayoutBinding,
+        customParams: MapboxExtendableButtonParams,
+        mapView: MapView?
+    ): CompassButtonComponent {
+        compassButton.recreate(
+            ::MapboxExtendableButton,
+            customParams,
+            binding.buttonContainer,
+            COMPASS_BUTTON_POSITION
+        ).let {
+            compassButton = it
+            return CompassButtonComponent(it, mapView, customParams.enabled)
+        }
+    }
+
     private fun audioGuidanceButtonComponent(
         binding: MapboxActionButtonsLayoutBinding,
         customParams: MapboxExtendableButtonParams,
@@ -165,9 +190,10 @@ internal class ActionButtonBinder(
     }
 
     private companion object {
-        private const val AUDIO_BUTTON_POSITION = 1
-        private const val CAMERA_BUTTON_POSITION = 0
-        private const val RECENTER_BUTTON_POSITION = 2
+        private const val COMPASS_BUTTON_POSITION = 0
+        private const val CAMERA_BUTTON_POSITION = 1
+        private const val AUDIO_BUTTON_POSITION = 2
+        private const val RECENTER_BUTTON_POSITION = 3
     }
 }
 

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

@@ -2,13 +2,21 @@ package com.mapbox.navigation.dropin.map
 
 import com.mapbox.maps.MapView
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.asStateFlow
 import java.util.concurrent.CopyOnWriteArraySet
 
 @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
 internal class MapViewOwner {
 
     private var mapView: MapView? = null
+        set(value) {
+            field = value
+            _mapViews.value = value
+        }
     private val listeners = CopyOnWriteArraySet<MapViewObserver>()
+    private val _mapViews = MutableStateFlow(mapView)
+    val mapViews = _mapViews.asStateFlow()
 
     fun registerObserver(observer: MapViewObserver) {
         if (listeners.add(observer)) {

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/navigationview/NavigationViewStyles.kt

@@ -58,6 +58,8 @@ internal class NavigationViewStyles(context: Context) {
     private val _mapScalebarParams: MutableStateFlow<MapboxMapScalebarParams> = MutableStateFlow(
         ViewStyleCustomization.defaultMapScalebarParams(context)
     )
+    private val _compassButtonParams: MutableStateFlow<MapboxExtendableButtonParams> =
+        MutableStateFlow(ViewStyleCustomization.defaultCompassButtonParams(context))
 
     val infoPanelPeekHeight: StateFlow<Int> = _infoPanelPeekHeight.asStateFlow()
     val infoPanelMarginStart: StateFlow<Int> = _infoPanelMarginStart.asStateFlow()
@@ -87,6 +89,8 @@ internal class NavigationViewStyles(context: Context) {
     val arrivalTextAppearance: StateFlow<Int> = _arrivalTextAppearance.asStateFlow()
     val locationPuck: StateFlow<LocationPuck> = _locationPuck.asStateFlow()
     val mapScalebarParams: StateFlow<MapboxMapScalebarParams> = _mapScalebarParams.asStateFlow()
+    val compassButtonParams: StateFlow<MapboxExtendableButtonParams> =
+        _compassButtonParams.asStateFlow()
 
     fun applyCustomization(customization: ViewStyleCustomization) {
         customization.infoPanelPeekHeight?.also { _infoPanelPeekHeight.value = it }
@@ -112,5 +116,6 @@ internal class NavigationViewStyles(context: Context) {
         customization.arrivalTextAppearance?.also { _arrivalTextAppearance.value = it }
         customization.locationPuck?.also { _locationPuck.value = it }
         customization.mapScalebarParams?.also { _mapScalebarParams.value = it }
+        customization.compassButtonParams?.also { _compassButtonParams.value = it }
     }
 }

libnavui-dropin/src/main/res/values/styles.xml

@@ -150,4 +150,9 @@
         <item name="extendableButtonIcon">@drawable/mapbox_ic_camera_recenter</item>
     </style>
 
+    <!-- Compass button -->
+    <style name="DropInStyleCompassButton" parent="MapboxStyleExtendableButton">
+        <item name="extendableButtonIcon">@drawable/mapbox_ic_compass</item>
+    </style>
+
 </resources>

libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/actionbutton/ActionButtonBinderTest.kt

@@ -12,7 +12,6 @@ import com.mapbox.navigation.dropin.databinding.MapboxActionButtonsLayoutBinding
 import com.mapbox.navigation.dropin.navigationview.NavigationViewContext
 import com.mapbox.navigation.dropin.navigationview.NavigationViewStyles
 import com.mapbox.navigation.dropin.util.TestStore
-import io.mockk.MockKAnnotations
 import io.mockk.every
 import io.mockk.mockk
 import kotlinx.coroutines.MainScope
@@ -33,11 +32,10 @@ internal class ActionButtonBinderTest {
 
     @Before
     fun setUp() {
-        MockKAnnotations.init(this, relaxUnitFun = true)
         ctx = ApplicationProvider.getApplicationContext()
         viewGroup = FrameLayout(ctx)
 
-        navContext = mockk {
+        navContext = mockk(relaxed = true) {
             every { store } returns TestStore()
             every { styles } returns NavigationViewStyles(ctx)
             every { viewModel } returns mockk {

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

@@ -5,6 +5,8 @@ import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import io.mockk.mockk
 import io.mockk.spyk
 import io.mockk.verify
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNull
 import org.junit.Test
 
 @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
@@ -114,6 +116,27 @@ internal class MapViewOwnerTest {
         verify(exactly = 1) { observer.onDetached(mapView1) }
         verify(exactly = 1) { observer.onAttached(mapView2) }
     }
+
+    @Test
+    fun `flow value is null by default`() {
+        val sut = MapViewOwner()
+        assertNull(sut.mapViews.value)
+    }
+
+    @Test
+    fun `flow value is chanhed when mapView is updated`() {
+        val sut = MapViewOwner()
+        val mapView1 = mockk<MapView>()
+        val mapView2 = mockk<MapView>()
+
+        sut.updateMapView(mapView1)
+
+        assertEquals(mapView1, sut.mapViews.value)
+
+        sut.updateMapView(mapView2)
+
+        assertEquals(mapView2, sut.mapViews.value)
+    }
 }
 
 @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)