Modifier and Type	Class and Description
public static enum	InputEvent.Type Types of low-level input events supported by scene2d.

Modifier and Type	Field and Description
private int	button
private char	character
private int	keyCode
private int	pointer
private Actor	relatedActor
private float	scrollAmountX
private float	scrollAmountY
private float	stageX
private float	stageY
private boolean	touchFocus
private InputEvent.Type	type

Access	Constructor and Description
public	InputEvent()

Method Summary

Modifier and Type	Method and Description
public int	getButton() The index for the mouse button pressed.
public char	getCharacter() The character for the key that was typed.
public int	getKeyCode() The key code of the key that was pressed.
public int	getPointer() The pointer index for the event.
public Actor	getRelatedActor() The actor related to the event.
public float	getScrollAmountX() The amount the mouse was scrolled horizontally.
public float	getScrollAmountY() The amount the mouse was scrolled vertically.
public float	getStageX() The stage x coordinate where the event occurred.
public float	getStageY() The stage x coordinate where the event occurred.
public boolean	getTouchFocus() If false, `InputListener#handle(Event)` will not add the listener to the stage's touch focus when a touch down event is handled.
public InputEvent.Type	getType() The type of input event.
public boolean	isTouchFocusCancel() Returns true if this event is a touchUp triggered by `Stage#cancelTouchFocus()`.
public void	reset() Overrides com.badlogic.gdx.scenes.scene2d.Event.reset. Implements com.badlogic.gdx.utils.Pool.Poolable.reset. Resets the object for reuse.
public void	setButton(int button)
public void	setCharacter(char character)
public void	setKeyCode(int keyCode)
public void	setPointer(int pointer)
public void	setRelatedActor(Actor May be null. relatedActor)
public void	setScrollAmountX(float scrollAmount)
public void	setScrollAmountY(float scrollAmount)
public void	setStageX(float stageX)
public void	setStageY(float stageY)
public void	setTouchFocus(boolean touchFocus)
public void	setType(InputEvent.Type type)
public Vector2	toCoordinates(Actor actor, Vector2 Output for resulting coordinates. actorCoords) Sets actorCoords to this event's coordinates relative to the specified actor.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from com.badlogic.gdx.scenes.scene2d.Event:: cancel getBubbles getListenerActor getStage getTarget handle isCancelled isCapture isHandled isStopped setBubbles setCapture setListenerActor setStage setTarget stop

Field Detail

button	back to summary
private int button

character	back to summary
private char character

keyCode	back to summary
private int keyCode

pointer	back to summary
private int pointer

relatedActor	back to summary
private Actor relatedActor Annotations @Null

scrollAmountX	back to summary
private float scrollAmountX

scrollAmountY	back to summary
private float scrollAmountY

stageX	back to summary
private float stageX

stageY	back to summary
private float stageY

touchFocus	back to summary
private boolean touchFocus

type	back to summary
private InputEvent.Type type

Constructor Detail

InputEvent	back to summary
public InputEvent()

Method Detail

getButton back to summary

getButton	back to summary
public int getButton() The index for the mouse button pressed. Always 0 on Android. Valid for: touchDown and touchUp. See Also `Buttons`

public int getButton()

The index for the mouse button pressed. Always 0 on Android. Valid for: touchDown and touchUp.

See Also: Buttons

getCharacter	back to summary
public char getCharacter() The character for the key that was typed. Valid for: keyTyped.

getKeyCode	back to summary
public int getKeyCode() The key code of the key that was pressed. Valid for: keyDown and keyUp.

getPointer	back to summary
public int getPointer() The pointer index for the event. The first touch is index 0, second touch is index 1, etc. On desktop it is always 0 for a touch, but -1 for enter/exit without a touch. Valid for: touchDown, touchDragged, touchUp, enter, and exit.

getRelatedActor	back to summary
public Actor getRelatedActor() The actor related to the event. Valid for: enter and exit. For enter, this is the actor being exited, or null. For exit, this is the actor being entered, or null. Annotations @Null

getRelatedActor

back to summary

public Actor getRelatedActor()

The actor related to the event. Valid for: enter and exit. For enter, this is the actor being exited, or null. For exit, this is the actor being entered, or null.

Annotations

@Null

getScrollAmountX	back to summary
public float getScrollAmountX() The amount the mouse was scrolled horizontally. Valid for: scrolled.

getScrollAmountY	back to summary
public float getScrollAmountY() The amount the mouse was scrolled vertically. Valid for: scrolled.

getStageX	back to summary
public float getStageX() The stage x coordinate where the event occurred. Valid for: touchDown, touchDragged, touchUp, mouseMoved, enter, and exit.

getStageY	back to summary
public float getStageY() The stage x coordinate where the event occurred. Valid for: touchDown, touchDragged, touchUp, mouseMoved, enter, and exit.

getTouchFocus	back to summary
public boolean getTouchFocus() If false, `InputListener#handle(Event)` will not add the listener to the stage's touch focus when a touch down event is handled. Default is true.

getType	back to summary
public InputEvent.Type getType() The type of input event.

isTouchFocusCancel	back to summary
public boolean isTouchFocusCancel() Returns true if this event is a touchUp triggered by `Stage#cancelTouchFocus()`.

reset	back to summary
public void reset() Overrides com.badlogic.gdx.scenes.scene2d.Event.reset. Implements com.badlogic.gdx.utils.Pool.Poolable.reset. Doc from com.badlogic.gdx.utils.Pool.Poolable.reset. Resets the object for reuse. Object references should be nulled and fields may be set to default values.

reset

back to summary

public void reset()

Overrides com.badlogic.gdx.scenes.scene2d.Event.reset.

Implements com.badlogic.gdx.utils.Pool.Poolable.reset.

Doc from com.badlogic.gdx.utils.Pool.Poolable.reset.

Resets the object for reuse. Object references should be nulled and fields may be set to default values.

setButton	back to summary
public void setButton(int button)

setCharacter	back to summary
public void setCharacter(char character)

setKeyCode	back to summary
public void setKeyCode(int keyCode)

setPointer	back to summary
public void setPointer(int pointer)

setRelatedActor	back to summary
public void setRelatedActor(Actor relatedActor) Parameters relatedActor:Actor May be null.

setScrollAmountX	back to summary
public void setScrollAmountX(float scrollAmount)

setScrollAmountY	back to summary
public void setScrollAmountY(float scrollAmount)

setStageX	back to summary
public void setStageX(float stageX)

setStageY	back to summary
public void setStageY(float stageY)

setTouchFocus	back to summary
public void setTouchFocus(boolean touchFocus)

setType	back to summary
public void setType(InputEvent.Type type)

toCoordinates	back to summary
public Vector2 toCoordinates(Actor actor, Vector2 actorCoords) Sets actorCoords to this event's coordinates relative to the specified actor. Parameters actorCoords:Vector2 Output for resulting coordinates.

toCoordinates

back to summary

public Vector2 toCoordinates(Actor actor, Vector2 actorCoords)

Sets actorCoords to this event's coordinates relative to the specified actor.

Parameters

actorCoords:Vector2: Output for resulting coordinates.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

com.badlogic.gdx.scenes.scene2d back to summary

public final Enum InputEvent.Type

Class Inheritance

extends Enum<InputEvent.Type>

java.lang.Object
java.lang.Enum
com.badlogic.gdx.scenes.scene2d.InputEvent.Type

Types of low-level input events supported by scene2d.

Field Summary

Modifier and Type	Field and Description
public static final InputEvent.Type	enter The mouse pointer or an active touch have entered (i.e., `hit`) an actor.
public static final InputEvent.Type	exit The mouse pointer or an active touch have exited an actor.
public static final InputEvent.Type	keyDown A keyboard key has been pressed.
public static final InputEvent.Type	keyTyped A keyboard key has been pressed and released.
public static final InputEvent.Type	keyUp A keyboard key has been released.
public static final InputEvent.Type	mouseMoved The mouse pointer has moved (without a mouse button being active).
public static final InputEvent.Type	scrolled The mouse scroll wheel has changed.
public static final InputEvent.Type	touchDown A new touch for a pointer on the stage was detected
public static final InputEvent.Type	touchDragged A pointer that is touching the stage has moved.
public static final InputEvent.Type	touchUp A pointer has stopped touching the stage.

Constructor Summary

Access	Constructor and Description
private	Type()

Method Summary

Modifier and Type	Method and Description
public static InputEvent.Type	valueOf(String name)
public static InputEvent.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

enter	back to summary
public static final InputEvent.Type enter The mouse pointer or an active touch have entered (i.e., `hit`) an actor.

exit	back to summary
public static final InputEvent.Type exit The mouse pointer or an active touch have exited an actor.

keyDown	back to summary
public static final InputEvent.Type keyDown A keyboard key has been pressed.

keyTyped	back to summary
public static final InputEvent.Type keyTyped A keyboard key has been pressed and released.

keyUp	back to summary
public static final InputEvent.Type keyUp A keyboard key has been released.

mouseMoved	back to summary
public static final InputEvent.Type mouseMoved The mouse pointer has moved (without a mouse button being active).

scrolled	back to summary
public static final InputEvent.Type scrolled The mouse scroll wheel has changed.

touchDown	back to summary
public static final InputEvent.Type touchDown A new touch for a pointer on the stage was detected

touchDragged	back to summary
public static final InputEvent.Type touchDragged A pointer that is touching the stage has moved.

touchUp	back to summary
public static final InputEvent.Type touchUp A pointer has stopped touching the stage.

Constructor Detail

Type	back to summary
private Type()

Method Detail

valueOf	back to summary
public static InputEvent.Type valueOf(String name)

values	back to summary
public static InputEvent.Type[] values()

public Class InputEvent

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum InputEvent.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail