vae::core::SpatialManager Class Reference

#include <vae_spatial_manager.hpp>

Collaboration diagram for vae::core::SpatialManager:

Public Member Functions
Result	init (Size emitterCount)
Result	addEmitter (EmitterHandle e)
EmitterHandle	createEmitter ()
EmitterHandle	createAutoEmitter (BankHandle bank, EventHandle event, float maxDist, const LocationDirection &locDir, Sample spread)
Result	removeEmitter (EmitterHandle e)
Emitter &	getEmitter (EmitterHandle e)
bool	hasEmitter (EmitterHandle e)
void	compact ()
Result	setEmitter (EmitterHandle emitter, const LocationDirection &locDir, Sample spread)
Listeners &	getListeners ()
template<class Func >
Result	forListeners (ListenerHandle handle, const Func &&func)
ListenerHandle	createListener ()
Result	setListener (ListenerHandle listener, const LocationOrientation &locOr)
Result	removeListener (ListenerHandle listener)
template<class Callback >
void	update (VoiceManger &manager, Callback callback)

Private Types
template<typename key , class T >
using	Map = robin_hood::unordered_map< key, T >

Private Attributes
Map< EmitterHandle, Emitter >	mEmitters
Listeners	mListeners

Detailed Description

Definition at line 28 of file vae_spatial_manager.hpp.

Member Typedef Documentation

Map

template<typename key , class T >

using vae::core::SpatialManager::Map = robin_hood::unordered_map<key, T>

private

Definition at line 31 of file vae_spatial_manager.hpp.

Member Function Documentation

addEmitter()

Result vae::core::SpatialManager::addEmitter ( EmitterHandle  e )

inline

Definition at line 44 of file vae_spatial_manager.hpp.

                                           {
            VAE_PROFILER_SCOPE()
            VAE_ASSERT(e != InvalidEmitterHandle)
            if (mEmitters.contains(e)) {
                VAE_INFO("Trying to add duplicate emitter %u", e)
                return Result::DuplicateEmitter;
            }
            Emitter emitter;
            emitter.bank = InvalidBankHandle;
            emitter.event = InvalidEventHandle;
            // TODO VAE_DEBUG when allocation happens and also lock audio thread
            mEmitters.insert({e, emitter});
            VAE_PROFILER_PLOT(profiler::emitters, int64_t(mEmitters.size()));
            return Result::Success;
        }

Here is the caller graph for this function:

compact()

void vae::core::SpatialManager::compact ( )

inline

Definition at line 105 of file vae_spatial_manager.hpp.

                       {
            VAE_PROFILER_SCOPE()
            // mEmitters.compact();
        }

createAutoEmitter()

EmitterHandle vae::core::SpatialManager::createAutoEmitter ( BankHandle  bank, EventHandle  event, float  maxDist, const LocationDirection &  locDir, Sample  spread  )

inline

Definition at line 70 of file vae_spatial_manager.hpp.

          {
            VAE_PROFILER_SCOPE()
            auto handle = createEmitter();
            auto& e = mEmitters[handle];
            e.position = { locDir.position.x, locDir.position.y, locDir.position.z };
            e.spread = spread;
            e.maxDist = maxDist;
            e.bank = bank;
            e.event = event;
            return handle;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

createEmitter()

EmitterHandle vae::core::SpatialManager::createEmitter ( )

inline

Definition at line 60 of file vae_spatial_manager.hpp.

                                      {
            VAE_PROFILER_SCOPE()
            EmitterHandle ret = rand();
            while (hasEmitter(ret)) {
                ret = rand();
            }
            auto result = addEmitter(ret);
            return result == Result::Success ? ret : InvalidEmitterHandle;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

createListener()

ListenerHandle vae::core::SpatialManager::createListener ( )

inline

Definition at line 146 of file vae_spatial_manager.hpp.

                                        {
            VAE_PROFILER_SCOPE()
            for (ListenerHandle index = 0; index < StaticConfig::MaxListeners; index++) {
                auto& i = mListeners[index];
                if (i.id == InvalidListenerHandle) {
                    i.id = index;
                    i.position  = { 0.f, 0.f,  0.f };
                    i.front     = { 0.f, 0.f, -1.f };
                    i.up        = { 0.f, 1.f,  0.f };
                    return index;
                }
            }
            VAE_ERROR("Exeeded maxim amount of listeners define in StaticConfig::MaxListeners")
            return InvalidListenerHandle;
        }

Here is the caller graph for this function:

forListeners()

template<class Func >

Result vae::core::SpatialManager::forListeners ( ListenerHandle  handle, const Func &&  func  )

inline

Definition at line 130 of file vae_spatial_manager.hpp.

                                                                      {
            VAE_PROFILER_SCOPE()
            if (handle == AllListeners) {
                for(ListenerHandle index = 0; index < StaticConfig::MaxListeners; index++) {
                    auto& i = mListeners[index];
                    if (i.id == InvalidListenerHandle) { continue; }
                    Result result = func(i);
                    if (result != Result::Success) {
                        return result;
                    }
                }
                return Result::Success;
            }
            return func(mListeners[handle]);
        }

Here is the caller graph for this function:

getEmitter()

Emitter & vae::core::SpatialManager::getEmitter ( EmitterHandle  e )

inline

Definition at line 95 of file vae_spatial_manager.hpp.

                                             {
            VAE_PROFILER_SCOPE()
            return mEmitters[e];
        }

Here is the caller graph for this function:

getListeners()

Listeners & vae::core::SpatialManager::getListeners ( )

inline

Definition at line 125 of file vae_spatial_manager.hpp.

                                  {
            return mListeners;
        }

Here is the caller graph for this function:

hasEmitter()

bool vae::core::SpatialManager::hasEmitter ( EmitterHandle  e )

inline

Definition at line 100 of file vae_spatial_manager.hpp.

                                         {
            VAE_PROFILER_SCOPE()
            return mEmitters.contains(e);
        }

Here is the caller graph for this function:

init()

Result vae::core::SpatialManager::init ( Size  emitterCount )

inline

Definition at line 38 of file vae_spatial_manager.hpp.

                                       {
            VAE_PROFILER_SCOPE_NAMED("Spatial Init")
            mEmitters.reserve(emitterCount);
            return Result::Success;
        }

removeEmitter()

Result vae::core::SpatialManager::removeEmitter ( EmitterHandle  e )

inline

Definition at line 85 of file vae_spatial_manager.hpp.

                                              {
            VAE_PROFILER_SCOPE()
            auto res = mEmitters.erase(e);
            if (res == 1) {
                VAE_PROFILER_PLOT(profiler::emitters, int64_t(mEmitters.size()));
                return Result::Success;
            }
            return Result::ElementNotFound;
        }

Here is the caller graph for this function:

removeListener()

Result vae::core::SpatialManager::removeListener ( ListenerHandle  listener )

inline

Definition at line 181 of file vae_spatial_manager.hpp.

                                                       {
            VAE_PROFILER_SCOPE()
            if (StaticConfig::MaxListeners <= listener) {
                VAE_WARN("Accessed invalid listener %i", listener)
                return Result::ValidHandleRequired;
            }
            mListeners[listener].id = InvalidListenerHandle;
            return Result::Success;
        }

Here is the caller graph for this function:

setEmitter()

Result vae::core::SpatialManager::setEmitter ( EmitterHandle  emitter, const LocationDirection &  locDir, Sample  spread  )

inline

Definition at line 110 of file vae_spatial_manager.hpp.

          {
            VAE_PROFILER_SCOPE()
            if (!hasEmitter(emitter)) {
                VAE_DEBUG("Accessed invalid emitter %i", emitter)
                return Result::ElementNotFound;
            }
            auto& e = getEmitter(emitter);
            e.position = { locDir.position.x, locDir.position.y, locDir.position.z };
            e.spread = spread;
            return Result::Success;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setListener()

Result vae::core::SpatialManager::setListener ( ListenerHandle  listener, const LocationOrientation &  locOr  )

inline

Definition at line 162 of file vae_spatial_manager.hpp.

          {
            VAE_PROFILER_SCOPE()
            if (StaticConfig::MaxListeners <= listener) {
                VAE_WARN("Accessed invalid listener %i", listener)
                return Result::ValidHandleRequired;
            }
            auto& l = mListeners[listener];
            if (l.id == InvalidBankHandle) {
                return Result::ValidHandleRequired;
            }
            l.position = { locOr.position.x, locOr.position.y, locOr.position.z };
            l.front = { locOr.front.x, locOr.front.y, locOr.front.z };
            l.up = { locOr.up.x, locOr.up.y, locOr.up.z };
            return Result::Success;
        }

Here is the caller graph for this function:

update()

template<class Callback >

void vae::core::SpatialManager::update ( VoiceManger &  manager, Callback  callback  )

inline

Definition at line 192 of file vae_spatial_manager.hpp.

                                                             {
            VAE_PROFILER_SCOPE_NAMED("Spatial Update")
 
            // TODO perf maybe swap loops
            // This triggers nearby auto emitters
            forListeners(AllListeners, [&](Listener& l) {
                for (auto& emitter : mEmitters) {
                    auto& e = emitter.second;
                    // TODO seperate auto emitter somehow
                    if (e.bank == InvalidBankHandle) { continue; } // means it wants to auto emit
                    if (e.autoplaying) { continue; }
                    // only trigger sounds which haven't been auto triggered
                    const auto distance = glm::distance(l.position, e.position);
                    if (distance < e.maxDist) {
                        mEmitters[emitter.first].autoplaying = true;
                        callback(e.event, e.bank, emitter.first);
                    }
                }
                return Result::Success;
            });
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mEmitters

Map<EmitterHandle, Emitter> vae::core::SpatialManager::mEmitters

private

Definition at line 34 of file vae_spatial_manager.hpp.

mListeners

Listeners vae::core::SpatialManager::mListeners

private

Definition at line 36 of file vae_spatial_manager.hpp.

---

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

• vae_spatial_manager.hpp