[android] Added dynamic scale widget to map view.

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MapboxConstants.java

@@ -1,6 +1,7 @@
 package com.mapbox.mapboxsdk.constants;
 
 import android.content.Context;
+
 import java.util.Locale;
 
 /**
@@ -15,6 +16,7 @@ public class MapboxConstants {
 
     /**
      * Key used to store access token in AndroidManifest.xml
+     *
      * @deprecated As of release 4.1.0, replaced by {@link com.mapbox.mapboxsdk.MapboxAccountManager#start(Context, String)}
      */
     @Deprecated
@@ -85,6 +87,13 @@ public class MapboxConstants {
      */
     public static final double MINIMUM_DIRECTION = 0;
 
+    /**
+     * Color choices for the scale widget
+     */
+
+    public static final int SCALE_COLOR_BLACK = 0;
+    public static final int SCALE_COLOR_WHITE = 1;
+
     /**
      * Fragment Argument Key for MapboxMapOptions
      */
@@ -107,6 +116,15 @@ public class MapboxConstants {
     public static final String STATE_MY_LOCATION_ENABLED = "myLocationEnabled";
     public static final String STATE_MY_LOCATION_TRACKING_MODE = "myLocationTracking";
     public static final String STATE_MY_BEARING_TRACKING_MODE = "myBearingTracking";
+    public static final String STATE_SCALE_ENABLED = "scaleEnabled";
+    public static final String STATE_SCALE_GRAVITY = "scaleGravity";
+    public static final String STATE_SCALE_MARGIN_LEFT = "scaleMarginLeft";
+    public static final String STATE_SCALE_MARGIN_TOP = "scaleMarginTop";
+    public static final String STATE_SCALE_MARGIN_RIGHT = "scaleMarginRight";
+    public static final String STATE_SCALE_MARGIN_BOTTOM = "scaleMarginBottom";
+    public static final String STATE_SCALE_WIDTH = "scaleWidth";
+    public static final String STATE_SCALE_UNIT = "scaleUnit";
+    public static final String STATE_SCALE_COLOR = "scaleColor";
     public static final String STATE_COMPASS_ENABLED = "compassEnabled";
     public static final String STATE_COMPASS_GRAVITY = "compassGravity";
     public static final String STATE_COMPASS_MARGIN_LEFT = "compassMarginLeft";

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMapOptions.java

@@ -10,6 +10,7 @@
 import android.os.Parcel;
 import android.os.Parcelable;
 import android.support.annotation.ColorInt;
+import android.support.annotation.FloatRange;
 import android.support.annotation.IntRange;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
@@ -34,6 +35,10 @@
  */
 public class MapboxMapOptions implements Parcelable {
 
+    // to avoid reliance on knowledge of ordinals, map values from xml here.
+
+    private static UiSettings.ScaleUnit[] scaleUnits = {UiSettings.ScaleUnit.KM, UiSettings.ScaleUnit.MILE, UiSettings.ScaleUnit.NM};
+
     private static final float DIMENSION_SEVEN_DP = 7f;
     private static final float DIMENSION_TEN_DP = 10f;
     private static final float DIMENSION_SIXTEEN_DP = 16f;
@@ -43,6 +48,13 @@ public class MapboxMapOptions implements Parcelable {
 
     private boolean debugActive;
 
+    private boolean scaleEnabled = true;
+    private float scaleWidth = 0.34f;
+    private int scaleGravity = Gravity.BOTTOM | Gravity.CENTER_HORIZONTAL;
+    private int[] scaleMargins;
+    private UiSettings.ScaleUnit scaleUnit = UiSettings.ScaleUnit.KM;
+    private int scaleColor = 0;
+
     private boolean compassEnabled = true;
     private int compassGravity = Gravity.TOP | Gravity.END;
     private int[] compassMargins;
@@ -95,6 +107,12 @@ private MapboxMapOptions(Parcel in) {
         cameraPosition = in.readParcelable(CameraPosition.class.getClassLoader());
         debugActive = in.readByte() != 0;
 
+        scaleColor = in.readByte();
+        scaleEnabled = in.readByte() != 0;
+        scaleGravity = in.readInt();
+        scaleMargins = in.createIntArray();
+        scaleUnit = UiSettings.ScaleUnit.values()[in.readInt()];
+
         compassEnabled = in.readByte() != 0;
         compassGravity = in.readInt();
         compassMargins = in.createIntArray();
@@ -187,6 +205,16 @@ public static MapboxMapOptions createFromAttributes(@NonNull Context context, @N
             mapboxMapOptions.maxZoom(typedArray.getFloat(R.styleable.MapView_zoom_max, MapboxConstants.MAXIMUM_ZOOM));
             mapboxMapOptions.minZoom(typedArray.getFloat(R.styleable.MapView_zoom_min, MapboxConstants.MINIMUM_ZOOM));
 
+            mapboxMapOptions.scaleEnabled(typedArray.getBoolean(R.styleable.MapView_scale_enabled, true));
+            mapboxMapOptions.scaleColor(typedArray.getInt(R.styleable.MapView_scale_color, MapboxConstants.SCALE_COLOR_BLACK));
+            mapboxMapOptions.scaleWidth(typedArray.getFloat(R.styleable.MapView_scale_width, 0.34f));
+            mapboxMapOptions.scaleUnit(scaleUnits[typedArray.getInt(R.styleable.MapView_scale_unit, 0)]);
+            mapboxMapOptions.scaleGravity(typedArray.getInt(R.styleable.MapView_scale_gravity, Gravity.BOTTOM | Gravity.CENTER_HORIZONTAL));
+            mapboxMapOptions.scaleMargins(new int[]{(int) (typedArray.getDimension(R.styleable.MapView_scale_margin_left, DIMENSION_SEVEN_DP) * screenDensity)
+                    , ((int) typedArray.getDimension(R.styleable.MapView_scale_margin_top, DIMENSION_SEVEN_DP * screenDensity))
+                    , ((int) typedArray.getDimension(R.styleable.MapView_scale_margin_right, DIMENSION_SEVEN_DP * screenDensity))
+                    , ((int) typedArray.getDimension(R.styleable.MapView_scale_margin_bottom, DIMENSION_SEVEN_DP * screenDensity))});
+
             mapboxMapOptions.compassEnabled(typedArray.getBoolean(R.styleable.MapView_compass_enabled, true));
             mapboxMapOptions.compassGravity(typedArray.getInt(R.styleable.MapView_compass_gravity, Gravity.TOP | Gravity.END));
             mapboxMapOptions.compassMargins(new int[]{(int) (typedArray.getDimension(R.styleable.MapView_compass_margin_left, DIMENSION_TEN_DP) * screenDensity)
@@ -325,6 +353,131 @@ public MapboxMapOptions maxZoom(float maxZoom) {
         return this;
     }
 
+    /**
+     * Is the map scale widget enabled?
+     *
+     * @return the current enabled state
+     */
+    public boolean getScaleEnabled() {
+        return scaleEnabled;
+    }
+
+    /**
+     * Control whether the map scale widget is shown.
+     * The scale widget shows a scale of distance on the map
+     *
+     * @param scaleEnabled
+     * @return this
+     */
+    public MapboxMapOptions scaleEnabled(boolean scaleEnabled) {
+        this.scaleEnabled = scaleEnabled;
+        return this;
+    }
+
+    /**
+     * Get the color index of the scale widget.
+     *
+     * @return the scale unit
+     */
+    public int getScaleColor() {
+        return scaleColor;
+    }
+
+    /**
+     * Set the color for the scale widget. Choices are:
+     * MapboxConstants.SCALE_COLOR_BLACK (default)
+     * MapboxConstants.SCALE_COLOR_WHITE
+     *
+     * @param scaleColor
+     * @return
+     */
+    public MapboxMapOptions scaleColor(int scaleColor) {
+        this.scaleColor = scaleColor;
+        return this;
+    }
+
+    /**
+     * Get the current unit used to label the scale widget
+     *
+     * @return the scale unit
+     */
+    public UiSettings.ScaleUnit getScaleUnit() {
+        return scaleUnit;
+    }
+
+    /**
+     * Set the unit used for labelling the scale widget.
+     * <p>
+     * See {@link UiSettings.ScaleUnit}
+     *
+     * @param scaleUnit
+     * @return
+     */
+    public MapboxMapOptions scaleUnit(UiSettings.ScaleUnit scaleUnit) {
+        this.scaleUnit = scaleUnit;
+        return this;
+    }
+
+    /**
+     * Get the width of the scale widget.
+     *
+     * @return The scale width as a fraction of the display width
+     */
+    public float getScaleWidth() {
+        return scaleWidth;
+    }
+
+    /**
+     * Set the width of the scale widget as a fraction of the display width.
+     *
+     * @param scaleWidth
+     * @return this
+     */
+    public MapboxMapOptions scaleWidth(@FloatRange(from = 0f, to = 1f) float scaleWidth) {
+        this.scaleWidth = scaleWidth;
+        return this;
+    }
+
+    /**
+     * Get the gravity settings for the scale widget.
+     *
+     * @return a bit mask of gravity contstants
+     */
+    public int getScaleGravity() {
+        return scaleGravity;
+    }
+
+    /**
+     * Set the gravity of the scale widget. See
+     *
+     * @param scaleGravity see {@link android.view.Gravity}
+     * @return this
+     */
+
+    public MapboxMapOptions scaleGravity(int scaleGravity) {
+        this.scaleGravity = scaleGravity;
+        return this;
+    }
+
+    /**
+     * Get the margins for the scale widget
+     *
+     * @return 4 long array for LTRB margins
+     */
+    public int[] getScaleMargins() {
+        return scaleMargins;
+    }
+
+    /**
+     * Set the margins for the scale widget
+     *
+     * @param scaleMargins 4 long array for LTRB margins
+     */
+    public MapboxMapOptions scaleMargins(int[] scaleMargins) {
+        this.scaleMargins = scaleMargins;
+        return this;
+    }
+
     /**
      * Specifies the visibility state of a compass for a map view.
      *
@@ -680,9 +833,9 @@ public int[] getCompassMargins() {
     }
 
     /**
-     * Get the current configured visibility state for compass for a map view.
+     * Get the current configured visibility state for logo for a map view.
      *
-     * @return Visibility state of the compass
+     * @return Visibility state of the logo
      */
     public boolean getLogoEnabled() {
         return logoEnabled;
@@ -931,6 +1084,12 @@ public void writeToParcel(Parcel dest, int flags) {
         dest.writeParcelable(cameraPosition, flags);
         dest.writeByte((byte) (debugActive ? 1 : 0));
 
+        dest.writeByte((byte) scaleColor);
+        dest.writeByte((byte) (scaleEnabled ? 1 : 0));
+        dest.writeInt(scaleGravity);
+        dest.writeIntArray(scaleMargins);
+        dest.writeInt(scaleUnit.ordinal());
+
         dest.writeByte((byte) (compassEnabled ? 1 : 0));
         dest.writeInt(compassGravity);
         dest.writeIntArray(compassMargins);
@@ -973,11 +1132,17 @@ public void writeToParcel(Parcel dest, int flags) {
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
-        if (o == null || getClass() != o.getClass()) return false;
+        if (o == null || this.getClass() != o.getClass()) return false;
 
         MapboxMapOptions options = (MapboxMapOptions) o;
 
         if (debugActive != options.debugActive) return false;
+        if (scaleColor != options.scaleColor) return false;
+        if (scaleEnabled != options.scaleEnabled) return false;
+        if (scaleGravity != options.scaleGravity) return false;
+        if (scaleWidth != options.scaleWidth) return false;
+        if (scaleUnit != options.scaleUnit) return false;
+
         if (compassEnabled != options.compassEnabled) return false;
         if (compassGravity != options.compassGravity) return false;
         if (logoEnabled != options.logoEnabled) return false;
@@ -999,6 +1164,7 @@ public boolean equals(Object o) {
         if (myLocationAccuracyAlpha != options.myLocationAccuracyAlpha) return false;
         if (cameraPosition != null ? !cameraPosition.equals(options.cameraPosition) : options.cameraPosition != null)
             return false;
+        if (!Arrays.equals(scaleMargins, options.scaleMargins)) return false;
         if (!Arrays.equals(compassMargins, options.compassMargins)) return false;
         if (!Arrays.equals(logoMargins, options.logoMargins)) return false;
         if (!Arrays.equals(attributionMargins, options.attributionMargins)) return false;
@@ -1014,15 +1180,19 @@ public boolean equals(Object o) {
         if (apiBaseUrl != null ? !apiBaseUrl.equals(options.apiBaseUrl) : options.apiBaseUrl != null)
             return false;
         return accessToken != null ? accessToken.equals(options.accessToken) : options.accessToken == null;
-
     }
 
     @Override
     public int hashCode() {
         int result = cameraPosition != null ? cameraPosition.hashCode() : 0;
         result = 31 * result + (debugActive ? 1 : 0);
+        result = 31 * result + (scaleEnabled ? 1 : 0);
+        result = 31 * result + scaleColor;
+        result = 31 * result + scaleGravity;
+        result = 31 * result + scaleUnit.ordinal();
         result = 31 * result + (compassEnabled ? 1 : 0);
         result = 31 * result + compassGravity;
+        result = 31 * result + Arrays.hashCode(scaleMargins);
         result = 31 * result + Arrays.hashCode(compassMargins);
         result = 31 * result + (logoEnabled ? 1 : 0);
         result = 31 * result + logoGravity;