Dokumentacja klasy Visuals

Klasa odpowiedzialna za wizualizację audio (FFT) w czasie rzeczywistym. Więcej...

#include <Visuals.h>

Diagram dziedziczenia dla Visuals

Metody publiczne
	Visuals (unsigned screenWidth, unsigned screenHeight, const Music &music, const char *filename, const float bottomBarHeight)
	Konstruktor klasy Visuals.
	~Visuals ()
	Destruktor klasy Visuals.
void	build () override
	Rozpoczyna odtwarzanie muzyki.
void	draw () override
	Rysuje wizualizację audio w czasie rzeczywistym.
Vector2	setElementSize (unsigned, unsigned) override
	Nieużywana implementacja ustawiania rozmiaru elementu GUI.
Vector2	setElementPosition (unsigned, unsigned) override
	Nieużywana implementacja ustawiania pozycji elementu GUI.
Music &	getMusic ()
	Zwraca referencję do obiektu Music.
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.

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

Opis szczegółowy

Klasa odpowiedzialna za wizualizację audio (FFT) w czasie rzeczywistym.

Visuals wyświetla dynamiczną wizualizację dźwięku odtwarzanego z obiektu Music, używając transformacji Fouriera (FFT) do analizy częstotliwości.

Dokumentacja konstruktora i destruktora

Visuals()

Visuals::Visuals ( unsigned screenWidth, unsigned screenHeight, const Music & music, const char * filename, const float bottomBarHeight )

inline

Konstruktor klasy Visuals.

Wczytuje plik WAV, zapisuje jego próbki i przygotowuje dane do wizualizacji.

Parametry

screenWidth	Szerokość okna aplikacji.
screenHeight	Wysokość okna aplikacji.
music	Obiekt Music do odtwarzania.
filename	Ścieżka do pliku WAV zawierającego dane audio.
bottomBarHeight	Wysokość dolnego paska GUI (dla przesunięcia wizualizacji).

< Załaduj dane WAV do pamięci

< Ilość ramek audio

< Liczba kanałów (mono/stereo)

< Częstotliwość próbkowania

< Wskaźnik na próbki audio

< Przypisanie strumienia muzyki

< Zwolnienie pamięci obiektu Wave

~Visuals()

Visuals::~Visuals ( )

inline

Destruktor klasy Visuals.

Zwalnia pamięć zajmowaną przez próbki audio i strumień muzyki.

Dokumentacja funkcji składowych

build()

void Visuals::build ( )

inlineoverridevirtual

Rozpoczyna odtwarzanie muzyki.

Implementuje GuiElement.

draw()

void Visuals::draw ( )

inlineoverridevirtual

Rysuje wizualizację audio w czasie rzeczywistym.

Aktualizuje strumień muzyczny, przelicza FFT i rysuje słupki reprezentujące częstotliwości.

Implementuje GuiElement.

getMusic()

Music & Visuals::getMusic ( )

inline

Zwraca referencję do obiektu Music.

Zwraca

Referencja do muzyki.

setElementPosition()

Vector2 Visuals::setElementPosition ( unsigned , unsigned  )

inlineoverridevirtual

Nieużywana implementacja ustawiania pozycji elementu GUI.

Zwraca

Pusty wektor.

Implementuje GuiElement.

setElementSize()

Vector2 Visuals::setElementSize ( unsigned , unsigned  )

inlineoverridevirtual

Nieużywana implementacja ustawiania rozmiaru elementu GUI.

Zwraca

Pusty wektor.

Implementuje GuiElement.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• includes/GUI/Visuals.h