From e36bce042b01402fa8aa26d8081b8c85e17dc49d Mon Sep 17 00:00:00 2001
From: "Tadashi G. Takaoka" <takaoka@google.com>
Date: Tue, 27 Jul 2010 22:59:50 -0700
Subject: [PATCH] Add hysteresis movement key debouncing

When key is pressed, each key will have a halo which is 0.05 inch
wider than the key.

Bug: bug2517112

Change-Id: I1368ff4af5f5d230b8c2f0c05c3c27bdb89027ae
---
 java/res/values/dimens.xml                    |  1 +
 .../latin/LatinKeyboardBaseView.java          | 40 +++++++++++--------
 2 files changed, 25 insertions(+), 16 deletions(-)

diff --git a/java/res/values/dimens.xml b/java/res/values/dimens.xml
index 81ae64e5f..39dce9db0 100644
--- a/java/res/values/dimens.xml
+++ b/java/res/values/dimens.xml
@@ -27,4 +27,5 @@
          will not go into extract (fullscreen) mode. -->
     <dimen name="max_height_for_fullscreen">2.5in</dimen>
     <dimen name="key_text_size">22sp</dimen>
+    <dimen name="key_debounce_hysteresis_distance">0.05in</dimen>
 </resources>
diff --git a/java/src/com/android/inputmethod/latin/LatinKeyboardBaseView.java b/java/src/com/android/inputmethod/latin/LatinKeyboardBaseView.java
index ba7aa5d1c..e25ef495e 100644
--- a/java/src/com/android/inputmethod/latin/LatinKeyboardBaseView.java
+++ b/java/src/com/android/inputmethod/latin/LatinKeyboardBaseView.java
@@ -332,12 +332,10 @@ public class LatinKeyboardBaseView extends View implements View.OnClickListener
         private long mLastMoveTime;
         private long mCurrentKeyTime;
 
-        private int mKeyDebounceThreshold;
-        private static final int KEY_DEBOUNCE_FACTOR = 6;
+        private final int mKeyDebounceThresholdSquared;
 
-        KeyDebouncer(int proximityThreshold) {
-            // 1/KEY_DEBOUNCE_FACTOR of distance between adjacent keys
-            mKeyDebounceThreshold = proximityThreshold / KEY_DEBOUNCE_FACTOR;
+        KeyDebouncer(float hysteresisPixel) {
+            mKeyDebounceThresholdSquared = (int)(hysteresisPixel * hysteresisPixel);
         }
 
         public int getLastCodeX() {
@@ -375,15 +373,23 @@ public class LatinKeyboardBaseView extends View implements View.OnClickListener
             mLastCodeY = mLastY;
         }
 
-        public boolean isMinorMoveBounce(int x, int y, int keyIndex, int currentKey) {
-            // TODO: Check the coordinate against each key border.  The current
-            // logic is pretty simple.
-            if (keyIndex == currentKey)
+        public boolean isMinorMoveBounce(int x, int y, Key newKey, Key curKey) {
+            if (newKey == curKey)
                 return true;
-            int dx = x - mLastCodeX;
-            int dy = y - mLastCodeY;
-            int delta = dx * dx + dy * dy;
-            return delta < mKeyDebounceThreshold;
+
+            return getSquareDistanceToKeyEdge(x, y, curKey) < mKeyDebounceThresholdSquared;
+        }
+
+        private static int getSquareDistanceToKeyEdge(int x, int y, Key key) {
+            final int left = key.x;
+            final int right = key.x + key.width;
+            final int top = key.y;
+            final int bottom = key.y + key.height;
+            final int edgeX = x < left ? left : (x > right ? right : x);
+            final int edgeY = y < top ? top : (y > bottom ? bottom : y);
+            final int dx = x - edgeX;
+            final int dy = y - edgeY;
+            return dx * dx + dy * dy;
         }
 
         public void startTimeDebouncing(long eventTime) {
@@ -766,7 +772,9 @@ public class LatinKeyboardBaseView extends View implements View.OnClickListener
         mProximityThreshold = (int) (dimensionSum * 1.4f / length);
         mProximityThreshold *= mProximityThreshold; // Square it
 
-        mDebouncer = new KeyDebouncer(mProximityThreshold);
+        final float hysteresisPixel = getContext().getResources()
+                .getDimension(R.dimen.key_debounce_hysteresis_distance);
+        mDebouncer = new KeyDebouncer(hysteresisPixel);
     }
 
     @Override
@@ -1354,8 +1362,8 @@ public class LatinKeyboardBaseView extends View implements View.OnClickListener
                     if (mCurrentKey == NOT_A_KEY) {
                         mCurrentKey = keyIndex;
                         mDebouncer.updateTimeDebouncing(eventTime);
-                    } else if (mDebouncer.isMinorMoveBounce(touchX, touchY,
-                            keyIndex, mCurrentKey)) {
+                    } else if (mDebouncer.isMinorMoveBounce(touchX, touchY, mKeys[keyIndex],
+                            mKeys[mCurrentKey])) {
                         mDebouncer.updateTimeDebouncing(eventTime);
                         continueLongPress = true;
                     } else if (mRepeatKeyIndex == NOT_A_KEY) {