Add NavigationCamera#update for MapboxMap animations

app/src/main/java/com/mapbox/services/android/navigation/testapp/activity/navigationui/ComponentNavigationActivity.java

@@ -9,6 +9,7 @@
 import android.os.VibrationEffect;
 import android.os.Vibrator;
 import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
 import android.support.constraint.ConstraintLayout;
 import android.support.design.widget.BaseTransientBottomBar;
 import android.support.design.widget.FloatingActionButton;
@@ -26,6 +27,7 @@
 import com.mapbox.geojson.Point;
 import com.mapbox.mapboxsdk.Mapbox;
 import com.mapbox.mapboxsdk.camera.CameraPosition;
+import com.mapbox.mapboxsdk.camera.CameraUpdate;
 import com.mapbox.mapboxsdk.camera.CameraUpdateFactory;
 import com.mapbox.mapboxsdk.geometry.LatLng;
 import com.mapbox.mapboxsdk.geometry.LatLngBounds;
@@ -38,6 +40,7 @@
 import com.mapbox.services.android.navigation.testapp.activity.HistoryActivity;
 import com.mapbox.services.android.navigation.ui.v5.camera.DynamicCamera;
 import com.mapbox.services.android.navigation.ui.v5.camera.NavigationCamera;
+import com.mapbox.services.android.navigation.ui.v5.camera.NavigationCameraUpdate;
 import com.mapbox.services.android.navigation.ui.v5.instruction.InstructionView;
 import com.mapbox.services.android.navigation.ui.v5.map.NavigationMapboxMap;
 import com.mapbox.services.android.navigation.ui.v5.voice.NavigationSpeechPlayer;
@@ -171,7 +174,6 @@ public boolean onMapLongClick(@NonNull LatLng point) {
 
   @OnClick(R.id.startNavigationFab)
   public void onStartNavigationClick(FloatingActionButton floatingActionButton) {
-    navigationMap.updateCameraTrackingMode(NavigationCamera.NAVIGATION_TRACKING_MODE_GPS);
     // Transition to navigation state
     mapState = MapState.NAVIGATION;
 
@@ -188,6 +190,14 @@ public void onStartNavigationClick(FloatingActionButton floatingActionButton) {
 
     // Location updates will be received from ProgressChangeListener
     removeLocationEngineListener();
+
+    // TODO remove example usage
+    navigationMap.resetCameraPositionWith(NavigationCamera.NAVIGATION_TRACKING_MODE_GPS);
+    CameraUpdate cameraUpdate = cameraOverheadUpdate();
+    if (cameraUpdate != null) {
+      NavigationCameraUpdate navUpdate = new NavigationCameraUpdate(cameraUpdate);
+      navigationMap.retrieveCamera().update(navUpdate);
+    }
   }
 
   @OnClick(R.id.cancelNavigationFab)
@@ -388,6 +398,15 @@ private void moveCameraOverhead() {
     );
   }
 
+  @Nullable
+  private CameraUpdate cameraOverheadUpdate() {
+    if (lastLocation == null) {
+      return null;
+    }
+    CameraPosition cameraPosition = buildCameraPositionFrom(lastLocation, DEFAULT_BEARING);
+    return CameraUpdateFactory.newCameraPosition(cameraPosition);
+  }
+
   @NonNull
   private CameraPosition buildCameraPositionFrom(Location location, double bearing) {
     return new CameraPosition.Builder()

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/NavigationContract.java

@@ -5,7 +5,6 @@
 
 import com.mapbox.api.directions.v5.models.DirectionsRoute;
 import com.mapbox.geojson.Point;
-import com.mapbox.services.android.navigation.ui.v5.camera.NavigationCamera;
 
 public interface NavigationContract {
 
@@ -21,8 +20,6 @@ interface View {
 
     void updateWayNameView(@NonNull String wayName);
 
-    void updateCameraTrackingMode(@NavigationCamera.TrackingMode int trackingMode);
-
     void resetCameraPosition();
 
     void showRecenterBtn();

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/NavigationPresenter.java

@@ -7,7 +7,6 @@
 import com.mapbox.api.directions.v5.models.DirectionsRoute;
 import com.mapbox.core.utils.TextUtils;
 import com.mapbox.geojson.Point;
-import com.mapbox.services.android.navigation.ui.v5.camera.NavigationCamera;
 
 class NavigationPresenter {
 
@@ -34,7 +33,6 @@ void onCameraTrackingDismissed() {
     if (!view.isSummaryBottomSheetHidden()) {
       view.setSummaryBehaviorHideable(true);
       view.setSummaryBehaviorState(BottomSheetBehavior.STATE_HIDDEN);
-      view.updateCameraTrackingMode(NavigationCamera.NAVIGATION_TRACKING_MODE_NONE);
       view.updateWayNameVisibility(false);
     }
   }

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/NavigationView.java

@@ -243,14 +243,6 @@ public boolean isSummaryBottomSheetHidden() {
     return summaryBehavior.getState() == BottomSheetBehavior.STATE_HIDDEN;
   }
 
-
-  @Override
-  public void updateCameraTrackingMode(int trackingMode) {
-    if (navigationMap != null) {
-      navigationMap.updateCameraTrackingMode(trackingMode);
-    }
-  }
-
   @Override
   public void resetCameraPosition() {
     if (navigationMap != null) {

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/camera/CameraAnimationDelegate.java

@@ -0,0 +1,37 @@
+package com.mapbox.services.android.navigation.ui.v5.camera;
+
+import com.mapbox.mapboxsdk.camera.CameraUpdate;
+import com.mapbox.mapboxsdk.location.modes.CameraMode;
+import com.mapbox.mapboxsdk.maps.MapboxMap;
+
+class CameraAnimationDelegate {
+
+  private final MapboxMap mapboxMap;
+
+  CameraAnimationDelegate(MapboxMap mapboxMap) {
+    this.mapboxMap = mapboxMap;
+  }
+
+  void render(NavigationCameraUpdate update, int durationMs, MapboxMap.CancelableCallback callback) {
+    handle(update, durationMs, callback);
+  }
+
+  private void handle(NavigationCameraUpdate update, int durationMs, MapboxMap.CancelableCallback callback) {
+    CameraUpdateMode mode = update.getMode();
+    CameraUpdate cameraUpdate = update.getCameraUpdate();
+    if (mode == CameraUpdateMode.OVERRIDE) {
+      mapboxMap.getLocationComponent().setCameraMode(CameraMode.NONE);
+      mapboxMap.animateCamera(cameraUpdate, durationMs, callback);
+    } else if (!isTracking()) {
+      mapboxMap.animateCamera(cameraUpdate, durationMs, callback);
+    }
+  }
+
+  private boolean isTracking() {
+    int cameraMode = mapboxMap.getLocationComponent().getCameraMode();
+    return cameraMode == CameraMode.TRACKING
+      || cameraMode == CameraMode.TRACKING_COMPASS
+      || cameraMode == CameraMode.TRACKING_GPS
+      || cameraMode == CameraMode.TRACKING_GPS_NORTH;
+  }
+}

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/camera/CameraUpdateMode.java

@@ -0,0 +1,8 @@
+package com.mapbox.services.android.navigation.ui.v5.camera;
+
+public enum CameraUpdateMode {
+
+  DEFAULT,
+
+  OVERRIDE
+}

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/camera/NavigationCamera.java

@@ -14,9 +14,11 @@
 import com.mapbox.mapboxsdk.camera.CameraPosition;
 import com.mapbox.mapboxsdk.camera.CameraUpdate;
 import com.mapbox.mapboxsdk.camera.CameraUpdateFactory;
+import com.mapbox.mapboxsdk.constants.MapboxConstants;
 import com.mapbox.mapboxsdk.geometry.LatLng;
 import com.mapbox.mapboxsdk.geometry.LatLngBounds;
 import com.mapbox.mapboxsdk.location.LocationComponent;
+import com.mapbox.mapboxsdk.location.OnCameraTrackingChangedListener;
 import com.mapbox.mapboxsdk.location.OnLocationCameraTransitionListener;
 import com.mapbox.mapboxsdk.location.modes.CameraMode;
 import com.mapbox.mapboxsdk.maps.MapboxMap;
@@ -74,6 +76,8 @@ public class NavigationCamera implements LifecycleObserver {
     = new CopyOnWriteArrayList<>();
   private final OnLocationCameraTransitionListener cameraTransitionListener
     = new NavigationCameraTransitionListener(this);
+  private final OnCameraTrackingChangedListener cameraTrackingChangedListener
+    = new NavigationCameraTrackingChangedListener(this);
   private MapboxMap mapboxMap;
   private LocationComponent locationComponent;
   private MapboxNavigation navigation;
@@ -82,6 +86,7 @@ public class NavigationCamera implements LifecycleObserver {
   @TrackingMode
   private int trackingCameraMode = NAVIGATION_TRACKING_MODE_GPS;
   private boolean isCameraResetting;
+  private CameraAnimationDelegate animationDelegate;
   private ProgressChangeListener progressChangeListener = new ProgressChangeListener() {
     @Override
     public void onProgressChange(Location location, RouteProgress routeProgress) {
@@ -107,6 +112,8 @@ public NavigationCamera(@NonNull MapboxMap mapboxMap, @NonNull MapboxNavigation
     this.mapboxMap = mapboxMap;
     this.navigation = navigation;
     this.locationComponent = locationComponent;
+    this.animationDelegate = new CameraAnimationDelegate(mapboxMap);
+    this.locationComponent.addOnCameraTrackingChangedListener(cameraTrackingChangedListener);
     initializeWith(navigation);
   }
 
@@ -121,6 +128,8 @@ public NavigationCamera(@NonNull MapboxMap mapboxMap, @NonNull MapboxNavigation
   public NavigationCamera(@NonNull MapboxMap mapboxMap, LocationComponent locationComponent) {
     this.mapboxMap = mapboxMap;
     this.locationComponent = locationComponent;
+    this.animationDelegate = new CameraAnimationDelegate(mapboxMap);
+    this.locationComponent.addOnCameraTrackingChangedListener(cameraTrackingChangedListener);
     updateCameraTrackingMode(trackingCameraMode);
   }
 
@@ -212,6 +221,18 @@ public void showRouteOverview(int[] padding) {
     animateCameraForRouteOverview(routeInformation, padding);
   }
 
+  public void update(NavigationCameraUpdate update) {
+    animationDelegate.render(update, MapboxConstants.ANIMATION_DURATION, null);
+  }
+
+  public void update(NavigationCameraUpdate update, int durationMs) {
+    animationDelegate.render(update, durationMs, null);
+  }
+
+  public void update(NavigationCameraUpdate update, int durationMs, @Nullable MapboxMap.CancelableCallback callback) {
+    animationDelegate.render(update, durationMs, callback);
+  }
+
   /**
    * Call in {@link FragmentActivity#onStart()} to properly add the {@link ProgressChangeListener}
    * for the camera and prevent any leaks or further updates.
@@ -309,6 +330,19 @@ void updateTransitionListenersCancelled(@CameraMode.Mode int cameraMode) {
     }
   }
 
+  @Nullable
+  Integer findTrackingModeFor(@CameraMode.Mode int cameraMode) {
+    if (cameraMode == CameraMode.TRACKING_GPS) {
+      return NAVIGATION_TRACKING_MODE_GPS;
+    } else if (cameraMode == CameraMode.TRACKING_GPS_NORTH) {
+      return NAVIGATION_TRACKING_MODE_NORTH;
+    } else if (cameraMode == CameraMode.NONE) {
+      return NAVIGATION_TRACKING_MODE_NONE;
+    } else {
+      return null;
+    }
+  }
+
   void updateIsResetting(boolean isResetting) {
     this.isCameraResetting = isResetting;
   }
@@ -429,19 +463,6 @@ private Integer findCameraModeFor(@TrackingMode int trackingCameraMode) {
     }
   }
 
-  @Nullable
-  private Integer findTrackingModeFor(@CameraMode.Mode int cameraMode) {
-    if (cameraMode == CameraMode.TRACKING_GPS) {
-      return NAVIGATION_TRACKING_MODE_GPS;
-    } else if (cameraMode == CameraMode.TRACKING_GPS_NORTH) {
-      return NAVIGATION_TRACKING_MODE_NORTH;
-    } else if (cameraMode == CameraMode.NONE) {
-      return NAVIGATION_TRACKING_MODE_NONE;
-    } else {
-      return null;
-    }
-  }
-
   private void updateTrackingModeListenersWith(@TrackingMode int trackingMode) {
     for (OnTrackingModeChangedListener listener : onTrackingModeChangedListeners) {
       listener.onTrackingModeChanged(trackingMode);

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/camera/NavigationCameraTrackingChangedListener.java

@@ -0,0 +1,25 @@
+package com.mapbox.services.android.navigation.ui.v5.camera;
+
+import com.mapbox.mapboxsdk.location.OnCameraTrackingChangedListener;
+
+class NavigationCameraTrackingChangedListener implements OnCameraTrackingChangedListener {
+
+  private final NavigationCamera camera;
+
+  NavigationCameraTrackingChangedListener(NavigationCamera camera) {
+    this.camera = camera;
+  }
+
+  @Override
+  public void onCameraTrackingDismissed() {
+    camera.updateCameraTrackingMode(NavigationCamera.NAVIGATION_TRACKING_MODE_NONE);
+  }
+
+  @Override
+  public void onCameraTrackingChanged(int currentMode) {
+    Integer trackingMode = camera.findTrackingModeFor(currentMode);
+    if (trackingMode != null) {
+      camera.updateCameraTrackingMode(trackingMode);
+    }
+  }
+}

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/camera/NavigationCameraUpdate.java

@@ -0,0 +1,30 @@
+package com.mapbox.services.android.navigation.ui.v5.camera;
+
+import android.support.annotation.NonNull;
+
+import com.mapbox.mapboxsdk.camera.CameraUpdate;
+
+public class NavigationCameraUpdate {
+
+  private final CameraUpdate cameraUpdate;
+  private CameraUpdateMode mode = CameraUpdateMode.DEFAULT;
+
+  public NavigationCameraUpdate(@NonNull CameraUpdate cameraUpdate) {
+    this.cameraUpdate = cameraUpdate;
+  }
+
+  public NavigationCameraUpdate setMode(CameraUpdateMode mode) {
+    this.mode = mode;
+    return this;
+  }
+
+  @NonNull
+  CameraUpdate getCameraUpdate() {
+    return cameraUpdate;
+  }
+
+  @NonNull
+  CameraUpdateMode getMode() {
+    return mode;
+  }
+}