Package com.badlogic.gdx.scenes.scene2d.utils

Class DragListener

java.lang.Object

com.badlogic.gdx.scenes.scene2d.InputListener

com.badlogic.gdx.scenes.scene2d.utils.DragListener

All Implemented Interfaces:

EventListener

Direct Known Subclasses:

DragScrollListener

public class DragListener
extends InputListener

Detects mouse or finger touch drags on an actor. A touch must go down over the actor and a drag won't start until it is moved outside the tap square. Any touch (not just the first) will trigger this listener. While pressed, other touch downs are ignored.

Constructor Summary

Constructors

Constructor	Description
DragListener()

Method Summary

Modifier and Type	Method	Description
void	cancel()
void	drag(InputEvent event, float x, float y, int pointer)
void	dragStart(InputEvent event, float x, float y, int pointer)
void	dragStop(InputEvent event, float x, float y, int pointer)
int	getButton()
float	getDeltaX()	Returns the amount on the x axis that the touch has been dragged since the last drag event.
float	getDeltaY()	Returns the amount on the y axis that the touch has been dragged since the last drag event.
float	getDragDistance()	The distance from drag start to the current drag position.
float	getDragStartX()
float	getDragStartY()
float	getDragX()
float	getDragY()
float	getStageTouchDownX()
float	getStageTouchDownY()
float	getTapSquareSize()
float	getTouchDownX()
float	getTouchDownY()
boolean	isDragging()	Returns true if a touch has been dragged outside the tap square.
void	setButton(int button)	Sets the button to listen for, all other buttons are ignored.
void	setDragStartX(float dragStartX)
void	setDragStartY(float dragStartY)
void	setTapSquareSize(float halfTapSquareSize)
boolean	touchDown(InputEvent event, float x, float y, int pointer, int button)	Called when a mouse button or a finger touch goes down on the actor.
void	touchDragged(InputEvent event, float x, float y, int pointer)	Called when a mouse button or a finger touch is moved anywhere, but only if touchDown previously returned true for the mouse button or touch.
void	touchUp(InputEvent event, float x, float y, int pointer, int button)	Called when a mouse button or a finger touch goes up anywhere, but only if touchDown previously returned true for the mouse button or touch.

Methods inherited from class com.badlogic.gdx.scenes.scene2d.InputListener

enter, exit, handle, keyDown, keyTyped, keyUp, mouseMoved, scrolled

Methods inherited from class java.lang.Object

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

Constructor Detail

DragListener

public DragListener()

Method Detail

touchDown

public boolean touchDown(InputEvent event,
                         float x,
                         float y,
                         int pointer,
                         int button)

Description copied from class: InputListener

Called when a mouse button or a finger touch goes down on the actor. If true is returned, this listener will have touch focus, so it will receive all touchDragged and touchUp events, even those not over this actor, until touchUp is received. Also when true is returned, the event is handled.

Overrides:

touchDown in class InputListener

See Also:

InputEvent

touchDragged

public void touchDragged(InputEvent event,
                         float x,
                         float y,
                         int pointer)

Description copied from class: InputListener

Called when a mouse button or a finger touch is moved anywhere, but only if touchDown previously returned true for the mouse button or touch. The touchDragged event is always handled.

Overrides:

touchDragged in class InputListener

See Also:

InputEvent

touchUp

public void touchUp(InputEvent event,
                    float x,
                    float y,
                    int pointer,
                    int button)

Description copied from class: InputListener

Called when a mouse button or a finger touch goes up anywhere, but only if touchDown previously returned true for the mouse button or touch. The touchUp event is always handled.

Overrides:

touchUp in class InputListener

See Also:

InputEvent

dragStart

public void dragStart(InputEvent event,
                      float x,
                      float y,
                      int pointer)

drag

public void drag(InputEvent event,
                 float x,
                 float y,
                 int pointer)

dragStop

public void dragStop(InputEvent event,
                     float x,
                     float y,
                     int pointer)

cancel

public void cancel()

isDragging

public boolean isDragging()

Returns true if a touch has been dragged outside the tap square.

setTapSquareSize

public void setTapSquareSize(float halfTapSquareSize)

getTapSquareSize

public float getTapSquareSize()

getTouchDownX

public float getTouchDownX()

getTouchDownY

public float getTouchDownY()

getStageTouchDownX

public float getStageTouchDownX()

getStageTouchDownY

public float getStageTouchDownY()

getDragStartX

public float getDragStartX()

setDragStartX

public void setDragStartX(float dragStartX)

getDragStartY

public float getDragStartY()

setDragStartY

public void setDragStartY(float dragStartY)

getDragX

public float getDragX()

getDragY

public float getDragY()

getDragDistance

public float getDragDistance()

The distance from drag start to the current drag position.

getDeltaX

public float getDeltaX()

Returns the amount on the x axis that the touch has been dragged since the last drag event.

getDeltaY

public float getDeltaY()

Returns the amount on the y axis that the touch has been dragged since the last drag event.

getButton

public int getButton()

setButton

public void setButton(int button)

Sets the button to listen for, all other buttons are ignored. Default is Input.Buttons.LEFT. Use -1 for any button.