Dokumentacja klasy GuiElement

Klasa Bazowa dla kadego elementu GUI tego Klasa ta poprzez wymuszenie definicji metod build() oraz draw() pozwala na uproszczenie konstruowania elementow graficznych wskazującym aktualną pozycję oraz czasem odtwarzania. Więcej...

#include <GuiElement.h>

Diagram dziedziczenia dla GuiElement

Metody publiczne
	GuiElement (const unsigned screenWidth, const unsigned screenHeight)
	Konstruktor parametryczny klasy GuiElement.
virtual	~GuiElement ()=default
	Wirtualny Deskrutor zapewniający odpowiednie usuwanie obiektów klas pochodnych.
virtual void	build ()=0
	Wirtualna metoda odpowiedzialna za konfigurację, inicjalizację komponentu.
virtual void	draw ()=0
	Wirtualna metoda odpowiedzialna za narysowanie elementu na ekranie.

Metody chronione
virtual Vector2	setElementSize (unsigned x, unsigned y)=0
	Metoda virtualna służąca do ustawienia rozmiaru elementu.
virtual Vector2	setElementPosition (unsigned x, unsigned y)=0
	Metoda virtualna służąca do ustawienia elementu względem osi x oraz y.

Atrybuty chronione
Vector2	windowSize {}
	Rozmiar okna.
Vector2	size {}
	Rozmiar elementu.
Vector2	position {}
	Pozycja elementu.

Opis szczegółowy

Klasa Bazowa dla kadego elementu GUI tego Klasa ta poprzez wymuszenie definicji metod build() oraz draw() pozwala na uproszczenie konstruowania elementow graficznych wskazującym aktualną pozycję oraz czasem odtwarzania.

Dokumentacja konstruktora i destruktora

GuiElement()

GuiElement::GuiElement ( const unsigned screenWidth, const unsigned screenHeight )

inline

Konstruktor parametryczny klasy GuiElement.

Parametry

screenWidth	Szerokość ekranu
screenHeight	Wysokość ekranu

Dokumentacja funkcji składowych

build()

virtual void GuiElement::build ( )

pure virtual

Wirtualna metoda odpowiedzialna za konfigurację, inicjalizację komponentu.

Implementowany w BottomBar, Sidebar, Slider, Timeline i Visuals.

draw()

virtual void GuiElement::draw ( )

pure virtual

Wirtualna metoda odpowiedzialna za narysowanie elementu na ekranie.

Implementowany w BottomBar, Sidebar, Slider, Timeline i Visuals.

setElementPosition()

virtual Vector2 GuiElement::setElementPosition ( unsigned x, unsigned y )

protectedpure virtual

Metoda virtualna służąca do ustawienia elementu względem osi x oraz y.

Parametry

x	Pozycja elementu względem osi x
y	Pozycja elementu względem osi y

Implementowany w Timeline i Visuals.

setElementSize()

virtual Vector2 GuiElement::setElementSize ( unsigned x, unsigned y )

protectedpure virtual

Metoda virtualna służąca do ustawienia rozmiaru elementu.

Parametry

x	Szerokość elementu
y	Wysokość elementu

Implementowany w Timeline i Visuals.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• includes/GUI/GuiElement.h