/*
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 "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;
}*/
/** Registers the factory function of a resource type
@tparam T Resource type.
@param factoryFunction Lambda function that creates a new instance of the resource.
*/
template
static void RegisterType(std::function factoryFunction);
/** 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);
/** 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);
/** Fetches a loaded resource
@tparam T Resource type.
@param resourceName Fully qualified name of the resource to fetch.
*/
template
static T* Fetch(std::string resourceName);
/** 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 Update();
private:
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
// 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
template
static T* CreateResource(std::string resourceName, Resource* parent);
};
template
T* ResourceManager::Load(std::string resourceName, Resource* parent /* = nullptr */)
{
auto resourceType = typeid(T).name();
auto it = m_ResourceCache.find(std::make_pair(resourceType, resourceName));
if (it != m_ResourceCache.end())
return static_cast(it->second);
if (m_Preloading) {
LOG_INFO("Preloading resource \"%s\"", resourceName.c_str());
} else {
LOG_WARNING("Hot-loading resource \"%s\"", resourceName.c_str());
}
return CreateResource(resourceName, parent);
}
template
T* ResourceManager::Fetch(std::string resourceName)
{
auto resourceType = typeid(T).name();
auto it = m_ResourceCache.find(std::make_pair(resourceType, resourceName));
if (it == m_ResourceCache.end())
{
LOG_ERROR("Failed to fetch resource \"%s\": Resource not loaded!", resourceName.c_str());
return nullptr;
} else
{
return static_cast(it->second);
}
}
template
void ResourceManager::RegisterType(std::function factoryFunction)
{
m_FactoryFunctions[typeid(T).name()] = factoryFunction;
}
template
void ResourceManager::Preload(std::string resourceName)
{
auto resourceType = typeid(T).name();
if (IsResourceLoaded(resourceType, resourceName))
{
LOG_WARNING("Attempted to preload resource \"%s\" multiple times!", resourceName);
return;
}
m_Preloading = true;
LOG_INFO("Preloading resource \"%s\"", resourceName.c_str());
CreateResource(resourceName);
m_Preloading = false;
}
template
T* ResourceManager::CreateResource(std::string resourceName, Resource* parent)
{
const char* resourceType = typeid(T).name();
/*auto facIt = m_FactoryFunctions.find(resourceType);
if (facIt == m_FactoryFunctions.end())
{
LOG_ERROR("Failed to load resource \"%s\" of type \"%s\": Type not registered", resourceName.c_str(), resourceType);
return nullptr;
}*/
// Call the factory function
T* resource = new T(resourceName);
// Store IDs
resource->TypeID = GetTypeID(resourceType);
resource->ResourceID = GetNewResourceID(resource->TypeID);
// Cache
m_ResourceCache[std::make_pair(resourceType, resourceName)] = resource;
m_ResourceFromName[resourceName] = resource;
if (parent != nullptr)
{
m_ResourceParents[resource] = parent;
}
if (!boost::filesystem::is_directory(resourceName))
{
LOG_DEBUG("Adding watch for %s", resourceName.c_str());
m_FileWatcher.AddWatch(resourceName, fileWatcherCallback);
}
return resource;
}
}
#endif // ResourceManager_h__