Referência da Classe Sound

Classe que modela sons. Mais...

#include <Sound.h>

Diagrama de colaboração para Sound:

Métodos Públicos
	Sound ()
	Construtor padrão. Mais...
	Sound (string file)
	Construtor. Mais...
void	Play (int times)
	Toca o som. Mais...
void	Stop (void)
	Interrompe o som. Mais...
void	Open (string file)
	Carrega um som. Mais...
bool	IsOpen (void) const
	Verifica se tem um arquivo aberto. Mais...

Atributos Privados
std::shared_ptr< Mix_Chunk >	sound
int	channel

Descrição Detalhada

Classe que modela sons.

Modela sons e permite operações básicas como: abiri um arquivo de som, tocar som e para som(stop). É permitido até a reprodução de 32 sons simultâneos(além da música). Cada som é tocado num canal diferente.

Construtores & Destrutores

Sound::Sound

(

)

Construtor padrão.

Futuras Atividades:

Verificar a necessidade da existência desse contrutor.

Cria uma instância não associada a nenhum som. O uso da instância nesse estado pode causar problemas.

Sound::Sound

(

string

file

)

Construtor.

Parâmetros

file	Arquivo com som a ser utilizado.

Cria uma instância associando-a um som. Todas as funcionalidades tornam-se disponíveis.

Métodos

bool Sound::IsOpen

(

void

)

const

Verifica se tem um arquivo aberto.

Parâmetros

return

verdadeiro se essa instância está associada a um som, falso caso contrário.

Verifica se a instância de Sound está associada ao som de algum arquivo.

void Sound::Open

(

string

file

)

Carrega um som.

Parâmetros

file	Arquivo com o som a ser utilizado.

Associa a instância ao som contido no arquivo. Caso essa instância de Sound já esteja com um som sendo tocado, esse som é interrompido para que depois o novo som seja carregado.

void Sound::Play

(

int

times

)

Toca o som.

Parâmetros

times

Número de vezes que a música deve repetir.

Toca o som, num canal arbritário. Caso essa instância de Sound já esteja com um som sendo tocado, esse som é interrompido. Caso times seja 0, o sem será tocado indefinidamente.

void Sound::Stop

(

void

)

Interrompe o som.

Interrompe a eecução do som associado à instância.

Atributos

int Sound::channel

private

Canal no qual o som está sendo tocado. -1 caso o som não esteja sendo tocado. O valor tem que ser -1 pois esse valor indica na hora da reprodução do som que p sistema pode escolher o canal no qual o som deve ser executado.

std::shared_ptr<Mix_Chunk> Sound::sound

private

Ponteiro para o Mix_Chunk com o som.

---

A documentação para esta classe foi gerada a partir dos seguintes arquivos:

• Engine/include/Sound.h
• Engine/src/Sound.cpp