Dokumentacja klasy Student

Modeuje pojęcie Studenta. Więcej...

#include <student.h>

Diagram dziedziczenia dla Student

Diagram współpracy dla Student:

Sloty publiczne
void	on_Game_stopStudent ()
	Zatrzymuje studenta. Więcej...
void	on_Game_startStudent ()
	Odblokowuje możliwości ruchu studentowi. Więcej...

Metody publiczne
	Student (GameSettings *gSettings, QObject *parent=nullptr)
	Kontrutor klasy Student. Więcej...
void	moveStudent (moveData data)
	Poruszanie studenta po scenie. Więcej...
void	resetPosition ()
	Ustawienie studenta do pozycji początkowej. Więcej...

Atrybuty prywatne
GameSettings *	_gameSettings
	Uchwyt do globalnych ustawień gry. Więcej...
bool	_stopStudent
	Flaga zatrzymania studenta. Więcej...

Opis szczegółowy

Klasa definiuje pojęcie studenta - gracza, który jest kołkiem poruszającym się po obszarze gry. Definiuje również sposób poruszania się studenta po scenie.

Definicja w linii 25 pliku student.h.

Dokumentacja konstruktora i destruktora

Student::Student ( GameSettings *  gSettings, QObject *  parent = nullptr  )

explicit

Tworzy obiekt Studenta jako koło, ustawia mu tekst oraz kolor.

Parametry

[in]	gSettings	- globalne ustawienia gry
[in]	parent	- rodzic obiektu

Definicja w linii 13 pliku student.cpp.

Oto graf wywołań dla tej funkcji:

Dokumentacja funkcji składowych

void Student::moveStudent

(

moveData

data

)

Metoda służy po poruszania studenta po scenie. Nie pozwala mu wyjść poza obszar gry.

Parametry

[in]

data

- dane o ile ma się przesunać student

Definicja w linii 52 pliku student.cpp.

Oto graf wywoływań tej funkcji:

void Student::on_Game_startStudent ( )

slot

Odblokowuje możliwości ruchu studentowi poporzez ustawienie flagi _stopStudent na false.

Definicja w linii 82 pliku student.cpp.

void Student::on_Game_stopStudent ( )

slot

Slot zatrzymuje studenta poprzez ustawienie flagi _stopStudent na true.

Definicja w linii 77 pliku student.cpp.

void Student::resetPosition

(

)

Ustawia studenta na pozycji początkowej (na dole, po środku pola z grą).

Definicja w linii 70 pliku student.cpp.

Oto graf wywoływań tej funkcji:

Dokumentacja atrybutów składowych

GameSettings* Student::_gameSettings

private

Uchwyt do globalnych ustawień gry

Definicja w linii 78 pliku student.h.

bool Student::_stopStudent

private

Flaga mówiąca o tym, czy student może się poruszać (false), czy nie (true).

Definicja w linii 84 pliku student.h.

---

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

• student.h
• student.cpp