Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
Almer Thie committed Sep 11, 2012
1 parent 6eb212c commit c8e8cf9
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
Android Gesture Detectors Framework
===================================

Introduction
------------

Since I was amazed Android has a ScaleGestureDetector since API level 8 but
(still) no such thing as a RotateGestureDetector I decided to create this class
myself. In the process I decided to create a small extendable framework for
GestureDetectors in general.

Tutorials
---------

### Using gesture detectors

If you want to use the ScaleGestureDetector and/or the gesture detectors
from this project, please read my tutorial: [code.almeros.com/android-multitouch-gesture-detectors](http://code.almeros.com/android-multitouch-gesture-detectors)

### Extending

If you want to extend this framework with new gesture detectors please read
my tutorial about that here: *coming soon*

I hope you'll send me a pull request with your FingerTwistGestureDetector or something ;)

Containments
------------

### RotateGestureDetector

Helps finding out the rotation angle between the line of two fingers (with the
normal or previous finger positions)

### MoveGestureDetector

Convenience gesture detector to keep it easy moving an object around with one
ore more fingers without losing the clean usage of the gesture detector pattern.

### ScaleGestureDetector (default Android)

This one is NOT in this framework, but is gesture detector that resides in the
Android API since API level 8 (2.2).

### BaseGestureDetector (abstract)

Abstract class that every new gesture detector class should extend.

### TwoFingerGestureDetector (abstract)

Abstract class that extends the BaseGestureDetector and that every new gesture
detector class for two finger operations should extend.

0 comments on commit c8e8cf9

Please sign in to comment.