ch.hevs.gdx2d.components.screen_management

Class RenderingScreen

java.lang.Object

ch.hevs.gdx2d.components.screen_management.RenderingScreen

All Implemented Interfaces:

GestureInterface, KeyboardInterface, TouchInterface, Disposable

public abstract class RenderingScreen
extends Object
implements KeyboardInterface, TouchInterface, GestureInterface, Disposable

Basic interface for all rendering screens

Author:

Pierre-André Mudry

Constructor Summary

Constructors

Constructor and Description
RenderingScreen()

Method Summary

Modifier and Type	Method and Description
void	dispose()
void	onClick(int x, int y, int button) Invoked when the pointer (mouse or touch) is pressed (once).
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.
protected abstract void	onGraphicRender(GdxGraphics g)
abstract void	onInit()
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	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	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	render(GdxGraphics g)

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderingScreen

public RenderingScreen()

Method Detail

onInit

public abstract void onInit()

onGraphicRender

protected abstract void onGraphicRender(GdxGraphics g)

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

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)

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

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)

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

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

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

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

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

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

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

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

dispose

public void dispose()

Specified by:

dispose in interface Disposable

render

public final void render(GdxGraphics g)