Core::ResourceManager

Resource manager for loading resources from the filesystem. More...

#include "Core/Resources/ResourceManager.h"

Public Classes

	Name
struct	ModelSaveEntry

Public Functions

	Name
	~ResourceManager()<br>If true loaded models will be normalized.
bool	cleanUpModelFiles(State::Scene * scene)<br>Ensure there are no unused model files in the scene_data directory of the passed scene.
virtual void	clearGlobal() override<br>Set the global state to some default empty state.
virtual void	clearScene() override<br>Set the scene state to some default empty state.
std::vector< ModelSaveEntry >	deserializeModels(const rapidjson::Value & modelsEntry)
std::vector< Resource >	getDefaultResources(ResourceType type)<br>Returns default resources of type.
std::vector< std::string >	getImportedResourceAliases()
bool	importModel(const fs::path & path, bool normalize)
void	loadDefaultResources(rapidjson::Document & doc)<br>Loads resources from the a json document and marks them as default.
virtual void	loadGlobal(const Memento & memento) override<br>Load global state from a memento.
virtual void	loadScene(const Memento & memento, State::Scene * scene) override<br>Called on scene load, undo and redo.
Mesh *	mesh(const std::string & alias, const std::string & path)<br>Get or create model by alias or file.
Mesh *	mesh(const std::string & alias, Mesh::PrimitiveType primitiveType, const float * verts, const unsigned int nVertices, const float * colors, const unsigned int nColors)<br>Get model by alias or create it using provided vertex data.
Mesh *	mesh(const std::string & alias, Mesh::PrimitiveType primitiveType, const float * verts, const unsigned int nVertices, const unsigned int * indices, const unsigned int nIndices, const float * colors, const unsigned int nColors)<br>Get model by alias or create it using provided indexed vertex data.
Mesh *	mesh(const std::string & path)<br>Get or create model from file.
Mesh *	meshByAlias(const std::string & alias)<br>Get existing model using an alias.
void	registerDefault(const std::string & alias)<br>Register an alias as a "default" resource.
bool	removeImportedModel(const std::string & alias)
bool	removeResource(ManagedResource * managedResource, bool force =false)<br>Dispose the specified resource and remove it from the manager.
bool	resourceExists(size_t id)
bool	resourceExists(std::string & alias)
virtual Memento	saveGlobal() override<br>Save shared global state.
virtual Memento	saveScene(State::Scene * scene) override<br>Save state for the current scene.
void	serializeModels(std::vector< std::string > modelAliases, Scene * scene, rapidjson::Value & targetArr, rapidjson::Document::AllocatorType & a)
GLuint	shader(const std::string & alias, const std::string & vertShader, const std::string & fragShader)<br>Get or create shader by alias or files.
GLuint	shader(const std::string & vertShader, const std::string & fragShader)<br>Get or create shader from files.
GLuint	shaderByAlias(const std::string & alias)<br>Get existing shader using an alias.
GLuint	shaderG(const std::string & alias, const std::string & vertShader, const std::string & fragShader, const std::string & geoShader)<br>Get or create shader by alias or files.
GLuint	shaderG(const std::string & vertShader, const std::string & fragShader, const std::string & geoShader)<br>Get or create shader from files.
GLuint	texture(const std::string & alias, const std::string & path)<br>Get or create texture by alias or path.
GLuint	texture(const std::string & path)<br>Get or create texture for file path.
GLuint	textureByAlias(const std::string & alias)<br>Get existing texture using an alias.
void	updateModelFiles(State::Scene * scene)<br>Ensure that model files required by the scene are in the right place.
ResourceManager &	instance()

Public Attributes

	Name
bool	m_forceMinimumLoad <br>If true any resource fetches will not be cached.
bool	m_forceModelNormalize <br>If true just the bare minimum of resources is loaded.
bool	m_forceReload

Additional inherited members

Public Functions inherited from Module

	Name
	Module() =default
virtual	~Module() =default
virtual void	onBeginFrame()
virtual void	onClose()
virtual void	onEndFrame()
virtual void	onInit()
virtual void	onUpdate(double deltaSeconds)

Friends inherited from Module

	Name
class	Application

Public Functions inherited from IStateful

	Name
virtual	~IStateful()
Memento	emptyMemento()<br>Create an empty memento (rapidjson::Document)

Detailed Description

cpp

class Core::ResourceManager;

class Core::ResourceManager;

Resource manager for loading resources from the filesystem.

Can be accessed from a singleton ResourceManager::instance()

Currently loads and manages models, shaders and textures.

Models are loaded using assimp or created directly from vertex arrays.

Resources are uniquely identified using a hash. Usually a hash of their file path string. Each resource can have an alias. A single string using which it can be retrieved. Aliases cannot be reassigned and point to a single resource type.

Finally a resource can be marked as default and returned using getDefaultResources().

An RM define is provided to shorten "Core::ResourceManager" An RMI define shortens "Core::ResourceManager::instance()"

Public Functions Documentation

function ~ResourceManager

cpp

~ResourceManager()

~ResourceManager()

If true loaded models will be normalized.

function cleanUpModelFiles

cpp

bool cleanUpModelFiles(
    State::Scene * scene
)

bool cleanUpModelFiles(
    State::Scene * scene
)

Ensure there are no unused model files in the scene_data directory of the passed scene.

function clearGlobal

cpp

virtual void clearGlobal() override

virtual void clearGlobal() override

Set the global state to some default empty state.

Reimplements: IStateful::clearGlobal

function clearScene

cpp

virtual void clearScene() override

virtual void clearScene() override

Set the scene state to some default empty state.

Reimplements: IStateful::clearScene

function deserializeModels

cpp

std::vector< ModelSaveEntry > deserializeModels(
    const rapidjson::Value & modelsEntry
)

std::vector< ModelSaveEntry > deserializeModels(
    const rapidjson::Value & modelsEntry
)

function getDefaultResources

cpp

std::vector< Resource > getDefaultResources(
    ResourceType type
)

std::vector< Resource > getDefaultResources(
    ResourceType type
)

Returns default resources of type.

function getImportedResourceAliases

cpp

std::vector< std::string > getImportedResourceAliases()

std::vector< std::string > getImportedResourceAliases()

function importModel

cpp

bool importModel(
    const fs::path & path,
    bool normalize
)

bool importModel(
    const fs::path & path,
    bool normalize
)

function loadDefaultResources

cpp

void loadDefaultResources(
    rapidjson::Document & doc
)

void loadDefaultResources(
    rapidjson::Document & doc
)

Loads resources from the a json document and marks them as default.

The json document must contain an "defaultResources" entry.

function loadGlobal

cpp

virtual void loadGlobal(
    const Memento & memento
) override

virtual void loadGlobal(
    const Memento & memento
) override

Load global state from a memento.

Parameters:

memento New global state

Reimplements: IStateful::loadGlobal

function loadScene

cpp

virtual void loadScene(
    const Memento & memento,
    State::Scene * scene
) override

virtual void loadScene(
    const Memento & memento,
    State::Scene * scene
) override

Called on scene load, undo and redo.

Parameters:

scene The current scene or nullptr (in case of undo/redo)
memento New scene state

Reimplements: IStateful::loadScene

function mesh

cpp

Mesh * mesh(
    const std::string & alias,
    const std::string & path
)

Mesh * mesh(
    const std::string & alias,
    const std::string & path
)

Get or create model by alias or file.

Return: Pointer to the Mesh object.

Necessary textures might be loaded as well. Alias is assigned if it doesn't exist.

function mesh

cpp

Mesh * mesh(
    const std::string & alias,
    Mesh::PrimitiveType primitiveType,
    const float * verts,
    const unsigned int nVertices,
    const float * colors,
    const unsigned int nColors
)

Mesh * mesh(
    const std::string & alias,
    Mesh::PrimitiveType primitiveType,
    const float * verts,
    const unsigned int nVertices,
    const float * colors,
    const unsigned int nColors
)

Get model by alias or create it using provided vertex data.

Parameters:

alias Resource alias
primitiveType Mesh primitive type
verts Pointer to vertex position array
nVertices Vertex position array size
colors Pointer to color array
nColors Color array size

Return: Pointer to the Mesh object.

Alias is assigned if it doesn't exist.

function mesh

cpp

Mesh * mesh(
    const std::string & alias,
    Mesh::PrimitiveType primitiveType,
    const float * verts,
    const unsigned int nVertices,
    const unsigned int * indices,
    const unsigned int nIndices,
    const float * colors,
    const unsigned int nColors
)

Mesh * mesh(
    const std::string & alias,
    Mesh::PrimitiveType primitiveType,
    const float * verts,
    const unsigned int nVertices,
    const unsigned int * indices,
    const unsigned int nIndices,
    const float * colors,
    const unsigned int nColors
)

Get model by alias or create it using provided indexed vertex data.

Parameters:

alias Resource alias
primitiveType Mesh primitive type
verts Pointer to vertex position array
nVertices Vertex position array size
indices Pointer to indices array
nIndices Indices array size
colors Pointer to color array
nColors Color array size

Return: Pointer to the Mesh object.

Alias is assigned if it doesn't exist.

function mesh

cpp

Mesh * mesh(
    const std::string & path
)

Mesh * mesh(
    const std::string & path
)

Get or create model from file.

Return: Pointer to the Mesh object.

Necessary textures might be loaded as well.

function meshByAlias

cpp

Mesh * meshByAlias(
    const std::string & alias
)

Mesh * meshByAlias(
    const std::string & alias
)

Get existing model using an alias.

Return: Pointer to the Mesh object.

function registerDefault

cpp

void registerDefault(
    const std::string & alias
)

void registerDefault(
    const std::string & alias
)

The aliased resource must exist.

function removeImportedModel

cpp

bool removeImportedModel(
    const std::string & alias
)

bool removeImportedModel(
    const std::string & alias
)

function removeResource

cpp

bool removeResource(
    ManagedResource * managedResource,
    bool force =false
)

bool removeResource(
    ManagedResource * managedResource,
    bool force =false
)

Dispose the specified resource and remove it from the manager.

Parameters:

managedResource The actual resource returned by fetch methods.

Return: false on failure

function resourceExists

cpp

bool resourceExists(
    size_t id
)

bool resourceExists(
    size_t id
)

function resourceExists

cpp

bool resourceExists(
    std::string & alias
)

bool resourceExists(
    std::string & alias
)

function saveGlobal

cpp

virtual Memento saveGlobal() override

virtual Memento saveGlobal() override

Save shared global state.

Reimplements: IStateful::saveGlobal

function saveScene

cpp

virtual Memento saveScene(
    State::Scene * scene
) override

virtual Memento saveScene(
    State::Scene * scene
) override

Save state for the current scene.

Parameters:

scene The current scene or nullptr (in case of undo/redo)

Reimplements: IStateful::saveScene

The scene parameter should contain a scene object for full filesystem saves and nullptr for quick undo/redo operations.

function serializeModels

cpp

void serializeModels(
    std::vector< std::string > modelAliases,
    Scene * scene,
    rapidjson::Value & targetArr,
    rapidjson::Document::AllocatorType & a
)

void serializeModels(
    std::vector< std::string > modelAliases,
    Scene * scene,
    rapidjson::Value & targetArr,
    rapidjson::Document::AllocatorType & a
)

function shader

cpp

GLuint shader(
    const std::string & alias,
    const std::string & vertShader,
    const std::string & fragShader
)

GLuint shader(
    const std::string & alias,
    const std::string & vertShader,
    const std::string & fragShader
)

Get or create shader by alias or files.

Return: OpenGL id of the shader object

Alias is assigned if it doesn't exist.

function shader

cpp

GLuint shader(
    const std::string & vertShader,
    const std::string & fragShader
)

GLuint shader(
    const std::string & vertShader,
    const std::string & fragShader
)

Get or create shader from files.

Return: OpenGL id of the shader object

function shaderByAlias

cpp

GLuint shaderByAlias(
    const std::string & alias
)

GLuint shaderByAlias(
    const std::string & alias
)

Get existing shader using an alias.

Return: OpenGL id of the shader object

function shaderG

cpp

GLuint shaderG(
    const std::string & alias,
    const std::string & vertShader,
    const std::string & fragShader,
    const std::string & geoShader
)

GLuint shaderG(
    const std::string & alias,
    const std::string & vertShader,
    const std::string & fragShader,
    const std::string & geoShader
)

Get or create shader by alias or files.

Return: OpenGL id of the shader object

Alias is assigned if it doesn't exist.

function shaderG

cpp

GLuint shaderG(
    const std::string & vertShader,
    const std::string & fragShader,
    const std::string & geoShader
)

GLuint shaderG(
    const std::string & vertShader,
    const std::string & fragShader,
    const std::string & geoShader
)

Get or create shader from files.

Return: OpenGL id of the shader object

function texture

cpp

GLuint texture(
    const std::string & alias,
    const std::string & path
)

GLuint texture(
    const std::string & alias,
    const std::string & path
)

Get or create texture by alias or path.

Return: OpenGL id of the texture object

Alias is assigned if it doesn't exist.

function texture

cpp

GLuint texture(
    const std::string & path
)

GLuint texture(
    const std::string & path
)

Get or create texture for file path.

Return: OpenGL id of the texture object

function textureByAlias

cpp

GLuint textureByAlias(
    const std::string & alias
)

GLuint textureByAlias(
    const std::string & alias
)

Get existing texture using an alias.

Return: OpenGL id of the texture object

function updateModelFiles

cpp

void updateModelFiles(
    State::Scene * scene
)

void updateModelFiles(
    State::Scene * scene
)

Ensure that model files required by the scene are in the right place.

function instance

cpp

static ResourceManager & instance()

static ResourceManager & instance()

Public Attributes Documentation

variable m_forceMinimumLoad

cpp

bool m_forceMinimumLoad {false};

bool m_forceMinimumLoad {false};

If true any resource fetches will not be cached.

variable m_forceModelNormalize

cpp

bool m_forceModelNormalize {false};

bool m_forceModelNormalize {false};

If true just the bare minimum of resources is loaded.

variable m_forceReload

cpp

bool m_forceReload {false};

bool m_forceReload {false};

Updated on 2024-11-06 at 20:16:54 +0000

Core::ResourceManager ​

Public Classes ​

Public Functions ​

Public Attributes ​

Additional inherited members ​

Detailed Description ​

Public Functions Documentation ​

function ~ResourceManager ​

function cleanUpModelFiles ​

function clearGlobal ​

function clearScene ​

function deserializeModels ​

function getDefaultResources ​

function getImportedResourceAliases ​

function importModel ​

function loadDefaultResources ​

function loadGlobal ​

function loadScene ​

function mesh ​

function mesh ​

function mesh ​

function mesh ​

function meshByAlias ​

function registerDefault ​

function removeImportedModel ​

function removeResource ​

function resourceExists ​

function resourceExists ​

function saveGlobal ​

function saveScene ​

function serializeModels ​

function shader ​

function shader ​

function shaderByAlias ​

function shaderG ​

function shaderG ​

function texture ​

function texture ​

function textureByAlias ​

function updateModelFiles ​

function instance ​

Public Attributes Documentation ​

variable m_forceMinimumLoad ​

variable m_forceModelNormalize ​

variable m_forceReload ​

Core::ResourceManager

Public Classes

Public Functions

Public Attributes

Additional inherited members

Detailed Description

Public Functions Documentation

function ~ResourceManager

function cleanUpModelFiles

function clearGlobal

function clearScene

function deserializeModels

function getDefaultResources

function getImportedResourceAliases

function importModel

function loadDefaultResources

function loadGlobal

function loadScene

function mesh

function mesh

function mesh

function mesh

function meshByAlias

function registerDefault

function removeImportedModel

function removeResource

function resourceExists

function resourceExists

function saveGlobal

function saveScene

function serializeModels

function shader

function shader

function shaderByAlias

function shaderG

function shaderG

function texture

function texture

function textureByAlias

function updateModelFiles

function instance

Public Attributes Documentation

variable m_forceMinimumLoad

variable m_forceModelNormalize

variable m_forceReload