Dokumentace šablony třídy CApplication< T >

Jádro aplikace. ...

#include <Application.h>

Diagram dědičnosti pro třídu CApplication< T >

Seznam všech členů.

Veřejné metody
void	init (int *argc, char **argv)
bool	initDevIL (void)
void	initManagers ()
void	run (void)
void	changeState (int state)
	CApplication (void)
	~CApplication (void)
void	setTitle (string str)
void	setTitle (const char *str)
string	getTitle ()
virtual void	terminate ()
Statické veřejné metody
static void	clear (void)
Chráněné metody
void	loadResources (void)
virtual void	loadTextures (void)=0
virtual void	loadFonts (void)=0
virtual void	createScenes ()=0
void	mouseMove (int x, int y)
void	mouseButtons (int button, int state, int x, int y)
void	keyboard (unsigned char key, int x, int y)
void	keyboardSpecial (int key, int x, int y)
void	timer (int value)
void	renderScene (void)
void	changeSize (int width, int height)
bool	isCallTerminate ()
void	cleanUp ()
Statické chráněné metody
static void	mouseMoveWrapper (int x, int y)
static void	mouseButtonsWrapper (int button, int state, int x, int y)
static void	keyboardWrapper (unsigned char key, int x, int y)
static void	keyboardSpecialWrapper (int key, int x, int y)
static void	renderSceneWrapper (void)
static void	changeSizeWrapper (int width, int height)
static void	timerWrapper (int value)
Chráněné atributy
string	m_title
bool	m_terminate
CGameStateManager *	m_gameStateManager

---

Detailní popis

template<class T>
class CApplication< T >

Jádro aplikace.

Jedná se o třídu starající se o správu celé aplikace.

Autor:

František Toman

Verze:

1.0

Kontakt: tomanfra@fit.cvut.cz

---

Dokumentace konstruktoru a destruktoru

template<class T >

CApplication< T >::CApplication

(

void

)

[inline]

Konstruktor

template<class T >

CApplication< T >::~CApplication

(

void

)

[inline]

Destruktor

---

Dokumentace k metodám

template<class T >

void CApplication< T >::changeSize	(	int	width,
		int	height
	)			[inline, protected]

Změna velikosti okna

Parametry:

	width
	height	Změma velikosti okna
	width
	height

template<class T >

void CApplication< T >::changeSizeWrapper	(	int	width,
		int	height
	)			[inline, static, protected]

Změna velikosti okna

Parametry:

	width
	height

template<class T >

void CApplication< T >::changeState

(

int

state

)

[inline]

Změní scénu hry

Parametry:

state

- identifikátor scény v manažeru scén

template<class T >

void CApplication< T >::cleanUp

(

)

[inline, protected]

Uvolnění zdrojů aplikace

template<class T >

void CApplication< T >::clear

(

void

)

[inline, static]

Uvolnění zdrojů aplikace

Dealokace alokovaných prostředků

template<class T>

virtual void CApplication< T >::createScenes

(

)

[protected, pure virtual]

Vytvoří scény hry

Implementováno v SokobanGame.

template<class T>

string CApplication< T >::getTitle

(

)

[inline]

Vrátí titulek aplikace

Návratová hodnota:

template<class T >

void CApplication< T >::init	(	int *	argc,
		char **	argv
	)			[inline]

Inicializuje aplikaci

Parametry:

	argc
	argv	Inicializace knihoven
	argc
	argv

template<class T >

bool CApplication< T >::initDevIL

(

void

)

[inline]

Inicializuje knihovnu DevIL - slouží k načítání a manipulaci obrázků

Návratová hodnota:

Inicializace knihovny DevIL - slouží k načítání obrázků z externích zdrojů Podrobnosti: http://openil.sourceforge.net/

Návratová hodnota:

template<class T >

void CApplication< T >::initManagers

(

)

[inline]

Inicializace manažerů zdrojů - textury, objekty, písma

template<class T>

bool CApplication< T >::isCallTerminate

(

)

[inline, protected]

Vrátí zdali bylo požádáno o ukončení aplikace

Návratová hodnota:

template<class T >

void CApplication< T >::keyboard	(	unsigned char	key,
		int	x,
		int	y
	)			[inline, protected]

Zachytí událost stisknutí klávesy - ASCII

Parametry:

	key
	x
	y	Obsluha klávesnice - ASCII
	key
	x
	y

template<class T >

void CApplication< T >::keyboardSpecial	(	int	key,
		int	x,
		int	y
	)			[inline, protected]

Zachytí událost stistknutí klávesy - kurzory, F1, F2, ...

Parametry:

	key
	x
	y	Obsluha klávesnice - speciální (F1, F2, kurzory)
	key
	x
	y

template<class T >

void CApplication< T >::keyboardSpecialWrapper	(	int	key,
		int	x,
		int	y
	)			[inline, static, protected]

Obsluha klávesnice - speciální

Parametry:

	key
	x
	y

template<class T >

void CApplication< T >::keyboardWrapper	(	unsigned char	key,
		int	x,
		int	y
	)			[inline, static, protected]

Obsluha klávesnice - ASCII

Parametry:

	key
	x
	y

template<class T>

virtual void CApplication< T >::loadFonts

(

void

)

[protected, pure virtual]

Načte písma

Implementováno v SokobanGame.

template<class T >

void CApplication< T >::loadResources

(

void

)

[inline, protected]

Načte základní zdroje aplikace

Načtení základních zdrojů - písma, textury

template<class T>

virtual void CApplication< T >::loadTextures

(

void

)

[protected, pure virtual]

Načte textury

Implementováno v SokobanGame.

template<class T >

void CApplication< T >::mouseButtons	(	int	button,
		int	state,
		int	x,
		int	y
	)			[inline, protected]

Zachytí událost stisknutí tlačítka myši

Parametry:

	button
	state
	x
	y	Obsluha tlačítek myši
	button
	state
	x
	y

template<class T >

void CApplication< T >::mouseButtonsWrapper	(	int	button,
		int	state,
		int	x,
		int	y
	)			[inline, static, protected]

Obsluha tlačítek myši

Parametry:

	button
	state
	x
	y

template<class T >

void CApplication< T >::mouseMove	(	int	x,
		int	y
	)			[inline, protected]

Zachytí událost pohybu myši

Parametry:

	x
	y	Obsluha pohybu myši
	x
	y

template<class T >

void CApplication< T >::mouseMoveWrapper	(	int	x,
		int	y
	)			[inline, static, protected]

Obsluha pohybu kurzoru

Parametry:

	x
	y

template<class T >

void CApplication< T >::renderScene

(

void

)

[inline, protected]

Vykreslení aktuální scény

Vykreslení scény

template<class T >

void CApplication< T >::renderSceneWrapper

(

void

)

[inline, static, protected]

Vykreslení scény

template<class T >

void CApplication< T >::run

(

void

)

[inline]

Spustí smyčku aplikace

Spustí hlavní smyčku aplikace

template<class T>

void CApplication< T >::setTitle

(

const char *

str

)

[inline]

Nastaví titulek okna aplikace

Parametry:

str

- titulek

template<class T>

void CApplication< T >::setTitle

(

string

str

)

[inline]

Nastaví titulek okna aplikace

Parametry:

str

- titulek

template<class T >

void CApplication< T >::terminate

(

)

[inline, virtual]

Ukončí aplikaci

template<class T >

void CApplication< T >::timer

(

int

value

)

[inline, protected]

Časovač

Parametry:

value

template<class T >

void CApplication< T >::timerWrapper

(

int

value

)

[inline, static, protected]

Časovač

Parametry:

value

---

Dokumentace k datovým členům

template<class T>

CGameStateManager* CApplication< T >::m_gameStateManager [protected]

Manažer scén

template<class T>

bool CApplication< T >::m_terminate [protected]

Ukončení aplikace

template<class T>

string CApplication< T >::m_title [protected]

Titulek okna

---

Dokumentace pro tuto třídu byla generována z následujícího souboru:

• Application.h