yap::IGameScreen Struct Reference

Represents a phase of the game client. More...

#include <IGameScreen.hpp>

Inheritance diagram for yap::IGameScreen:

Collaboration diagram for yap::IGameScreen:

List of all members.

Public Member Functions
virtual	~IGameScreen ()
virtual void	Init ()=0
	Called once after the add into a IGameScreenManager.
virtual void	Activate ()=0
	Called each time this IGameScreen is slected to be run.
virtual void	Deactivate ()=0
	Called each time this IGameScreen is not running anymore.
virtual void	NextFrame ()=0
virtual const ScreenType &	Run (const Time &dt, IDrawingContext &context)=0
	Performs one frame of the screen life.
virtual const GuiManager &	GetGuiManager () const =0
	Gets the root widget of this Screen.
virtual GuiManager &	GetGuiManager ()=0
	Gets the root widget of this Screen.
virtual const ScreenType &	GetType () const =0
	Gets the unique type name of this Screen.
virtual Event< IGameScreen & > &	OnGameExitedEvent ()=0
Public Member Functions inherited from yap::IEventHandler
virtual	~IEventHandler ()
virtual bool	OnEvent (const GuiEvent &guiEvent)=0
	Treats an event. Transferts the event before treating it.
virtual bool	OnPriorityEvent (const GuiEvent &guiEvent)=0
	Treats an event. Treats the event before transfering it.

---

Detailed Description

Represents a phase of the game client.

Definition at line 18 of file IGameScreen.hpp.

---

Constructor & Destructor Documentation

virtual yap::IGameScreen::~IGameScreen ( )

inlinevirtual

Definition at line 20 of file IGameScreen.hpp.

---

Member Function Documentation

virtual void yap::IGameScreen::Activate ( )

pure virtual

Called each time this IGameScreen is slected to be run.

Implemented in yap::GameScreen.

Here is the caller graph for this function:

virtual void yap::IGameScreen::Deactivate ( )

pure virtual

Called each time this IGameScreen is not running anymore.

Implemented in yap::GameScreen.

Here is the caller graph for this function:

virtual const GuiManager& yap::IGameScreen::GetGuiManager ( ) const

pure virtual

Gets the root widget of this Screen.

Returns:

A constant reference to the root widget of this Screen.

Implemented in yap::GameScreen.

virtual GuiManager& yap::IGameScreen::GetGuiManager ( )

pure virtual

Gets the root widget of this Screen.

Returns:

A non-constant reference to the root widget of this Screen.

Implemented in yap::GameScreen.

virtual const ScreenType& yap::IGameScreen::GetType ( ) const

pure virtual

Gets the unique type name of this Screen.

Implemented in yap::GameScreen.

Here is the caller graph for this function:

virtual void yap::IGameScreen::Init ( )

pure virtual

Called once after the add into a IGameScreenManager.

Implemented in yap::GameScreen.

virtual void yap::IGameScreen::NextFrame ( )

pure virtual

Implemented in yap::GameScreen.

Here is the caller graph for this function:

virtual Event<IGameScreen&>& yap::IGameScreen::OnGameExitedEvent ( )

pure virtual

Implemented in yap::GameScreen.

Here is the caller graph for this function:

virtual const ScreenType& yap::IGameScreen::Run ( const Time &  dt, IDrawingContext &  context  )

pure virtual

Performs one frame of the screen life.

Parameters:

dt	Delta time elapsed since last frame.
context	Drawing context where are drawn graphical elements.

Returns:

Next screen type that must be executed. By default, the returned type is the type of this Screen.

Implemented in yap::GameScreen.

Here is the caller graph for this function:

---

The documentation for this struct was generated from the following file:

• G:/YAPOG/YAPOG/YAPOG/include/YAPOG/Graphics/Game/IGameScreen.hpp