io.github.controlwear.virtual.joystick.android

Class JoystickView

java.lang.Object

android.view.View

io.github.controlwear.virtual.joystick.android.JoystickView

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback, android.view.accessibility.AccessibilityEventSource, android.view.KeyEvent.Callback, java.lang.Runnable

public class JoystickView
extends android.view.View
implements java.lang.Runnable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JoystickView.OnMoveListener Interface definition for a callback to be invoked when a JoystickView's button is moved
static interface	JoystickView.OnMultipleLongPressListener Interface definition for a callback to be invoked when a JoystickView is touched and held by multiple pointers.

Nested classes/interfaces inherited from class android.view.View

android.view.View.AccessibilityDelegate, android.view.View.BaseSavedState, android.view.View.DragShadowBuilder, android.view.View.MeasureSpec, android.view.View.OnApplyWindowInsetsListener, android.view.View.OnAttachStateChangeListener, android.view.View.OnCapturedPointerListener, android.view.View.OnClickListener, android.view.View.OnContextClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnDragListener, android.view.View.OnFocusChangeListener, android.view.View.OnGenericMotionListener, android.view.View.OnHoverListener, android.view.View.OnKeyListener, android.view.View.OnLayoutChangeListener, android.view.View.OnLongClickListener, android.view.View.OnScrollChangeListener, android.view.View.OnSystemUiVisibilityChangeListener, android.view.View.OnTouchListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUTTON_DIRECTION_BOTH Default value.

Fields inherited from class android.view.View

ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR, AUTOFILL_HINT_CREDIT_CARD_NUMBER, AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE, AUTOFILL_HINT_EMAIL_ADDRESS, AUTOFILL_HINT_NAME, AUTOFILL_HINT_PASSWORD, AUTOFILL_HINT_PHONE, AUTOFILL_HINT_POSTAL_ADDRESS, AUTOFILL_HINT_POSTAL_CODE, AUTOFILL_HINT_USERNAME, AUTOFILL_TYPE_DATE, AUTOFILL_TYPE_LIST, AUTOFILL_TYPE_NONE, AUTOFILL_TYPE_TEXT, AUTOFILL_TYPE_TOGGLE, DRAG_FLAG_GLOBAL, DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION, DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION, DRAG_FLAG_GLOBAL_URI_READ, DRAG_FLAG_GLOBAL_URI_WRITE, DRAG_FLAG_OPAQUE, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, EMPTY_STATE_SET, ENABLED_FOCUSED_SELECTED_STATE_SET, ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_FOCUSED_STATE_SET, ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, ENABLED_SELECTED_STATE_SET, ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_STATE_SET, ENABLED_WINDOW_FOCUSED_STATE_SET, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLE, FOCUSABLE_AUTO, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, FOCUSED_SELECTED_STATE_SET, FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, FOCUSED_STATE_SET, FOCUSED_WINDOW_FOCUSED_STATE_SET, GONE, HAPTIC_FEEDBACK_ENABLED, IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_NO, IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, IMPORTANT_FOR_ACCESSIBILITY_YES, IMPORTANT_FOR_AUTOFILL_AUTO, IMPORTANT_FOR_AUTOFILL_NO, IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_AUTOFILL_YES, IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE, LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, NOT_FOCUSABLE, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_SELECTED_STATE_SET, PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_STATE_SET, PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_SELECTED_STATE_SET, PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_STATE_SET, PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_SELECTED_STATE_SET, PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_STATE_SET, PRESSED_WINDOW_FOCUSED_STATE_SET, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCREEN_STATE_OFF, SCREEN_STATE_ON, SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_NONE, SCROLL_AXIS_VERTICAL, SCROLL_INDICATOR_BOTTOM, SCROLL_INDICATOR_END, SCROLL_INDICATOR_LEFT, SCROLL_INDICATOR_RIGHT, SCROLL_INDICATOR_START, SCROLL_INDICATOR_TOP, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SELECTED_STATE_SET, SELECTED_WINDOW_FOCUSED_STATE_SET, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_IMMERSIVE, SYSTEM_UI_FLAG_IMMERSIVE_STICKY, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR, SYSTEM_UI_FLAG_LIGHT_STATUS_BAR, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, SYSTEM_UI_LAYOUT_FLAGS, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_VIEW_END, TEXT_ALIGNMENT_VIEW_START, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL, TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TRANSLATION_X, TRANSLATION_Y, TRANSLATION_Z, VIEW_LOG_TAG, VISIBLE, WINDOW_FOCUSED_STATE_SET, X, Y, Z

Constructor Summary

Constructors

Constructor and Description
JoystickView(android.content.Context context) Simple constructor to use when creating a JoystickView from code.
JoystickView(android.content.Context context, android.util.AttributeSet attrs) Constructor that is called when inflating a JoystickView from XML.
JoystickView(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr)

Method Summary

Modifier and Type	Method and Description
int	getButtonDirection() Return the current direction allowed for the button to move
float	getButtonSizeRatio() Return the size of the button (as a ratio of the total width/height) Default is 0.25 (25%).
float	getmBackgroundSizeRatio() Return the size of the background (as a ratio of the total width/height) Default is 0.75 (75%).
int	getNormalizedX() Return the relative X coordinate of button center related to top-left virtual corner of the border
int	getNormalizedY() Return the relative Y coordinate of the button center related to top-left virtual corner of the border
boolean	isAutoReCenterButton() Return the current behavior of the auto re-center button
boolean	isButtonStickToBorder() Return the current behavior of the button stick to border
boolean	isEnabled() Return the state of the joystick.
protected void	onDraw(android.graphics.Canvas canvas) Draw the background, the border and the button
protected void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
protected void	onSizeChanged(int w, int h, int oldW, int oldH) This is called during layout when the size of this view has changed.
boolean	onTouchEvent(android.view.MotionEvent event) Handle touch screen motion event.
void	resetButtonPosition() Reset the button position to the center.
void	run()
void	setAutoReCenterButton(boolean b) Set the current behavior of the auto re-center button
void	setBackgroundColor(int color) Set the background color for this JoystickView.
void	setBackgroundSizeRatio(float newRatio) Set the joystick button size (as a fraction of the real width/height) By default it is 75% (0.75).
void	setBorderColor(int color) Set the border color for this JoystickView.
void	setBorderWidth(int width) Set the border width for this JoystickView.
void	setButtonColor(int color) Set the button color for this JoystickView.
void	setButtonDirection(int direction) Set the current authorized direction for the button to move
void	setButtonDrawable(android.graphics.drawable.Drawable d) Set an image to the button with a drawable
void	setButtonSizeRatio(float newRatio) Set the joystick button size (as a fraction of the real width/height) By default it is 25% (0.25).
void	setButtonStickToBorder(boolean b) Set the current behavior of the button stick to border
void	setEnabled(boolean enabled) Enable or disable the joystick
void	setFixedCenter(boolean fixedCenter) Set the joystick center's behavior (fixed or auto-defined)
void	setOnMoveListener(JoystickView.OnMoveListener l) Register a callback to be invoked when this JoystickView's button is moved
void	setOnMoveListener(JoystickView.OnMoveListener l, int loopInterval) Register a callback to be invoked when this JoystickView's button is moved
void	setOnMultiLongPressListener(JoystickView.OnMultipleLongPressListener l) Register a callback to be invoked when this JoystickView is touch and held by multiple pointers

Methods inherited from class android.view.View

addChildrenForAccessibility, addExtraDataToAccessibilityNodeInfo, addFocusables, addFocusables, addKeyboardNavigationClusters, addOnAttachStateChangeListener, addOnLayoutChangeListener, addTouchables, animate, announceForAccessibility, autofill, autofill, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, clearFocus, combineMeasuredStates, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchApplyWindowInsets, dispatchCapturedPointerEvent, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFinishTemporaryDetach, dispatchGenericFocusedEvent, dispatchGenericMotionEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPointerCaptureChanged, dispatchPopulateAccessibilityEvent, dispatchProvideAutofillStructure, dispatchProvideStructure, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchStartTemporaryDetach, dispatchSystemUiVisibilityChanged, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, draw, drawableHotspotChanged, drawableStateChanged, findFocus, findViewById, findViewsWithText, findViewWithTag, fitSystemWindows, focusSearch, forceHasOverlappingRendering, forceLayout, generateViewId, getAccessibilityClassName, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAlpha, getAnimation, getApplicationWindowToken, getAutofillHints, getAutofillId, getAutofillType, getAutofillValue, getBackground, getBackgroundTintList, getBackgroundTintMode, getBaseline, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentDescription, getContext, getContextMenuInfo, getDefaultFocusHighlightEnabled, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusable, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintList, getForegroundTintMode, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getId, getImportantForAccessibility, getImportantForAutofill, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextClusterForwardId, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineProvider, getOverlay, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getPointerIcon, getResources, getRevealOnFocusHint, getRight, getRightFadingEdgeStrength, getRightPaddingOffset, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getStateListAnimator, getSuggestedMinimumHeight, getSuggestedMinimumWidth, getSystemUiVisibility, getTag, getTag, getTextAlignment, getTextDirection, getTooltipText, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasExplicitFocusable, hasFocus, hasFocusable, hasNestedScrollingParent, hasOnClickListeners, hasOverlappingRendering, hasPointerCapture, hasTransientState, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityFocused, isActivated, isAttachedToWindow, isClickable, isContextClickable, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isFocusable, isFocusableInTouchMode, isFocused, isFocusedByDefault, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isImportantForAutofill, isInEditMode, isInLayout, isInTouchMode, isKeyboardNavigationCluster, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingOffsetRequired, isPaddingRelative, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScrollbarFadingEnabled, isScrollContainer, isSelected, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, jumpDrawablesToCurrentState, keyboardNavigationClusterSearch, layout, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onAttachedToWindow, onCancelPendingInputEvents, onCapturedPointerEvent, onCheckIsTextEditor, onConfigurationChanged, onCreateContextMenu, onCreateDrawableState, onCreateInputConnection, onDetachedFromWindow, onDisplayHint, onDragEvent, onDrawForeground, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onFocusChanged, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onLayout, onOverScrolled, onPointerCaptureChange, onPopulateAccessibilityEvent, onProvideAutofillStructure, onProvideAutofillVirtualStructure, onProvideStructure, onProvideVirtualStructure, onResolvePointerIcon, onRestoreInstanceState, onRtlPropertiesChanged, onSaveInstanceState, onScreenStateChanged, onScrollChanged, onSetAlpha, onStartTemporaryDetach, onTrackballEvent, onVisibilityAggregated, onVisibilityChanged, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, onWindowVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performContextClick, performContextClick, performHapticFeedback, performHapticFeedback, performLongClick, performLongClick, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, releasePointerCapture, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestPointerCapture, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, resolveSize, resolveSizeAndState, restoreDefaultFocus, restoreHierarchyState, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDelegate, setAccessibilityLiveRegion, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAlpha, setAnimation, setAutofillHints, setBackground, setBackgroundDrawable, setBackgroundResource, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentDescription, setContextClickable, setDefaultFocusHighlightEnabled, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusable, setFocusableInTouchMode, setFocusedByDefault, setForeground, setForegroundGravity, setForegroundTintList, setForegroundTintMode, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHovered, setId, setImportantForAccessibility, setImportantForAutofill, setKeepScreenOn, setKeyboardNavigationCluster, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextClusterForwardId, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnCapturedPointerListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineProvider, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPointerIcon, setPressed, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollbarFadingEnabled, setScrollBarSize, setScrollBarStyle, setScrollContainer, setScrollIndicators, setScrollIndicators, setScrollX, setScrollY, setSelected, setSoundEffectsEnabled, setStateListAnimator, setSystemUiVisibility, setTag, setTag, setTextAlignment, setTextDirection, setTooltipText, setTop, setTouchDelegate, setTransitionName, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, showContextMenu, startActionMode, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, unscheduleDrawable, unscheduleDrawable, updateDragShadow, verifyDrawable, willNotCacheDrawing, willNotDraw

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BUTTON_DIRECTION_BOTH

public static int BUTTON_DIRECTION_BOTH

Default value. Both direction correspond to horizontal and vertical movement

Constructor Detail

JoystickView

public JoystickView(android.content.Context context)

Simple constructor to use when creating a JoystickView from code. Call another constructor passing null to Attribute.

Parameters:

context - The Context the JoystickView is running in, through which it can access the current theme, resources, etc.

JoystickView

public JoystickView(android.content.Context context,
                    android.util.AttributeSet attrs,
                    int defStyleAttr)

JoystickView

public JoystickView(android.content.Context context,
                    android.util.AttributeSet attrs)

Constructor that is called when inflating a JoystickView from XML. This is called when a JoystickView is being constructed from an XML file, supplying attributes that were specified in the XML file.

Parameters:

context - The Context the JoystickView is running in, through which it can access the current theme, resources, etc.

attrs - The attributes of the XML tag that is inflating the JoystickView.

Method Detail

onDraw

protected void onDraw(android.graphics.Canvas canvas)

Draw the background, the border and the button

Overrides:

onDraw in class android.view.View

Parameters:

canvas - the canvas on which the shapes will be drawn

onSizeChanged

protected void onSizeChanged(int w,
                             int h,
                             int oldW,
                             int oldH)

This is called during layout when the size of this view has changed. Here we get the center of the view and the radius to draw all the shapes.

Overrides:

onSizeChanged in class android.view.View

Parameters:

w - Current width of this view.

h - Current height of this view.

oldW - Old width of this view.

oldH - Old height of this view.

onMeasure

protected void onMeasure(int widthMeasureSpec,
                         int heightMeasureSpec)

Overrides:

onMeasure in class android.view.View

onTouchEvent

public boolean onTouchEvent(android.view.MotionEvent event)

Handle touch screen motion event. Move the button according to the finger coordinate and detect longPress by multiple pointers only.

Overrides:

onTouchEvent in class android.view.View

Parameters:

event - The motion event.

Returns:

True if the event was handled, false otherwise.

resetButtonPosition

public void resetButtonPosition()

Reset the button position to the center.

getButtonDirection

public int getButtonDirection()

Return the current direction allowed for the button to move

Returns:

Actually return an integer corresponding to the direction: - A negative value is horizontal axe, - A positive value is vertical axe, - Zero means both axes

isEnabled

public boolean isEnabled()

Return the state of the joystick. False when the button don't move.

Overrides:

isEnabled in class android.view.View

Returns:

the state of the joystick

getButtonSizeRatio

public float getButtonSizeRatio()

Return the size of the button (as a ratio of the total width/height) Default is 0.25 (25%).

Returns:

button size (value between 0.0 and 1.0)

getmBackgroundSizeRatio

public float getmBackgroundSizeRatio()

Return the size of the background (as a ratio of the total width/height) Default is 0.75 (75%).

Returns:

background size (value between 0.0 and 1.0)

isAutoReCenterButton

public boolean isAutoReCenterButton()

Return the current behavior of the auto re-center button

Returns:

True if automatically re-centered or False if not

isButtonStickToBorder

public boolean isButtonStickToBorder()

Return the current behavior of the button stick to border

Returns:

True if the button stick to the border otherwise False

getNormalizedX

public int getNormalizedX()

Return the relative X coordinate of button center related to top-left virtual corner of the border

Returns:

coordinate of X (normalized between 0 and 100)

getNormalizedY

public int getNormalizedY()

Return the relative Y coordinate of the button center related to top-left virtual corner of the border

Returns:

coordinate of Y (normalized between 0 and 100)

setButtonDrawable

public void setButtonDrawable(android.graphics.drawable.Drawable d)

Set an image to the button with a drawable

Parameters:

d - drawable to pick the image

setButtonColor

public void setButtonColor(int color)

Set the button color for this JoystickView.

Parameters:

color - the color of the button

setBorderColor

public void setBorderColor(int color)

Set the border color for this JoystickView.

Parameters:

color - the color of the border

setBackgroundColor

public void setBackgroundColor(int color)

Set the background color for this JoystickView.

Overrides:

setBackgroundColor in class android.view.View

Parameters:

color - the color of the background

setBorderWidth

public void setBorderWidth(int width)

Set the border width for this JoystickView.

Parameters:

width - the width of the border

setOnMoveListener

public void setOnMoveListener(JoystickView.OnMoveListener l)

Register a callback to be invoked when this JoystickView's button is moved

Parameters:

l - The callback that will run

setOnMoveListener

public void setOnMoveListener(JoystickView.OnMoveListener l,
                              int loopInterval)

Register a callback to be invoked when this JoystickView's button is moved

Parameters:

l - The callback that will run

loopInterval - Refresh rate to be invoked in milliseconds

setOnMultiLongPressListener

public void setOnMultiLongPressListener(JoystickView.OnMultipleLongPressListener l)

Register a callback to be invoked when this JoystickView is touch and held by multiple pointers

Parameters:

l - The callback that will run

setFixedCenter

public void setFixedCenter(boolean fixedCenter)

Set the joystick center's behavior (fixed or auto-defined)

Parameters:

fixedCenter - True for fixed center, False for auto-defined center based on touch down

setEnabled

public void setEnabled(boolean enabled)

Enable or disable the joystick

Overrides:

setEnabled in class android.view.View

Parameters:

enabled - False mean the button won't move and onMove won't be called

setButtonSizeRatio

public void setButtonSizeRatio(float newRatio)

Set the joystick button size (as a fraction of the real width/height) By default it is 25% (0.25).

Parameters:

newRatio - between 0.0 and 1.0

setBackgroundSizeRatio

public void setBackgroundSizeRatio(float newRatio)

Set the joystick button size (as a fraction of the real width/height) By default it is 75% (0.75). Not working if the background is an image.

Parameters:

newRatio - between 0.0 and 1.0

setAutoReCenterButton

public void setAutoReCenterButton(boolean b)

Set the current behavior of the auto re-center button

Parameters:

b - True if automatically re-centered or False if not

setButtonStickToBorder

public void setButtonStickToBorder(boolean b)

Set the current behavior of the button stick to border

Parameters:

b - True if the button stick to the border or False (default) if not

setButtonDirection

public void setButtonDirection(int direction)

Set the current authorized direction for the button to move

Parameters:

direction - the value will define the authorized direction: - any negative value (such as -1) for horizontal axe - any positive value (such as 1) for vertical axe - zero (0) for the full direction (both axes)

run

public void run()

Specified by:

run in interface java.lang.Runnable