org.mini2Dx.ecs.system

Class ScreenManagerSystem

java.lang.Object

org.mini2Dx.ecs.system.ScreenManagerSystem

All Implemented Interfaces:

ScreenManager<GameScreenEntity>, System<GameScreenEntity>

public class ScreenManagerSystem
extends Object
implements System<GameScreenEntity>, ScreenManager<GameScreenEntity>

An implementation of ScreenManager as a System suitable for the Entity-Component-System architecture

Author:

Thomas Cashman

Field Summary

Fields

Modifier and Type	Field and Description
protected GameScreenEntity	currentScreen
protected GameScreenEntity	nextScreen
protected Transition	transitionIn
protected Transition	transitionOut

Constructor Summary

Constructors

Constructor and Description
ScreenManagerSystem()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEntity(GameScreenEntity entity) Adds an Entity to the System
void	addGameScreen(GameScreenEntity screen) Interface implementation.
void	enterGameScreen(int id, Transition transitionOut, Transition transitionIn) Begins a transition to a new GameScreen
GameScreenEntity	getGameScreen(int id) Returns the GameScreen with the given id
void	initialise(GameContainer gc) Initialise the System
void	interpolate(GameContainer gc, float alpha) Interpolate the System
boolean	isDebugging() Returns if this System is debugging
boolean	isTransitioning() Returns if the ScreenManager is moving between Screens
void	removeEntity(GameScreenEntity entity) Removes an Entity from the System
void	render(GameContainer gc, Graphics g) Render the System
void	setDebugging(boolean debugging) Sets whether or not this System is in debug mode
void	update(GameContainer gc, float delta) Update the System

Methods inherited from class java.lang.Object

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

Field Detail

currentScreen

protected GameScreenEntity currentScreen

nextScreen

protected GameScreenEntity nextScreen

transitionIn

protected Transition transitionIn

transitionOut

protected Transition transitionOut

Constructor Detail

ScreenManagerSystem

public ScreenManagerSystem()

Method Detail

addEntity

public void addEntity(GameScreenEntity entity)

Description copied from interface: System

Adds an Entity to the System

Specified by:

addEntity in interface System<GameScreenEntity>

Parameters:

entity - The Entity to be added

removeEntity

public void removeEntity(GameScreenEntity entity)

Description copied from interface: System

Removes an Entity from the System

Specified by:

removeEntity in interface System<GameScreenEntity>

Parameters:

entity - The UUIDEntity to be removed

initialise

public void initialise(GameContainer gc)

Description copied from interface: System

Initialise the System

Specified by:

initialise in interface System<GameScreenEntity>

Parameters:

gc - The GameContainer calling initialise

update

public void update(GameContainer gc,
          float delta)

Description copied from interface: System

Update the System

Specified by:

update in interface ScreenManager<GameScreenEntity>

Specified by:

update in interface System<GameScreenEntity>

Parameters:

gc - The GameContainer calling update

delta - The time in seconds since the last update

interpolate

public void interpolate(GameContainer gc,
               float alpha)

Description copied from interface: System

Interpolate the System

Specified by:

interpolate in interface ScreenManager<GameScreenEntity>

Specified by:

interpolate in interface System<GameScreenEntity>

Parameters:

gc - The GameContainer calling interpolate

alpha - The alpha value to use during interpolation

render

public void render(GameContainer gc,
          Graphics g)

Description copied from interface: System

Render the System

Specified by:

render in interface ScreenManager<GameScreenEntity>

Specified by:

render in interface System<GameScreenEntity>

Parameters:

gc - The GameContainer calling render

g - The Graphics instance

isDebugging

public boolean isDebugging()

Description copied from interface: System

Returns if this System is debugging

Specified by:

isDebugging in interface System<GameScreenEntity>

Returns:

True if debugging

setDebugging

public void setDebugging(boolean debugging)

Description copied from interface: System

Sets whether or not this System is in debug mode

Specified by:

setDebugging in interface System<GameScreenEntity>

Parameters:

debugging - True if debugging

enterGameScreen

public void enterGameScreen(int id,
                   Transition transitionOut,
                   Transition transitionIn)

Description copied from interface: ScreenManager

Begins a transition to a new GameScreen

Specified by:

enterGameScreen in interface ScreenManager<GameScreenEntity>

Parameters:

id - The id of the GameScreen to transition to

transitionOut - The outgoing Transition, e.g. fade out

transitionIn - The incoming Transition, e.g. fade in

addGameScreen

public void addGameScreen(GameScreenEntity screen)

Interface implementation. Calls addEntity.

Specified by:

addGameScreen in interface ScreenManager<GameScreenEntity>

Parameters:

screen - The GameScreen to be added

getGameScreen

public GameScreenEntity getGameScreen(int id)

Description copied from interface: ScreenManager

Returns the GameScreen with the given id

Specified by:

getGameScreen in interface ScreenManager<GameScreenEntity>

Parameters:

id - The id to search for

Returns:

Null if there is no such GameScreen registered with this manager

isTransitioning

public boolean isTransitioning()

Description copied from interface: ScreenManager

Returns if the ScreenManager is moving between Screens

Specified by:

isTransitioning in interface ScreenManager<GameScreenEntity>

Returns:

False if there are no Transitions active