Skip to content

sorobon/sensey

 
 

Repository files navigation

Image

Specs

Maven Central API

Featured in

Android Arsenal Android Weekly AndroidSweets AndroidDev Digest awesome-android

Show some ❤️

GitHub stars GitHub forks GitHub watchers GitHub followers
Twitter Follow

Android library which makes detecting gestures a breeze.

The library is built for simplicity and ease of use. It eliminates most boilerplate code for dealing with setting up gesture detection on Android.

Changelog

Starting with 1.0.1, Changes exist in the releases tab.

Supported gestures

  1. Flip
    • onFaceUp
    • onFaceDown
  2. Light
    • onDark
    • onLight
  3. Orientation
    • onTopSideUp
    • onBottomSideUp
    • onLeftSideUp
    • onRightSideUp
  4. PinchScale
    • OnScale
    • OnScaleStart
    • OnScaleEnd
  5. Proximity
    • onNear
    • onFar
  6. Shake
  7. TouchType
    • onDoubleTap
    • onScroll(direction)
    • onSingleTap
    • onSwipeLeft
    • onSwipeRight
    • onLongPress
    • onTwoFingerSingleTap
    • onThreeFingerSingleTap

Including in your project

  • Sensey is available in the MavenCentral, so getting it as simple as adding it as a dependency
compile 'com.github.nisrulz:sensey:1.4.0'

Simple example

  • Initialize Sensey under your onCreate() in the activity/service
Sensey.getInstance().init(context);
  • Next to enable shake detection

    • Create an instance of ShakeListener
    ShakeDetector.ShakeListener shakeListener=new ShakeDetector.ShakeListener() {
        @Override public void onShakeDetected() {
           // Shake detected, do something
       }
    };
    • Now to start listening for Shake gesture, pass the instance shakeListener to startShakeDetection() function
    Sensey.getInstance().startShakeDetection(shakeListener);

    If you want to modify the threshold , pass an int as value

    Sensey.getInstance().startShakeDetection(threshold,shakeListener);
    • To stop listening for Shake gesture, pass the instance shakeListener to stopShakeDetection() function
    Sensey.getInstance().stopShakeDetection(shakeListener);

📃 For more info , check the Wiki Docs

Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:

  1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
  2. If its a feature, bugfix, or anything please only change code to what you specify.
  3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
  4. Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.
  5. Check for existing issues first, before filing an issue.
  6. Have fun!

Apps using Sensey

If you are using Sensey in your app and would like to be listed here, please let me know by opening a new issue!

Created & Maintained By

Nishant Srivastava (@nisrulz)

About

⚡ [Android Library] Detecting gestures in a snap

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%