diff --git a/README.md~ b/README.md~ new file mode 100644 index 0000000..23dbc13 --- /dev/null +++ b/README.md~ @@ -0,0 +1,176 @@ +# JoyStick +Android Library for JoyStick View.
+Customizable, small and lightweight. + +[![Download](https://api.bintray.com/packages/erz05/maven/JoyStick/images/download.svg)](https://bintray.com/erz05/maven/JoyStick/_latestVersion) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-JoyStick-blue.svg?style=flat)](http://android-arsenal.com/details/1/2712) + +

Sample App

+ +Get it on Google Play + + +

+ +

+JoyStick with Image for button
+ +
+ +

Usage

+Gradle Import: jcenter
+ +```groovy + +repositories { + maven { + url "http://dl.bintray.com/erz05/maven" + } + + //Or + + jcenter() +} + +dependencies { + compile 'com.github.erz05:JoyStick:1.1.0' +} +``` + +

v1.1.0 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 + + + +``` + +```java +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); + +//Set Button Color +joyStick.setButtonColor(Color.RED); + +//Set Background Image +joyStick.setPadBackground(resId); + +//Set Button Image +joyStick.setButtonDrawable(resId); + +//Set Button Scale +joyStick.setButtonRadiusScale(scale); + +//Enable Button to Stay Put +joyStick.enableStayPut(enable); + +//Get Power +joyStick.getPower(); + +//Get Angle +joyStick.getAngle(); + +//Get Angle in Degrees +joyStick.getAngleDegrees(); +``` + +

License

+ Copyright 2015 erz05 + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +test \ No newline at end of file