add the ability to show/hide scalebar

Author: dzinad

CHANGELOG.md

@@ -22,6 +22,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Improved stop detector for auto profile. [#6373](https://github.com/mapbox/mapbox-navigation-android/pull/6373)
 - Fixed `RoadNameLabel` position issues by making sure that it updates when expanding and collapsing the info panel. [#6361](https://github.com/mapbox/mapbox-navigation-android/pull/6361)
 - Fixed `InfoPanel` overlapping the `RoadNameLabel` in free drive state with the device being in landscape orientation. [#6361](https://github.com/mapbox/mapbox-navigation-android/pull/6361)
+- Introduced `ViewStyleCustomization#mapScalebarParams` that allows for configuring map scalebar. [#6355](https://github.com/mapbox/mapbox-navigation-android/pull/6355)
 
 ## Mapbox Navigation SDK 2.9.0-alpha.2 - 16 September, 2022
 ### Changelog

libnavui-dropin/api/current.txt

@@ -28,6 +28,20 @@ package com.mapbox.navigation.dropin {
     property public final int style;
   }
 
+  public final class MapboxMapScalebarParams {
+    method public boolean getEnabled();
+    method public boolean isMetricUnits();
+    property public final boolean enabled;
+    property public final boolean isMetricUnits;
+  }
+
+  public static final class MapboxMapScalebarParams.Builder {
+    ctor public MapboxMapScalebarParams.Builder(android.content.Context context);
+    method public com.mapbox.navigation.dropin.MapboxMapScalebarParams build();
+    method public com.mapbox.navigation.dropin.MapboxMapScalebarParams.Builder enabled(boolean enabled);
+    method public com.mapbox.navigation.dropin.MapboxMapScalebarParams.Builder isMetricsUnits(Boolean? isMetricUnits);
+  }
+
   @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class NavigationView extends android.widget.FrameLayout implements androidx.lifecycle.LifecycleOwner {
     ctor public NavigationView(android.content.Context context, android.util.AttributeSet? attrs = null, String accessToken = attrs.navigationViewAccessToken(context), androidx.lifecycle.ViewModelStoreOwner viewModelStoreOwner = context.toViewModelStoreOwner());
     ctor public NavigationView(android.content.Context context, android.util.AttributeSet? attrs = null, String accessToken = attrs.navigationViewAccessToken(context));
@@ -220,6 +234,7 @@ package com.mapbox.navigation.dropin {
     method public Integer? getInfoPanelPeekHeight();
     method public com.mapbox.maps.plugin.LocationPuck? getLocationPuck();
     method public com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions? getManeuverViewOptions();
+    method public com.mapbox.navigation.dropin.MapboxMapScalebarParams? getMapScalebarParams();
     method public Integer? getPoiNameTextAppearance();
     method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams? getRecenterButtonParams();
     method public Integer? getRoadNameBackground();
@@ -240,6 +255,7 @@ package com.mapbox.navigation.dropin {
     method public void setInfoPanelPeekHeight(Integer?);
     method public void setLocationPuck(com.mapbox.maps.plugin.LocationPuck?);
     method public void setManeuverViewOptions(com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions?);
+    method public void setMapScalebarParams(com.mapbox.navigation.dropin.MapboxMapScalebarParams?);
     method public void setPoiNameTextAppearance(Integer?);
     method public void setRecenterButtonParams(com.mapbox.navigation.dropin.MapboxExtendableButtonParams?);
     method public void setRoadNameBackground(Integer?);
@@ -260,6 +276,7 @@ package com.mapbox.navigation.dropin {
     property public final Integer? infoPanelPeekHeight;
     property public final com.mapbox.maps.plugin.LocationPuck? locationPuck;
     property public final com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions? maneuverViewOptions;
+    property public final com.mapbox.navigation.dropin.MapboxMapScalebarParams? mapScalebarParams;
     property public final Integer? poiNameTextAppearance;
     property public final com.mapbox.navigation.dropin.MapboxExtendableButtonParams? recenterButtonParams;
     property public final Integer? roadNameBackground;
@@ -284,6 +301,7 @@ package com.mapbox.navigation.dropin {
     method @Px public int defaultInfoPanelPeekHeight(android.content.Context context);
     method public com.mapbox.maps.plugin.LocationPuck defaultLocationPuck(android.content.Context context);
     method public com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions defaultManeuverViewOptions();
+    method public com.mapbox.navigation.dropin.MapboxMapScalebarParams defaultMapScalebarParams(android.content.Context context);
     method @StyleRes public int defaultPoiNameTextAppearance();
     method public com.mapbox.navigation.dropin.MapboxExtendableButtonParams defaultRecenterButtonParams(android.content.Context context);
     method @DrawableRes public int defaultRoadNameBackground();

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

@@ -0,0 +1,101 @@
+package com.mapbox.navigation.dropin
+
+import android.content.Context
+import com.mapbox.navigation.base.formatter.UnitType
+import com.mapbox.navigation.base.internal.extensions.LocaleEx.getUnitTypeForLocale
+import com.mapbox.navigation.base.internal.extensions.inferDeviceLocale
+
+/**
+ * Params describing the map scalebar config.
+ *
+ * @param enabled true if the scalebar should be shown on the map, false otherwise
+ * @param isMetricUnits true if the scale bar is using metric system,
+ *  false if the scale bar is using imperial units.
+ */
+class MapboxMapScalebarParams private constructor(
+    val enabled: Boolean,
+    val isMetricUnits: Boolean,
+) {
+
+    /**
+     * Indicates whether some other object is "equal to" this one.
+     */
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as MapboxMapScalebarParams
+
+        if (enabled != other.enabled) return false
+        if (isMetricUnits != other.isMetricUnits) return false
+
+        return true
+    }
+
+    /**
+     * Returns a hash code value for the object.
+     */
+    override fun hashCode(): Int {
+        var result = enabled.hashCode()
+        result = 31 * result + isMetricUnits.hashCode()
+        return result
+    }
+
+    /**
+     * Returns a string representation of the object.
+     */
+    override fun toString(): String {
+        return "MapboxMapScalebarParams(" +
+            "enabled=$enabled, " +
+            "isMetricUnits=$isMetricUnits" +
+            ")"
+    }
+
+    /**
+     * Builder for [MapboxMapScalebarParams].
+     */
+    class Builder(context: Context) {
+
+        private val applicationContext = context.applicationContext
+        private var enabled: Boolean = false
+        private var isMetricsUnits: Boolean? = null
+
+        /**
+         * Whether to show the scalebar on the map.
+         * @param enabled true if the scalebar should be shown on the map, false otherwise
+         * @return the same builder object
+         */
+        fun enabled(enabled: Boolean): Builder = apply {
+            this.enabled = enabled
+        }
+
+        /**
+         * Whether the scale bar is using metric unit.
+         * @param isMetricUnits true if the scale bar is using metric system,
+         *  false if the scale bar is using imperial units.
+         *  @return the same builder object
+         */
+        fun isMetricsUnits(isMetricUnits: Boolean?): Builder = apply {
+            this.isMetricsUnits = isMetricUnits
+        }
+
+        /**
+         * Create a [MapboxMapScalebarParams] object.
+         * @return [MapboxMapScalebarParams]
+         */
+        fun build(): MapboxMapScalebarParams {
+            return MapboxMapScalebarParams(
+                enabled,
+                isMetricsUnits ?: getDefaultIsMetricUnits()
+            )
+        }
+
+        private fun getDefaultIsMetricUnits(): Boolean {
+            val unitType = applicationContext.inferDeviceLocale().getUnitTypeForLocale()
+            return when (unitType) {
+                UnitType.IMPERIAL -> false
+                UnitType.METRIC -> true
+            }
+        }
+    }
+}

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

@@ -32,6 +32,7 @@ import com.mapbox.navigation.dropin.coordinator.ManeuverCoordinator
 import com.mapbox.navigation.dropin.coordinator.MapLayoutCoordinator
 import com.mapbox.navigation.dropin.coordinator.RightFrameCoordinator
 import com.mapbox.navigation.dropin.coordinator.RoadNameLabelCoordinator
+import com.mapbox.navigation.dropin.coordinator.ScalebarPlaceholderCoordinator
 import com.mapbox.navigation.dropin.coordinator.SpeedLimitCoordinator
 import com.mapbox.navigation.dropin.databinding.MapboxNavigationViewLayoutBinding
 import com.mapbox.navigation.dropin.internal.MapboxNavigationViewApi
@@ -129,6 +130,7 @@ class NavigationView @JvmOverloads constructor(
                 this,
                 navigationContext.listenerRegistry
             ),
+            ScalebarPlaceholderCoordinator(navigationContext, binding.scalebarLayout),
             ManeuverCoordinator(navigationContext, binding.guidanceLayout),
             InfoPanelCoordinator(
                 navigationContext,

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

@@ -52,6 +52,9 @@ internal class NavigationViewStyles(context: Context) {
         MutableStateFlow(ViewStyleCustomization.defaultArrivalTextAppearance())
     private val _locationPuck: MutableStateFlow<LocationPuck> =
         MutableStateFlow(ViewStyleCustomization.defaultLocationPuck(context))
+    private val _mapScalebarParams: MutableStateFlow<MapboxMapScalebarParams> = MutableStateFlow(
+        ViewStyleCustomization.defaultMapScalebarParams(context)
+    )
 
     val infoPanelPeekHeight: StateFlow<Int> = _infoPanelPeekHeight.asStateFlow()
     val infoPanelMarginStart: StateFlow<Int> = _infoPanelMarginStart.asStateFlow()
@@ -80,6 +83,7 @@ internal class NavigationViewStyles(context: Context) {
     val maneuverViewOptions: StateFlow<ManeuverViewOptions> = _maneuverViewOptions.asStateFlow()
     val arrivalTextAppearance: StateFlow<Int> = _arrivalTextAppearance.asStateFlow()
     val locationPuck: StateFlow<LocationPuck> = _locationPuck.asStateFlow()
+    val mapScalebarParams: StateFlow<MapboxMapScalebarParams> = _mapScalebarParams.asStateFlow()
 
     fun applyCustomization(customization: ViewStyleCustomization) {
         customization.infoPanelPeekHeight?.also { _infoPanelPeekHeight.value = it }
@@ -104,5 +108,6 @@ internal class NavigationViewStyles(context: Context) {
         customization.roadNameTextAppearance?.also { _roadNameTextAppearance.value = it }
         customization.arrivalTextAppearance?.also { _arrivalTextAppearance.value = it }
         customization.locationPuck?.also { _locationPuck.value = it }
+        customization.mapScalebarParams?.also { _mapScalebarParams.value = it }
     }
 }

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

@@ -168,6 +168,16 @@ class ViewStyleCustomization {
      */
     var locationPuck: LocationPuck? = null
 
+    /**
+     * Map scalebar params.
+     * Use [defaultMapScalebarParams] to reset to default.
+     * NOTE: When `enabled`, the `scalebar` will always be added to the top start corner
+     * of the screen. Position of the `scalebar` using `NavigationView` cannot be changed at any
+     * given time. However, if you change the position using `MapView`, the behavior is undefined
+     * and you will be responsible to ensure the correct positioning based on other view overlays.
+     */
+    var mapScalebarParams: MapboxMapScalebarParams? = null
+
     companion object {
         /**
          * Default info panel peek height in pixels.
@@ -375,6 +385,12 @@ class ViewStyleCustomization {
             )
         )
 
+        /**
+         * Default map scalebar parameters.
+         */
+        fun defaultMapScalebarParams(context: Context): MapboxMapScalebarParams =
+            MapboxMapScalebarParams.Builder(context).build()
+
         private fun Context.defaultSpacing() =
             resources.getDimensionPixelSize(R.dimen.mapbox_actionList_spacing)
 

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

@@ -5,7 +5,6 @@ import com.mapbox.geojson.Point
 import com.mapbox.maps.MapView
 import com.mapbox.maps.plugin.compass.compass
 import com.mapbox.maps.plugin.locationcomponent.location
-import com.mapbox.maps.plugin.scalebar.scalebar
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.core.MapboxNavigation
@@ -15,6 +14,7 @@ import com.mapbox.navigation.dropin.NavigationViewContext
 import com.mapbox.navigation.dropin.component.camera.CameraComponent
 import com.mapbox.navigation.dropin.component.camera.CameraLayoutObserver
 import com.mapbox.navigation.dropin.component.logo.LogoAttributionComponent
+import com.mapbox.navigation.dropin.component.map.ScalebarComponent
 import com.mapbox.navigation.dropin.component.marker.FreeDriveLongPressMapComponent
 import com.mapbox.navigation.dropin.component.marker.GeocodingComponent
 import com.mapbox.navigation.dropin.component.marker.MapMarkersComponent
@@ -48,9 +48,14 @@ internal class MapBinder(
 
     init {
         mapView.compass.enabled = false
-        mapView.scalebar.enabled = false
     }
 
+    private val scalebarComponent = ScalebarComponent(
+        mapView,
+        context.styles.mapScalebarParams,
+        context.systemBarsInsets
+    )
+
     private val store = context.store
 
     override fun bind(viewGroup: ViewGroup): MapboxNavigationObserver {
@@ -86,7 +91,8 @@ internal class MapBinder(
                 navigationState
             ) { _, arrowOptions, navState ->
                 routeArrowComponent(navState, arrowOptions)
-            }
+            },
+            scalebarComponent
         )
     }
 

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

@@ -0,0 +1,49 @@
+package com.mapbox.navigation.dropin.component.map
+
+import android.view.Gravity
+import androidx.core.graphics.Insets
+import com.mapbox.maps.MapView
+import com.mapbox.maps.plugin.scalebar.scalebar
+import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.core.MapboxNavigation
+import com.mapbox.navigation.dropin.MapboxMapScalebarParams
+import com.mapbox.navigation.ui.base.lifecycle.UIComponent
+import kotlinx.coroutines.flow.StateFlow
+
+@ExperimentalPreviewMapboxNavigationAPI
+internal class ScalebarComponent(
+    private val mapView: MapView,
+    private val scalebarParams: StateFlow<MapboxMapScalebarParams>,
+    private val systemBarInsets: StateFlow<Insets>,
+) : UIComponent() {
+
+    private val defaultMarginTop = 4f
+    private val defaultMarginLeft = 4f
+
+    init {
+        setUpScalebar(scalebarParams.value)
+        mapView.scalebar.updateSettings {
+            position = Gravity.TOP or Gravity.START
+            // temporary workaround, remove after MAPSMBL-173
+            textBorderWidth = 3f
+        }
+    }
+
+    override fun onAttached(mapboxNavigation: MapboxNavigation) {
+        super.onAttached(mapboxNavigation)
+        scalebarParams.observe { setUpScalebar(it) }
+        systemBarInsets.observe { insets ->
+            mapView.scalebar.updateSettings {
+                marginTop = defaultMarginTop + insets.top
+                marginLeft = defaultMarginLeft + insets.left
+            }
+        }
+    }
+
+    private fun setUpScalebar(params: MapboxMapScalebarParams) {
+        mapView.scalebar.updateSettings {
+            enabled = params.enabled
+            isMetricUnits = params.isMetricUnits
+        }
+    }
+}

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

@@ -0,0 +1,36 @@
+package com.mapbox.navigation.dropin.component.map
+
+import android.view.View
+import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.core.MapboxNavigation
+import com.mapbox.navigation.dropin.MapboxMapScalebarParams
+import com.mapbox.navigation.ui.app.internal.State
+import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
+import com.mapbox.navigation.ui.base.lifecycle.UIComponent
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.collect
+import kotlinx.coroutines.flow.combine
+import kotlinx.coroutines.launch
+
+@ExperimentalPreviewMapboxNavigationAPI
+internal class ScalebarPlaceholderComponent(
+    private val scalebarPlaceholder: View,
+    private val scalebarParams: StateFlow<MapboxMapScalebarParams>,
+    private val navigationState: StateFlow<State>,
+) : UIComponent() {
+
+    override fun onAttached(mapboxNavigation: MapboxNavigation) {
+        super.onAttached(mapboxNavigation)
+        coroutineScope.launch {
+            combine(scalebarParams, navigationState) { params, state ->
+                scalebarPlaceholder.visibility =
+                    if (params.enabled && state.navigation !is NavigationState.ActiveNavigation) {
+                        View.VISIBLE
+                    } else {
+                        View.GONE
+                    }
+            }.collect()
+        }
+    }
+}

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

@@ -0,0 +1,34 @@
+package com.mapbox.navigation.dropin.coordinator
+
+import android.view.View
+import android.view.ViewGroup
+import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
+import com.mapbox.navigation.dropin.NavigationViewContext
+import com.mapbox.navigation.dropin.R
+import com.mapbox.navigation.dropin.component.map.ScalebarPlaceholderComponent
+import com.mapbox.navigation.dropin.databinding.MapboxScalebarPlaceholderLayoutBinding
+import com.mapbox.navigation.ui.app.internal.extension.actionsFlowable
+import com.mapbox.navigation.ui.base.lifecycle.UIBinder
+import kotlinx.coroutines.flow.map
+
+@OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
+internal class ScalebarPlaceholderBinder(
+    private val context: NavigationViewContext,
+) : UIBinder {
+
+    override fun bind(viewGroup: ViewGroup): MapboxNavigationObserver {
+        val binding = inflateLayout(viewGroup)
+        return ScalebarPlaceholderComponent(
+            binding.scalebarPlaceholder,
+            context.styles.mapScalebarParams,
+            context.store.state
+        )
+    }
+
+    private fun inflateLayout(viewGroup: ViewGroup): MapboxScalebarPlaceholderLayoutBinding {
+        viewGroup.removeAllViews()
+        View.inflate(viewGroup.context, R.layout.mapbox_scalebar_placeholder_layout, viewGroup)
+        return MapboxScalebarPlaceholderLayoutBinding.bind(viewGroup)
+    }
+}