Dokumentacja klasy Game

Klasa Game - obszar główny z grą Więcej...

#include <game.h>

Diagram dziedziczenia dla Game

Diagram współpracy dla Game:

Sygnały
void	changeDeficit (int ECTS)
	Zmienia wartość deficytu. Więcej...
void	changeECTS (int ECTS)
	Zmienia wartość punktów ECTS. Więcej...
void	changeTerm (int term)
	Zmienia wartość numeru semestru. Więcej...
void	changeDeansLeave (int number)
	Zmienia wartość ilości dziekanek. Więcej...
void	stopStudent ()
	Zatrzymuje studenta w miejscu. Więcej...
void	startStudent ()
	Odblokowuje studenta. Więcej...
void	closeGame ()
	Sygnał zamknięcia gry. Więcej...
void	changeButtonToStart ()
	Sygnał zmiany napisu na przyciusku start. Więcej...

Metody publiczne
	Game (QWidget *parent=0)
	Konstruktor klasy Game. Więcej...
bool	getGameStarted () const
	Zwraca flagę stanu gry. Więcej...
void	setGameStarted (bool isStarted)
	Ustawia flagę stanu gry. Więcej...

Atrybuty publiczne
GameSettings *	gameSettings
	Globalne ustawienia gry. Więcej...

Sloty prywatne
void	on_Courses_increaseDeficit (int ECTS)
	Zwiększa liczbę punktów deficytu. Więcej...
void	on_Courses_decreaseDeficit (int ECTS)
	Zmniejsza liczbę punktów deficytu. Więcej...
void	on_Courses_increaseECTS (int ECTS)
	Zwiększa liczbę sumy punktów ECTS. Więcej...
void	on_Courses_changeTerm (int term)
	Zmienia numer aktualnego semestru. Więcej...
void	on_Courses_failedToReadData ()
	Obsługuje błąd odczytu plików semestrów. Więcej...
void	on_startGame_clicked ()
	Obsługuje naciśnięcie przycisu rozpoczęcia gry. Więcej...
void	on_stopGame_clicked ()
	Obsługuje naciśnięcie przycisu spauzowania gry. Więcej...
void	on_MainWindow_inicializeNewGame ()
	Reaguje na sygnał potrzeby inicjalizacji nowej gry. Więcej...
void	on_Courses_checkDeficitOverstep ()
	Sprawdza przekroczenie deficytu. Więcej...
void	on_Courses_gameFinished ()
	Wyświetla końcowy komunikat w przypadku powodzenia gry. Więcej...
void	newDataArrived (rawData data)
	Obsługuje przyjścienowych danych z czujników. Więcej...

Metody prywatne
void	startTimers ()
	Zatrzymuje wszystkie timery. Więcej...
void	stopTimers ()
	Startuje wszystkie timery. Więcej...
void	connectCourses ()
	Łączy wszystkie sloty i sygnały związane z kursami. Więcej...
void	connectStudent ()
	Łączy wszystkie sloty i sygnały związane ze studentem. Więcej...
void	setupScene ()
	Ustawia scenę gry. Więcej...
void	createNewGame ()
	Generuje nową grę Więcej...
void	deficitOversteped ()
	Obsługuje przekroczenie deficytu punków ECTS. Więcej...
void	playStartingMusic ()
	Odtwarza początkową muzykę Więcej...
void	playEndMusic ()
	Odtwarza muzykę końca gry. Więcej...

Atrybuty prywatne
QGraphicsScene *	_scene
	Uchwyt do sceny. Więcej...
Student *	_student
	Uchwyt do studenta. Więcej...
Courses *	_courses
	Uchwyt do kursów. Więcej...
QTimer *	_timerCourses
	Uchwyt do timera generujacego kursy. Więcej...
QTimer *	_timerMove
	Uchwyt do timera przesuwającego kursy. Więcej...
int	_ECTS
	Suma zdobytych punktów ECTS. Więcej...
int	_term
	Aktualny semestr studiów. Więcej...
int	_deficit
	Deficyt punktowy. Więcej...
int	_deansLeave
	Liczba wzietych urlopów dziekańskich. Więcej...
bool	_gameStarted
	Flaga wystartowania gry. Więcej...
QMediaPlayer *	player
	Odtwarzacz muzyki. Więcej...

Opis szczegółowy

Klasa modeluje pojęcie gry. Dziedziczy po klasie QGraphicsView. Klasa ta definiuje obszar główny z grą, na której porusza się student oraz wyświetlanie są kolejne kursy. Służy ona do obsługi całej gry. Zawiera definicje oraz metody do obsługi timerów odpowiedzialnych za działanie gry.

Definicja w linii 29 pliku game.h.

Dokumentacja konstruktora i destruktora

Game::Game

(

QWidget *

parent = 0

)

Inicjalizuje pola klasy wartościami początkowymi oraz generuje ustawienia globalne gry.

Parametry

parent

- rodzic

Definicja w linii 22 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Dokumentacja funkcji składowych

void Game::changeButtonToStart ( )

signal

Sygnał wysyłany, gdy należy zmienić napis na przycisku START/PAUZA na START.

Oto graf wywoływań tej funkcji:

void Game::changeDeansLeave ( int  number )

signal

Sygnał emitowany, gdy należy zmienić wartość na wyświetlaczu ilości wziętych dziekanek.

Parametry

[in]

number

- Przekazuje w parametrze liczbę dziekanek, na jaką należy zmienić.

Oto graf wywoływań tej funkcji:

void Game::changeDeficit ( int  ECTS )

signal

Sygnał emitowany, gdy należy zmienić wartość na wyświetlaczu deficytu punktów.

Parametry

[in]

ECTS

- Przekazuje w parametrze liczbę punktów o jaką należy zmienić deficyt.

Oto graf wywoływań tej funkcji:

void Game::changeECTS ( int  ECTS )

signal

Sygnał emitowany, gdy należy zmienić wartość na wyświetlaczu punktów ECTS.

Parametry

[in]

ECTS

- Przekazuje w parametrze liczbę punktów o jaką należy zmienić liczbę punktów.

Oto graf wywoływań tej funkcji:

void Game::changeTerm ( int  term )

signal

Sygnał emitowany, gdy należy zmienić wartość na wyświetlaczu numeru semestru.

Parametry

[in]

term

- Przekazuje w parametrze liczbę na jaką nalezy zmienić numer semestru.

Oto graf wywoływań tej funkcji:

void Game::closeGame ( )

signal

Sygnał wysyłany, gdy należy zamknąć całą grę

Oto graf wywoływań tej funkcji:

void Game::connectCourses ( )

private

Łączy wszystkie sloty i sygnały związane z kursami.

Definicja w linii 170 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Game::connectStudent ( )

private

Łączy wszystkie sloty i sygnały związane ze studentem.

Definicja w linii 188 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::createNewGame ( )

private

Usuwa dotychczasowe kursy ze sceny oraz pamięci, resetuje liczniki gry oraz ładuje nowe kursy.

Definicja w linii 206 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Game::deficitOversteped ( )

private

Służy do obsługi przekorczenia deficytu w grze. Zatrzymuje całą grę. Sprawdza, czy

Definicja w linii 231 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

bool Game::getGameStarted ( ) const

inline

Zwraca wartość w zależności od stanu gry.

Zwracane wartości

true	- gry gra została wystartowana
false	- gdy gra jest zastopowana

Definicja w linii 55 pliku game.h.

void Game::newDataArrived ( rawData  data )

privateslot

Obsługuje przyjście nowych danych z czujniów, poprzez przetworzenie ich i wywołanie funkcji Student::moveStudent().

Parametry

[in]

data

- surowe dane z czujników

Definicja w linii 149 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Game::on_Courses_changeTerm ( int  term )

privateslot

Zmienia numer aktualnego semestru i wysyła sygnał changeTerm(int).

• Parametry

  [out]

  term

  - Przekazuje w parametrze liczbę punktów o jaką należy zmienić.

Definicja w linii 68 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::on_Courses_checkDeficitOverstep ( )

privateslot

Sprawdza przekroczenie deficytu punktów w zależności od semestru na którym się znajduje aktualnie student.

Definicja w linii 111 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Game::on_Courses_decreaseDeficit ( int  ECTS )

privateslot

Zmniejsza sumę deficytu punków ECTS. Wysyła sygnał changeDeficit(int).

Parametry

[out]

ECTS

- Przekazuje w parametrze liczbę punktów o jaką należy zmienić.

Definicja w linii 80 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::on_Courses_failedToReadData ( )

privateslot

W przypadku, gdy nie można poprawnie odczytać plików z semestrami z zasobów wyświetlany jest odpowiedni komunikat i wysyłany jest sygnał closeGame().

Definicja w linii 86 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::on_Courses_gameFinished ( )

privateslot

Gdy ukończono grę wyświetlany jest komunikat o ukończeniu gry, z mołziwością wyboru daleszego postępowania.

Definicja w linii 124 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Game::on_Courses_increaseDeficit ( int  ECTS )

privateslot

Zwiększa sumę deficytu punków ECTS. Wysyła sygnał changeDeficit(int).

Parametry

[out]

ECTS

- Przekazuje w parametrze liczbę punktów o jaką należy zmienić.

Definicja w linii 74 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::on_Courses_increaseECTS ( int  ECTS )

privateslot

Zwiększa liczbę sumy punktów ECTS. Wysyła sygnał changeECTS(int).

Parametry

[out]

ECTS

- Przekazuje w parametrze liczbę punktów o jaką należy zmienić.

Definicja w linii 62 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::on_MainWindow_inicializeNewGame ( )

privateslot

Inicjalizuje nową grę poprzez ustawienie flagi _gameStarted na false i wywołanie funkcji createNewGame().

Definicja w linii 106 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Game::on_startGame_clicked ( )

privateslot

Ustawia wartość falgi _gameStarted na true, startuje timery gry oraz odblokowuje studenta.

Definicja w linii 92 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Game::on_stopGame_clicked ( )

privateslot

Ustawia wartość falgi _gameStarted na false, stopuje timery gry oraz blokowuje studenta.

Definicja w linii 99 pliku game.cpp.

Oto graf wywołań dla tej funkcji:

Oto graf wywoływań tej funkcji:

void Game::playEndMusic ( )

private

Odtwarza muzykę, gdy nastąpił koniec gry

Definicja w linii 312 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::playStartingMusic ( )

private

Odtwarza muzykę podczas generowania nowej gry.

Definicja w linii 306 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::setGameStarted ( bool  isStarted )

inline

Ustawia przekazaną flagę stanu gry.

Parametry

[in]

isStarted

- wartość logiczna, czy gra została wystatowana

Definicja w linii 62 pliku game.h.

Oto graf wywołań dla tej funkcji:

void Game::setupScene ( )

private

Ustawia scenę gry, m.in. rozmiar, kolor tła, czy ustawienia scroll barów.

Definicja w linii 195 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::startStudent ( )

signal

Sygnał emitowany, gdy należy odblokować możliwość ruchu studentowi.

Oto graf wywoływań tej funkcji:

void Game::startTimers ( )

private

Zatrzymuje wszystkie timery.

Definicja w linii 164 pliku game.cpp.

Oto graf wywoływań tej funkcji:

void Game::stopStudent ( )

signal

Sygnał emitowany, gdy należy zatrzymać studenta, aby nie mógł się poruszać.

Oto graf wywoływań tej funkcji:

void Game::stopTimers ( )

private

Startuje wszystkie timery.

Definicja w linii 158 pliku game.cpp.

Oto graf wywoływań tej funkcji:

Dokumentacja atrybutów składowych

Courses* Game::_courses

private

Przechowuje wszystkie kursy ze wszystkich semestrów.

Definicja w linii 215 pliku game.h.

int Game::_deansLeave

private

Liczba do tej pory wykorzystanych aktywnych urlopów dziekańskich.

Definicja w linii 251 pliku game.h.

int Game::_deficit

private

Suma deficytu punków ECTS studenta.

Definicja w linii 245 pliku game.h.

int Game::_ECTS

private

Suma zdobytych ogółem punktów ECTS.

Definicja w linii 233 pliku game.h.

bool Game::_gameStarted

private

Flaga wystartowania gry. True - gra w trakcie, False - gra jest zatrzymana.

Definicja w linii 257 pliku game.h.

QGraphicsScene* Game::_scene

private

Uchwyt do sceny, na której wyświetlana jest gra.

Definicja w linii 203 pliku game.h.

Student* Game::_student

private

Uchwyt do studenta - gracza.

Definicja w linii 209 pliku game.h.

int Game::_term

private

Aktualny semestr studiów, na którym znajduje się student.

Definicja w linii 239 pliku game.h.

QTimer* Game::_timerCourses

private

Timer ten odpowiada za wyświetlanie kolejnych kursów co określony czas na scenie.

Definicja w linii 221 pliku game.h.

QTimer* Game::_timerMove

private

Timer ten odpowiada za przesuwanie kursów po scenie.

Definicja w linii 227 pliku game.h.

GameSettings* Game::gameSettings

Przechowuje globalne ustawienia gry.

Definicja w linii 46 pliku game.h.

QMediaPlayer* Game::player

private

Odtwarzacz muzyki służy do odtworzenia dźwięku startu nowej gry.

Definicja w linii 263 pliku game.h.

---

Dokumentacja dla tej klasy została wygenerowana z plików:

• game.h
• game.cpp