Bitmap markers (#340)

* Upgrades Tangram to version 0.5.1

* Adds basic bitmap marker support using drawable resource

* Adds custom marker demo

* Javadoc

* Adds marker pick listener callback

* Fix NPE

* Markers should be removable

* Invoke map controller marker pick only if listener has been set

* Disable my location layer in custom marker demo

Author: ecgreb

core/build.gradle

@@ -19,7 +19,7 @@ group = GROUP
 version = VERSION_NAME
 project.archivesBaseName = POM_ARTIFACT_ID
 
-ext.tangram_version = "0.5.0"
+ext.tangram_version = "0.5.1"
 
 android {
   compileSdkVersion 25

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

@@ -3,6 +3,7 @@
 import com.mapzen.android.core.MapzenManager;
 import com.mapzen.android.graphics.model.BubbleWrapStyle;
 import com.mapzen.android.graphics.model.MapStyle;
+import com.mapzen.android.graphics.model.MarkerManager;
 import com.mapzen.tangram.MapController;
 import com.mapzen.tangram.SceneUpdate;
 
@@ -92,7 +93,8 @@ private void loadMap(final MapView mapView, String sceneFile, final OnMapReadyCa
         mapController.setHttpHandler(tileHttpHandler);
         callback.onMapReady(
             new MapzenMap(mapView, mapController, new OverlayManager(mapView, mapController,
-                mapDataManager, mapStateManager), mapStateManager, new LabelPickHandler(mapView)));
+                mapDataManager, mapStateManager), mapStateManager, new LabelPickHandler(mapView),
+                new MarkerManager(mapController)));
       }
     }, sceneFile, sceneUpdates);
   }

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

@@ -1,14 +1,18 @@
 package com.mapzen.android.graphics;
 
+import com.mapzen.android.graphics.model.BitmapMarker;
 import com.mapzen.android.graphics.model.CameraType;
 import com.mapzen.android.graphics.model.EaseType;
 import com.mapzen.android.graphics.model.MapStyle;
 import com.mapzen.android.graphics.model.Marker;
+import com.mapzen.android.graphics.model.MarkerManager;
+import com.mapzen.android.graphics.model.MarkerOptions;
 import com.mapzen.android.graphics.model.Polygon;
 import com.mapzen.android.graphics.model.Polyline;
 import com.mapzen.tangram.LngLat;
 import com.mapzen.tangram.MapController;
 import com.mapzen.tangram.MapData;
+import com.mapzen.tangram.MarkerPickResult;
 import com.mapzen.tangram.SceneUpdate;
 import com.mapzen.tangram.TouchInput;
 
@@ -36,9 +40,11 @@ public class MapzenMap {
   private final OverlayManager overlayManager;
   private final MapStateManager mapStateManager;
   private final LabelPickHandler labelPickHandler;
+  private final MarkerManager markerManager;
 
   boolean pickFeatureOnSingleTapConfirmed = false;
   boolean pickLabelOnSingleTapConfirmed = false;
+  boolean pickMarkerOnSingleTapConfirmed = false;
 
   private TouchInput.TapResponder internalTapResponder = new TouchInput.TapResponder() {
     @Override public boolean onSingleTapUp(float x, float y) {
@@ -58,6 +64,9 @@ public class MapzenMap {
       if (pickLabelOnSingleTapConfirmed) {
         mapController.pickLabel(x, y);
       }
+      if (pickMarkerOnSingleTapConfirmed) {
+        mapController.pickMarker(x, y);
+      }
       return false;
     }
   };
@@ -130,12 +139,14 @@ public boolean onRotate(float x, float y, float rotation) {
    * Creates a new map based on the given {@link MapView} and {@link MapController}.
    */
   MapzenMap(MapView mapView, MapController mapController, OverlayManager overlayManager,
-      MapStateManager mapStateManager, LabelPickHandler labelPickHandler) {
+      MapStateManager mapStateManager, LabelPickHandler labelPickHandler,
+      MarkerManager markerManager) {
     this.mapView = mapView;
     this.mapController = mapController;
     this.overlayManager = overlayManager;
     this.mapStateManager = mapStateManager;
     this.labelPickHandler = labelPickHandler;
+    this.markerManager = markerManager;
     mapView.setMapzenMap(this);
     mapController.setPanResponder(internalPanResponder);
     mapController.setRotateResponder(internalRotateResponder);
@@ -611,6 +622,29 @@ public void setLabelPickListener(final LabelPickListener listener) {
     mapController.setTapResponder(internalTapResponder);
   }
 
+  /**
+   * Set a listener for marker pick events.
+   *
+   * @param listener Listener to receive callback when markers are selected.
+   */
+  public void setMarkerPickListener(final MarkerPickListener listener) {
+    mapController.setMarkerPickListener(new MapController.MarkerPickListener() {
+      @Override
+      public void onMarkerPick(final MarkerPickResult markerPickResult, final float positionX,
+          final float positionY) {
+        mapView.post(new Runnable() {
+          @Override public void run() {
+            if (markerPickResult != null) {
+              listener.onMarkerPick(new BitmapMarker(markerManager, markerPickResult.getMarker()));
+            }
+          }
+        });
+      }
+    });
+    pickMarkerOnSingleTapConfirmed = (listener != null);
+    mapController.setTapResponder(internalTapResponder);
+  }
+
   private void postFeaturePickRunnable(final Map<String, String> properties, final float positionX,
       final float positionY, final FeaturePickListener listener) {
     mapView.post(new Runnable() {
@@ -843,4 +877,14 @@ void onDestroy() {
     mapStateManager.setRotation(mapController.getRotation());
     mapStateManager.setTilt(mapController.getTilt());
   }
+
+  /**
+   * Adds a custom bitmap marker to the map.
+   *
+   * @param markerOptions options used to define marker appearance.
+   * @return a new bitmap marker instance.
+   */
+  public BitmapMarker addBitmapMarker(MarkerOptions markerOptions) {
+    return markerManager.addMarker(markerOptions);
+  }
 }

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

@@ -0,0 +1,14 @@
+package com.mapzen.android.graphics;
+
+import com.mapzen.android.graphics.model.BitmapMarker;
+
+/**
+ * Listener invoked when a marker on the map is selected.
+ */
+public interface MarkerPickListener {
+  /**
+   * Receives information about markers found in a call to {@link
+   * com.mapzen.tangram.MapController#pickMarker(float, float)} (float, float)}.
+   */
+  void onMarkerPick(BitmapMarker marker);
+}

core/src/main/java/com/mapzen/android/graphics/model/BitmapMarker.java

@@ -0,0 +1,29 @@
+package com.mapzen.android.graphics.model;
+
+import com.mapzen.tangram.Marker;
+
+/**
+ * Dynamic marker overlay constructed using a local bitmap.
+ */
+public class BitmapMarker {
+  private final MarkerManager markerManager;
+  private final Marker tangramMarker;
+
+  /**
+   * Constructor that wraps a Tangram marker.
+   *
+   * @param tangramMarker the underlying Tangram marker object.
+   */
+  public BitmapMarker(MarkerManager markerManager, Marker tangramMarker) {
+    this.markerManager = markerManager;
+    this.tangramMarker = tangramMarker;
+  }
+
+  /**
+   * Removes this marker from the map. After a marker has been removed, the behavior of all its
+   * methods is undefined.
+   */
+  public void remove() {
+    markerManager.removeMarker(tangramMarker);
+  }
+}

core/src/main/java/com/mapzen/android/graphics/model/MarkerManager.java

@@ -0,0 +1,43 @@
+package com.mapzen.android.graphics.model;
+
+import com.mapzen.tangram.MapController;
+import com.mapzen.tangram.Marker;
+
+/**
+ * Manages {@link BitmapMarker} instances on the map.
+ */
+public class MarkerManager {
+  private final MapController mapController;
+
+  /**
+   * Constructor.
+   *
+   * @param mapController Tangram map controller used to generate markers.
+   */
+  public MarkerManager(MapController mapController) {
+    this.mapController = mapController;
+  }
+
+  /**
+   * Adds a new marker to the map.
+   *
+   * @param markerOptions options that define the appearance of the marker.
+   * @return a new bitmap marker wrapper for the Tangram marker object.
+   */
+  public BitmapMarker addMarker(MarkerOptions markerOptions) {
+    final Marker marker = mapController.addMarker();
+    marker.setPoint(markerOptions.getPosition());
+    marker.setDrawable(markerOptions.getIcon());
+    marker.setStylingFromString(markerOptions.getStyle());
+    return new BitmapMarker(this, marker);
+  }
+
+  /**
+   * Removes a marker from the map.
+   *
+   * @param marker Tangram marker to be removed.
+   */
+  public void removeMarker(Marker marker) {
+    mapController.removeMarker(marker);
+  }
+}

core/src/main/java/com/mapzen/android/graphics/model/MarkerOptions.java

@@ -0,0 +1,67 @@
+package com.mapzen.android.graphics.model;
+
+import com.mapzen.R;
+import com.mapzen.tangram.LngLat;
+
+/**
+ * Defines options for a {@link BitmapMarker}.
+ */
+public class MarkerOptions {
+  private static final LngLat DEFAULT_POSITION = new LngLat(-73.985428, 40.748817);
+  private static final int DEFAULT_DRAWABLE = R.drawable.mapzen;
+  private static final String DEFAULT_STYLE = "{ style: 'points', color: 'white',"
+      + "size: [50px, 50px], collide: false, interactive: true }";
+
+  private LngLat position = DEFAULT_POSITION;
+  private int resId = DEFAULT_DRAWABLE;
+  private String style = DEFAULT_STYLE;
+
+  // Setters
+
+  /**
+   * Set the marker position.
+   *
+   * @param position coordinate to display the marker.
+   * @return this marker options instance.
+   */
+  public MarkerOptions position(LngLat position) {
+    this.position = position;
+    return this;
+  }
+
+  /**
+   * Set the marker icon resource ID.
+   *
+   * @param resId drawable resource ID for the marker to display.
+   * @return this marker options instance.
+   */
+  public MarkerOptions icon(int resId) {
+    this.resId = resId;
+    return this;
+  }
+
+  /**
+   * Set the marker icon style string.
+   *
+   * @param style Tangram style string used to define the marker appearance.
+   * @return this marker options instance.
+   */
+  public MarkerOptions style(String style) {
+    this.style = style;
+    return this;
+  }
+
+  // Getters
+
+  public LngLat getPosition() {
+    return position;
+  }
+
+  public int getIcon() {
+    return resId;
+  }
+
+  public String getStyle() {
+    return style;
+  }
+}

core/src/main/res/drawable/mapzen.png

@@ -1,8 +1,10 @@
 package com.mapzen.android.graphics;
 
+import com.mapzen.android.graphics.model.BitmapMarker;
 import com.mapzen.android.graphics.model.CameraType;
 import com.mapzen.android.graphics.model.EaseType;
 import com.mapzen.android.graphics.model.Marker;
+import com.mapzen.android.graphics.model.MarkerManager;
 import com.mapzen.android.graphics.model.Polygon;
 import com.mapzen.android.graphics.model.Polyline;
 import com.mapzen.tangram.LabelPickResult;
@@ -46,13 +48,17 @@ public class MapzenMapTest {
   private OverlayManager overlayManager;
   private LabelPickHandler labelPickHandler;
   private MapStateManager mapStateManager;
+  private MarkerManager markerManager;
 
   @Before public void setUp() throws Exception {
     mapView = new TestMapView();
     mapController = mock(TestMapController.class);
     doCallRealMethod().when(mapController)
         .setFeaturePickListener(any(MapController.FeaturePickListener.class));
     doCallRealMethod().when(mapController).pickFeature(anyFloat(), anyFloat());
+    doCallRealMethod().when(mapController)
+        .setMarkerPickListener(any(MapController.MarkerPickListener.class));
+    doCallRealMethod().when(mapController).pickMarker(anyFloat(), anyFloat());
     doCallRealMethod().when(mapController).queueSceneUpdate(any(SceneUpdate.class));
     doCallRealMethod().when(mapController).getSceneUpdate();
     doCallRealMethod().when(mapController).setPosition(any(LngLat.class));
@@ -66,7 +72,9 @@ public class MapzenMapTest {
     overlayManager = mock(OverlayManager.class);
     mapStateManager = new MapStateManager();
     labelPickHandler = new LabelPickHandler(mapView);
-    map = new MapzenMap(mapView, mapController, overlayManager, mapStateManager, labelPickHandler);
+    markerManager = new MarkerManager(mapController);
+    map = new MapzenMap(mapView, mapController, overlayManager, mapStateManager, labelPickHandler,
+        markerManager);
   }
 
   @Test public void shouldNotBeNull() throws Exception {
@@ -473,7 +481,7 @@ public class MapzenMapTest {
     verify(overlayManager).clearTransitRouteLine();
   }
 
-  @Test public void setFeaturePickListener_shouldInvokeFeatureListener() {
+  @Test public void setFeaturePickListener_shouldInvokeFeatureListener() throws Exception {
     TestFeaturePickListener listener = new TestFeaturePickListener();
     map.setFeaturePickListener(listener);
     mapController.pickFeature(0, 0);
@@ -487,6 +495,20 @@ public class MapzenMapTest {
     assertThat(mapView.getAction()).isNotNull();
   }
 
+  @Test public void setMarkerPickListener_shouldInvokeMarkerListener() throws Exception {
+    TestMarkerPickListener listener = new TestMarkerPickListener();
+    map.setMarkerPickListener(listener);
+    mapController.pickMarker(0, 0);
+    assertThat(listener.picked).isTrue();
+  }
+
+  @Test public void setMarkerPickListener_shouldInvokeCallbackOnMainThread() throws Exception {
+    TestMarkerPickListener listener = new TestMarkerPickListener();
+    map.setMarkerPickListener(listener);
+    mapController.pickMarker(0, 0);
+    assertThat(mapView.getAction()).isNotNull();
+  }
+
   @Test public void setLabelPickListener_shouldInvokeLabelListener() {
     TestLabelPickListener listener = new TestLabelPickListener();
     map.setLabelPickListener(listener);
@@ -581,6 +603,16 @@ public void onFeaturePick(Map<String, String> properties, float positionX, float
     }
   }
 
+  private class TestMarkerPickListener implements MarkerPickListener {
+
+    boolean picked = false;
+
+    @Override
+    public void onMarkerPick(BitmapMarker marker) {
+      picked = true;
+    }
+  }
+
   private class TestLabelPickListener implements LabelPickListener {
 
     boolean picked = false;