Dokumentacja klasy Timeline

Element GUI przedstawiający pasek postępu odtwarzania muzyki. Więcej...

#include <Timeline.h>

Diagram dziedziczenia dla Timeline

Metody publiczne
	Timeline (int width, const Music &music)
	Konstruktor klasy Timeline.
void	build () override
	Buduje element GUI, ustawiając jego pozycję i rozmiar.
Vector2	setElementPosition (unsigned x, unsigned y) override
	Ustawia pozycję elementu Timeline na ekranie.
Vector2	setElementSize (unsigned x, unsigned y) override
	Ustawia rozmiar paska postępu.
void	draw () override
	Rysuje pasek postępu, znacznik oraz aktualny czas odtwarzania.
	~Timeline () override=default
	Destruktor klasy Timeline.
Metody publiczne dziedziczone z GuiElement
	GuiElement (const unsigned screenWidth, const unsigned screenHeight)
	Konstruktor parametryczny klasy GuiElement.
virtual	~GuiElement ()=default
	Wirtualny Deskrutor zapewniający odpowiednie usuwanie obiektów klas pochodnych.

Atrybuty publiczne
int	timelineX
	Pozycja X paska na ekranie.
int	timelineY
	Pozycja Y paska na ekranie.
int	timelineWidth
	Szerokość paska postępu.
int	timelineHeight
	Wysokość paska postępu.
float	musicLength
	Długość utworu muzycznego (w sekundach)

Dodatkowe dziedziczone składowe
Atrybuty chronione dziedziczone z GuiElement
Vector2	windowSize {}
	Rozmiar okna.
Vector2	size {}
	Rozmiar elementu.
Vector2	position {}
	Pozycja elementu.

Opis szczegółowy

Element GUI przedstawiający pasek postępu odtwarzania muzyki.

Klasa Timeline odpowiada za wizualne przedstawienie aktualnego czasu odtwarzania utworu muzycznego. Wyświetla prostokątny pasek z markerem wskazującym aktualną pozycję oraz czasem odtwarzania.

Dokumentacja konstruktora i destruktora

Timeline()

Timeline::Timeline ( int width, const Music & music )

inline

Konstruktor klasy Timeline.

Parametry

width	Szerokość całkowita elementu GUI.
music	Obiekt muzyki do śledzenia.

Dokumentacja funkcji składowych

build()

void Timeline::build ( )

inlineoverridevirtual

Buduje element GUI, ustawiając jego pozycję i rozmiar.

Implementuje GuiElement.

draw()

void Timeline::draw ( )

inlineoverridevirtual

Rysuje pasek postępu, znacznik oraz aktualny czas odtwarzania.

Pasek jest rysowany w kolorze szarym, marker postępu w czerwonym. Tekst z aktualnym czasem pojawia się nad paskiem.

Implementuje GuiElement.

setElementPosition()

Vector2 Timeline::setElementPosition ( unsigned x, unsigned y )

inlineoverridevirtual

Ustawia pozycję elementu Timeline na ekranie.

Parametry

x	Współrzędna X.
y	Współrzędna Y.

Zwraca

Wektor z nową pozycją.

Implementuje GuiElement.

setElementSize()

Vector2 Timeline::setElementSize ( unsigned x, unsigned y )

inlineoverridevirtual

Ustawia rozmiar paska postępu.

Parametry

x	Szerokość.
y	Wysokość.

Zwraca

Wektor z nowym rozmiarem.

Implementuje GuiElement.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• includes/GUI/Timeline.h