ch.hevs.gdx2d.desktop

Class PortableApplication

java.lang.Object

ch.hevs.gdx2d.desktop.PortableApplication

All Implemented Interfaces:

GameInterface, GestureInterface, KeyboardInterface, TouchInterface

public abstract class PortableApplication
extends Object
implements TouchInterface, KeyboardInterface, GameInterface, GestureInterface

The base class that should be sub-classed by all gdx2d applications. To get the functionality required you simply have to overload the required methods.

Version:

1.1

Author:

Pierre-André Mudry (mui), Christopher Metrailler (mei)

See Also:

TouchInterface, KeyboardInterface, GameInterface

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CreateLwjglApplication
protected boolean	onAndroid Deprecated.

Constructor Summary

Constructors

Constructor and Description
PortableApplication() Creates an application using gdx2d.
PortableApplication(boolean onAndroid) Deprecated.
PortableApplication(boolean onAndroid, int width, int height) Deprecated.
PortableApplication(boolean onAndroid, int width, int height, boolean fullScreen) Deprecated.
PortableApplication(int width, int height) Creates an application using gdx2d.
PortableApplication(int width, int height, boolean fullScreen) Create a full-screen gdx2d application.

Method Summary

Modifier and Type	Method and Description
void	exit() Schedule an exit from the application.
AndroidResolver	getAndroidResolver() Return the AndroidResolver to use Android actions.
int	getWindowHeight() Rendering surface information
int	getWindowWidth() Rendering surface information
boolean	onAndroid() Detect android
void	onClick(int x, int y, int button) Invoked when the pointer (mouse or touch) is pressed (once).
void	onDispose() Called when the application stops.
void	onDrag(int x, int y) Invoked when the pointer (mouse or touch) is moved and down.
void	onFling(float velocityX, float velocityY, int button) Called when the user dragged a finger over the screen and lifted it.
void	onGameLogicUpdate() Called when the logic has to be updated.
void	onKeyDown(int keycode) Invoked when a key is typed.
void	onKeyUp(int keycode) Invoked when a key is released.
void	onLongPress(float x, float y) Called on long press on Android.
void	onPan(float x, float y, float deltaX, float deltaY) Called when the user drags a finger over the screen on Android.
void	onPause() Invoked when the application is paused.
void	onPinch(Vector2 initialPointer1, Vector2 initialPointer2, Vector2 pointer1, Vector2 pointer2) Called when a user performs a pinch zoom gesture on Android.
void	onRelease(int x, int y, int button) Invoked when the pointer (mouse or touch) is released.
void	onResume() Called when the application is restarted.
void	onScroll(int amount) Invoked when the mouse scroll (wheel) has been moved.
void	onTap(float x, float y, int count, int button) Invoked for a tap gesture on Android.
void	onZoom(float initialDistance, float distance) Called when the user performs a pinch zoom gesture on Android.
void	setAndroidResolver(AndroidResolver resolver) Set the AndroidResolver when the application is created on Android.
void	setTitle(String title) Change the title of the application window (works only on desktop).

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.hevs.gdx2d.lib.interfaces.GameInterface

onGraphicRender, onInit

Field Detail

onAndroid

@Deprecated
protected final boolean onAndroid

Deprecated.

CreateLwjglApplication

public static boolean CreateLwjglApplication

Constructor Detail

PortableApplication

@Deprecated
public PortableApplication(boolean onAndroid)

Deprecated.

Creates an application using gdx2d. Use a default windows size.

Parameters:

onAndroid - true if running on Android, false otherwise

PortableApplication

public PortableApplication()

Creates an application using gdx2d. Use a default windows size.

PortableApplication

@Deprecated
public PortableApplication(boolean onAndroid,
                                        int width,
                                        int height)

Deprecated.

Creates an application using gdx2d. Screen dimension are ignored when running on Android.

Parameters:

onAndroid - true if running on Android, false otherwise

width - The width of the screen (only for desktop)

height - The height of the screen (only for desktop)

PortableApplication

public PortableApplication(int width,
                           int height)

Creates an application using gdx2d. Screen dimension are ignored when running on Android.

Parameters:

width - The width of the screen (only for desktop)

height - The height of the screen (only for desktop)

PortableApplication

public PortableApplication(int width,
                           int height,
                           boolean fullScreen)

Create a full-screen gdx2d application.

Parameters:

width - The width of the screen

height - The height of the screen

fullScreen - Indicates if the application should be launched full screen on desktop, or in default resolution

PortableApplication

@Deprecated
public PortableApplication(boolean onAndroid,
                                        int width,
                                        int height,
                                        boolean fullScreen)

Deprecated.

Creates an application using gdx2d, running full screen or not on desktop. Screen dimension are ignored when running on Android.

Parameters:

onAndroid - true if running on Android, false otherwise

width - The width of the screen (only for desktop)

height - The height of the screen (only for desktop)

fullScreen - true to create a fullscreen application (only for desktop)

Method Detail

onAndroid

public boolean onAndroid()

Detect android

Returns:

true when running on Android.

setTitle

public void setTitle(String title)

Change the title of the application window (works only on desktop). This method has no effect (ignored) when running on Android.

Parameters:

title - the application title

getWindowHeight

public int getWindowHeight()

Rendering surface information

Returns:

The height of the display surface (window)

getWindowWidth

public int getWindowWidth()

Rendering surface information

Returns:

The width of the display surface (window)

exit

public void exit()

Schedule an exit from the application. On android, this will cause a call to onPause() and onDispose() some time in the future, it will not immediately finish your application.

onClick

public void onClick(int x,
                    int y,
                    int button)

Description copied from interface: TouchInterface

Invoked when the pointer (mouse or touch) is pressed (once).

Note: on Android, the button parameter will always be Input.Buttons.LEFT.

Specified by:

onClick in interface TouchInterface

Parameters:

x - the screen X coordinate (origin is the lower left corner)

y - the screen Y coordinate (origin is the lower left corner)

button - Input.Buttons.LEFT or Input.Buttons.RIGHT button clicked

See Also:

TouchInterface.onClick(int, int, int)

onDrag

public void onDrag(int x,
                   int y)

Description copied from interface: TouchInterface

Invoked when the pointer (mouse or touch) is moved and down.

Specified by:

onDrag in interface TouchInterface

Parameters:

x - the screen X coordinate (origin is the lower left corner)

y - the screen Y coordinate (origin is the lower left corner)

See Also:

TouchInterface.onDrag(int, int)

onRelease

public void onRelease(int x,
                      int y,
                      int button)

Description copied from interface: TouchInterface

Invoked when the pointer (mouse or touch) is released.

Note: on Android, the button parameter will always be Input.Buttons.LEFT.

Specified by:

onRelease in interface TouchInterface

Parameters:

x - the screen X coordinate (origin is the lower left corner)

y - the screen Y coordinate (origin is the lower left corner)

button - Input.Buttons.LEFT or Input.Buttons.RIGHT button clicked

See Also:

TouchInterface.onRelease(int, int, int)

onScroll

public void onScroll(int amount)

Description copied from interface: TouchInterface

Invoked when the mouse scroll (wheel) has been moved.

The amount can be positive or negative depending on the direction the wheel was scrolled.

Specified by:

onScroll in interface TouchInterface

Parameters:

amount - the scroll amount

See Also:

TouchInterface.onScroll(int)

onKeyDown

public void onKeyDown(int keycode)

Description copied from interface: KeyboardInterface

Invoked when a key is typed.

Use Input.Keys to read the key code.

Specified by:

onKeyDown in interface KeyboardInterface

Parameters:

keycode - the code key, see Input.Keys

See Also:

KeyboardInterface.onKeyDown(int)

onKeyUp

public void onKeyUp(int keycode)

Description copied from interface: KeyboardInterface

Invoked when a key is released.

Use Input.Keys to read the key code.

Specified by:

onKeyUp in interface KeyboardInterface

Parameters:

keycode - the code key, see Input.Keys

See Also:

KeyboardInterface.onKeyUp(int)

onDispose

public void onDispose()

Description copied from interface: GameInterface

Called when the application stops.

Tidying up must be done here.

Specified by:

onDispose in interface GameInterface

See Also:

GameInterface.onDispose()

onPause

public void onPause()

Description copied from interface: GameInterface

Invoked when the application is paused.

Called only when running on Android.

Specified by:

onPause in interface GameInterface

See Also:

GameInterface.onPause()

onGameLogicUpdate

public void onGameLogicUpdate()

Description copied from interface: GameInterface

Called when the logic has to be updated. Might not be called.

Specified by:

onGameLogicUpdate in interface GameInterface

See Also:

GameInterface.onGameLogicUpdate()

onResume

public void onResume()

Description copied from interface: GameInterface

Called when the application is restarted.

Called only when running on Android. Initializations and creation of new new objects must be done here.

Specified by:

onResume in interface GameInterface

See Also:

GameInterface.onResume()

onZoom

public void onZoom(float initialDistance,
                   float distance)

Description copied from interface: GestureInterface

Called when the user performs a pinch zoom gesture on Android.

The original distance is the distance in pixels when the gesture started.

Specified by:

onZoom in interface GestureInterface

Parameters:

initialDistance - distance between fingers when the gesture started

distance - current distance between fingers

See Also:

GestureInterface.onZoom(float, float)

onTap

public void onTap(float x,
                  float y,
                  int count,
                  int button)

Description copied from interface: GestureInterface

Invoked for a tap gesture on Android.

A tap happens if a touch went down on the screen and was lifted again without moving outside of the tap square.

Specified by:

onTap in interface GestureInterface

Parameters:

x - the screen X coordinate (origin is the lower left corner)

y - the screen Y coordinate (origin is the lower left corner)

count - the number of taps

button - Input.Buttons.LEFT or Input.Buttons.RIGHT button clicked

See Also:

GestureInterface.onTap(float, float, int, int)

onPinch

public void onPinch(Vector2 initialPointer1,
                    Vector2 initialPointer2,
                    Vector2 pointer1,
                    Vector2 pointer2)

Description copied from interface: GestureInterface

Called when a user performs a pinch zoom gesture on Android. Reports the initial positions of the two involved fingers and their current positions.

Specified by:

onPinch in interface GestureInterface

Parameters:

initialPointer1 - finger 1 initial position

initialPointer2 - finger 2 initial position

pointer1 - finger 1 current position

pointer2 - finger 2 current position

See Also:

GestureInterface.onPinch(Vector2, Vector2, Vector2, Vector2)

onPan

public void onPan(float x,
                  float y,
                  float deltaX,
                  float deltaY)

Description copied from interface: GestureInterface

Called when the user drags a finger over the screen on Android.

Specified by:

onPan in interface GestureInterface

Parameters:

x - the screen X coordinate (origin is the lower left corner)

y - the screen Y coordinate (origin is the lower left corner)

deltaX - the difference in pixels to the last drag event on x

deltaY - the difference in pixels to the last drag event on y

See Also:

GestureInterface.onPan(float, float, float, float)

onLongPress

public void onLongPress(float x,
                        float y)

Description copied from interface: GestureInterface

Called on long press on Android.

Specified by:

onLongPress in interface GestureInterface

Parameters:

x - the screen X coordinate (origin is the lower left corner)

y - the screen Y coordinate (origin is the lower left corner)

See Also:

GestureInterface.onLongPress(float, float)

onFling

public void onFling(float velocityX,
                    float velocityY,
                    int button)

Description copied from interface: GestureInterface

Called when the user dragged a finger over the screen and lifted it. Reports the last known velocity of the finger in pixels per second.

Specified by:

onFling in interface GestureInterface

Parameters:

velocityX - velocity on the X axis in seconds

velocityY - velocity on the Y axis in seconds

button - Input.Buttons.LEFT or Input.Buttons.RIGHT button clicked

See Also:

GestureInterface.onFling(float, float, int)

getAndroidResolver

public AndroidResolver getAndroidResolver()

Return the AndroidResolver to use Android actions.

Returns:

The resolver, or null if no running on Android

Since:

1.1

setAndroidResolver

public void setAndroidResolver(AndroidResolver resolver)

Set the AndroidResolver when the application is created on Android. The resolver must be create in an Android Activity with its Context

Parameters:

resolver - the Android resolver

Since:

1.1