[android] - custom location engine fixes (#9139)

4 files changed, 116 insertions, 63 deletions

diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MapboxConstants.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MapboxConstants.java
index 9adefa3221..09e8d451bc 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MapboxConstants.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/constants/MapboxConstants.java
@@ -134,5 +134,6 @@ public class MapboxConstants {
   public static final String STATE_ATTRIBUTION_MARGIN_RIGHT = "mapbox_attrMarginRight";
   public static final String STATE_ATTRIBUTION_MARGIN_BOTTOM = "mapbox_atrrMarginBottom";
   public static final String STATE_ATTRIBUTION_ENABLED = "mapbox_atrrEnabled";
+  public static final String STATE_USING_CUSTOM_LOCATION_SOURCE = "mapbox_usingcCustomLocationSource";
 
 }
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java
index 0bfa74d1c0..8bf0150c3c 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java
@@ -470,7 +470,7 @@ public final class MapboxMap {
    */
   @UiThread
   public void setMinZoomPreference(
-    @FloatRange(from = MapboxConstants.MINIMUM_ZOOM, to = MapboxConstants.MAXIMUM_ZOOM) double minZoom) {
+          @FloatRange(from = MapboxConstants.MINIMUM_ZOOM, to = MapboxConstants.MAXIMUM_ZOOM) double minZoom) {
     transform.setMinZoom(minZoom);
   }
 
@@ -499,7 +499,7 @@ public final class MapboxMap {
    */
   @UiThread
   public void setMaxZoomPreference(@FloatRange(from = MapboxConstants.MINIMUM_ZOOM,
-    to = MapboxConstants.MAXIMUM_ZOOM) double maxZoom) {
+          to = MapboxConstants.MAXIMUM_ZOOM) double maxZoom) {
     transform.setMaxZoom(maxZoom);
   }
 
@@ -1154,7 +1154,7 @@ public final class MapboxMap {
   @UiThread
   @NonNull
   public List<MarkerView> addMarkerViews(@NonNull List<? extends
-    BaseMarkerViewOptions> markerViewOptions) {
+          BaseMarkerViewOptions> markerViewOptions) {
     return annotationManager.addMarkerViews(markerViewOptions, this);
   }
 
@@ -1183,7 +1183,7 @@ public final class MapboxMap {
   @UiThread
   @NonNull
   public List<Marker> addMarkers(@NonNull List<? extends
-    BaseMarkerOptions> markerOptionsList) {
+          BaseMarkerOptions> markerOptionsList) {
     return annotationManager.addMarkers(markerOptionsList, this);
   }
 
@@ -1746,7 +1746,7 @@ public final class MapboxMap {
    */
   @UiThread
   public void setOnInfoWindowLongClickListener(@Nullable OnInfoWindowLongClickListener
-                                                 listener) {
+                                                       listener) {
     annotationManager.getInfoWindowManager().setOnInfoWindowLongClickListener(listener);
   }
 
@@ -1828,16 +1828,25 @@ public final class MapboxMap {
    */
   @UiThread
   public void setOnMyLocationChangeListener(@Nullable MapboxMap.OnMyLocationChangeListener
-                                              listener) {
+                                                    listener) {
     trackingSettings.setOnMyLocationChangeListener(listener);
   }
 
   /**
+   * Removes custom location source of the my-location layer and brings back default {@link LocationSource}
+   * location source.
+   *
+   */
+  @UiThread
+  public void removeLocationSource() {
+    trackingSettings.removeLocationSource();
+  }
+
+  /**
    * Replaces the location source of the my-location layer.
    *
    * @param locationSource A {@link LocationEngine} location source to use in the my-location layer.
-   *                       Set to null to use the default {@link LocationSource}
-   *                       location source.
+   *
    */
   @UiThread
   public void setLocationSource(@Nullable LocationEngine locationSource) {
@@ -1852,7 +1861,7 @@ public final class MapboxMap {
    */
   @UiThread
   public void setOnMyLocationTrackingModeChangeListener(
-    @Nullable MapboxMap.OnMyLocationTrackingModeChangeListener listener) {
+          @Nullable MapboxMap.OnMyLocationTrackingModeChangeListener listener) {
     trackingSettings.setOnMyLocationTrackingModeChangeListener(listener);
   }
 
@@ -1891,7 +1900,7 @@ public final class MapboxMap {
   @UiThread
   @NonNull
   public List<Feature> queryRenderedFeatures(@NonNull PointF coordinates, @Nullable String...
-    layerIds) {
+          layerIds) {
     return nativeMapView.queryRenderedFeatures(coordinates, layerIds, null);
   }
 
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java
index 25b60aa72d..24d58a0ed4 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/TrackingSettings.java
@@ -29,6 +29,7 @@ public final class TrackingSettings {
   private final CameraZoomInvalidator zoomInvalidator;
   private LocationEngine locationSource;
   private LocationEngineListener myLocationListener;
+  private boolean isCustomLocationSource;
 
   private boolean myLocationEnabled;
   private boolean dismissLocationTrackingOnGesture = true;
@@ -58,27 +59,31 @@ public final class TrackingSettings {
     outState.putBoolean(MapboxConstants.STATE_MY_BEARING_TRACKING_DISMISS, isDismissBearingTrackingOnGesture());
     outState.putBoolean(MapboxConstants.STATE_MY_LOCATION_ENABLED, isMyLocationEnabled());
     outState.putBoolean(MapboxConstants.STATE_MY_TRACKING_MODE_DISMISS_FOR_CAMERA,
-      isDismissTrackingModesForCameraPositionChange());
+            isDismissTrackingModesForCameraPositionChange());
+    outState.putBoolean(MapboxConstants.STATE_USING_CUSTOM_LOCATION_SOURCE, isCustomLocationSource());
   }
 
   void onRestoreInstanceState(Bundle savedInstanceState) {
     try {
-      setMyLocationEnabled(savedInstanceState.getBoolean(MapboxConstants.STATE_MY_LOCATION_ENABLED));
+      setMyLocationEnabled(
+              savedInstanceState.getBoolean(MapboxConstants.STATE_MY_LOCATION_ENABLED),
+              savedInstanceState.getBoolean(MapboxConstants.STATE_USING_CUSTOM_LOCATION_SOURCE)
+      );
     } catch (SecurityException ignore) {
       // User did not accept location permissions
     }
     // noinspection ResourceType
     setMyLocationTrackingMode(savedInstanceState.getInt(
-      MapboxConstants.STATE_MY_LOCATION_TRACKING_MODE, MyLocationTracking.TRACKING_NONE));
+            MapboxConstants.STATE_MY_LOCATION_TRACKING_MODE, MyLocationTracking.TRACKING_NONE));
     // noinspection ResourceType
     setMyBearingTrackingMode(savedInstanceState.getInt(
-      MapboxConstants.STATE_MY_BEARING_TRACKING_MODE, MyBearingTracking.NONE));
+            MapboxConstants.STATE_MY_BEARING_TRACKING_MODE, MyBearingTracking.NONE));
     setDismissLocationTrackingOnGesture(savedInstanceState.getBoolean(
-      MapboxConstants.STATE_MY_LOCATION_TRACKING_DISMISS, true));
+            MapboxConstants.STATE_MY_LOCATION_TRACKING_DISMISS, true));
     setDismissBearingTrackingOnGesture(savedInstanceState.getBoolean(
-      MapboxConstants.STATE_MY_BEARING_TRACKING_DISMISS, true));
+            MapboxConstants.STATE_MY_BEARING_TRACKING_DISMISS, true));
     setDismissTrackingModeForCameraPositionChange(savedInstanceState.getBoolean(
-      MapboxConstants.STATE_MY_TRACKING_MODE_DISMISS_FOR_CAMERA, true));
+            MapboxConstants.STATE_MY_TRACKING_MODE_DISMISS_FOR_CAMERA, true));
   }
 
   /**
@@ -242,9 +247,9 @@ public final class TrackingSettings {
     //    The user settings are enabled AND;
     //    EITHER bearing tracking is dismissed on gesture OR there is no bearing tracking
     return uiSettings.isRotateGesturesEnabled()
-      && (dismissBearingTrackingOnGesture
-      || myLocationView.getMyBearingTrackingMode() == MyBearingTracking.NONE
-      || myLocationView.getMyLocationTrackingMode() == MyLocationTracking.TRACKING_NONE);
+            && (dismissBearingTrackingOnGesture
+            || myLocationView.getMyBearingTrackingMode() == MyBearingTracking.NONE
+            || myLocationView.getMyLocationTrackingMode() == MyLocationTracking.TRACKING_NONE);
   }
 
   /**
@@ -254,8 +259,8 @@ public final class TrackingSettings {
    */
   public boolean isScrollGestureCurrentlyEnabled() {
     return uiSettings.isScrollGesturesEnabled()
-      && (dismissLocationTrackingOnGesture
-      || myLocationView.getMyLocationTrackingMode() == MyLocationTracking.TRACKING_NONE);
+            && (dismissLocationTrackingOnGesture
+            || myLocationView.getMyLocationTrackingMode() == MyLocationTracking.TRACKING_NONE);
   }
 
   /**
@@ -338,6 +343,10 @@ public final class TrackingSettings {
     }
   }
 
+  public boolean isCustomLocationSource() {
+    return isCustomLocationSource;
+  }
+
   void setOnMyLocationTrackingModeChangeListener(MapboxMap.OnMyLocationTrackingModeChangeListener listener) {
     this.onMyLocationTrackingModeChangeListener = listener;
   }
@@ -356,20 +365,32 @@ public final class TrackingSettings {
   }
 
   void setMyLocationEnabled(boolean locationEnabled) {
+    setMyLocationEnabled(locationEnabled, isCustomLocationSource());
+  }
+
+  private void setMyLocationEnabled(boolean locationEnabled, boolean isCustomLocationSource) {
     if (!PermissionsManager.areLocationPermissionsGranted(myLocationView.getContext())) {
       Timber.e("Could not activate user location tracking: "
-        + "user did not accept the permission or permissions were not requested.");
+              + "user did not accept the permission or permissions were not requested.");
       return;
     }
     myLocationEnabled = locationEnabled;
-    myLocationView.setEnabled(locationEnabled);
+    this.isCustomLocationSource = isCustomLocationSource;
+    myLocationView.setEnabled(locationEnabled, isCustomLocationSource);
   }
 
   void setLocationSource(LocationEngine locationSource) {
     this.locationSource = locationSource;
+    this.isCustomLocationSource = true;
     myLocationView.setLocationSource(locationSource);
   }
 
+  void removeLocationSource() {
+    locationSource = LocationSource.getLocationEngine(myLocationView.getContext());
+    this.isCustomLocationSource = false;
+    myLocationView.removeLocationSource();
+  }
+
   void update() {
     if (!myLocationView.isEnabled()) {
       return;
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationView.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationView.java
index 338d29c87c..da741d7396 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationView.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/widgets/MyLocationView.java
@@ -70,12 +70,12 @@ public class MyLocationView extends View {
   private ValueAnimator directionAnimator;
 
   private ValueAnimator.AnimatorUpdateListener invalidateSelfOnUpdateListener =
-    new ValueAnimator.AnimatorUpdateListener() {
-      @Override
-      public void onAnimationUpdate(ValueAnimator animation) {
-        invalidate();
-      }
-    };
+          new ValueAnimator.AnimatorUpdateListener() {
+            @Override
+            public void onAnimationUpdate(ValueAnimator animation) {
+              invalidate();
+            }
+          };
 
   private Drawable foregroundDrawable;
   private Drawable foregroundBearingDrawable;
@@ -134,8 +134,8 @@ public class MyLocationView extends View {
 
     // setup LayoutParams
     ViewGroup.LayoutParams lp = new ViewGroup.LayoutParams(
-      ViewGroup.LayoutParams.MATCH_PARENT,
-      ViewGroup.LayoutParams.MATCH_PARENT);
+            ViewGroup.LayoutParams.MATCH_PARENT,
+            ViewGroup.LayoutParams.MATCH_PARENT);
     setLayoutParams(lp);
 
     matrix = new Matrix();
@@ -165,7 +165,7 @@ public class MyLocationView extends View {
     }
 
     if (defaultDrawable.getIntrinsicWidth() != bearingDrawable.getIntrinsicWidth()
-      || defaultDrawable.getIntrinsicHeight() != bearingDrawable.getIntrinsicHeight()) {
+            || defaultDrawable.getIntrinsicHeight() != bearingDrawable.getIntrinsicHeight()) {
       throw new RuntimeException("The dimensions from location and bearing drawables should be match");
     }
 
@@ -232,8 +232,8 @@ public class MyLocationView extends View {
     int horizontalOffset = backgroundOffsetLeft - backgroundOffsetRight;
     int verticalOffset = backgroundOffsetTop - backgroundOffsetBottom;
     backgroundBounds = new Rect(-backgroundWidth / 2 + horizontalOffset,
-      -backgroundHeight / 2 + verticalOffset, backgroundWidth / 2 + horizontalOffset, backgroundHeight / 2
-      + verticalOffset);
+            -backgroundHeight / 2 + verticalOffset, backgroundWidth / 2 + horizontalOffset, backgroundHeight / 2
+            + verticalOffset);
     backgroundDrawable.setBounds(backgroundBounds);
 
     int foregroundWidth = foregroundDrawable.getIntrinsicWidth();
@@ -251,7 +251,7 @@ public class MyLocationView extends View {
     super.onDraw(canvas);
 
     if (location == null || foregroundBounds == null || backgroundBounds == null || accuracyAnimator == null
-      || screenLocation == null) {
+            || screenLocation == null) {
       // Not ready yet
       return;
     }
@@ -390,9 +390,13 @@ public class MyLocationView extends View {
 
   @Override
   public void setEnabled(boolean enabled) {
+    setEnabled(enabled, false);
+  }
+
+  public void setEnabled(boolean enabled, boolean isCustomLocationSource) {
     super.setEnabled(enabled);
     setVisibility(enabled ? View.VISIBLE : View.INVISIBLE);
-    toggleGps(enabled);
+    toggleGps(enabled, isCustomLocationSource);
   }
 
   @Override
@@ -413,17 +417,23 @@ public class MyLocationView extends View {
     super.onRestoreInstanceState(state);
   }
 
+  private void toggleGps(boolean enableGps) {
+    toggleGps(enableGps, mapboxMap != null && mapboxMap.getTrackingSettings().isCustomLocationSource());
+  }
+
   /**
    * Enabled / Disable GPS location updates along with updating the UI
    *
    * @param enableGps true if GPS is to be enabled, false if GPS is to be disabled
    */
-  private void toggleGps(boolean enableGps) {
-    if (locationSource == null) {
-      locationSource = LocationSource.getLocationEngine(this.getContext());
-    }
-
+  private void toggleGps(boolean enableGps, boolean isCustomLocationSource) {
     if (enableGps) {
+      if (locationSource == null) {
+        if (!isCustomLocationSource)
+          locationSource = LocationSource.getLocationEngine(this.getContext());
+        else
+          return;
+      }
       // Set an initial location if one available
       Location lastLocation = locationSource.getLastLocation();
 
@@ -437,15 +447,17 @@ public class MyLocationView extends View {
 
       locationSource.addLocationEngineListener(userLocationListener);
       locationSource.activate();
+
+      locationSource.setPriority(LocationEnginePriority.HIGH_ACCURACY);
     } else {
+      if (locationSource == null)
+        return;
       // Disable location and user dot
       location = null;
       locationSource.removeLocationUpdates();
       locationSource.removeLocationEngineListener(userLocationListener);
       locationSource.deactivate();
     }
-
-    locationSource.setPriority(LocationEnginePriority.HIGH_ACCURACY);
   }
 
   public Location getLocation() {
@@ -487,17 +499,17 @@ public class MyLocationView extends View {
         // center map directly
         mapboxMap.getTrackingSettings().setDismissTrackingModeForCameraPositionChange(false);
         mapboxMap.easeCamera(CameraUpdateFactory.newLatLng(new LatLng(location)), 0, false /*linear interpolator*/,
-          new MapboxMap.CancelableCallback() {
-            @Override
-            public void onCancel() {
+                new MapboxMap.CancelableCallback() {
+                  @Override
+                  public void onCancel() {
 
-            }
+                  }
 
-            @Override
-            public void onFinish() {
-              mapboxMap.getTrackingSettings().setDismissTrackingModeForCameraPositionChange(true);
-            }
-          });
+                  @Override
+                  public void onFinish() {
+                    mapboxMap.getTrackingSettings().setDismissTrackingModeForCameraPositionChange(true);
+                  }
+                });
       } else {
         // do not use interpolated location from tracking mode
         latLng = null;
@@ -565,7 +577,17 @@ public class MyLocationView extends View {
   }
 
   public void setLocationSource(LocationEngine locationSource) {
+    toggleGps(false);
     this.locationSource = locationSource;
+    this.userLocationListener = null;
+    setEnabled(isEnabled(), true);
+  }
+
+  public void removeLocationSource() {
+    toggleGps(false);
+    this.locationSource = LocationSource.getLocationEngine(getContext());
+    this.userLocationListener = null;
+    setEnabled(isEnabled(), false);
   }
 
   private static class GpsLocationListener implements LocationEngineListener {
@@ -665,17 +687,17 @@ public class MyLocationView extends View {
       builder.bearing(rotation);
       mapboxMap.getTrackingSettings().setDismissTrackingModeForCameraPositionChange(false);
       mapboxMap.easeCamera(CameraUpdateFactory.newCameraPosition(builder.build()), COMPASS_UPDATE_RATE_MS,
-        false /*linear interpolator*/, new MapboxMap.CancelableCallback() {
-          @Override
-          public void onCancel() {
+              false /*linear interpolator*/, new MapboxMap.CancelableCallback() {
+                @Override
+                public void onCancel() {
 
-          }
+                }
 
-          @Override
-          public void onFinish() {
-            mapboxMap.getTrackingSettings().setDismissTrackingModeForCameraPositionChange(true);
-          }
-        });
+                @Override
+                public void onFinish() {
+                  mapboxMap.getTrackingSettings().setDismissTrackingModeForCameraPositionChange(true);
+                }
+              });
     }
 
     @Override
@@ -852,7 +874,7 @@ public class MyLocationView extends View {
       locationChangeAnimator = ValueAnimator.ofFloat(0.0f, 1.0f);
       locationChangeAnimator.setDuration(locationUpdateDuration);
       locationChangeAnimator.addUpdateListener(new MarkerCoordinateAnimatorListener(this,
-        latLng, newLocation
+              latLng, newLocation
       ));
       locationChangeAnimator.start();
       latLng = newLocation;