Merge branch 'master' of github_erz05:erz05/JoyStick

README.md

@@ -26,12 +26,29 @@ repositories {
     maven {
         url  "http://dl.bintray.com/erz05/maven" 
     }
+    
+    //Or
+    
+    jcenter()
 }
 
 dependencies {
-    compile 'com.github.erz05:JoyStick:1.0.3'
+    compile 'com.github.erz05:JoyStick:1.1.0'
 }
 ```
+<H2>v1.1.0 BREAKING CHANGE!</H2>
+1. Made changes to JoyStickListener<br>
+a. Added Direction to onMove<br>
+b. Added Event calls for onTap and onDoubleTap<br>
+
+<H2>Defaults:</H2>
+1. Background = White
+2. Button = Red
+3. Button Radius = 25%
+4. StayPut = false
+5. Directional-Axis = 8
+
+<H2>Setup:</H2>
 
 ```xml
 <com.erz.joysticklibrary.JoyStick
@@ -46,7 +63,11 @@ dependencies {
     android:layout_height="200dp"
     android:layout_gravity="bottom|right"
     app:padColor="#55ffffff"
-    app:buttonColor="#55ff0000"/>
+    app:buttonColor="#55ff0000"
+    app:stayPut="true"
+    app:percentage="25" //default 25: radius percentage of full size of the view between 25% and 50%
+    app:backgroundDrawable="R.drawable.background"
+    app:buttonDrawable="R.drawable.button"/>
 ```
 
 ```java
@@ -55,7 +76,54 @@ JoyStick joyStick = (JoyStick) findViewById(R.id.joyStick);
 //or 
 
 JoyStick joyStick = new JoyStick(context);
+```
 
+<H2>JoyStickListener:</H2>
+```java
+//JoyStickListener Interface
+public interface JoyStickListener {
+        void onMove(JoyStick joyStick, double angle, double power, int direction);
+        void onTap();
+        void onDoubleTap();
+}
+
+//Set JoyStickListener
+joyStick.setListener(this);
+```
+1. onMove: gets called everytime theres a touch interaction
+2. onTap: gets called onSingleTapConfirmed
+3. onDoubleTap: gets called onDoubleTap
+
+<H2>Directions:</H2>
+1. DIRECTION_CENTER = -1
+2. DIRECTION_LEFT = 0
+3. DIRECTION_LEFT_UP = 1
+4. DIRECTION_UP = 2
+5. DIRECTION_UP_RIGHT = 3 
+6. DIRECTION_RIGHT = 4
+7. DIRECTION_RIGHT_DOWN = 5 
+8. DIRECTION_DOWN = 6
+9. DIRECTION_DOWN_LEFT = 7
+
+To get JoyStick direction you can use
+```java
+joyStick.getDirection();
+```
+or get it from the JoyStickListener
+
+<H2>Axis Types:</H2>
+1. TYPE_8_AXIS 
+2. TYPE_4_AXIS 
+3. TYPE_2_AXIS_LEFT_RIGHT 
+4. TYPE_2_AXIS_UP_DOWN
+
+To set Axis Type:
+```java
+joyStick.setType(JoyStick.TYPE_4_AXIS);
+```
+
+<H2>Getters/Setters</H2>
+```java
 //Set GamePad Color
 joyStick.setPadColor(Color.BLACK);
 
@@ -82,15 +150,8 @@ joyStick.getAngle();
 
 //Get Angle in Degrees
 joyStick.getAngleDegrees();
-
-//Set JoyStickListener
-joyStick.setListener(this);
-
-//JoyStickListener Interface
-public interface JoyStickListener {
-        void onMove(JoyStick joyStick, double angle, double power);
-}
 ```
+
 <H2>License</H2>
     Copyright 2015 erz05