summaryrefslogtreecommitdiff
path: root/platform/android/MapboxGLAndroidSDK/src/main/java/com/almeros/android/multitouch/gesturedetectors/ShoveGestureDetector.java
blob: 9396578e48ab560ee1e34179bf9bbcb60c9814f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
package com.almeros.android.multitouch.gesturedetectors;

import android.content.Context;
import android.view.MotionEvent;

/**
 * @author Robert Nordan (robert.nordan@norkart.no)
 *         <p>
 *         Copyright (c) 2013, Norkart AS
 *         <p>
 *         All rights reserved.
 *         <p>
 *         Redistribution and use in source and binary forms, with or without
 *         modification, are permitted provided that the following conditions
 *         are met:
 *         <p>
 *         Redistributions of source code must retain the above copyright
 *         notice, this list of conditions and the following disclaimer.
 *         Redistributions in binary form must reproduce the above copyright
 *         notice, this list of conditions and the following disclaimer in the
 *         documentation and/or other materials provided with the distribution.
 *         <p>
 *         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *         "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *         LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *         A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *         HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *         INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *         BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 *         OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 *         AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *         LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 *         WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *         POSSIBILITY OF SUCH DAMAGE.
 */
public class ShoveGestureDetector extends TwoFingerGestureDetector {

  /**
   * Listener which must be implemented which is used by ShoveGestureDetector
   * to perform callbacks to any implementing class which is registered to a
   * ShoveGestureDetector via the constructor.
   *
   * @see ShoveGestureDetector.SimpleOnShoveGestureListener
   */
  public interface OnShoveGestureListener {
    public boolean onShove(ShoveGestureDetector detector);

    public boolean onShoveBegin(ShoveGestureDetector detector);

    public void onShoveEnd(ShoveGestureDetector detector);
  }

  /**
   * Helper class which may be extended and where the methods may be
   * implemented. This way it is not necessary to implement all methods of
   * OnShoveGestureListener.
   */
  public static class SimpleOnShoveGestureListener implements
    OnShoveGestureListener {
    public boolean onShove(ShoveGestureDetector detector) {
      return false;
    }

    public boolean onShoveBegin(ShoveGestureDetector detector) {
      return true;
    }

    public void onShoveEnd(ShoveGestureDetector detector) {
      // Do nothing, overridden implementation may be used
    }
  }

  private float prevAverageY;
  private float currAverageY;

  private final OnShoveGestureListener listener;
  private boolean sloppyGesture;

  public ShoveGestureDetector(Context context, OnShoveGestureListener listener) {
    super(context);
    this.listener = listener;
  }

  @Override
  protected void handleStartProgressEvent(int actionCode, MotionEvent event) {
    switch (actionCode) {
      case MotionEvent.ACTION_POINTER_DOWN:
        // At least the second finger is on screen now

        resetState(); // In case we missed an UP/CANCEL event
        prevEvent = MotionEvent.obtain(event);
        timeDelta = 0;

        updateStateByEvent(event);

        // See if we have a sloppy gesture
        sloppyGesture = isSloppyGesture(event);
        if (!sloppyGesture) {
          // No, start gesture now
          gestureInProgress = listener.onShoveBegin(this);
        }
        break;

      case MotionEvent.ACTION_MOVE:
        if (!sloppyGesture) {
          break;
        }

        // See if we still have a sloppy gesture
        sloppyGesture = isSloppyGesture(event);
        if (!sloppyGesture) {
          // No, start normal gesture now
          gestureInProgress = listener.onShoveBegin(this);
        }

        break;

      case MotionEvent.ACTION_POINTER_UP:
        if (!sloppyGesture) {
          break;
        }

        break;
    }
  }

  @Override
  protected void handleInProgressEvent(int actionCode, MotionEvent event) {
    switch (actionCode) {
      case MotionEvent.ACTION_POINTER_UP:
        // Gesture ended but
        updateStateByEvent(event);

        if (!sloppyGesture) {
          listener.onShoveEnd(this);
        }

        resetState();
        break;

      case MotionEvent.ACTION_CANCEL:
        if (!sloppyGesture) {
          listener.onShoveEnd(this);
        }

        resetState();
        break;

      case MotionEvent.ACTION_MOVE:
        updateStateByEvent(event);

        // Only accept the event if our relative pressure is within
        // a certain limit. This can help filter shaky data as a
        // finger is lifted. Also check that shove is meaningful.
        if (currPressure / prevPressure > PRESSURE_THRESHOLD
          && Math.abs(getShovePixelsDelta()) > 0.5f) {
          final boolean updatePrevious = listener.onShove(this);
          if (updatePrevious) {
            prevEvent.recycle();
            prevEvent = MotionEvent.obtain(event);
          }
        }
        break;
    }
  }

  @Override
  protected void resetState() {
    super.resetState();
    sloppyGesture = false;
    prevAverageY = 0.0f;
    currAverageY = 0.0f;
  }

  @Override
  protected void updateStateByEvent(MotionEvent curr) {
    super.updateStateByEvent(curr);

    final MotionEvent prev = prevEvent;
    float py0 = prev.getY(0);
    float py1 = prev.getY(1);
    prevAverageY = (py0 + py1) / 2.0f;

    float cy0 = curr.getY(0);
    float cy1 = curr.getY(1);
    currAverageY = (cy0 + cy1) / 2.0f;
  }

  @Override
  protected boolean isSloppyGesture(MotionEvent event) {
    boolean sloppy = super.isSloppyGesture(event);
    if (sloppy) {
      return true;
    }

    // If it's not traditionally sloppy, we check if the angle between
    // fingers
    // is acceptable.
    double angle = Math.abs(Math.atan2(currFingerDiffY, currFingerDiffX));
    // about 20 degrees, left or right
    return !((0.0f < angle && angle < 0.35f) || 2.79f < angle
      && angle < Math.PI);
  }

  /**
   * Return the distance in pixels from the previous shove event to the
   * current event.
   *
   * @return The current distance in pixels.
   */
  public float getShovePixelsDelta() {
    return currAverageY - prevAverageY;
  }
}