diff --git a/README.md b/README.md index ca48755..b51384d 100644 --- a/README.md +++ b/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' } ``` +

v1.10 BREAKING CHANGE!

+1. Made changes to JoyStickListener
+a. Added Direction to onMove
+b. Added Event calls for onTap and onDoubleTap
+ +

Defaults:

+1. Background = White +2. Button = Red +3. Button Radius = 25% +4. StayPut = false +5. Directional-Axis = 8 + +

Setup:

```xml + 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); +``` +

JoyStickListener:

+```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 + +

Directions:

+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 + +

Axis Types:

+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); +``` + +

Getters/Setters

+```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); -} ``` +

License

Copyright 2015 erz05