JoyStick/README.md
2017-01-22 22:07:43 -08:00

4.5 KiB

JoyStick

Android Library for JoyStick View.
Its customizable, small and lightweight.
Change Background/Button Color, use image for Background/Button.

Download

Android Arsenal

Get it on Google Play

Images: Sample App





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' }

<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
  android:id="@+id/joy1"
  android:layout_width="200dp"
  android:layout_height="200dp"
  android:layout_gravity="bottom"/>

<com.erz.joysticklibrary.JoyStick
    android:id="@+id/joy2"
    android:layout_width="200dp"
    android:layout_height="200dp"
    android:layout_gravity="bottom|right"
    app:padColor="#55ffffff"
    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"/>
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

<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

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:

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();


<H2>License</H2>
    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.