SoundEffect Class Reference

#include <SoundEffect.h>

Inheritance diagram for SoundEffect:

List of all members.

Public Member Functions
	SoundEffect (std::string name)
	~SoundEffect ()
Private Member Functions
void	Play ()
void	Pause ()
void	Stop ()
void	Update (unsigned int ticks)
void	InitializeSource ()
Private Attributes
SoundResource *	m_resource

---

Detailed Description

Definition at line 14 of file SoundEffect.h.

---

Constructor & Destructor Documentation

SoundEffect::SoundEffect

(

std::string

name

)

Definition at line 18 of file SoundEffect.cpp.

References IResource::ConstructKey(), m_resource, ResourceManager::s_resourceManager, and SoundResource::s_type.

                                   : ISound() {
  m_resource = (SoundResource *) ResourceManager::s_resourceManager->Acquire(IResource::ConstructKey(SoundResource::s_type, name));
}

SoundEffect::~SoundEffect

(

)

Definition at line 22 of file SoundEffect.cpp.

References m_resource, ResourceManager::Release(), SoundSystem::ReleaseSound(), ResourceManager::s_resourceManager, SoundSystem::s_soundSystem, and Stop().

                          {
  Stop();
  SoundSystem::s_soundSystem->ReleaseSound(this);
  ResourceManager::s_resourceManager->Release(m_resource);
}

---

Member Function Documentation

void SoundEffect::InitializeSource

(

)

[private, virtual]

Implements ISound.

Definition at line 52 of file SoundEffect.cpp.

References SoundResource::GetBuffer(), OpenALSource::GetSource(), m_resource, ISound::m_source, Log::Message(), and Log::s_log.

                                   {
  if (m_source == NULL) {
    Log::s_log->Message("Warning: Attempt to initialize NULL source");
    return;
  }
  alSourcei(m_source->GetSource(), AL_BUFFER, m_resource->GetBuffer());
}

void SoundEffect::Pause

(

)

[private, virtual]

Implements ISound.

Definition at line 36 of file SoundEffect.cpp.

References OpenALSource::GetSource(), and ISound::m_source.

                        {
  if (m_source != NULL) {
    alSourcePause(m_source->GetSource());
  }
}

void SoundEffect::Play

(

)

[private, virtual]

Implements ISound.

Definition at line 28 of file SoundEffect.cpp.

References OpenALSource::GetSource(), ISound::m_source, Log::Message(), and Log::s_log.

                       {
  if (m_source != NULL) {
    alSourcePlay(m_source->GetSource());
  } else {
    Log::s_log->Message("Warning: SoundEffect Play without source set");
  }
}

void SoundEffect::Stop

(

)

[private, virtual]

Implements ISound.

Definition at line 42 of file SoundEffect.cpp.

References OpenALSource::GetSource(), and ISound::m_source.

Referenced by ~SoundEffect().

                       {
  if (m_source != NULL) {
    alSourceStop(m_source->GetSource());
  }
}

void SoundEffect::Update

(

unsigned int

ticks

)

[private, virtual]

Implements ISound.

Definition at line 48 of file SoundEffect.cpp.

                                           {
  // Do nothing
}

---

Member Data Documentation

SoundResource* SoundEffect::m_resource [private]

Definition at line 20 of file SoundEffect.h.

Referenced by InitializeSource(), SoundEffect(), and ~SoundEffect().

---

The documentation for this class was generated from the following files:

• src/SoundEffect.h
• src/SoundEffect.cpp

---