Add CameraPosition option for initializing NavigationView

Author: danesfeder

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

@@ -24,6 +24,8 @@
 import com.mapbox.api.directions.v5.models.DirectionsRoute;
 import com.mapbox.geojson.Point;
 import com.mapbox.mapboxsdk.Mapbox;
+import com.mapbox.mapboxsdk.camera.CameraPosition;
+import com.mapbox.mapboxsdk.geometry.LatLng;
 import com.mapbox.services.android.navigation.testapp.R;
 import com.mapbox.services.android.navigation.ui.v5.NavigationView;
 import com.mapbox.services.android.navigation.ui.v5.NavigationViewOptions;
@@ -46,6 +48,7 @@ public class EmbeddedNavigationActivity extends AppCompatActivity implements OnN
 
   private static final Point ORIGIN = Point.fromLngLat(-77.03194990754128, 38.909664963450105);
   private static final Point DESTINATION = Point.fromLngLat(-77.0270025730133, 38.91057077063121);
+  private static final int INITIAL_ZOOM = 16;
 
   private NavigationView navigationView;
   private View spacer;
@@ -67,8 +70,12 @@ protected void onCreate(@Nullable Bundle savedInstanceState) {
     spacer = findViewById(R.id.spacer);
     setSpeedWidgetAnchor(R.id.summaryBottomSheet);
 
+    CameraPosition initialPosition = new CameraPosition.Builder()
+      .target(new LatLng(ORIGIN.latitude(), ORIGIN.longitude()))
+      .zoom(INITIAL_ZOOM)
+      .build();
     navigationView.onCreate(savedInstanceState);
-    navigationView.initialize(this);
+    navigationView.initialize(this, initialPosition);
   }
 
   @Override

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

@@ -65,6 +65,7 @@ public class NavigationLauncherActivity extends AppCompatActivity implements OnM
   private static final int CAMERA_ANIMATION_DURATION = 1000;
   private static final int DEFAULT_CAMERA_ZOOM = 16;
   private static final int CHANGE_SETTING_REQUEST_CODE = 1;
+  private static final int INITIAL_ZOOM = 16;
 
   private LocationEngine locationEngine;
   private NavigationMapRoute mapRoute;
@@ -332,9 +333,12 @@ private void launchNavigationWithRoute() {
     NavigationLauncherOptions.Builder optionsBuilder = NavigationLauncherOptions.builder()
       .shouldSimulateRoute(getShouldSimulateRouteFromSharedPreferences())
       .directionsProfile(getRouteProfileFromSharedPreferences());
-
+    CameraPosition initialPosition = new CameraPosition.Builder()
+      .target(new LatLng(currentLocation.latitude(), currentLocation.longitude()))
+      .zoom(INITIAL_ZOOM)
+      .build();
+    optionsBuilder.initialMapCameraPosition(initialPosition);
     optionsBuilder.directionsRoute(route);
-
     NavigationLauncher.startNavigation(this, optionsBuilder.build());
   }
 

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

@@ -2,12 +2,14 @@
 
 import android.content.SharedPreferences;
 import android.os.Bundle;
+import android.os.Parcelable;
 import android.preference.PreferenceManager;
 import android.support.annotation.Nullable;
 import android.support.v7.app.AppCompatActivity;
 
 import com.mapbox.api.directions.v5.DirectionsCriteria;
 import com.mapbox.api.directions.v5.models.DirectionsRoute;
+import com.mapbox.mapboxsdk.camera.CameraPosition;
 import com.mapbox.services.android.navigation.ui.v5.listeners.NavigationListener;
 import com.mapbox.services.android.navigation.v5.navigation.MapboxNavigationOptions;
 import com.mapbox.services.android.navigation.v5.navigation.NavigationConstants;
@@ -29,7 +31,7 @@ protected void onCreate(@Nullable Bundle savedInstanceState) {
     setContentView(R.layout.activity_navigation);
     navigationView = findViewById(R.id.navigationView);
     navigationView.onCreate(savedInstanceState);
-    navigationView.initialize(this);
+    initialize();
   }
 
   @Override
@@ -116,6 +118,15 @@ public void onNavigationRunning() {
     // Intentionally empty
   }
 
+  private void initialize() {
+    Parcelable position = getIntent().getParcelableExtra(NavigationConstants.NAVIGATION_VIEW_INITIAL_MAP_POSITION);
+    if (position != null) {
+      navigationView.initialize(this, (CameraPosition) position);
+    } else {
+      navigationView.initialize(this);
+    }
+  }
+
   private void extractRoute(NavigationViewOptions.Builder options) {
     DirectionsRoute route = NavigationLauncher.extractRoute(this);
     options.directionsRoute(route);

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

@@ -44,6 +44,7 @@ public static void startNavigation(Activity activity, NavigationLauncherOptions
     editor.apply();
 
     Intent navigationActivity = new Intent(activity, MapboxNavigationActivity.class);
+    storeInitialMapPosition(options, navigationActivity);
     activity.startActivity(navigationActivity);
   }
 
@@ -87,4 +88,12 @@ private static void storeThemePreferences(NavigationLauncherOptions options, Sha
       }
     }
   }
+
+  private static void storeInitialMapPosition(NavigationLauncherOptions options, Intent navigationActivity) {
+    if (options.initialMapCameraPosition() != null) {
+      navigationActivity.putExtra(
+        NavigationConstants.NAVIGATION_VIEW_INITIAL_MAP_POSITION, options.initialMapCameraPosition()
+      );
+    }
+  }
 }

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

@@ -1,8 +1,11 @@
 package com.mapbox.services.android.navigation.ui.v5;
 
+import android.support.annotation.Nullable;
+
 import com.google.auto.value.AutoValue;
 import com.mapbox.api.directions.v5.DirectionsCriteria;
 import com.mapbox.api.directions.v5.models.DirectionsRoute;
+import com.mapbox.mapboxsdk.camera.CameraPosition;
 
 @AutoValue
 public abstract class NavigationLauncherOptions extends NavigationUiOptions {
@@ -11,6 +14,9 @@ public abstract class NavigationLauncherOptions extends NavigationUiOptions {
 
   public abstract boolean snapToRoute();
 
+  @Nullable
+  public abstract CameraPosition initialMapCameraPosition();
+
   @AutoValue.Builder
   public abstract static class Builder {
 
@@ -30,6 +36,8 @@ public abstract static class Builder {
 
     public abstract Builder snapToRoute(boolean snapToRoute);
 
+    public abstract Builder initialMapCameraPosition(@Nullable CameraPosition initialMapCameraPosition);
+
     public abstract NavigationLauncherOptions build();
   }
 

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

@@ -9,6 +9,7 @@
 import android.content.res.Resources;
 import android.location.Location;
 import android.os.Bundle;
+import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 import android.support.design.widget.BottomSheetBehavior;
 import android.support.design.widget.CoordinatorLayout;
@@ -20,6 +21,7 @@
 import com.mapbox.api.directions.v5.models.DirectionsRoute;
 import com.mapbox.api.directions.v5.models.RouteOptions;
 import com.mapbox.geojson.Point;
+import com.mapbox.mapboxsdk.camera.CameraPosition;
 import com.mapbox.mapboxsdk.constants.MapboxConstants;
 import com.mapbox.mapboxsdk.maps.MapView;
 import com.mapbox.mapboxsdk.maps.MapboxMap;
@@ -81,6 +83,7 @@ public class NavigationView extends CoordinatorLayout implements LifecycleObserv
   private OnNavigationReadyCallback onNavigationReadyCallback;
   private NavigationOnCameraTrackingChangedListener onTrackingChangedListener;
   private NavigationMapboxMapInstanceState mapInstanceState;
+  private CameraPosition initialMapCameraPosition;
   private boolean isMapInitialized;
   private boolean isSubscribed;
 
@@ -269,6 +272,10 @@ private void initializeNavigationMap(MapView mapView, MapboxMap map) {
     navigationMap = new NavigationMapboxMap(mapView, map);
     if (mapInstanceState != null) {
       navigationMap.restoreFrom(mapInstanceState);
+      return;
+    }
+    if (initialMapCameraPosition != null) {
+      map.setCameraPosition(initialMapCameraPosition);
     }
   }
 
@@ -376,7 +383,7 @@ public void stopNavigation() {
    * Should be called after {@link NavigationView#onCreate(Bundle)}.
    * <p>
    * This method adds the {@link OnNavigationReadyCallback},
-   * which will fire ready / cancel events for this view.
+   * which will fire the ready events for this view.
    *
    * @param onNavigationReadyCallback to be set to this view
    */
@@ -389,6 +396,29 @@ public void initialize(OnNavigationReadyCallback onNavigationReadyCallback) {
     }
   }
 
+  /**
+   * Should be called after {@link NavigationView#onCreate(Bundle)}.
+   * <p>
+   * This method adds the {@link OnNavigationReadyCallback},
+   * which will fire the ready events for this view.
+   * <p>
+   * This method also accepts a {@link CameraPosition} that will be set as soon as the map is
+   * ready.  Note, this position is ignored during rotation in favor of the last know map position.
+   *
+   * @param onNavigationReadyCallback to be set to this view
+   * @param initialMapCameraPosition  to be shown once the map is ready
+   */
+  public void initialize(OnNavigationReadyCallback onNavigationReadyCallback,
+                         @NonNull CameraPosition initialMapCameraPosition) {
+    this.onNavigationReadyCallback = onNavigationReadyCallback;
+    this.initialMapCameraPosition = initialMapCameraPosition;
+    if (!isMapInitialized) {
+      mapView.getMapAsync(this);
+    } else {
+      onNavigationReadyCallback.onNavigationReady(navigationViewModel.isRunning());
+    }
+  }
+
   /**
    * Gives the ability to manipulate the map directly for anything that might not currently be
    * supported. This returns null until the view is initialized.

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

@@ -142,6 +142,11 @@ private NavigationConstants() {
    */
   public static final String NAVIGATION_VIEW_DARK_THEME = "navigation_view_dark_theme";
 
+  /**
+   * NavigationLauncher key for storing initial map position in Intent
+   */
+  public static final String NAVIGATION_VIEW_INITIAL_MAP_POSITION = "navigation_view_initial_map_position";
+
   /**
    * In seconds, how quickly {@link com.mapbox.services.android.navigation.v5.route.FasterRouteDetector}
    * will tell {@link RouteProcessorBackgroundThread} to check