APIdia Launch Partner
Top Description Fields Constructors Methods
com.badlogic.gdx.backends.headless.mock.input

public Class MockInput

extends Object
implements Input
Class Inheritance
All Implemented Interfaces
com.badlogic.gdx.Input
Imports
com.badlogic.gdx.Input, .InputAdapter, .InputProcessor, com.badlogic.gdx.input.NativeInputConfiguration
The headless backend does its best to mock elements. This is intended to make code-sharing between server and client as simple as possible.

Field Summary

Modifier and TypeField and Description
private InputProcessor
mockInputProcessor

Constructor Summary

AccessConstructor and Description
public
MockInput()

Method Summary

Modifier and TypeMethod and Description
public void
closeTextInputField(boolean sendReturn)

Overrides default com.badlogic.gdx.Input.closeTextInputField.

Closes the native input field and applies the result to the input wrapper.

public float
getAccelerometerX()

Implements com.badlogic.gdx.Input.getAccelerometerX.

public float
getAccelerometerY()

Implements com.badlogic.gdx.Input.getAccelerometerY.

public float
getAccelerometerZ()

Implements com.badlogic.gdx.Input.getAccelerometerZ.

public float
getAzimuth()

Implements com.badlogic.gdx.Input.getAzimuth.

The azimuth is the angle of the device's orientation around the z-axis.

public long
getCurrentEventTime()

Implements com.badlogic.gdx.Input.getCurrentEventTime.

public int
getDeltaX()

Implements com.badlogic.gdx.Input.getDeltaX.

public int
getDeltaX(int pointer)

Implements com.badlogic.gdx.Input.getDeltaX.

public int
getDeltaY()

Implements com.badlogic.gdx.Input.getDeltaY.

public int
getDeltaY(int pointer)

Implements com.badlogic.gdx.Input.getDeltaY.

public float
getGyroscopeX()

Implements com.badlogic.gdx.Input.getGyroscopeX.

public float
getGyroscopeY()

Implements com.badlogic.gdx.Input.getGyroscopeY.

public float
getGyroscopeZ()

Implements com.badlogic.gdx.Input.getGyroscopeZ.

public InputProcessor
getInputProcessor()

Implements com.badlogic.gdx.Input.getInputProcessor.

public int
getMaxPointers()

Implements com.badlogic.gdx.Input.getMaxPointers.

public Input.Orientation
getNativeOrientation()

Implements com.badlogic.gdx.Input.getNativeOrientation.

public float
getPitch()

Implements com.badlogic.gdx.Input.getPitch.

The pitch is the angle of the device's orientation around the x-axis.

public float
getPressure()

Implements com.badlogic.gdx.Input.getPressure.

public float
getPressure(int pointer)

Implements com.badlogic.gdx.Input.getPressure.

Returns the pressure of the given pointer, where 0 is untouched.

public float
getRoll()

Implements com.badlogic.gdx.Input.getRoll.

The roll is the angle of the device's orientation around the y-axis.

public int
getRotation()

Implements com.badlogic.gdx.Input.getRotation.

public void
getRotationMatrix(float[] matrix)

Implements com.badlogic.gdx.Input.getRotationMatrix.

Returns the rotation matrix describing the devices rotation as per SensorManager#getRotationMatrix(float[], float[], float[], float[]).

public void
getTextInput(Input.TextInputListener listener, String title, String text, String hint)

Implements com.badlogic.gdx.Input.getTextInput.

System dependent method to input a string of text.

public void
getTextInput(Input.TextInputListener listener, String title, String text, String hint, Input.OnscreenKeyboardType type)

Implements com.badlogic.gdx.Input.getTextInput.

System dependent method to input a string of text.

public int
getX()

Implements com.badlogic.gdx.Input.getX.

public int
getX(int pointer)

Implements com.badlogic.gdx.Input.getX.

Returns the x coordinate in screen coordinates of the given pointer.

public int
getY()

Implements com.badlogic.gdx.Input.getY.

public int
getY(int pointer)

Implements com.badlogic.gdx.Input.getY.

Returns the y coordinate in screen coordinates of the given pointer.

public boolean
isButtonJustPressed(int button)

Implements com.badlogic.gdx.Input.isButtonJustPressed.

Returns whether a given button has just been pressed.

public boolean
isButtonPressed(int button)

Implements com.badlogic.gdx.Input.isButtonPressed.

Whether a given button is pressed or not.

public boolean
isCatchKey(int keycode)

Implements com.badlogic.gdx.Input.isCatchKey.

public boolean
isCursorCatched()

Implements com.badlogic.gdx.Input.isCursorCatched.

public boolean
isKeyJustPressed(int key)

Implements com.badlogic.gdx.Input.isKeyJustPressed.

Returns whether the key has just been pressed.

public boolean
isKeyPressed(int key)

Implements com.badlogic.gdx.Input.isKeyPressed.

Returns whether the key is pressed.

public boolean
isPeripheralAvailable(Input.Peripheral peripheral)

Implements com.badlogic.gdx.Input.isPeripheralAvailable.

Queries whether a Peripheral is currently available.

public boolean
isTouched()

Implements com.badlogic.gdx.Input.isTouched.

public boolean
isTouched(int pointer)

Implements com.badlogic.gdx.Input.isTouched.

Whether the screen is currently touched by the pointer with the given index.

public boolean
justTouched()

Implements com.badlogic.gdx.Input.justTouched.

public void
openTextInputField(NativeInputConfiguration configuration)

Implements com.badlogic.gdx.Input.openTextInputField.

Sets the on-screen keyboard visible if available.

public void
setCatchKey(int keycode, boolean catchKey)

Implements com.badlogic.gdx.Input.setCatchKey.

Sets whether the given key on Android or GWT should be caught.

public void
setCursorCatched(boolean catched)

Implements com.badlogic.gdx.Input.setCursorCatched.

Only viable on the desktop.

public void
setCursorPosition(int x, int y)

Implements com.badlogic.gdx.Input.setCursorPosition.

Only viable on the desktop.

public void
setInputProcessor(InputProcessor processor)

Implements com.badlogic.gdx.Input.setInputProcessor.

Sets the InputProcessor that will receive all touch and key input events.

public void
setKeyboardHeightObserver(Input.KeyboardHeightObserver observer)

Implements com.badlogic.gdx.Input.setKeyboardHeightObserver.

This will set a keyboard height callback.

public void
setOnscreenKeyboardVisible(boolean visible)

Implements com.badlogic.gdx.Input.setOnscreenKeyboardVisible.

Sets the on-screen keyboard visible if available.

public void
setOnscreenKeyboardVisible(boolean visible, Input.OnscreenKeyboardType type)

Implements com.badlogic.gdx.Input.setOnscreenKeyboardVisible.

Sets the on-screen keyboard visible if available.

public void
vibrate(int milliseconds)

Implements com.badlogic.gdx.Input.vibrate.

Generates a simple haptic effect of a given duration or a vibration effect on devices without haptic capabilities.

public void
vibrate(int milliseconds, boolean fallback)

Implements com.badlogic.gdx.Input.vibrate.

Generates a simple haptic effect of a given duration and default amplitude.

public void
vibrate(int milliseconds, int amplitude, boolean fallback)

Implements com.badlogic.gdx.Input.vibrate.

Generates a simple haptic effect of a given duration and amplitude.

public void
vibrate(Input.VibrationType vibrationType)

Implements com.badlogic.gdx.Input.vibrate.

Generates a simple haptic effect of a type.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

mockInputProcessorback to summary
private InputProcessor mockInputProcessor

Constructor Detail

MockInputback to summary
public MockInput()

Method Detail

closeTextInputFieldback to summary
public void closeTextInputField(boolean sendReturn)

Overrides default com.badlogic.gdx.Input.closeTextInputField.

Doc from com.badlogic.gdx.Input.closeTextInputField.

Closes the native input field and applies the result to the input wrapper.

Annotations
@Override
getAccelerometerXback to summary
public float getAccelerometerX()

Implements com.badlogic.gdx.Input.getAccelerometerX.

Annotations
@Override
getAccelerometerYback to summary
public float getAccelerometerY()

Implements com.badlogic.gdx.Input.getAccelerometerY.

Annotations
@Override
getAccelerometerZback to summary
public float getAccelerometerZ()

Implements com.badlogic.gdx.Input.getAccelerometerZ.

Annotations
@Override
getAzimuthback to summary
public float getAzimuth()

Implements com.badlogic.gdx.Input.getAzimuth.

Doc from com.badlogic.gdx.Input.getAzimuth.

The azimuth is the angle of the device's orientation around the z-axis. The positive z-axis points towards the earths center.

Annotations
@Override
getCurrentEventTimeback to summary
public long getCurrentEventTime()

Implements com.badlogic.gdx.Input.getCurrentEventTime.

Annotations
@Override
getDeltaXback to summary
public int getDeltaX()

Implements com.badlogic.gdx.Input.getDeltaX.

Annotations
@Override
getDeltaXback to summary
public int getDeltaX(int pointer)

Implements com.badlogic.gdx.Input.getDeltaX.

Annotations
@Override
getDeltaYback to summary
public int getDeltaY()

Implements com.badlogic.gdx.Input.getDeltaY.

Annotations
@Override
getDeltaYback to summary
public int getDeltaY(int pointer)

Implements com.badlogic.gdx.Input.getDeltaY.

Annotations
@Override
getGyroscopeXback to summary
public float getGyroscopeX()

Implements com.badlogic.gdx.Input.getGyroscopeX.

Annotations
@Override
getGyroscopeYback to summary
public float getGyroscopeY()

Implements com.badlogic.gdx.Input.getGyroscopeY.

Annotations
@Override
getGyroscopeZback to summary
public float getGyroscopeZ()

Implements com.badlogic.gdx.Input.getGyroscopeZ.

Annotations
@Override
getInputProcessorback to summary
public InputProcessor getInputProcessor()

Implements com.badlogic.gdx.Input.getInputProcessor.

Annotations
@Override
getMaxPointersback to summary
public int getMaxPointers()

Implements com.badlogic.gdx.Input.getMaxPointers.

Annotations
@Override
getNativeOrientationback to summary
public Input.Orientation getNativeOrientation()

Implements com.badlogic.gdx.Input.getNativeOrientation.

Annotations
@Override
getPitchback to summary
public float getPitch()

Implements com.badlogic.gdx.Input.getPitch.

Doc from com.badlogic.gdx.Input.getPitch.

The pitch is the angle of the device's orientation around the x-axis. The positive x-axis roughly points to the west and is orthogonal to the z- and y-axis.

Annotations
@Override
getPressureback to summary
public float getPressure()

Implements com.badlogic.gdx.Input.getPressure.

Annotations
@Override
getPressureback to summary
public float getPressure(int pointer)

Implements com.badlogic.gdx.Input.getPressure.

Doc from com.badlogic.gdx.Input.getPressure.

Returns the pressure of the given pointer, where 0 is untouched. On Android it should be up to 1.0, but it can go above that slightly and its not consistent between devices. On iOS 1.0 is the normal touch and significantly more of hard touch. Check relevant manufacturer documentation for details. Check availability with Input#isPeripheralAvailable(Peripheral). If not supported, returns 1.0 when touched.

Annotations
@Override
getRollback to summary
public float getRoll()

Implements com.badlogic.gdx.Input.getRoll.

Doc from com.badlogic.gdx.Input.getRoll.

The roll is the angle of the device's orientation around the y-axis. The positive y-axis points to the magnetic north pole of the earth.

Annotations
@Override
getRotationback to summary
public int getRotation()

Implements com.badlogic.gdx.Input.getRotation.

Annotations
@Override
getRotationMatrixback to summary
public void getRotationMatrix(float[] matrix)

Implements com.badlogic.gdx.Input.getRotationMatrix.

Doc from com.badlogic.gdx.Input.getRotationMatrix.

Returns the rotation matrix describing the devices rotation as per SensorManager#getRotationMatrix(float[], float[], float[], float[]). Does not manipulate the matrix if the platform does not have an accelerometer.

Annotations
@Override
getTextInputback to summary
public void getTextInput(Input.TextInputListener listener, String title, String text, String hint)

Implements com.badlogic.gdx.Input.getTextInput.

Doc from com.badlogic.gdx.Input.getTextInput.

System dependent method to input a string of text. A dialog box will be created with the given title and the given text as a message for the user. Will use the Default keyboard type. Once the dialog has been closed the provided TextInputListener will be called on the rendering thread.

Annotations
@Override
getTextInputback to summary
public void getTextInput(Input.TextInputListener listener, String title, String text, String hint, Input.OnscreenKeyboardType type)

Implements com.badlogic.gdx.Input.getTextInput.

Doc from com.badlogic.gdx.Input.getTextInput.

System dependent method to input a string of text. A dialog box will be created with the given title and the given text as a message for the user. Once the dialog has been closed the provided TextInputListener will be called on the rendering thread.

Annotations
@Override
getXback to summary
public int getX()

Implements com.badlogic.gdx.Input.getX.

Annotations
@Override
getXback to summary
public int getX(int pointer)

Implements com.badlogic.gdx.Input.getX.

Doc from com.badlogic.gdx.Input.getX.

Returns the x coordinate in screen coordinates of the given pointer. Pointers are indexed from 0 to n. The pointer id identifies the order in which the fingers went down on the screen, e.g. 0 is the first finger, 1 is the second and so on. When two fingers are touched down and the first one is lifted the second one keeps its index. If another finger is placed on the touch screen the first free index will be used.

Annotations
@Override
getYback to summary
public int getY()

Implements com.badlogic.gdx.Input.getY.

Annotations
@Override
getYback to summary
public int getY(int pointer)

Implements com.badlogic.gdx.Input.getY.

Doc from com.badlogic.gdx.Input.getY.

Returns the y coordinate in screen coordinates of the given pointer. Pointers are indexed from 0 to n. The pointer id identifies the order in which the fingers went down on the screen, e.g. 0 is the first finger, 1 is the second and so on. When two fingers are touched down and the first one is lifted the second one keeps its index. If another finger is placed on the touch screen the first free index will be used.

Annotations
@Override
isButtonJustPressedback to summary
public boolean isButtonJustPressed(int button)

Implements com.badlogic.gdx.Input.isButtonJustPressed.

Doc from com.badlogic.gdx.Input.isButtonJustPressed.

Returns whether a given button has just been pressed. Button constants can be found in Buttons. On Android only the Buttons#LEFT constant is meaningful before version 4.0. On WebGL (GWT), only LEFT, RIGHT and MIDDLE buttons are supported.

Annotations
@Override
isButtonPressedback to summary
public boolean isButtonPressed(int button)

Implements com.badlogic.gdx.Input.isButtonPressed.

Doc from com.badlogic.gdx.Input.isButtonPressed.

Whether a given button is pressed or not. Button constants can be found in Buttons. On Android only the Buttons#LEFT constant is meaningful before version 4.0.

Annotations
@Override
isCatchKeyback to summary
public boolean isCatchKey(int keycode)

Implements com.badlogic.gdx.Input.isCatchKey.

Annotations
@Override
isCursorCatchedback to summary
public boolean isCursorCatched()

Implements com.badlogic.gdx.Input.isCursorCatched.

Annotations
@Override
isKeyJustPressedback to summary
public boolean isKeyJustPressed(int key)

Implements com.badlogic.gdx.Input.isKeyJustPressed.

Doc from com.badlogic.gdx.Input.isKeyJustPressed.

Returns whether the key has just been pressed.

Annotations
@Override
isKeyPressedback to summary
public boolean isKeyPressed(int key)

Implements com.badlogic.gdx.Input.isKeyPressed.

Doc from com.badlogic.gdx.Input.isKeyPressed.

Returns whether the key is pressed.

Annotations
@Override
isPeripheralAvailableback to summary
public boolean isPeripheralAvailable(Input.Peripheral peripheral)

Implements com.badlogic.gdx.Input.isPeripheralAvailable.

Doc from com.badlogic.gdx.Input.isPeripheralAvailable.

Queries whether a Peripheral is currently available. In case of Android and the Peripheral#HardwareKeyboard this returns the whether the keyboard is currently slid out or not.

Annotations
@Override
isTouchedback to summary
public boolean isTouched()

Implements com.badlogic.gdx.Input.isTouched.

Annotations
@Override
isTouchedback to summary
public boolean isTouched(int pointer)

Implements com.badlogic.gdx.Input.isTouched.

Doc from com.badlogic.gdx.Input.isTouched.

Whether the screen is currently touched by the pointer with the given index. Pointers are indexed from 0 to n. The pointer id identifies the order in which the fingers went down on the screen, e.g. 0 is the first finger, 1 is the second and so on. When two fingers are touched down and the first one is lifted the second one keeps its index. If another finger is placed on the touch screen the first free index will be used.

Annotations
@Override
justTouchedback to summary
public boolean justTouched()

Implements com.badlogic.gdx.Input.justTouched.

Annotations
@Override
openTextInputFieldback to summary
public void openTextInputField(NativeInputConfiguration configuration)

Implements com.badlogic.gdx.Input.openTextInputField.

Doc from com.badlogic.gdx.Input.openTextInputField.

Sets the on-screen keyboard visible if available.

Annotations
@Override
setCatchKeyback to summary
public void setCatchKey(int keycode, boolean catchKey)

Implements com.badlogic.gdx.Input.setCatchKey.

Doc from com.badlogic.gdx.Input.setCatchKey.

Sets whether the given key on Android or GWT should be caught. No effect on other platforms. All keys that are not caught may be handled by other apps or background processes on Android, or may trigger default browser behaviour on GWT. For example, media or volume buttons are handled by background media players if present, or Space key triggers a scroll. All keys you need to control your game should be caught to prevent unintended behaviour.

Annotations
@Override
setCursorCatchedback to summary
public void setCursorCatched(boolean catched)

Implements com.badlogic.gdx.Input.setCursorCatched.

Doc from com.badlogic.gdx.Input.setCursorCatched.

Only viable on the desktop. Will confine the mouse cursor location to the window and hide the mouse cursor. X and y coordinates are still reported as if the mouse was not catched.

Annotations
@Override
setCursorPositionback to summary
public void setCursorPosition(int x, int y)

Implements com.badlogic.gdx.Input.setCursorPosition.

Doc from com.badlogic.gdx.Input.setCursorPosition.

Only viable on the desktop. Will set the mouse cursor location to the given window coordinates (origin top-left corner).

Annotations
@Override
setInputProcessorback to summary
public void setInputProcessor(InputProcessor processor)

Implements com.badlogic.gdx.Input.setInputProcessor.

Doc from com.badlogic.gdx.Input.setInputProcessor.

Sets the InputProcessor that will receive all touch and key input events. It will be called before the ApplicationListener#render() method each frame.

Annotations
@Override
setKeyboardHeightObserverback to summary
public void setKeyboardHeightObserver(Input.KeyboardHeightObserver observer)

Implements com.badlogic.gdx.Input.setKeyboardHeightObserver.

Doc from com.badlogic.gdx.Input.setKeyboardHeightObserver.

This will set a keyboard height callback. This will get called, whenever the keyboard height changes.

Note

When using openTextInputField, it will report the height of the native input field too.

Annotations
@Override
setOnscreenKeyboardVisibleback to summary
public void setOnscreenKeyboardVisible(boolean visible)

Implements com.badlogic.gdx.Input.setOnscreenKeyboardVisible.

Doc from com.badlogic.gdx.Input.setOnscreenKeyboardVisible.

Sets the on-screen keyboard visible if available. Will use the Default keyboard type.

Annotations
@Override
setOnscreenKeyboardVisibleback to summary
public void setOnscreenKeyboardVisible(boolean visible, Input.OnscreenKeyboardType type)

Implements com.badlogic.gdx.Input.setOnscreenKeyboardVisible.

Doc from com.badlogic.gdx.Input.setOnscreenKeyboardVisible.

Sets the on-screen keyboard visible if available.

Annotations
@Override
vibrateback to summary
public void vibrate(int milliseconds)

Implements com.badlogic.gdx.Input.vibrate.

Doc from com.badlogic.gdx.Input.vibrate.

Generates a simple haptic effect of a given duration or a vibration effect on devices without haptic capabilities. Note that on Android backend you'll need the permission <uses-permission android:name="android.permission.VIBRATE" /> in your manifest file in order for this to work. On iOS backend you'll need to set useHaptics = true for devices with haptics capabilities to use them.

Annotations
@Override
vibrateback to summary
public void vibrate(int milliseconds, boolean fallback)

Implements com.badlogic.gdx.Input.vibrate.

Doc from com.badlogic.gdx.Input.vibrate.

Generates a simple haptic effect of a given duration and default amplitude. Note that on Android backend you'll need the permission <uses-permission android:name="android.permission.VIBRATE" /> in your manifest file in order for this to work. On iOS backend you'll need to set useHaptics = true for devices with haptics capabilities to use them.

Annotations
@Override
vibrateback to summary
public void vibrate(int milliseconds, int amplitude, boolean fallback)

Implements com.badlogic.gdx.Input.vibrate.

Doc from com.badlogic.gdx.Input.vibrate.

Generates a simple haptic effect of a given duration and amplitude. Note that on Android backend you'll need the permission <uses-permission android:name="android.permission.VIBRATE" /> in your manifest file in order for this to work. On iOS backend you'll need to set useHaptics = true for devices with haptics capabilities to use them.

Annotations
@Override
vibrateback to summary
public void vibrate(Input.VibrationType vibrationType)

Implements com.badlogic.gdx.Input.vibrate.

Doc from com.badlogic.gdx.Input.vibrate.

Generates a simple haptic effect of a type. VibrationTypes are length/amplitude haptic effect presets that depend on each device and are defined by manufacturers. Should give most consistent results across devices and OSs. Note that on Android backend you'll need the permission <uses-permission android:name="android.permission.VIBRATE" /> in your manifest file in order for this to work. On iOS backend you'll need to set useHaptics = true for devices with haptics capabilities to use them.

Annotations
@Override