Place picker map position (#335)

* Forward onDestroy() events from MapView to MapzenMap

* Save current map position onDestroy

* Save zoom, rotation, and tilt too

* Do not re-init map on configuration change

* Set default zoom before calculating bounding box

* Javadoc

Author: ecgreb

core/src/main/java/com/mapzen/android/graphics/MapView.java

@@ -40,6 +40,7 @@ public class MapView extends RelativeLayout {
   TextView attribution;
 
   private int overlayMode = OVERLAY_MODE_SDK;
+  private MapzenMap mapzenMap;
 
   /**
    * Create new instance.
@@ -241,6 +242,11 @@ public TextView getAttribution() {
    * You must call this method from the parent Activity/Fragment's corresponding method.
    */
   public void onDestroy() {
+    mapzenMap.onDestroy();
     getTangramMapView().onDestroy();
   }
+
+  void setMapzenMap(MapzenMap mapzenMap) {
+    this.mapzenMap = mapzenMap;
+  }
 }

core/src/main/java/com/mapzen/android/graphics/MapzenMap.java

@@ -136,6 +136,7 @@ public boolean onRotate(float x, float y, float rotation) {
     this.overlayManager = overlayManager;
     this.mapStateManager = mapStateManager;
     this.labelPickHandler = labelPickHandler;
+    mapView.setMapzenMap(this);
     mapController.setPanResponder(internalPanResponder);
     mapController.setRotateResponder(internalRotateResponder);
     overlayManager.restoreMapData();
@@ -832,4 +833,14 @@ private void restoreMapState() {
     setTilt(mapStateManager.getTilt());
     setCameraType(mapStateManager.getCameraType());
   }
+
+  /**
+   * Invoked by {@link MapView} when the parent activity or fragment is destroyed.
+   */
+  void onDestroy() {
+    mapStateManager.setPosition(mapController.getPosition());
+    mapStateManager.setZoom(mapController.getZoom());
+    mapStateManager.setRotation(mapController.getRotation());
+    mapStateManager.setTilt(mapController.getTilt());
+  }
 }

core/src/test/java/com/mapzen/android/graphics/MapViewTest.java

@@ -91,6 +91,13 @@ public class MapViewTest {
     assertThat(layoutInflater.getRoot()).isEqualTo(mapView);
   }
 
+  @Test public void onDestroy_shouldDestroyMapzenMap() throws Exception {
+    MapzenMap map = mock(MapzenMap.class);
+    mapView.setMapzenMap(map);
+    mapView.onDestroy();
+    verify(map).onDestroy();
+  }
+
   private void initMockAttributes(Context context, TypedArray typedArray,
       TestLayoutInflater layoutInflater, int overlayMode) {
     when(context.obtainStyledAttributes(any(AttributeSet.class), eq(R.styleable.MapView)))

core/src/test/java/com/mapzen/android/graphics/MapzenMapTest.java

@@ -45,6 +45,7 @@ public class MapzenMapTest {
   private TestMapController mapController;
   private OverlayManager overlayManager;
   private LabelPickHandler labelPickHandler;
+  private MapStateManager mapStateManager;
 
   @Before public void setUp() throws Exception {
     mapView = new TestMapView();
@@ -54,8 +55,16 @@ public class MapzenMapTest {
     doCallRealMethod().when(mapController).pickFeature(anyFloat(), anyFloat());
     doCallRealMethod().when(mapController).queueSceneUpdate(any(SceneUpdate.class));
     doCallRealMethod().when(mapController).getSceneUpdate();
+    doCallRealMethod().when(mapController).setPosition(any(LngLat.class));
+    doCallRealMethod().when(mapController).getPosition();
+    doCallRealMethod().when(mapController).setZoom(anyFloat());
+    doCallRealMethod().when(mapController).getZoom();
+    doCallRealMethod().when(mapController).setRotation(anyFloat());
+    doCallRealMethod().when(mapController).getRotation();
+    doCallRealMethod().when(mapController).setTilt(anyFloat());
+    doCallRealMethod().when(mapController).getTilt();
     overlayManager = mock(OverlayManager.class);
-    MapStateManager mapStateManager = new MapStateManager();
+    mapStateManager = new MapStateManager();
     labelPickHandler = new LabelPickHandler(mapView);
     map = new MapzenMap(mapView, mapController, overlayManager, mapStateManager, labelPickHandler);
   }
@@ -527,6 +536,31 @@ public class MapzenMapTest {
     verify(mapController).applySceneUpdates();
   }
 
+  @Test public void onDestroy_shouldPersistMapPosition() throws Exception {
+    LngLat position = new LngLat(1, 2);
+    mapController.setPosition(position);
+    map.onDestroy();
+    assertThat(mapStateManager.getPosition()).isEqualTo(position);
+  }
+
+  @Test public void onDestroy_shouldPersistMapZoom() throws Exception {
+    mapController.setZoom(15);
+    map.onDestroy();
+    assertThat(mapStateManager.getZoom()).isEqualTo(15);
+  }
+
+  @Test public void onDestroy_shouldPersistMapRotation() throws Exception {
+    mapController.setRotation(3.14f);
+    map.onDestroy();
+    assertThat(mapStateManager.getRotation()).isEqualTo(3.14f);
+  }
+
+  @Test public void onDestroy_shouldPersistMapTilt() throws Exception {
+    mapController.setTilt(1.57f);
+    map.onDestroy();
+    assertThat(mapStateManager.getTilt()).isEqualTo(1.57f);
+  }
+
   public class TestRotateResponder implements TouchInput.RotateResponder {
 
     boolean rotated = false;

core/src/test/java/com/mapzen/android/graphics/TestMapController.java

@@ -28,6 +28,11 @@ public TestMapController() {
     super(new GLSurfaceView(getMockContext()));
   }
 
+  @Override public void setPosition(LngLat position) {
+    longitude = position.longitude;
+    latitude = position.latitude;
+  }
+
   @Override public void setPositionEased(LngLat lngLat, int duration) {
     longitude = lngLat.longitude;
     latitude = lngLat.latitude;

mapzen-places-api/src/main/java/com/mapzen/places/api/internal/PlacePickerActivity.java

@@ -39,6 +39,8 @@ public class PlacePickerActivity extends Activity implements
   AlertDialog dialog;
   String dialogPlaceId;
 
+  private boolean mapInitComplete = false;
+
   @Override protected void onCreate(Bundle savedInstanceState) {
     super.onCreate(savedInstanceState);
     setContentView(R.layout.place_picker_activity);
@@ -53,6 +55,10 @@ public class PlacePickerActivity extends Activity implements
         callbackHandler));
     presenter.setController(this);
 
+    if (savedInstanceState != null) {
+      mapInitComplete = true;
+    }
+
     mapView = (MapView) findViewById(R.id.mz_map_view);
     mapView.getMapAsync(this);
   }
@@ -67,6 +73,15 @@ public class PlacePickerActivity extends Activity implements
     presenter.onShowView();
   }
 
+  @Override protected void onDestroy() {
+    super.onDestroy();
+    mapView.onDestroy();
+  }
+
+  @Override protected void onSaveInstanceState(Bundle outState) {
+    super.onSaveInstanceState(new Bundle());
+  }
+
   @Override public void setMyLocationEnabled(boolean enabled) {
     if (map != null) {
       map.setMyLocationEnabled(enabled);
@@ -130,6 +145,15 @@ public class PlacePickerActivity extends Activity implements
   private void initializeMap() {
     map.setMyLocationEnabled(true);
     map.setLabelPickListener(this);
+    map.setPersistMapState(true);
+    if (!mapInitComplete) {
+      initMapView();
+    }
+  }
+
+  private void initMapView() {
+    // The calculation below fails if map.getZoom() returns 0 so set a reasonable default zoom.
+    map.setZoom(15);
 
     Bundle extras = getIntent().getExtras();
     if (extras != null) {

samples/mapzen-android-sdk-sample/src/main/java/com/mapzen/android/sdk/sample/BasicMapzenActivity.java

@@ -77,6 +77,7 @@ private void configureMap(boolean enabled) {
 
     map.setCompassButtonEnabled(true);
     map.setZoomButtonsEnabled(true);
+    map.setPersistMapState(true);
   }
 
   @Override protected void onPause() {