de.verygame.surface.screen.base

Class BaseScreen

java.lang.Object

de.verygame.surface.screen.base.BaseScreen

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable, Screen

Direct Known Subclasses:

BaseSubScreen, SimpleScreen

public abstract class BaseScreen
extends java.lang.Object
implements Screen

Field Summary

Fields

Modifier and Type	Field and Description
protected Content	content content, which is displayed by the screen
protected SubScreenContext	context All not content related information about the screen
protected Transition[]	transition De|Activate transition

Constructor Summary

Constructors

Constructor and Description
BaseScreen(com.badlogic.gdx.utils.viewport.Viewport viewport, Content content) Constructs a basic screen.

Method Summary

Modifier and Type	Method and Description
void	dispose()
Content	getContent()
void	onActivate(ScreenId predecessor) Will be called when the screen gets set active.
void	onAdd(com.badlogic.gdx.graphics.g2d.PolygonSpriteBatch batch, com.badlogic.gdx.InputMultiplexer inputMultiplexer, java.util.Map<java.lang.String,java.lang.Object> dependencyMap) Will be called when the screen gets added to a screen switch.
float	onDeactivate(ScreenId successor) Will be called when the screen gets set inactive.
void	onPause() Will always be called on pause when the screen has been added to the screen switch.
void	onRender() Will be called on render when the screen is active.
void	onResize(int width, int height) Will be called on resize when the screen is active.
void	onResume() Will always be called on resume when the screen has been added to the screen switch.
void	onUpdate() Will be called on update when the screen is active.
void	setInTransition(Transition in) Sets a transition which will determine the animation when the screen gets activated.
void	setOutTransition(Transition out) Sets a transition which will determine the animation when the screen gets deactivated.

Methods inherited from class java.lang.Object

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

Field Detail

content

protected final Content content

content, which is displayed by the screen

context

protected final SubScreenContext context

All not content related information about the screen

transition

protected Transition[] transition

De|Activate transition

Constructor Detail

BaseScreen

public BaseScreen(com.badlogic.gdx.utils.viewport.Viewport viewport,
                  Content content)

Constructs a basic screen.

Parameters:

viewport - viewport, which should be used to manage glViewport

content - content of the screen

Method Detail

setOutTransition

public void setOutTransition(Transition out)

Description copied from interface: Screen

Sets a transition which will determine the animation when the screen gets deactivated.

Specified by:

setOutTransition in interface Screen

Parameters:

out - the transition

setInTransition

public void setInTransition(Transition in)

Description copied from interface: Screen

Sets a transition which will determine the animation when the screen gets activated.

Specified by:

setInTransition in interface Screen

Parameters:

in - the transition

onActivate

public void onActivate(ScreenId predecessor)

Description copied from interface: Screen

Will be called when the screen gets set active.

Specified by:

onActivate in interface Screen

Parameters:

predecessor - predecessor of the screen

onDeactivate

public float onDeactivate(ScreenId successor)

Description copied from interface: Screen

Will be called when the screen gets set inactive. With returning a number greater than 0 you can delay the switch to perform an animation.

Specified by:

onDeactivate in interface Screen

Parameters:

successor - successor of the screen

Returns:

number greater than 0 as delay

onAdd

public void onAdd(com.badlogic.gdx.graphics.g2d.PolygonSpriteBatch batch,
                  com.badlogic.gdx.InputMultiplexer inputMultiplexer,
                  java.util.Map<java.lang.String,java.lang.Object> dependencyMap)

Description copied from interface: Screen

Will be called when the screen gets added to a screen switch.

Specified by:

onAdd in interface Screen

Parameters:

batch - batch of the screen switch

onResize

public void onResize(int width,
                     int height)

Description copied from interface: Screen

Will be called on resize when the screen is active.

Specified by:

onResize in interface Screen

Parameters:

width - width of the frame

height - height of the frame

onUpdate

public void onUpdate()

Description copied from interface: Screen

Will be called on update when the screen is active.

Specified by:

onUpdate in interface Screen

onRender

public void onRender()

Description copied from interface: Screen

Will be called on render when the screen is active.

Specified by:

onRender in interface Screen

onPause

public void onPause()

Description copied from interface: Screen

Will always be called on pause when the screen has been added to the screen switch.

Specified by:

onPause in interface Screen

onResume

public void onResume()

Description copied from interface: Screen

Will always be called on resume when the screen has been added to the screen switch.

Specified by:

onResume in interface Screen

dispose

public void dispose()

Specified by:

dispose in interface com.badlogic.gdx.utils.Disposable

getContent

public Content getContent()

Specified by:

getContent in interface Screen

Returns:

content of the screen