COgreResourceGroup Class Reference

Ogre Resource Group management This class handles a resource group, possibly shared by multiple scenarios. Its reference count keeps track of when it is actually needed. Resources are freed when the count reaches 0. More...

Public Member Functions

 COgreResourceGroup (const OpenViBE::Kernel::IKernelContext &rKernelContext, const std::string &rName)
 Constructor Create a resource group names 'name'. More...
 
 ~COgreResourceGroup ()
 Destructor.
 
const std::string & getName ()
 Get resource group name.
 
bool addResourceLocation (const std::string &rPath, const std::string &rType, bool bRecursive)
 Add a resource location. More...
 
bool initialize ()
 Initialize resource group. More...
 
bool destroy ()
 Destroy resource group. More...
 

Detailed Description

Ogre Resource Group management This class handles a resource group, possibly shared by multiple scenarios. Its reference count keeps track of when it is actually needed. Resources are freed when the count reaches 0.

Author
Vincent Delannoy (INRIA/IRISA)
Date
2008-06

Constructor & Destructor Documentation

COgreResourceGroup ( const OpenViBE::Kernel::IKernelContext rKernelContext,
const std::string &  rName 
)

Constructor Create a resource group names 'name'.

Parameters
[in]rKernelContextOpenViBE kernel context
[in]rNamename of this resource group

Member Function Documentation

bool addResourceLocation ( const std::string &  rPath,
const std::string &  rType,
bool  bRecursive 
)

Add a resource location.

Remarks
Resources can't be added once Resource Group has been initialized
Parameters
rPathResources location path
typeResources type (path or zip file)
bRecursiveResources are added recursively from location passed in parameter if true
Returns
True if location could be added, false otherwise
bool initialize ( )

Initialize resource group.

Remarks
This increments the resource group internal reference counter
Returns
True if this group was effectively intialised (i.e. upon first call to this method), false otherwise
bool destroy ( )

Destroy resource group.

Remarks
This decrements the resource group internal reference counter
Returns
True if this group was effectively destroyed (i.e. its refcount reached 0), false otherwise