[android] expose camera padding option

This removes the cached insets on the Android side, making the core TransformState the source of truth. This still leaves an option to lazily set the padding which is going to be applied only when the next camera animation is started.

5 files changed, 82 insertions, 52 deletions

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 8e1019b379..acd5093dad 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
@@ -1540,24 +1540,38 @@ public final class MapboxMap {
    * frame from the viewport. For instance, if the only the top edge is inset, the
    * map center is effectively shifted downward.
    * </p>
+   * <p>
+   * This method sets the padding "lazily".
+   * This means that the <b>padding is going to be applied with the next camera transformation.</b>
+   * To apply the padding immediately use {@link CameraPosition.Builder#padding(double, double, double, double)}
+   * or {@link CameraUpdateFactory#paddingTo(double, double, double, double)}.
+   * </p>
    *
    * @param left   The left margin in pixels.
    * @param top    The top margin in pixels.
    * @param right  The right margin in pixels.
    * @param bottom The bottom margin in pixels.
+   * @deprecated Use {@link CameraPosition.Builder#padding(double, double, double, double)}
+   * or {@link CameraUpdateFactory#paddingTo(double, double, double, double)} instead.
    */
+  @Deprecated
   public void setPadding(int left, int top, int right, int bottom) {
+    // TODO padding should be passed as doubles
     projection.setContentPadding(new int[] {left, top, right, bottom});
     uiSettings.invalidate();
   }
 
   /**
-   * Returns the current configured content padding on map view.
+   * Returns the current configured content padding on map view. This might return the currently visible padding
+   * or the padding cached but not yet applied by {@link #setPadding(int, int, int, int)}.
    *
    * @return An array with length 4 in the LTRB order.
+   * @deprecated Use {@link CameraPosition#padding} instead.
    */
+  @Deprecated
   @NonNull
   public int[] getPadding() {
+    // TODO this should return double[] (semver major change)
     return projection.getContentPadding();
   }
 
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/NativeMap.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/NativeMap.java
index da70013713..7f3017c7ae 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/NativeMap.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/NativeMap.java
@@ -41,12 +41,12 @@ interface NativeMap {
   // Camera API
   //
 
-  void jumpTo(@NonNull LatLng center, double zoom, double pitch, double bearing);
+  void jumpTo(@NonNull LatLng center, double zoom, double pitch, double bearing, double[] padding);
 
-  void easeTo(@NonNull LatLng center, double zoom, double bearing, double pitch, long duration,
+  void easeTo(@NonNull LatLng center, double zoom, double bearing, double pitch, double[] padding, long duration,
               boolean easingInterpolator);
 
-  void flyTo(@NonNull LatLng center, double zoom, double bearing, double pitch, long duration);
+  void flyTo(@NonNull LatLng center, double zoom, double bearing, double pitch, double[] padding, long duration);
 
   void moveBy(double deltaX, double deltaY, long duration);
 
@@ -161,9 +161,9 @@ interface NativeMap {
   // Content padding API
   //
 
-  void setContentPadding(float[] padding);
+  void setContentPadding(double[] padding);
 
-  float[] getContentPadding();
+  double[] getContentPadding();
 
   //
   // Query API
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/NativeMapView.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/NativeMapView.java
index fc68a408fa..8496160c7e 100755
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/NativeMapView.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/NativeMapView.java
@@ -10,6 +10,7 @@ import android.support.annotation.Keep;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 import android.text.TextUtils;
+
 import com.mapbox.geojson.Feature;
 import com.mapbox.geojson.Geometry;
 import com.mapbox.mapboxsdk.LibraryLoader;
@@ -68,6 +69,10 @@ final class NativeMapView implements NativeMap {
   // Flag to indicate destroy was called
   private boolean destroyed = false;
 
+  // Cached to enable lazily set padding.
+  // Whenever an animation is schedule, this value is cleared and the source of truth becomes the core transform state.
+  private double[] edgeInsets;
+
   // Holds the pointer to JNI NativeMapView
   @Keep
   private long nativePtr = 0;
@@ -241,7 +246,8 @@ final class NativeMapView implements NativeMap {
     if (checkState("setLatLng")) {
       return;
     }
-    nativeSetLatLng(latLng.getLatitude(), latLng.getLongitude(), duration);
+    nativeSetLatLng(latLng.getLatitude(), latLng.getLongitude(),
+      getAnimationPaddingAndClearCachedInsets(null), duration);
   }
 
   @Override
@@ -374,30 +380,20 @@ final class NativeMapView implements NativeMap {
   }
 
   @Override
-  public void setContentPadding(float[] padding) {
+  public void setContentPadding(double[] padding) {
     if (checkState("setContentPadding")) {
       return;
     }
-    // TopLeftBottomRight
-    nativeSetContentPadding(
-      padding[1] / pixelRatio,
-      padding[0] / pixelRatio,
-      padding[3] / pixelRatio,
-      padding[2] / pixelRatio);
+    this.edgeInsets = padding;
   }
 
   @Override
-  public float[] getContentPadding() {
+  public double[] getContentPadding() {
     if (checkState("getContentPadding")) {
-      return new float[] {0, 0, 0, 0};
+      return new double[] {0, 0, 0, 0};
     }
-    float[] topLeftBottomRight = nativeGetContentPadding();
-    return new float[] {
-      topLeftBottomRight[1] * pixelRatio,
-      topLeftBottomRight[0] * pixelRatio,
-      topLeftBottomRight[3] * pixelRatio,
-      topLeftBottomRight[2] * pixelRatio
-    };
+    // if cached insets are not applied yet, return them, otherwise, get the padding from the camera
+    return edgeInsets != null ? edgeInsets : getCameraPosition().padding;
   }
 
   @Override
@@ -672,29 +668,31 @@ final class NativeMapView implements NativeMap {
   }
 
   @Override
-  public void jumpTo(@NonNull LatLng center, double zoom, double pitch, double angle) {
+  public void jumpTo(@NonNull LatLng center, double zoom, double pitch, double angle, double[] padding) {
     if (checkState("jumpTo")) {
       return;
     }
-    nativeJumpTo(angle, center.getLatitude(), center.getLongitude(), pitch, zoom);
+    nativeJumpTo(angle, center.getLatitude(), center.getLongitude(), pitch, zoom,
+      getAnimationPaddingAndClearCachedInsets(padding));
   }
 
   @Override
-  public void easeTo(@NonNull LatLng center, double zoom, double angle, double pitch, long duration,
+  public void easeTo(@NonNull LatLng center, double zoom, double angle, double pitch, double[] padding, long duration,
                      boolean easingInterpolator) {
     if (checkState("easeTo")) {
       return;
     }
     nativeEaseTo(angle, center.getLatitude(), center.getLongitude(), duration, pitch, zoom,
-      easingInterpolator);
+      getAnimationPaddingAndClearCachedInsets(padding), easingInterpolator);
   }
 
   @Override
-  public void flyTo(@NonNull LatLng center, double zoom, double angle, double pitch, long duration) {
+  public void flyTo(@NonNull LatLng center, double zoom, double angle, double pitch, double[] padding, long duration) {
     if (checkState("flyTo")) {
       return;
     }
-    nativeFlyTo(angle, center.getLatitude(), center.getLongitude(), duration, pitch, zoom);
+    nativeFlyTo(angle, center.getLatitude(), center.getLongitude(), duration, pitch, zoom,
+      getAnimationPaddingAndClearCachedInsets(padding));
   }
 
   @Override
@@ -703,7 +701,11 @@ final class NativeMapView implements NativeMap {
     if (checkState("getCameraValues")) {
       return new CameraPosition.Builder().build();
     }
-    return nativeGetCameraPosition();
+    if (edgeInsets != null) {
+      return new CameraPosition.Builder(nativeGetCameraPosition()).padding(edgeInsets).build();
+    } else {
+      return nativeGetCameraPosition();
+    }
   }
 
   @Override
@@ -1126,7 +1128,7 @@ final class NativeMapView implements NativeMap {
   private native void nativeMoveBy(double dx, double dy, long duration);
 
   @Keep
-  private native void nativeSetLatLng(double latitude, double longitude, long duration);
+  private native void nativeSetLatLng(double latitude, double longitude, double[] padding, long duration);
 
   @NonNull
   @Keep
@@ -1176,12 +1178,6 @@ final class NativeMapView implements NativeMap {
   private native void nativeRotateBy(double sx, double sy, double ex, double ey, long duration);
 
   @Keep
-  private native void nativeSetContentPadding(float top, float left, float bottom, float right);
-
-  @Keep
-  private native float[] nativeGetContentPadding();
-
-  @Keep
   private native void nativeSetBearing(double degrees, long duration);
 
   @Keep
@@ -1270,16 +1266,17 @@ final class NativeMapView implements NativeMap {
   private native double nativeGetTopOffsetPixelsForAnnotationSymbol(String symbolName);
 
   @Keep
-  private native void nativeJumpTo(double angle, double latitude, double longitude, double pitch, double zoom);
+  private native void nativeJumpTo(double angle, double latitude, double longitude, double pitch, double zoom,
+                                   double[] padding);
 
   @Keep
   private native void nativeEaseTo(double angle, double latitude, double longitude,
-                                   long duration, double pitch, double zoom,
+                                   long duration, double pitch, double zoom, double[] padding,
                                    boolean easingInterpolator);
 
   @Keep
   private native void nativeFlyTo(double angle, double latitude, double longitude,
-                                  long duration, double pitch, double zoom);
+                                  long duration, double pitch, double zoom, double[] padding);
 
   @NonNull
   @Keep
@@ -1437,6 +1434,20 @@ final class NativeMapView implements NativeMap {
     return destroyed;
   }
 
+  private double[] getAnimationPaddingAndClearCachedInsets(double[] providedPadding) {
+    if (providedPadding == null) {
+      providedPadding = this.edgeInsets;
+    }
+    this.edgeInsets = null;
+    return providedPadding == null ? null :
+      new double[] {
+        providedPadding[1] / pixelRatio,
+        providedPadding[0] / pixelRatio,
+        providedPadding[3] / pixelRatio,
+        providedPadding[2] / pixelRatio
+      };
+  }
+
   public interface ViewCallback {
     @Nullable
     Bitmap getViewContent();
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/Projection.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/Projection.java
index 8ed003b821..76395f9564 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/Projection.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/Projection.java
@@ -3,6 +3,7 @@ package com.mapbox.mapboxsdk.maps;
 import android.graphics.PointF;
 import android.support.annotation.FloatRange;
 import android.support.annotation.NonNull;
+
 import com.mapbox.geojson.Point;
 import com.mapbox.mapboxsdk.constants.GeometryConstants;
 import com.mapbox.mapboxsdk.geometry.LatLng;
@@ -24,7 +25,6 @@ public class Projection {
   private final NativeMap nativeMapView;
   @NonNull
   private final MapView mapView;
-  private int[] contentPadding = new int[] {0, 0, 0, 0};
 
   Projection(@NonNull NativeMap nativeMapView, @NonNull MapView mapView) {
     this.nativeMapView = nativeMapView;
@@ -32,8 +32,7 @@ public class Projection {
   }
 
   void setContentPadding(int[] contentPadding) {
-    this.contentPadding = contentPadding;
-    float[] output = new float[contentPadding.length];
+    double[] output = new double[contentPadding.length];
     for (int i = 0; i < contentPadding.length; i++) {
       output[i] = contentPadding[i];
     }
@@ -41,11 +40,15 @@ public class Projection {
   }
 
   int[] getContentPadding() {
-    return contentPadding;
+    double[] padding = nativeMapView.getCameraPosition().padding;
+    return new int[] {(int) padding[0], (int) padding[1], (int) padding[2], (int) padding[3]};
   }
 
+  /**
+   * @deprecated unused
+   */
+  @Deprecated
   public void invalidateContentPadding() {
-    setContentPadding(contentPadding);
   }
 
   /**
@@ -126,10 +129,11 @@ public class Projection {
       top = 0;
       bottom = mapView.getHeight();
     } else {
-      left = (float) contentPadding[0];
-      right = (float) (mapView.getWidth() - contentPadding[2]);
-      top = (float) contentPadding[1];
-      bottom = (float) (mapView.getHeight() - contentPadding[3]);
+      int[] contentPadding = getContentPadding();
+      left = contentPadding[0];
+      right = mapView.getWidth() - contentPadding[2];
+      top = contentPadding[1];
+      bottom = mapView.getHeight() - contentPadding[3];
     }
 
     LatLng center = fromScreenLocation(new PointF(left + (right - left) / 2, top + (bottom - top) / 2));
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/Transform.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/Transform.java
index 1961cf0450..02cd05545d 100644
--- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/Transform.java
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/Transform.java
@@ -108,7 +108,8 @@ public final class Transform implements MapView.OnCameraDidChangeListener {
     if (isValidCameraPosition(cameraPosition)) {
       cancelTransitions();
       cameraChangeDispatcher.onCameraMoveStarted(OnCameraMoveStartedListener.REASON_API_ANIMATION);
-      nativeMap.jumpTo(cameraPosition.target, cameraPosition.zoom, cameraPosition.tilt, cameraPosition.bearing);
+      nativeMap.jumpTo(cameraPosition.target, cameraPosition.zoom, cameraPosition.tilt, cameraPosition.bearing,
+        cameraPosition.padding);
       cameraChangeDispatcher.onCameraIdle();
       invalidateCameraPosition();
       handler.post(new Runnable() {
@@ -135,7 +136,7 @@ public final class Transform implements MapView.OnCameraDidChangeListener {
       }
       mapView.addOnCameraDidChangeListener(this);
       nativeMap.easeTo(cameraPosition.target, cameraPosition.zoom, cameraPosition.bearing, cameraPosition.tilt,
-        durationMs, easingInterpolator);
+        cameraPosition.padding, durationMs, easingInterpolator);
     }
   }
 
@@ -155,7 +156,7 @@ public final class Transform implements MapView.OnCameraDidChangeListener {
       }
       mapView.addOnCameraDidChangeListener(this);
       nativeMap.flyTo(cameraPosition.target, cameraPosition.zoom, cameraPosition.bearing,
-        cameraPosition.tilt, durationMs);
+        cameraPosition.tilt, cameraPosition.padding, durationMs);
     }
   }