/*
This file is part of Daydream Engine.
Copyright 2014 Adam Byléhn, Tobias Dahl, Simon Holmberg, Viktor Ljung
Daydream Engine is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Daydream Engine is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Daydream Engine. If not, see .
*/
#ifndef ResourceManager_h__
#define ResourceManager_h__
#include
#include
#include
#include
#include
#include
#include "Util/UnorderedMapPair.h"
#include "Util/Factory.h"
#include "Util/FileWatcher.h"
namespace dd
{
/** Base Resource class.
Implement this class for every resource to be handled by the resource manager.
Implement Create() to return a new object of that type.
*/
class Resource
{
friend class ResourceManager;
protected:
Resource() { }
public:
// Pretend that this is a pure virtual function that you have to implement
// FIXME: Why did we do this again instead of just using the constructor?
// static Resource* Create(std::string resourceName);
virtual void Reload() { }
virtual void OnChildReloaded(Resource* child) { }
unsigned int TypeID;
unsigned int ResourceID;
};
/** Singleton resource manager to keep track of and cache any external engine assets */
class ResourceManager
{
private:
ResourceManager();
public:
/*static ResourceManager& Instance()
{
static ResourceManager s;
return s;
}*/
template
static void RegisterType(std::string typeName);
/** Preloads a resource and caches it for future use
@tparam T Resource type.
@param resourceName Fully qualified name of the resource to preload.
*/
template
static void Preload(std::string resourceName);
static void Preload(std::string resourceType, std::string resourceName);
/** Checks if a resource is in cache
@param resourceType Resource type as string.
@param resourceName Fully qualified name of the resource to preload.
*/
// TODO: Templateify
static bool IsResourceLoaded(std::string resourceType, std::string resourceName);
/** Hot-loads a resource and caches it for future use
@tparam T Resource type.
@param resourceName Fully qualified name of the resource to load.
*/
template
static T* Load(std::string resourceName, Resource* parent = nullptr);
static Resource* Load(std::string resourceType, std::string resourceName, Resource* parent = nullptr);
/** Reloads an already loaded resource, keeping its resource ID intact.
@tparam T Resource type.
@param resourceName Fully qualified name of the resource to reload.
*/
static void Reload(std::string resourceName);
static void LoadPreloadsFromFile();
static const std::set>& GetPreloads() { return m_Preloads; }
static void Update();
private:
static std::unordered_map m_CompilerTypenameToResourceType;
static std::unordered_map> m_FactoryFunctions; // type -> factory function
static std::unordered_map, Resource*> m_ResourceCache; // (type, name) -> resource
static std::unordered_map m_ResourceFromName; // name -> resource
static std::unordered_map m_ResourceParents; // resource -> parent resource
static std::set> m_Preloads; // (type, name)
// TODO: Getters for IDs
static unsigned int m_CurrentResourceTypeID;
static std::unordered_map m_ResourceTypeIDs;
// Number of resources of a type. Doubles as local ID.
static std::unordered_map m_ResourceCount;
// Flag to suppress hot-load warnings when a preloading resource chain loads another resource
static bool m_Preloading;
static FileWatcher m_FileWatcher;
static void fileWatcherCallback(std::string path, FileWatcher::FileEventFlags flags);
static unsigned int GetTypeID(std::string resourceType);
static unsigned int GetNewResourceID(unsigned int typeID);
// Internal: Create a resource and cache it
static Resource* CreateResource(std::string resourceType, std::string resourceName, Resource* parent);
};
template
T* ResourceManager::Load(std::string resourceName, Resource* parent /* = nullptr */)
{
auto resourceTypename = typeid(T).name();
auto it = m_CompilerTypenameToResourceType.find(resourceTypename);
if (it == m_CompilerTypenameToResourceType.end()) {
LOG_ERROR("Failed to load resource \"%s\" of type \"%s\": type not registered", resourceName.c_str(), resourceTypename);
return nullptr;
}
return static_cast(Load(it->second, resourceName, parent));
}
template
void ResourceManager::RegisterType(std::string typeName)
{
m_CompilerTypenameToResourceType[typeid(T).name()] = typeName;
m_FactoryFunctions[typeName] = [](std::string resourceName) { return new T(resourceName); };
}
template
void ResourceManager::Preload(std::string resourceName)
{
auto resourceTypename = typeid(T).name();
auto it = m_CompilerTypenameToResourceType.find(resourceTypename);
if (it == m_CompilerTypenameToResourceType.end()) {
LOG_ERROR("Failed to load resource \"%s\" of type \"%s\": type not registered", resourceName.c_str(), resourceTypename);
return;
}
Preload(it->second, resourceName);
}
}
#endif // ResourceManager_h__