#include <iResourceManager.h>

Inherits igor::iModule< iResourceManager >.

Public Member Functions
void	addSearchPath (const iaString &searchPath)

void	removeSearchPath (const iaString &searchPath)

void	clearSearchPaths ()

const iaString	resolvePath (const iaString &filepath)

const iaString	getFilename (const iResourceID &id)

const iaString	getAlias (const iResourceID &id)

void	setAlias (const iResourceID &id, const iaString &alias)

iaString	getRelativePath (const iaString &filename)

bool	fileExists (const iaString &filename)

iResourcePtr	requestResource (const iParameters &parameters)

iResourcePtr	loadResource (const iParameters &parameters)

iResourcePtr	createResource (const iParameters &parameters)

template<typename T >
std::shared_ptr< T >	requestResource (const iParameters &parameters)

template<typename T >
std::shared_ptr< T >	loadResource (const iParameters &parameters)

template<typename T >
std::shared_ptr< T >	createResource ()

template<typename T >
std::shared_ptr< T >	requestResource (const iaString &alias, iResourceCacheMode cacheMode=iResourceCacheMode::Cache)

template<typename T >
std::shared_ptr< T >	loadResource (const iaString &alias, iResourceCacheMode cacheMode=iResourceCacheMode::Cache)

template<typename T >
std::shared_ptr< T >	requestResource (const iResourceID &resourceID, iResourceCacheMode cacheMode=iResourceCacheMode::Cache)

template<typename T >
std::shared_ptr< T >	loadResource (const iResourceID &resourceID, iResourceCacheMode cacheMode=iResourceCacheMode::Cache)

iResourcePtr	getResource (const iResourceID &id)

template<typename T >
std::shared_ptr< T >	getResource (const iResourceID &id)

template<typename T >
std::shared_ptr< T >	getResource (const iaString &alias)

void	getMaterials (std::vector< iShaderPtr > &materials)

void	flush (iResourceCacheMode cacheModeLevel=iResourceCacheMode::Free)

void	interruptFlush ()

void	registerFactory (iFactoryPtr factory)

void	unregisterFactory (iFactoryPtr factory)

void	setLoadMode (iResourceManagerLoadMode loadMode)

iResourceManagerLoadMode	getLoadMode () const

void	loadResourceDictionary (const iaString &filename)

void	saveResourceDictionary (const iaString &filename)

void	clearResourceDictionary ()

const iResourceID	getResourceID (const iaString &aliasOrFilename) const

void	addToDictionary (const iaString &filename, const iaString &alias="", const iaUUID &uuid=iaUUID::getInvalid())

void	removeFromDictionary (const iResourceID &resourceID)

const iaString	getType (const iaString &filename) const

const iaString	getType (const iResourceID &resourceID) const

bool	saveResource (iResourcePtr resource, const iaString &filename="")

bool	saveResource (iResourceID resourceID, const iaString &filename="")

iResourceProcessedEvent &	getResourceProcessedEvent ()

template<>
iTexturePtr	requestResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iTexturePtr	loadResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iTexturePtr	requestResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iTexturePtr	loadResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iTexturePtr	requestResource (const iParameters &param)

template<>
iTexturePtr	loadResource (const iParameters &param)

template<>
iTexturePtr	createResource ()

template<>
iTexturePtr	getResource (const iResourceID &id)

template<>
iTexturePtr	getResource (const iaString &alias)

template<>
iSoundPtr	requestResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iSoundPtr	loadResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iSoundPtr	requestResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iSoundPtr	loadResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iSoundPtr	requestResource (const iParameters &param)

template<>
iSoundPtr	loadResource (const iParameters &param)

template<>
iSoundPtr	createResource ()

template<>
iSoundPtr	getResource (const iResourceID &id)

template<>
iSoundPtr	getResource (const iaString &alias)

template<>
iSpritePtr	requestResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iSpritePtr	loadResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iSpritePtr	requestResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iSpritePtr	loadResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iSpritePtr	requestResource (const iParameters &param)

template<>
iSpritePtr	loadResource (const iParameters &param)

template<>
iSpritePtr	createResource ()

template<>
iSpritePtr	getResource (const iResourceID &id)

template<>
iSpritePtr	getResource (const iaString &alias)

template<>
iAnimationPtr	requestResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iAnimationPtr	loadResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iAnimationPtr	requestResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iAnimationPtr	loadResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iAnimationPtr	requestResource (const iParameters &param)

template<>
iAnimationPtr	loadResource (const iParameters &param)

template<>
iAnimationPtr	createResource ()

template<>
iAnimationPtr	getResource (const iResourceID &id)

template<>
iAnimationPtr	getResource (const iaString &alias)

template<>
iModelPtr	requestResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iModelPtr	loadResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iModelPtr	requestResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iModelPtr	loadResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iModelPtr	requestResource (const iParameters &param)

template<>
iModelPtr	loadResource (const iParameters &param)

template<>
iModelPtr	createResource ()

template<>
iModelPtr	getResource (const iResourceID &id)

template<>
iModelPtr	getResource (const iaString &alias)

template<>
iShaderPtr	requestResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iShaderPtr	loadResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iShaderPtr	requestResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iShaderPtr	loadResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iShaderPtr	requestResource (const iParameters &param)

template<>
iShaderPtr	loadResource (const iParameters &param)

template<>
iShaderPtr	createResource ()

template<>
iShaderPtr	getResource (const iResourceID &id)

template<>
iShaderPtr	getResource (const iaString &alias)

template<>
iMaterialPtr	requestResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iMaterialPtr	loadResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iMaterialPtr	requestResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iMaterialPtr	loadResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iMaterialPtr	requestResource (const iParameters &param)

template<>
iMaterialPtr	loadResource (const iParameters &param)

template<>
iMaterialPtr	createResource ()

template<>
iMaterialPtr	getResource (const iResourceID &id)

template<>
iMaterialPtr	getResource (const iaString &alias)

template<>
iPrefabPtr	requestResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iPrefabPtr	loadResource (const iaString &alias, iResourceCacheMode cacheMode)

template<>
iPrefabPtr	requestResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iPrefabPtr	loadResource (const iResourceID &resourceID, iResourceCacheMode cacheMode)

template<>
iPrefabPtr	requestResource (const iParameters &param)

template<>
iPrefabPtr	loadResource (const iParameters &param)

template<>
iPrefabPtr	createResource ()

template<>
iPrefabPtr	getResource (const iResourceID &id)

template<>
iPrefabPtr	getResource (const iaString &alias)

Friends
class	iModule< iResourceManager >

Additional Inherited Members
Static Public Member Functions inherited from igor::iModule< iResourceManager >
static IGOR_INLINE iResourceManager &	getInstance ()

static IGOR_INLINE bool	isInstantiated ()

static void	createInstance ()

static void	destroyInstance ()

Protected Member Functions inherited from igor::iModule< iResourceManager >
	iModule ()=default

virtual	~iModule ()=default

Detailed Description

manages resources and their factories

Member Function Documentation

◆ addSearchPath()

void igor::iResourceManager::addSearchPath ( const iaString & searchPath )

adds search path to list

Parameters

searchPath search path to add

◆ addToDictionary()

void igor::iResourceManager::addToDictionary	(	const iaString &	filename,
		const iaString &	alias = `""`,
		const iaUUID &	uuid = `iaUUID::getInvalid()`
	)

adds new resource to dictionary

Parameters

filename	path to resource (must be relative to search paths)
alias	optional alias

◆ clearResourceDictionary()

void igor::iResourceManager::clearResourceDictionary ( )

clear resource dictionary

(means it will only contain igor internal resources)

◆ clearSearchPaths()

void igor::iResourceManager::clearSearchPaths ( )

clears search path list

◆ createResource() [1/10]

template<typename T >

std::shared_ptr< T > igor::iResourceManager::createResource ( )

creates a new resource of given type

template version for more convenience

Returns: shared pointer to resource

◆ createResource() [2/10]

template<>

iTexturePtr igor::iResourceManager::createResource ( )

inline

◆ createResource() [3/10]

template<>

iSoundPtr igor::iResourceManager::createResource ( )

inline

◆ createResource() [4/10]

template<>

iSpritePtr igor::iResourceManager::createResource ( )

inline

◆ createResource() [5/10]

template<>

iAnimationPtr igor::iResourceManager::createResource ( )

inline

◆ createResource() [6/10]

template<>

iModelPtr igor::iResourceManager::createResource ( )

inline

◆ createResource() [7/10]

template<>

iShaderPtr igor::iResourceManager::createResource ( )

inline

◆ createResource() [8/10]

template<>

iMaterialPtr igor::iResourceManager::createResource ( )

inline

◆ createResource() [9/10]

template<>

iPrefabPtr igor::iResourceManager::createResource ( )

inline

◆ createResource() [10/10]

iResourcePtr igor::iResourceManager::createResource ( const iParameters & parameters )

creates a new resource

Parameters

param parameters for creating resource

Returns: shared pointer to resource

◆ fileExists()

bool igor::iResourceManager::fileExists ( const iaString & filename )

Returns: true if filename is a file in our search paths or an absolute path to an existing file

Parameters

filename the file we are looking for

◆ flush()

void igor::iResourceManager::flush ( iResourceCacheMode cacheModeLevel = iResourceCacheMode::Free )

works like a garbage collector.

Iterates through all resources and checks how many references every resource has. If reference count goes down to 1 then the resource will be released. If reference count is greater 1 and the resource was not loaded yet then the resource will be loaded.

Parameters

cacheModeLevel level of cache mode to be released

◆ getAlias()

const iaString igor::iResourceManager::getAlias ( const iResourceID & id )

Returns: alias for given resource id (if available)

Parameters

id	the given resource id

◆ getFilename()

const iaString igor::iResourceManager::getFilename ( const iResourceID & id )

Returns: filename for given resource id

Parameters

id	the given resource id

◆ getLoadMode()

iResourceManagerLoadMode igor::iResourceManager::getLoadMode ( ) const

Returns: the load mode

◆ getMaterials()

void igor::iResourceManager::getMaterials ( std::vector< iShaderPtr > & materials )

returns all materials

Parameters

[out] materials the materials

TODO how about a more general interface?

◆ getRelativePath()

iaString igor::iResourceManager::getRelativePath ( const iaString & filename )

Returns: relative path to search path. returns full path if no matching search path found

Parameters

filename full path to file

◆ getResource() [1/19]

template<typename T >

std::shared_ptr< T > igor::iResourceManager::getResource ( const iaString & alias )

Returns: resource by name

typed version

Parameters

name	the name of the resource

◆ getResource() [2/19]

template<>

iTexturePtr igor::iResourceManager::getResource ( const iaString & alias )

inline

◆ getResource() [3/19]

template<>

iSoundPtr igor::iResourceManager::getResource ( const iaString & alias )

inline

◆ getResource() [4/19]

template<>

iSpritePtr igor::iResourceManager::getResource ( const iaString & alias )

inline

◆ getResource() [5/19]

template<>

iAnimationPtr igor::iResourceManager::getResource ( const iaString & alias )

inline

◆ getResource() [6/19]

template<>

iModelPtr igor::iResourceManager::getResource ( const iaString & alias )

inline

◆ getResource() [7/19]

template<>

iShaderPtr igor::iResourceManager::getResource ( const iaString & alias )

inline

◆ getResource() [8/19]

template<>

iMaterialPtr igor::iResourceManager::getResource ( const iaString & alias )

inline

◆ getResource() [9/19]

template<>

iPrefabPtr igor::iResourceManager::getResource ( const iaString & alias )

inline

◆ getResource() [10/19]

iResourcePtr igor::iResourceManager::getResource ( const iResourceID & id )

Returns: resource by id

Parameters

id	the id of the resource

◆ getResource() [11/19]

template<typename T >

std::shared_ptr< T > igor::iResourceManager::getResource ( const iResourceID & id )

Returns: resource by id

typed version

Parameters

id	the id of the resource

◆ getResource() [12/19]

template<>

iTexturePtr igor::iResourceManager::getResource ( const iResourceID & id )

inline

◆ getResource() [13/19]

template<>

iSoundPtr igor::iResourceManager::getResource ( const iResourceID & id )

inline

◆ getResource() [14/19]

template<>

iSpritePtr igor::iResourceManager::getResource ( const iResourceID & id )

inline

◆ getResource() [15/19]

template<>

iAnimationPtr igor::iResourceManager::getResource ( const iResourceID & id )

inline

◆ getResource() [16/19]

template<>

iModelPtr igor::iResourceManager::getResource ( const iResourceID & id )

inline

◆ getResource() [17/19]

template<>

iShaderPtr igor::iResourceManager::getResource ( const iResourceID & id )

inline

◆ getResource() [18/19]

template<>

iMaterialPtr igor::iResourceManager::getResource ( const iResourceID & id )

inline

◆ getResource() [19/19]

template<>

iPrefabPtr igor::iResourceManager::getResource ( const iResourceID & id )

inline

◆ getResourceID()

const iResourceID igor::iResourceManager::getResourceID ( const iaString & aliasOrFilename ) const

Returns: resource id for given alias or filepath

If it does not exist yet but it represents a valid file path within one of the search path. We add a new resource.

Parameters

aliasOrFilename the given alias or filename

◆ getResourceProcessedEvent()

iResourceProcessedEvent & igor::iResourceManager::getResourceProcessedEvent ( )

Returns: resource process event

◆ getType() [1/2]

const iaString igor::iResourceManager::getType ( const iaString & filename ) const

Returns: resource type for given filename

this is purely based on file extension

Parameters

filename the file name to guess the type of

◆ getType() [2/2]

const iaString igor::iResourceManager::getType ( const iResourceID & resourceID ) const

Returns: resource type for given resource id

this is purely based on file extension

Parameters

resourceID the given resource id

◆ interruptFlush()

void igor::iResourceManager::interruptFlush ( )

if a flush in a different thread is currently running. this will prevent loading new data from disk and in consequence make it stop earlier

◆ loadResource() [1/28]

template<>

iTexturePtr igor::iResourceManager::loadResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [2/28]

template<>

iSoundPtr igor::iResourceManager::loadResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [3/28]

template<>

iSpritePtr igor::iResourceManager::loadResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [4/28]

template<>

iAnimationPtr igor::iResourceManager::loadResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [5/28]

template<>

iModelPtr igor::iResourceManager::loadResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [6/28]

template<>

iShaderPtr igor::iResourceManager::loadResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [7/28]

template<>

iMaterialPtr igor::iResourceManager::loadResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [8/28]

template<>

iPrefabPtr igor::iResourceManager::loadResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [9/28]

template<typename T >

std::shared_ptr< T > igor::iResourceManager::loadResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode = `iResourceCacheMode::Cache`
	)

loads a resource synchronously

template version for more convenience

Parameters

alias the name of the resource (this can also be a filename)

Returns: shared pointer to resource

◆ loadResource() [10/28]

template<>

iTexturePtr igor::iResourceManager::loadResource ( const iParameters & param )

inline

◆ loadResource() [11/28]

template<>

iSoundPtr igor::iResourceManager::loadResource ( const iParameters & param )

inline

◆ loadResource() [12/28]

template<>

iSpritePtr igor::iResourceManager::loadResource ( const iParameters & param )

inline

◆ loadResource() [13/28]

template<>

iAnimationPtr igor::iResourceManager::loadResource ( const iParameters & param )

inline

◆ loadResource() [14/28]

template<>

iModelPtr igor::iResourceManager::loadResource ( const iParameters & param )

inline

◆ loadResource() [15/28]

template<>

iShaderPtr igor::iResourceManager::loadResource ( const iParameters & param )

inline

◆ loadResource() [16/28]

template<>

iMaterialPtr igor::iResourceManager::loadResource ( const iParameters & param )

inline

◆ loadResource() [17/28]

template<>

iPrefabPtr igor::iResourceManager::loadResource ( const iParameters & param )

inline

◆ loadResource() [18/28]

iResourcePtr igor::iResourceManager::loadResource ( const iParameters & parameters )

loads a resource synchronously.

Parameters

param parameters for loading resource

Returns: shared pointer to resource

◆ loadResource() [19/28]

template<typename T >

std::shared_ptr< T > igor::iResourceManager::loadResource ( const iParameters & parameters )

loads a resource synchronously.

template version for more convenience

Parameters

param parameters for loading resource

Returns: shared pointer to resource

◆ loadResource() [20/28]

template<>

iTexturePtr igor::iResourceManager::loadResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [21/28]

template<>

iSoundPtr igor::iResourceManager::loadResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [22/28]

template<>

iSpritePtr igor::iResourceManager::loadResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [23/28]

template<>

iAnimationPtr igor::iResourceManager::loadResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [24/28]

template<>

iModelPtr igor::iResourceManager::loadResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [25/28]

template<>

iShaderPtr igor::iResourceManager::loadResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [26/28]

template<>

iMaterialPtr igor::iResourceManager::loadResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [27/28]

template<>

iPrefabPtr igor::iResourceManager::loadResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ loadResource() [28/28]

template<typename T >

std::shared_ptr< T > igor::iResourceManager::loadResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode = `iResourceCacheMode::Cache`
	)

loads a resource synchronously by id

template version for more convenience

Parameters

resourceID the id of the resource

Returns: shared pointer to resource

◆ loadResourceDictionary()

void igor::iResourceManager::loadResourceDictionary ( const iaString & filename )

loads resource dictionary

this will append resources to existing dictionary

Parameters

filename filename to resource dictionary

◆ registerFactory()

void igor::iResourceManager::registerFactory ( iFactoryPtr factory )

registers factory to resource manager

Parameters

factory the given factory

◆ removeFromDictionary()

void igor::iResourceManager::removeFromDictionary ( const iResourceID & resourceID )

removes given resource from dictionary

Parameters

resourceID the given resource id

◆ removeSearchPath()

void igor::iResourceManager::removeSearchPath ( const iaString & searchPath )

removes search path from list

Parameters

searchPath search path to remove

◆ requestResource() [1/28]

template<>

iTexturePtr igor::iResourceManager::requestResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [2/28]

template<>

iSoundPtr igor::iResourceManager::requestResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [3/28]

template<>

iSpritePtr igor::iResourceManager::requestResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [4/28]

template<>

iAnimationPtr igor::iResourceManager::requestResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [5/28]

template<>

iModelPtr igor::iResourceManager::requestResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [6/28]

template<>

iShaderPtr igor::iResourceManager::requestResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [7/28]

template<>

iMaterialPtr igor::iResourceManager::requestResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [8/28]

template<>

iPrefabPtr igor::iResourceManager::requestResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [9/28]

template<typename T >

std::shared_ptr< T > igor::iResourceManager::requestResource	(	const iaString &	alias,
		iResourceCacheMode	cacheMode = `iResourceCacheMode::Cache`
	)

requests a resource to be loaded asynchronously

template version for more convenience

Parameters

alias the name of the resource (this can also be a filename)

Returns: shared pointer to resource

◆ requestResource() [10/28]

template<>

iTexturePtr igor::iResourceManager::requestResource ( const iParameters & param )

inline

◆ requestResource() [11/28]

template<>

iSoundPtr igor::iResourceManager::requestResource ( const iParameters & param )

inline

◆ requestResource() [12/28]

template<>

iSpritePtr igor::iResourceManager::requestResource ( const iParameters & param )

inline

◆ requestResource() [13/28]

template<>

iAnimationPtr igor::iResourceManager::requestResource ( const iParameters & param )

inline

◆ requestResource() [14/28]

template<>

iModelPtr igor::iResourceManager::requestResource ( const iParameters & param )

inline

◆ requestResource() [15/28]

template<>

iShaderPtr igor::iResourceManager::requestResource ( const iParameters & param )

inline

◆ requestResource() [16/28]

template<>

iMaterialPtr igor::iResourceManager::requestResource ( const iParameters & param )

inline

◆ requestResource() [17/28]

template<>

iPrefabPtr igor::iResourceManager::requestResource ( const iParameters & param )

inline

◆ requestResource() [18/28]

iResourcePtr igor::iResourceManager::requestResource ( const iParameters & parameters )

requests a resource to be loaded asynchronously.

Parameters

param parameters for loading resource

Returns: shared pointer to resource

◆ requestResource() [19/28]

template<typename T >

std::shared_ptr< T > igor::iResourceManager::requestResource ( const iParameters & parameters )

requests a resource to be loaded asynchronously.

template version for more convenience

Parameters

param parameters for loading resource

Returns: shared pointer to resource

◆ requestResource() [20/28]

template<>

iTexturePtr igor::iResourceManager::requestResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [21/28]

template<>

iSoundPtr igor::iResourceManager::requestResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [22/28]

template<>

iSpritePtr igor::iResourceManager::requestResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [23/28]

template<>

iAnimationPtr igor::iResourceManager::requestResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [24/28]

template<>

iModelPtr igor::iResourceManager::requestResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [25/28]

template<>

iShaderPtr igor::iResourceManager::requestResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [26/28]

template<>

iMaterialPtr igor::iResourceManager::requestResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [27/28]

template<>

iPrefabPtr igor::iResourceManager::requestResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode
	)

inline

◆ requestResource() [28/28]

template<typename T >

std::shared_ptr< T > igor::iResourceManager::requestResource	(	const iResourceID &	resourceID,
		iResourceCacheMode	cacheMode = `iResourceCacheMode::Cache`
	)

requests a resource to be loaded asynchronously by id

template version for more convenience

Parameters

resourceID the id of the resource

Returns: shared pointer to resource

◆ resolvePath()

const iaString igor::iResourceManager::resolvePath ( const iaString & filepath )

Returns: full path to a file

If the file does not exist it returns an empty string

It only resolves for files that are within one of the given search paths

Parameters

filepath relative or absolute path to file

◆ saveResource() [1/2]

bool igor::iResourceManager::saveResource	(	iResourceID	resourceID,
		const iaString &	filename = `""`
	)

saves a resource to the filesystem

Parameters

resourceID	the given resource ID to save (must be valid and have a valid source/filename)
filename	optional filename if resource is to be saved in a new location

Returns: true if successfully saved

◆ saveResource() [2/2]

bool igor::iResourceManager::saveResource	(	iResourcePtr	resource,
		const iaString &	filename = `""`
	)

saves a resource to the filesystem

Parameters

resource	the given resource to save (must be valid and have a valid source/filename)
filename	optional filename if resource is to be saved in a new location

Returns: true if successfully saved

◆ saveResourceDictionary()

void igor::iResourceManager::saveResourceDictionary ( const iaString & filename )

write resource dictionary to given filename

Parameters

filename the file to write the dictionary to

◆ setAlias()

void igor::iResourceManager::setAlias	(	const iResourceID &	id,
		const iaString &	alias
	)

sets alias for given resource id

Parameters

id	the given resource id
alias	the given alias

◆ setLoadMode()

void igor::iResourceManager::setLoadMode ( iResourceManagerLoadMode loadMode )

sets the load mode

Does not effect load requests that are already in queue

Parameters

loadMode the load mode to set

◆ unregisterFactory()

void igor::iResourceManager::unregisterFactory ( iFactoryPtr factory )

unregisters factory from resource manager

Parameters

factory the given factory

Friends And Related Function Documentation

◆ iModule< iResourceManager >

friend class iModule< iResourceManager >

friend

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

/home/martin/dev/Igor/src/igor/igor/resources/iResourceManager.h
/home/martin/dev/Igor/src/igor/igor/resources/iResourceManager.cpp
/home/martin/dev/Igor/src/igor/igor/resources/iResourceManager.inl

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addSearchPath()

◆ addToDictionary()

◆ clearResourceDictionary()

◆ clearSearchPaths()

◆ createResource() [1/10]

◆ createResource() [2/10]

◆ createResource() [3/10]

◆ createResource() [4/10]

◆ createResource() [5/10]

◆ createResource() [6/10]

◆ createResource() [7/10]

◆ createResource() [8/10]

◆ createResource() [9/10]

◆ createResource() [10/10]

◆ fileExists()

◆ flush()

◆ getAlias()

◆ getFilename()

◆ getLoadMode()

◆ getMaterials()

◆ getRelativePath()

◆ getResource() [1/19]

◆ getResource() [2/19]

◆ getResource() [3/19]

◆ getResource() [4/19]

◆ getResource() [5/19]

◆ getResource() [6/19]

◆ getResource() [7/19]

◆ getResource() [8/19]

◆ getResource() [9/19]

◆ getResource() [10/19]

◆ getResource() [11/19]

◆ getResource() [12/19]

◆ getResource() [13/19]

◆ getResource() [14/19]

◆ getResource() [15/19]

◆ getResource() [16/19]

◆ getResource() [17/19]

◆ getResource() [18/19]

◆ getResource() [19/19]

◆ getResourceID()

◆ getResourceProcessedEvent()

◆ getType() [1/2]

◆ getType() [2/2]

◆ interruptFlush()

◆ loadResource() [1/28]

◆ loadResource() [2/28]

◆ loadResource() [3/28]

◆ loadResource() [4/28]

◆ loadResource() [5/28]

◆ loadResource() [6/28]

◆ loadResource() [7/28]

◆ loadResource() [8/28]

◆ loadResource() [9/28]

◆ loadResource() [10/28]

◆ loadResource() [11/28]

◆ loadResource() [12/28]

◆ loadResource() [13/28]

◆ loadResource() [14/28]

◆ loadResource() [15/28]

◆ loadResource() [16/28]

◆ loadResource() [17/28]

◆ loadResource() [18/28]

◆ loadResource() [19/28]

◆ loadResource() [20/28]

◆ loadResource() [21/28]

◆ loadResource() [22/28]

◆ loadResource() [23/28]

◆ loadResource() [24/28]

◆ loadResource() [25/28]

◆ loadResource() [26/28]

◆ loadResource() [27/28]

◆ loadResource() [28/28]

◆ loadResourceDictionary()

◆ registerFactory()