Elevate::SoundEngine Class Reference

#include <SoundEngine.h>

Static Public Member Functions
static void	SetImplementation (SoundEngine *implementation)
static bool	Init ()
static void	RenderAudio ()
static void	Terminate ()
static void	SetDefaultListener (GameObject *obj)
static void	SetDistanceProbe (GameObject *obj)
static void	UnsetDistanceProbe ()
static void	RegisterGameObject (GameObject *obj)
static void	UnregisterGameObject (GameObject *obj)
static void	UpdatePosition (GameObject *obj)
static void	PostEvent (const char *eventName, GameObject *object)
static void	PostEvent (uint32_t eventId, GameObject *object)
static void	PostEvent (const char *eventName)
static void	PostEvent (uint32_t eventId)
static void	Wakeup ()
static void	Suspend (bool renderAnyway=false, bool fadeOut=true)
static SoundEngine *	GetImpl ()

Protected Member Functions
virtual bool	InitImpl ()=0
virtual void	RenderAudioImpl ()=0
virtual void	TerminateImpl ()=0
virtual void	WakeUpImpl ()=0
virtual void	SuspendImpl (bool renderAnyway, bool fadeOut)=0
virtual void	SetDefaultListenerImpl (GameObject *obj)=0
virtual void	SetDistanceProbeImpl (GameObject *obj)=0
virtual void	UnsetDistanceProbeImpl ()=0
virtual void	RegisterGameObjectImpl (GameObject *obj)=0
virtual void	UnregisterGameObjectImpl (GameObject *obj)=0
virtual void	UpdateObjectPositionImpl (GameObject *obj)=0
virtual void	PostEventImpl (const char *eventName, GameObject *object)=0
virtual void	PostEventImpl (uint32_t eventName, GameObject *object)=0
virtual void	PostEventImpl (const char *eventName)=0
virtual void	PostEventImpl (uint32_t eventName)=0

Detailed Description

Definition at line 9 of file SoundEngine.h.

Member Function Documentation

GetImpl()

Elevate::SoundEngine * Elevate::SoundEngine::GetImpl ( )

static

Definition at line 106 of file SoundEngine.cpp.

{
    return Impl;
}

Init()

bool Elevate::SoundEngine::Init ( )

static

Definition at line 12 of file SoundEngine.cpp.

{
    EE_CORE_CWARN(!Impl, "Error : No valid SoundEngine impl. found. Using a null SoundEngine.");
    EE_CHECK_SOUNDENGINE(false);
    bool result = Impl->InitImpl();
    EE_CERROR(!result, "Error (SoundEngine::Init) : Could not initialize the sound engine.");
    return result;
    // todo register to native window callbacks
}

InitImpl()

virtual bool Elevate::SoundEngine::InitImpl ( )

protectedpure virtual

PostEvent() [1/4]

void Elevate::SoundEngine::PostEvent ( const char *  eventName )

static

Definition at line 82 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->PostEventImpl(eventName);
}

PostEvent() [2/4]

void Elevate::SoundEngine::PostEvent ( const char *  eventName, GameObject *  object  )

static

Definition at line 70 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->PostEventImpl(eventName, object);
}

PostEvent() [3/4]

void Elevate::SoundEngine::PostEvent ( uint32_t  eventId )

static

Definition at line 88 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->PostEventImpl(eventId);
}

PostEvent() [4/4]

void Elevate::SoundEngine::PostEvent ( uint32_t  eventId, GameObject *  object  )

static

Definition at line 76 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->PostEventImpl(eventId, object);
}

PostEventImpl() [1/4]

virtual void Elevate::SoundEngine::PostEventImpl ( const char *  eventName )

protectedpure virtual

PostEventImpl() [2/4]

virtual void Elevate::SoundEngine::PostEventImpl ( const char *  eventName, GameObject *  object  )

protectedpure virtual

PostEventImpl() [3/4]

virtual void Elevate::SoundEngine::PostEventImpl ( uint32_t  eventName )

protectedpure virtual

PostEventImpl() [4/4]

virtual void Elevate::SoundEngine::PostEventImpl ( uint32_t  eventName, GameObject *  object  )

protectedpure virtual

RegisterGameObject()

void Elevate::SoundEngine::RegisterGameObject ( GameObject *  obj )

static

Definition at line 52 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->RegisterGameObjectImpl(obj);
}

RegisterGameObjectImpl()

virtual void Elevate::SoundEngine::RegisterGameObjectImpl ( GameObject *  obj )

protectedpure virtual

RenderAudio()

void Elevate::SoundEngine::RenderAudio ( )

static

Definition at line 22 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->RenderAudioImpl();
}

RenderAudioImpl()

virtual void Elevate::SoundEngine::RenderAudioImpl ( )

protectedpure virtual

SetDefaultListener()

void Elevate::SoundEngine::SetDefaultListener ( GameObject *  obj )

static

Definition at line 34 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->SetDefaultListenerImpl(obj);
}

SetDefaultListenerImpl()

virtual void Elevate::SoundEngine::SetDefaultListenerImpl ( GameObject *  obj )

protectedpure virtual

SetDistanceProbe()

void Elevate::SoundEngine::SetDistanceProbe ( GameObject *  obj )

static

Definition at line 40 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->SetDistanceProbeImpl(obj);
}

SetDistanceProbeImpl()

virtual void Elevate::SoundEngine::SetDistanceProbeImpl ( GameObject *  obj )

protectedpure virtual

SetImplementation()

static void Elevate::SoundEngine::SetImplementation ( SoundEngine *  implementation )

inlinestatic

Definition at line 12 of file SoundEngine.h.

        {
            Impl = implementation;
        }

Suspend()

void Elevate::SoundEngine::Suspend ( bool  renderAnyway = false, bool  fadeOut = true  )

static

Definition at line 100 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->SuspendImpl(renderAnyway, fadeOut);
}

SuspendImpl()

virtual void Elevate::SoundEngine::SuspendImpl ( bool  renderAnyway, bool  fadeOut  )

protectedpure virtual

Terminate()

void Elevate::SoundEngine::Terminate ( )

static

Definition at line 28 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->TerminateImpl();
}

TerminateImpl()

virtual void Elevate::SoundEngine::TerminateImpl ( )

protectedpure virtual

UnregisterGameObject()

void Elevate::SoundEngine::UnregisterGameObject ( GameObject *  obj )

static

Definition at line 58 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->UnregisterGameObjectImpl(obj);
}

UnregisterGameObjectImpl()

virtual void Elevate::SoundEngine::UnregisterGameObjectImpl ( GameObject *  obj )

protectedpure virtual

UnsetDistanceProbe()

void Elevate::SoundEngine::UnsetDistanceProbe ( )

static

Definition at line 46 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->UnsetDistanceProbeImpl();
}

UnsetDistanceProbeImpl()

virtual void Elevate::SoundEngine::UnsetDistanceProbeImpl ( )

protectedpure virtual

UpdateObjectPositionImpl()

virtual void Elevate::SoundEngine::UpdateObjectPositionImpl ( GameObject *  obj )

protectedpure virtual

UpdatePosition()

void Elevate::SoundEngine::UpdatePosition ( GameObject *  obj )

static

Definition at line 64 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->UpdateObjectPositionImpl(obj);
}

Wakeup()

void Elevate::SoundEngine::Wakeup ( )

static

Definition at line 94 of file SoundEngine.cpp.

{
    EE_CHECK_SOUNDENGINE();
    Impl->WakeUpImpl();
}

WakeUpImpl()

virtual void Elevate::SoundEngine::WakeUpImpl ( )

protectedpure virtual

---

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

• ElevateEngine/src/ElevateEngine/Audio/SoundEngine.h
• ElevateEngine/src/ElevateEngine/Audio/SoundEngine.cpp