Elevate::WwiseFileDataSource Class Reference

#include <WwiseFileDataSource.h>

Inheritance diagram for Elevate::WwiseFileDataSource:

Public Member Functions
	WwiseFileDataSource (const std::string projectPath)
	~WwiseFileDataSource ()=default
virtual void	InitializeSource () override
virtual void	RefreshSource () override
Public Member Functions inherited from WwiseDataSource
virtual std::weak_ptr< WwiseItem >	GetItems () const
virtual void	GetItemsOfType ()

Protected Member Functions
void	ProcessRootFolder (const std::filesystem::path &rootFolder)
void	ProcessWorkUnit (WwiseItemPtr parent, const std::filesystem::path &workUnitPath)
void	ProcessNode (WwiseItemPtr parent, flxml::xml_node< char > *node)
WwiseItemPtr	ProcessBus (WwiseItemPtr parent, flxml::xml_node< char > *node)
WwiseItemPtr	ProcessAuxBus (WwiseItemPtr parent, flxml::xml_node< char > *node)
WwiseItemPtr	ProcessEvent (WwiseItemPtr parent, flxml::xml_node< char > *node)
WwiseItemPtr	ProcessSoundBank (WwiseItemPtr parent, flxml::xml_node< char > *node)
WwiseItemPtr	ProcessStateGroup (WwiseItemPtr parent, flxml::xml_node< char > *node)
WwiseItemPtr	ProcessState (WwiseItemPtr parent, flxml::xml_node< char > *node)
WwiseItemPtr	ProcessSwitchGroup (WwiseItemPtr parent, flxml::xml_node< char > *node)
WwiseItemPtr	ProcessSwitch (WwiseItemPtr parent, flxml::xml_node< char > *node)
bool	IsValidDirectory (std::string directoryName)
Protected Member Functions inherited from WwiseDataSource
	WwiseDataSource ()=default

Additional Inherited Members
Protected Attributes inherited from WwiseDataSource
std::shared_ptr< WwiseItem >	m_treeRoot

Detailed Description

Definition at line 14 of file WwiseFileDataSource.h.

Constructor & Destructor Documentation

WwiseFileDataSource()

Elevate::WwiseFileDataSource::WwiseFileDataSource ( const std::string  projectPath )

inline

Definition at line 17 of file WwiseFileDataSource.h.

            : m_projectPath(projectPath) {
        }

~WwiseFileDataSource()

Elevate::WwiseFileDataSource::~WwiseFileDataSource ( )

default

Member Function Documentation

InitializeSource()

void Elevate::WwiseFileDataSource::InitializeSource ( )

overridevirtual

Implements WwiseDataSource.

Definition at line 263 of file WwiseFileDataSource.cpp.

    {
        RefreshSource();
    }

IsValidDirectory()

bool Elevate::WwiseFileDataSource::IsValidDirectory ( std::string  directoryName )

protected

Definition at line 228 of file WwiseFileDataSource.cpp.

    {
        constexpr std::array<std::string_view, 6> validDirectories = {
            "Busses", "Events", "SoundBanks", "States", "Switches"
        };
 
        for (const auto& name : validDirectories)
        {
            if (name == directoryName)
            {
                return true;
            }
        }
        return false;
    }

ProcessAuxBus()

WwiseItemPtr Elevate::WwiseFileDataSource::ProcessAuxBus ( WwiseItemPtr  parent, flxml::xml_node< char > *  node  )

protected

Definition at line 193 of file WwiseFileDataSource.cpp.

    {
        return WwiseAuxBus::Create();
    }

ProcessBus()

WwiseItemPtr Elevate::WwiseFileDataSource::ProcessBus ( WwiseItemPtr  parent, flxml::xml_node< char > *  node  )

protected

Definition at line 188 of file WwiseFileDataSource.cpp.

    {
        return WwiseBus::Create(); 
    }

ProcessEvent()

WwiseItemPtr Elevate::WwiseFileDataSource::ProcessEvent ( WwiseItemPtr  parent, flxml::xml_node< char > *  node  )

protected

Definition at line 198 of file WwiseFileDataSource.cpp.

    {
        return WwiseEvent::Create();
    }

ProcessNode()

void Elevate::WwiseFileDataSource::ProcessNode ( WwiseItemPtr  parent, flxml::xml_node< char > *  node  )

protected

Definition at line 120 of file WwiseFileDataSource.cpp.

    {
        WwiseType type = GetTypeFromName(std::string(node->name()));
 
        WwiseItemPtr item = nullptr;
        switch (type)
        {
        case WwiseType::Bus:
            item = ProcessBus(parent, node);
            break;
        case WwiseType::AuxBus:
            item = ProcessAuxBus(parent, node);
            break;
        case WwiseType::Event:
            item = ProcessEvent(parent, node);
            break;
        case WwiseType::SoundBank:
            item = ProcessSoundBank(parent, node);
            break;
        case WwiseType::StateGroup:
            item = ProcessStateGroup(parent, node);
            break;
        case WwiseType::State:
            item = ProcessState(parent, node);
            break;
        case WwiseType::SwitchGroup:
            item = ProcessSwitchGroup(parent, node);
            break;
        case WwiseType::Switch:
            item = ProcessSwitch(parent, node);
            break;
        default:
            return;
        }
 
        if (item)
        {
            item->IsOnDisk = true;
 
            auto optName = node->first_attribute("Name");
            auto optId = node->first_attribute("ID");
            auto optShortId = node->first_attribute("ShortID");
 
            if (optName)
            {
                item->Name = optName->value();
            }
            if (optId)
            {
                item->GUID = optId->value();
            }
            if (optShortId)
            {
                item->ShortID = std::stoi(std::string(optShortId->value()));
            }
            parent->AddChildren(item);
 
            if (item->IsDirectory())
            {
                auto optChildrenList = node->first_node("ChildrenList");
                if (optChildrenList)
                {
                    ProcessNode(item, optChildrenList.get());
                }
            }
        }
    }

ProcessRootFolder()

void Elevate::WwiseFileDataSource::ProcessRootFolder ( const std::filesystem::path &  rootFolder )

protected

Definition at line 45 of file WwiseFileDataSource.cpp.

    {
        // todo avoid checking useless folders like cache and others
        if (!fs::is_directory(rootFolder) || !IsValidDirectory(rootFolder.stem().string()))
        {
            return; // We do not have a directory
        }
 
        WwiseItemPtr folderItem = WwiseItem::Create();
        folderItem->Name = rootFolder.filename().string();
        folderItem->Type = WwiseType::RootDirectory;
        folderItem->IsOnDisk = true;
        m_treeRoot->AddChildren(folderItem);
 
        for (const auto& entry : fs::directory_iterator(rootFolder))
        {
            ProcessWorkUnit(folderItem, entry);
        }
    }

ProcessSoundBank()

WwiseItemPtr Elevate::WwiseFileDataSource::ProcessSoundBank ( WwiseItemPtr  parent, flxml::xml_node< char > *  node  )

protected

Definition at line 203 of file WwiseFileDataSource.cpp.

    {
        return WwiseSoundbank::Create();
    }

ProcessState()

WwiseItemPtr Elevate::WwiseFileDataSource::ProcessState ( WwiseItemPtr  parent, flxml::xml_node< char > *  node  )

protected

Definition at line 213 of file WwiseFileDataSource.cpp.

    {
        return WwiseState::Create();
    }

ProcessStateGroup()

WwiseItemPtr Elevate::WwiseFileDataSource::ProcessStateGroup ( WwiseItemPtr  parent, flxml::xml_node< char > *  node  )

protected

Definition at line 208 of file WwiseFileDataSource.cpp.

    {
        return WwiseStateGroup::Create();
    }

ProcessSwitch()

WwiseItemPtr Elevate::WwiseFileDataSource::ProcessSwitch ( WwiseItemPtr  parent, flxml::xml_node< char > *  node  )

protected

Definition at line 223 of file WwiseFileDataSource.cpp.

    {
        return WwiseSwitch::Create();
    }

ProcessSwitchGroup()

WwiseItemPtr Elevate::WwiseFileDataSource::ProcessSwitchGroup ( WwiseItemPtr  parent, flxml::xml_node< char > *  node  )

protected

Definition at line 218 of file WwiseFileDataSource.cpp.

    {
        return WwiseSwitchGroup::Create();
    }

ProcessWorkUnit()

void Elevate::WwiseFileDataSource::ProcessWorkUnit ( WwiseItemPtr  parent, const std::filesystem::path &  workUnitPath  )

protected

Definition at line 65 of file WwiseFileDataSource.cpp.

    {
        if (workUnitPath.extension() != WWISE_WORKUNIT_EXTENSION)
        {
            return;
        }
 
        rapidxml::
            file<> workUnitFile(workUnitPath.string().c_str());
        flxml::xml_document<> doc;
        doc.parse<0>(workUnitFile.data());
 
        // Get the second node as the first one is the xml
        // todo check the document type to check if really workunit
        auto optDocNode = doc.first_node();
        if (!optDocNode) return;
        flxml::xml_node<char>* docNode = optDocNode.get();
 
        auto optTypeNode = docNode->first_node();
        if (!optTypeNode) return;
        flxml::xml_node<char>* typeNode = optTypeNode.get();
 
        auto optWorkUnitNode = typeNode->first_node();
        if (!optWorkUnitNode) return;
        flxml::xml_node<char>* workUnitNode = optWorkUnitNode.get();
 
        auto optIdAttr = workUnitNode->first_attribute("ID");
 
        WwiseItemPtr workUnitItem = WwiseItem::Create();
        workUnitItem->Name = workUnitPath.stem().string();
        workUnitItem->Type = WwiseType::WorkUnit;
        workUnitItem->IsOnDisk = true;
 
        if (optIdAttr)
        {
            workUnitItem->GUID = optIdAttr.get()->value();
        }
 
        parent->AddChildren(workUnitItem);
 
        auto optChildrenListNode = workUnitNode->first_node();
        if (optWorkUnitNode)
        {
            for (auto child = optWorkUnitNode->first_node(); child; child = child->next_sibling())
            {
                if (child)
                {
                    ProcessNode(workUnitItem, child.get());
                }
            }
        }
 
        doc.clear();
    }

RefreshSource()

void Elevate::WwiseFileDataSource::RefreshSource ( )

overridevirtual

Implements WwiseDataSource.

Definition at line 23 of file WwiseFileDataSource.cpp.

    {
        EE_CORE_INFO("Getting Wwise Project Info from Files...");
 
        m_treeRoot.reset(new WwiseItem());
        m_treeRoot->Type = WwiseType::TreeRoot;
        m_treeRoot->IsOnDisk = true;
 
        fs::path basePath = m_projectPath;
        if (!fs::is_directory(basePath))
        {
            EE_CORE_ERROR("ERROR (WwiseFileDataSource::RefreshSource() : The provided project path is not a valid directory : {}", basePath.string());
        }
 
        for (const auto& entry : fs::directory_iterator(basePath))
        {
            ProcessRootFolder(entry);
        }
 
        EE_CORE_TRACE("Wwise Project File Analysed.");
    }

---

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

• ElevateEngine/src/ElevateEngine/Audio/Wwise/DataSources/WwiseFileDataSource.h
• ElevateEngine/src/ElevateEngine/Audio/Wwise/DataSources/WwiseFileDataSource.cpp