Android Tilt Implementation

android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/MapView.java

@@ -51,8 +51,8 @@
 import android.widget.FrameLayout;
 import android.widget.ImageView;
 import android.widget.ZoomButtonsController;
-
 import com.almeros.android.multitouch.gesturedetectors.RotateGestureDetector;
+import com.almeros.android.multitouch.gesturedetectors.ShoveGestureDetector;
 import com.almeros.android.multitouch.gesturedetectors.TwoFingerGestureDetector;
 import com.mapbox.mapboxsdk.R;
 import com.mapbox.mapboxsdk.annotations.Annotation;
@@ -118,6 +118,7 @@ public final class MapView extends FrameLayout {
     private static final String STATE_ZOOM_ENABLED = "zoomEnabled";
     private static final String STATE_SCROLL_ENABLED = "scrollEnabled";
     private static final String STATE_ROTATE_ENABLED = "rotateEnabled";
+    private static final String STATE_TILT_ENABLED = "tiltEnabled";
     private static final String STATE_ZOOM_CONTROLS_ENABLED = "zoomControlsEnabled";
     private static final String STATE_DEBUG_ACTIVE = "debugActive";
     private static final String STATE_STYLE_URL = "styleUrl";
@@ -162,6 +163,14 @@ public final class MapView extends FrameLayout {
      */
     public static final double MAXIMUM_ZOOM_LEVEL = 18.0;
 
+    /**
+     * The currently supported maximum and minimum tilt values.
+     *
+     * @see MapView#setTilt(double)
+     */
+    private static final double MINIMUM_TILT = 0;
+    private static final double MAXIMUM_TILT = 60;
+
     //
     // Instance members
     //
@@ -179,6 +188,7 @@ public final class MapView extends FrameLayout {
     private GestureDetectorCompat mGestureDetector;
     private ScaleGestureDetector mScaleGestureDetector;
     private RotateGestureDetector mRotateGestureDetector;
+    private ShoveGestureDetector mShoveGestureDetector;
     private boolean mTwoTap = false;
     private boolean mZoomStarted = false;
     private boolean mQuickZoom = false;
@@ -241,6 +251,7 @@ public final class MapView extends FrameLayout {
     private boolean mZoomEnabled = true;
     private boolean mScrollEnabled = true;
     private boolean mRotateEnabled = true;
+    private boolean mTiltEnabled = true;
     private boolean mAllowConcurrentMultipleOpenInfoWindows = false;
     private String mStyleUrl;
 
@@ -681,6 +692,7 @@ private void initialize(Context context, AttributeSet attrs) {
         mScaleGestureDetector = new ScaleGestureDetector(context, new ScaleGestureListener());
         ScaleGestureDetectorCompat.setQuickScaleEnabled(mScaleGestureDetector, true);
         mRotateGestureDetector = new RotateGestureDetector(context, new RotateGestureListener());
+        mShoveGestureDetector = new ShoveGestureDetector(context, new ShoveGestureListener());
 
         // Shows the zoom controls
         if (!context.getPackageManager()
@@ -726,6 +738,7 @@ private void initialize(Context context, AttributeSet attrs) {
             setZoomEnabled(typedArray.getBoolean(R.styleable.MapView_zoom_enabled, true));
             setScrollEnabled(typedArray.getBoolean(R.styleable.MapView_scroll_enabled, true));
             setRotateEnabled(typedArray.getBoolean(R.styleable.MapView_rotate_enabled, true));
+            setTiltEnabled(typedArray.getBoolean(R.styleable.MapView_tilt_enabled, true));
             setZoomControlsEnabled(typedArray.getBoolean(R.styleable.MapView_zoom_controls_enabled, isZoomControlsEnabled()));
             setDebugActive(typedArray.getBoolean(R.styleable.MapView_debug_active, false));
             if (typedArray.getString(R.styleable.MapView_style_url) != null) {
@@ -801,6 +814,7 @@ public void onCreate(@Nullable Bundle savedInstanceState) {
             setZoomEnabled(savedInstanceState.getBoolean(STATE_ZOOM_ENABLED));
             setScrollEnabled(savedInstanceState.getBoolean(STATE_SCROLL_ENABLED));
             setRotateEnabled(savedInstanceState.getBoolean(STATE_ROTATE_ENABLED));
+            setTiltEnabled(savedInstanceState.getBoolean(STATE_TILT_ENABLED));
             setZoomControlsEnabled(savedInstanceState.getBoolean(STATE_ZOOM_CONTROLS_ENABLED));
             setDebugActive(savedInstanceState.getBoolean(STATE_DEBUG_ACTIVE));
             setStyleUrl(savedInstanceState.getString(STATE_STYLE_URL));
@@ -881,6 +895,7 @@ public void onSaveInstanceState(@NonNull Bundle outState) {
         outState.putBoolean(STATE_ZOOM_ENABLED, isZoomEnabled());
         outState.putBoolean(STATE_SCROLL_ENABLED, isScrollEnabled());
         outState.putBoolean(STATE_ROTATE_ENABLED, isRotateEnabled());
+        outState.putBoolean(STATE_TILT_ENABLED, isTiltEnabled());
         outState.putBoolean(STATE_ZOOM_CONTROLS_ENABLED, isZoomControlsEnabled());
         outState.putBoolean(STATE_DEBUG_ACTIVE, isDebugActive());
         outState.putString(STATE_STYLE_URL, getStyleUrl());
@@ -1101,6 +1116,32 @@ public void setScrollEnabled(boolean scrollEnabled) {
         this.mScrollEnabled = scrollEnabled;
     }
 
+    //
+    // Pitch / Tilt
+    //
+
+    /**
+     * Gets the current Tilt in degrees of the MapView
+     * @return tilt in degrees
+     */
+    public double getTilt() {
+        return mNativeMapView.getPitch();
+    }
+
+    /**
+     * Sets the Tilt in degrees of the MapView.
+     * @param pitch New tilt in degrees
+     * @param duration Animation time in milliseconds.  If null then 0 is used, making the animation immediate.
+     */
+    @FloatRange(from = MINIMUM_TILT, to = MAXIMUM_TILT)
+    public void setTilt(Double pitch, @Nullable Long duration) {
+        long actualDuration = 0;
+        if (duration != null) {
+            actualDuration = duration;
+        }
+        mNativeMapView.setPitch(pitch, actualDuration);
+    }
+
     //
     // Rotation
     //
@@ -1335,6 +1376,35 @@ private void zoom(boolean zoomIn, float x, float y) {
         }
     }
 
+    //
+    // Tilt
+    //
+
+    /**
+     * Returns whether the user may tilt the map.
+     *
+     * @return If true, tilting is enabled.
+     */
+    @UiThread
+    public boolean isTiltEnabled() {
+        return mTiltEnabled;
+    }
+
+    /**
+     * Changes whether the user may tilt the map.
+     * <p/>
+     * This setting controls only user interactions with the map. If you set the value to false,
+     * you may still change the map location programmatically.
+     * <p/>
+     * The default value is true.
+     *
+     * @param tiltEnabled If true, tilting is enabled.
+     */
+    @UiThread
+    public void setTiltEnabled(boolean tiltEnabled) {
+        this.mTiltEnabled = tiltEnabled;
+    }
+
     //
     // InfoWindows
     //
@@ -2380,11 +2450,13 @@ protected void onVisibilityChanged(@NonNull View changedView, int visibility) {
      * @see MapView#setZoomEnabled(boolean)
      * @see MapView#setScrollEnabled(boolean)
      * @see MapView#setRotateEnabled(boolean)
+     * @see MapView#setTiltEnabled(boolean)
      */
     public void setAllGesturesEnabled(boolean enabled) {
         setZoomEnabled(enabled);
         setScrollEnabled(enabled);
         setRotateEnabled(enabled);
+        setTiltEnabled(enabled);
     }
 
     // Called when user touches the screen, all positions are absolute
@@ -2399,6 +2471,7 @@ public boolean onTouchEvent(@NonNull MotionEvent event) {
         // Check two finger gestures first
         mRotateGestureDetector.onTouchEvent(event);
         mScaleGestureDetector.onTouchEvent(event);
+        mShoveGestureDetector.onTouchEvent(event);
 
         // Handle two finger tap
         switch (event.getActionMasked()) {
@@ -2420,7 +2493,9 @@ public boolean onTouchEvent(@NonNull MotionEvent event) {
                 // First pointer up
                 long tapInterval = event.getEventTime() - event.getDownTime();
                 boolean isTap = tapInterval <= ViewConfiguration.getTapTimeout();
-                boolean inProgress = mRotateGestureDetector.isInProgress() || mScaleGestureDetector.isInProgress();
+                boolean inProgress = mRotateGestureDetector.isInProgress()
+                        || mScaleGestureDetector.isInProgress()
+                        || mShoveGestureDetector.isInProgress();
 
                 if (mTwoTap && isTap && !inProgress) {
                     PointF focalPoint = TwoFingerGestureDetector.determineFocalPoint(event);
@@ -2789,6 +2864,71 @@ public boolean onRotate(RotateGestureDetector detector) {
         }
     }
 
+    // This class handles a vertical two-finger shove. (If you place two fingers on screen with
+    // less than a 20 degree angle between them, this will detect movement on the Y-axis.)
+    private class ShoveGestureListener implements ShoveGestureDetector.OnShoveGestureListener {
+
+        long mBeginTime = 0;
+        float mTotalDelta = 0.0f;
+        boolean mStarted = false;
+
+        @Override
+        public boolean onShoveBegin(ShoveGestureDetector detector) {
+            if (!mTiltEnabled) {
+                return false;
+            }
+
+            mBeginTime = detector.getEventTime();
+            return true;
+        }
+
+        @Override
+        public void onShoveEnd(ShoveGestureDetector detector) {
+            mBeginTime = 0;
+            mTotalDelta = 0.0f;
+            mStarted = false;
+        }
+
+        @Override
+        public boolean onShove(ShoveGestureDetector detector) {
+            if (!mTiltEnabled) {
+                return false;
+            }
+
+            // If tilt is large enough ignore a tap
+            // Also if zoom already started, don't tilt
+            mTotalDelta += detector.getShovePixelsDelta();
+            if (!mZoomStarted && ((mTotalDelta > 10.0f) || (mTotalDelta < -10.0f))) {
+                mStarted = true;
+            }
+
+            // Ignore short touches in case it is a tap
+            // Also ignore small tilt
+            long time = detector.getEventTime();
+            long interval = time - mBeginTime;
+            if (!mStarted && (interval <= ViewConfiguration.getTapTimeout())) {
+                return false;
+            }
+
+            if (!mStarted) {
+                return false;
+            }
+
+            // Cancel any animation
+            mNativeMapView.cancelTransitions();
+
+            // Get tilt value (scale and clamp)
+            double pitch = mNativeMapView.getPitch();
+            pitch += 0.1 * detector.getShovePixelsDelta();
+            pitch = Math.max(MINIMUM_TILT, Math.min(MAXIMUM_TILT, pitch));
+
+            // Tilt the map
+            setTilt(pitch, null);
+
+            return true;
+        }
+    }
+
     // This class handles input events from the zoom control buttons
     // Zoom controls allow single touch only devices to zoom in and out
     private class OnZoomListener implements ZoomButtonsController.OnZoomListener {

android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/views/NativeMapView.java

@@ -256,6 +256,14 @@ public void resetPosition() {
         nativeResetPosition(mNativeMapViewPtr);
     }
 
+    public double getPitch() {
+        return nativeGetPitch(mNativeMapViewPtr);
+    }
+
+    public void setPitch(double pitch, long duration) {
+        nativeSetPitch(mNativeMapViewPtr, pitch, duration);
+    }
+
     public void scaleBy(double ds) {
         scaleBy(ds, -1.0, -1.0);
     }
@@ -533,6 +541,10 @@ private native void nativeSetLatLng(long nativeMapViewPtr, LatLng latLng,
 
     private native void nativeResetPosition(long nativeMapViewPtr);
 
+    private native double nativeGetPitch(long nativeMapViewPtr);
+
+    private native void nativeSetPitch(long nativeMapViewPtr, double pitch, long duration);
+
     private native void nativeScaleBy(long nativeMapViewPtr, double ds,
                                       double cx, double cy, long duration);
 

android/MapboxGLAndroidSDK/src/main/res/values/attrs.xml

@@ -8,6 +8,7 @@
         <attr name="zoom_enabled" format="boolean" />
         <attr name="scroll_enabled" format="boolean" />
         <attr name="rotate_enabled" format="boolean" />
+        <attr name="tilt_enabled" format="boolean" />
         <attr name="zoom_controls_enabled" format="boolean" />
         <attr name="debug_active" format="boolean" />
         <attr name="style_url" format="string" />

android/MapboxGLAndroidSDKTestApp/src/main/AndroidManifest.xml

@@ -13,7 +13,6 @@
         android:label="@string/app_name"
         android:supportsRtl="true"
         android:theme="@style/AppTheme">
-
         <activity
             android:name=".MainActivity"
             android:label="@string/app_name">
@@ -23,47 +22,41 @@
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
-
         <activity
             android:name=".VisibleCoordinateBoundsActivity"
             android:label="@string/activity_visible_coordinate_bounds" />
-
         <activity
             android:name=".InfoWindowAdapterActivity"
             android:label="@string/activity_infowindow_adapter" />
-
         <activity
             android:name=".InfoWindowActivity"
             android:label="@string/activity_info_window" />
-
         <activity
             android:name=".BulkMarkerActivity"
             android:configChanges="orientation|keyboardHidden|screenSize"
             android:label="@string/action_add_bulk_markers" />
-
+        <activity
+            android:name=".TiltActivity"
+            android:label="@string/activity_tilt" />
         <activity
             android:name=".MapFragmentActivity"
             android:label="@string/activity_map_fragment" />
-
         <activity
             android:name=".PressForMarkerActivity"
             android:label="@string/activity_press_for_marker" />
-
-        <activity android:name=".ManualZoomActivity"
-                  android:label="@string/action_manual_zoom"/>
-
+        <activity
+            android:name=".ManualZoomActivity"
+            android:label="@string/action_manual_zoom" />
         <activity
             android:name=".MyLocationTrackingModeActivity"
             android:label="@string/activity_user_tracking_mode" />
-
         <activity
             android:name=".PolylineActivity"
             android:label="@string/activity_polyline" />
 
         <meta-data
             android:name="io.fabric.ApiKey"
             android:value="9724157045ff7d083492c6d9ae03e60e8609d461" />
-
         <meta-data
             android:name="com.mapbox.AccessToken"
             android:value="" />

android/MapboxGLAndroidSDKTestApp/src/main/java/com/mapbox/mapboxsdk/testapp/MainActivity.java

@@ -341,6 +341,10 @@ public boolean onNavigationItemSelected(MenuItem menuItem) {
                                 startActivity(new Intent(getApplicationContext(), InfoWindowAdapterActivity.class));
                                 return true;
 
+                            case R.id.action_tilt:
+                                startActivity(new Intent(getApplicationContext(), TiltActivity.class));
+                                return true;
+
                             case R.id.action_map_fragment:
                                 startActivity(new Intent(getApplicationContext(), MapFragmentActivity.class));
                                 return true;