OGRE  1.10.10
Object-Oriented Graphics Rendering Engine
Ogre::ResourceGroupManager Class Reference

This singleton class manages the list of resource groups, and notifying the various resource managers of their obligations to load / unload resources in a group. More...

#include <OgreResourceGroupManager.h>

+ Inheritance diagram for Ogre::ResourceGroupManager:

Classes

struct  ResourceDeclaration
 Nested struct defining a resource declaration. More...
 
struct  ResourceLocation
 Resource location entry. More...
 

Public Types

typedef list< ResourceLocation * >::type LocationList
 List of possible file locations. More...
 
typedef list< ResourceDeclaration >::type ResourceDeclarationList
 List of resource declarations. More...
 
typedef MapIterator< ResourceManagerMapResourceManagerIterator
 
typedef map< String, ResourceManager * >::type ResourceManagerMap
 

Public Member Functions

 ResourceGroupManager ()
 
virtual ~ResourceGroupManager ()
 
ScriptLoader_findScriptLoader (const String &pattern) const
 Method used to directly query for registered script loaders. More...
 
ResourceManager_getResourceManager (const String &resourceType) const
 Internal method for getting a registered ResourceManager. More...
 
void _notifyAllResourcesRemoved (ResourceManager *manager) const
 Internal method called by ResourceManager when all resources for that manager are removed. More...
 
void _notifyResourceCreated (ResourcePtr &res) const
 Internal method called by ResourceManager when a resource is created. More...
 
void _notifyResourceGroupChanged (const String &oldGroup, Resource *res) const
 Internal method to notify the group manager that a resource has changed group (only applicable for autodetect group) More...
 
void _notifyResourceRemoved (const ResourcePtr &res) const
 Internal method called by ResourceManager when a resource is removed. More...
 
void _notifyWorldGeometryStageEnded (void) const
 Notify this manager that one stage of world geometry loading has been completed. More...
 
void _notifyWorldGeometryStageStarted (const String &description) const
 Notify this manager that one stage of world geometry loading has been started. More...
 
void _registerResourceManager (const String &resourceType, ResourceManager *rm)
 Internal method for registering a ResourceManager (which should be a singleton). More...
 
void _registerScriptLoader (ScriptLoader *su)
 Internal method for registering a ScriptLoader. More...
 
void _unregisterResourceManager (const String &resourceType)
 Internal method for unregistering a ResourceManager. More...
 
void _unregisterScriptLoader (ScriptLoader *su)
 Internal method for unregistering a ScriptLoader. More...
 
void addResourceGroupListener (ResourceGroupListener *l)
 Adds a ResourceGroupListener which will be called back during resource loading events. More...
 
void addResourceLocation (const String &name, const String &locType, const String &resGroup=DEFAULT_RESOURCE_GROUP_NAME, bool recursive=false, bool readOnly=true)
 Method to add a resource location to for a given resource group. More...
 
void clearResourceGroup (const String &name)
 Clears a resource group. More...
 
DataStreamPtr createResource (const String &filename, const String &groupName=DEFAULT_RESOURCE_GROUP_NAME, bool overwrite=false, const String &locationPattern=BLANKSTRING)
 Create a new resource file in a given group. More...
 
void createResourceGroup (const String &name, bool inGlobalPool=!OGRE_RESOURCEMANAGER_STRICT)
 Create a resource group. More...
 
void declareResource (const String &name, const String &resourceType, const String &groupName=DEFAULT_RESOURCE_GROUP_NAME, const NameValuePairList &loadParameters=NameValuePairList())
 Declares a resource to be a part of a resource group, allowing you to load and unload it as part of the group. More...
 
void declareResource (const String &name, const String &resourceType, const String &groupName, ManualResourceLoader *loader, const NameValuePairList &loadParameters=NameValuePairList())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void deleteMatchingResources (const String &filePattern, const String &groupName=DEFAULT_RESOURCE_GROUP_NAME, const String &locationPattern=BLANKSTRING)
 Delete all matching resource files. More...
 
void deleteResource (const String &filename, const String &groupName=DEFAULT_RESOURCE_GROUP_NAME, const String &locationPattern=BLANKSTRING)
 Delete a single resource file. More...
 
void destroyResourceGroup (const String &name)
 Destroys a resource group, clearing it first, destroying the resources which are part of it, and then removing it from the list of resource groups. More...
 
const StringfindGroupContainingResource (const String &filename) const
 Find the group in which a resource exists. More...
 
FileInfoListPtr findResourceFileInfo (const String &group, const String &pattern, bool dirs=false) const
 Find all files or directories matching a given pattern in a group and get some detailed information about them. More...
 
StringVectorPtr findResourceLocation (const String &groupName, const String &pattern) const
 Find all resource location names matching a given pattern in a resource group. More...
 
StringVectorPtr findResourceNames (const String &groupName, const String &pattern, bool dirs=false) const
 Find all file or directory names matching a given pattern in a resource group. More...
 
ResourceLoadingListenergetLoadingListener () const
 Returns the current loading listener. More...
 
ResourceDeclarationList getResourceDeclarationList (const String &groupName) const
 Get the list of resource declarations for the specified group name. More...
 
StringVector getResourceGroups (void) const
 Get a list of the currently defined resource groups. More...
 
const LocationListgetResourceLocationList (const String &groupName) const
 Get the list of resource locations for the specified group name. More...
 
ResourceManagerIterator getResourceManagerIterator ()
 Get an iterator over the registered resource managers. More...
 
const StringgetWorldResourceGroupName (void) const
 Gets the resource group that 'world' resources will use. More...
 
void initialiseAllResourceGroups (void)
 Initialise all resource groups which are yet to be initialised. More...
 
void initialiseResourceGroup (const String &name)
 Initialises a resource group. More...
 
bool isResourceGroupInGlobalPool (const String &name) const
 Checks the status of a resource group. More...
 
bool isResourceGroupInitialised (const String &name) const
 Checks the status of a resource group. More...
 
bool isResourceGroupLoaded (const String &name) const
 Checks the status of a resource group. More...
 
void linkWorldGeometryToResourceGroup (const String &group, const String &worldGeometry, SceneManager *sceneManager)
 Associates some world geometry with a resource group, causing it to be loaded / unloaded with the resource group. More...
 
FileInfoListPtr listResourceFileInfo (const String &groupName, bool dirs=false) const
 List all files in a resource group with accompanying information. More...
 
StringVectorPtr listResourceLocations (const String &groupName) const
 List all resource locations in a resource group. More...
 
StringVectorPtr listResourceNames (const String &groupName, bool dirs=false) const
 List all file or directory names in a resource group. More...
 
void loadResourceGroup (const String &name, bool loadMainResources=true, bool loadWorldGeom=true)
 Loads a resource group. More...
 
DataStreamPtr openResource (const String &resourceName, const String &groupName=DEFAULT_RESOURCE_GROUP_NAME, Resource *resourceBeingLoaded=NULL) const
 Open a single resource by name and return a DataStream pointing at the source of the data. More...
 
DataStreamPtr openResource (const String &resourceName, const String &groupName, bool searchGroupsIfNotFound, Resource *resourceBeingLoaded=0) const
 
DataStreamListPtr openResources (const String &pattern, const String &groupName=DEFAULT_RESOURCE_GROUP_NAME) const
 Open all resources matching a given pattern (which can contain the character '*' as a wildcard), and return a collection of DataStream objects on them. More...
 
void prepareResourceGroup (const String &name, bool prepareMainResources=true, bool prepareWorldGeom=true)
 Prepares a resource group. More...
 
void removeResourceGroupListener (ResourceGroupListener *l)
 Removes a ResourceGroupListener. More...
 
void removeResourceLocation (const String &name, const String &resGroup=DEFAULT_RESOURCE_GROUP_NAME)
 Removes a resource location from the search path. More...
 
bool resourceExists (const String &group, const String &filename) const
 Find out if the named file exists in a group. More...
 
bool resourceExistsInAnyGroup (const String &filename) const
 Find out if the named file exists in any group. More...
 
bool resourceGroupExists (const String &name) const
 
bool resourceLocationExists (const String &name, const String &resGroup=DEFAULT_RESOURCE_GROUP_NAME) const
 Verify if a resource location exists for the given group. More...
 
time_t resourceModifiedTime (const String &group, const String &filename) const
 Retrieve the modification time of a given file. More...
 
void setLoadingListener (ResourceLoadingListener *listener)
 Sets a new loading listener. More...
 
void setWorldResourceGroupName (const String &groupName)
 Sets the resource group that 'world' resources will use. More...
 
void shutdownAll (void)
 Shutdown all ResourceManagers, performed as part of clean-up. More...
 
void undeclareResource (const String &name, const String &groupName)
 Undeclare a resource. More...
 
void unlinkWorldGeometryFromResourceGroup (const String &group)
 Clear any link to world geometry from a resource group. More...
 
void unloadResourceGroup (const String &name, bool reloadableOnly=true)
 Unloads a resource group. More...
 
void unloadUnreferencedResourcesInGroup (const String &name, bool reloadableOnly=true)
 Unload all resources which are not referenced by any other object. More...
 

Static Public Member Functions

static ResourceGroupManagergetSingleton (void)
 Get the singleton instance. More...
 
static ResourceGroupManagergetSingletonPtr (void)
 Get the singleton instance. More...
 

Public Attributes

 OGRE_AUTO_MUTEX
 

Static Public Attributes

static const String AUTODETECT_RESOURCE_GROUP_NAME
 Special resource group name which causes resource group to be automatically determined based on searching for the resource in all groups. More...
 
static const String DEFAULT_RESOURCE_GROUP_NAME
 Default resource group name. More...
 
static const String INTERNAL_RESOURCE_GROUP_NAME
 Internal resource group name (should be used by OGRE internal only) More...
 
static const long RESOURCE_SYSTEM_NUM_REFERENCE_COUNTS
 The number of reference counts held per resource by the resource system. More...
 

Detailed Description

This singleton class manages the list of resource groups, and notifying the various resource managers of their obligations to load / unload resources in a group.

It also provides facilities to monitor resource loading per group (to do progress bars etc), provided the resources that are required are pre-registered.

Defining new resource groups, and declaring the resources you intend to use in advance is optional, however it is a very useful feature. In addition, if a ResourceManager supports the definition of resources through scripts, then this is the class which drives the locating of the scripts and telling the ResourceManager to parse them.
There are several states that a resource can be in (the concept, not the object instance in this case):
  1. Undefined. Nobody knows about this resource yet. It might be in the filesystem, but Ogre is oblivious to it at the moment - there is no Resource instance. This might be because it's never been declared (either in a script, or using ResourceGroupManager::declareResource), or it may have previously been a valid Resource instance but has been removed, either individually through ResourceManager::remove or as a group through ResourceGroupManager::clearResourceGroup.
  2. Declared. Ogre has some forewarning of this resource, either through calling ResourceGroupManager::declareResource, or by declaring the resource in a script file which is on one of the resource locations which has been defined for a group. There is still no instance of Resource, but Ogre will know to create this resource when ResourceGroupManager::initialiseResourceGroup is called (which is automatic if you declare the resource group before Root::initialise).
  3. Unloaded. There is now a Resource instance for this resource, although it is not loaded. This means that code which looks for this named resource will find it, but the Resource is not using a lot of memory because it is in an unloaded state. A Resource can get into this state by having just been created by ResourceGroupManager::initialiseResourceGroup (either from a script, or from a call to declareResource), by being created directly from code (ResourceManager::create), or it may have previously been loaded and has been unloaded, either individually through Resource::unload, or as a group through ResourceGroupManager::unloadResourceGroup.
  4. LoadedThe Resource instance is fully loaded. This may have happened implicitly because something used it, or it may have been loaded as part of a group.
See also
ResourceGroupManager::declareResource
ResourceGroupManager::initialiseResourceGroup
ResourceGroupManager::loadResourceGroup
ResourceGroupManager::unloadResourceGroup
ResourceGroupManager::clearResourceGroup

Member Typedef Documentation

List of resource declarations.

List of possible file locations.

Constructor & Destructor Documentation

Ogre::ResourceGroupManager::ResourceGroupManager ( )
virtual Ogre::ResourceGroupManager::~ResourceGroupManager ( )
virtual

Member Function Documentation

void Ogre::ResourceGroupManager::createResourceGroup ( const String name,
bool  inGlobalPool = !OGRE_RESOURCEMANAGER_STRICT 
)

Create a resource group.

Remarks
A resource group allows you to define a set of resources that can be loaded / unloaded as a unit. For example, it might be all the resources used for the level of a game. There is always one predefined resource group called ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, which is typically used to hold all resources which do not need to be unloaded until shutdown. There is another predefined resource group called ResourceGroupManager::INTERNAL_RESOURCE_GROUP_NAME too, which should be used by OGRE internal only, the resources created in this group aren't supposed to modify, unload or remove by user. You can create additional ones so that you can control the life of your resources in whichever way you wish. There is one other predefined value, ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME; using this causes the group name to be derived at load time by searching for the resource in the resource locations of each group in turn.
Once you have defined a resource group, resources which will be loaded as part of it are defined in one of 3 ways:
  1. Manually through declareResource(); this is useful for scripted declarations since it is entirely generalised, and does not create Resource instances right away
  2. Through the use of scripts; some ResourceManager subtypes have script formats (e.g. .material, .overlay) which can be used to declare resources
  3. By calling ResourceManager::create to create a resource manually. This resource will go on the list for it's group and will be loaded and unloaded with that group
You must remember to call initialiseResourceGroup if you intend to use the first 2 types.
Parameters
nameThe name to give the resource group.
inGlobalPoolif true the resource will be loaded even a different group was requested in the load method as a parameter.
void Ogre::ResourceGroupManager::initialiseResourceGroup ( const String name)

Initialises a resource group.

Remarks
After creating a resource group, adding some resource locations, and perhaps pre-declaring some resources using declareResource(), but before you need to use the resources in the group, you should call this method to initialise the group. By calling this, you are triggering the following processes:
  1. Scripts for all resource types which support scripting are parsed from the resource locations, and resources within them are created (but not loaded yet).
  2. Creates all the resources which have just pre-declared using declareResource (again, these are not loaded yet)
So what this essentially does is create a bunch of unloaded Resource entries in the respective ResourceManagers based on scripts, and resources you've pre-declared. That means that code looking for these resources will find them, but they won't be taking up much memory yet, until they are either used, or they are loaded in bulk using loadResourceGroup. Loading the resource group in bulk is entirely optional, but has the advantage of coming with progress reporting as resources are loaded.
Failure to call this method means that loadResourceGroup will do nothing, and any resources you define in scripts will not be found. Similarly, once you have called this method you won't be able to pick up any new scripts or pre-declared resources, unless you call clearResourceGroup, set up declared resources, and call this method again.
Note
When you call Root::initialise, all resource groups that have already been created are automatically initialised too. Therefore you do not need to call this method for groups you define and set up before you call Root::initialise. However, since one of the most useful features of resource groups is to set them up after the main system initialisation has occurred (e.g. a group per game level), you must remember to call this method for the groups you create after this.
Parameters
nameThe name of the resource group to initialise
void Ogre::ResourceGroupManager::initialiseAllResourceGroups ( void  )

Initialise all resource groups which are yet to be initialised.

See also
ResourceGroupManager::intialiseResourceGroup
void Ogre::ResourceGroupManager::prepareResourceGroup ( const String name,
bool  prepareMainResources = true,
bool  prepareWorldGeom = true 
)

Prepares a resource group.

Remarks
Prepares any created resources which are part of the named group. Note that resources must have already been created by calling ResourceManager::create, or declared using declareResource() or in a script (such as .material and .overlay). The latter requires that initialiseResourceGroup has been called.

When this method is called, this class will callback any ResourceGroupListeners which have been registered to update them on progress.

Parameters
nameThe name of the resource group to prepare.
prepareMainResourcesIf true, prepares normal resources associated with the group (you might want to set this to false if you wanted to just prepare world geometry in bulk)
prepareWorldGeomIf true, prepares any linked world geometry
See also
ResourceGroupManager::linkWorldGeometryToResourceGroup
void Ogre::ResourceGroupManager::loadResourceGroup ( const String name,
bool  loadMainResources = true,
bool  loadWorldGeom = true 
)

Loads a resource group.

Remarks
Loads any created resources which are part of the named group. Note that resources must have already been created by calling ResourceManager::create, or declared using declareResource() or in a script (such as .material and .overlay). The latter requires that initialiseResourceGroup has been called.

When this method is called, this class will callback any ResourceGroupListeners which have been registered to update them on progress.

Parameters
nameThe name of the resource group to load.
loadMainResourcesIf true, loads normal resources associated with the group (you might want to set this to false if you wanted to just load world geometry in bulk)
loadWorldGeomIf true, loads any linked world geometry
See also
ResourceGroupManager::linkWorldGeometryToResourceGroup
void Ogre::ResourceGroupManager::unloadResourceGroup ( const String name,
bool  reloadableOnly = true 
)

Unloads a resource group.

Remarks
This method unloads all the resources that have been declared as being part of the named resource group. Note that these resources will still exist in their respective ResourceManager classes, but will be in an unloaded state. If you want to remove them entirely, you should use clearResourceGroup or destroyResourceGroup.
Parameters
nameThe name to of the resource group to unload.
reloadableOnlyIf set to true, only unload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't load them later. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.
See also
Resource::isReloadable for resource is reloadable.
void Ogre::ResourceGroupManager::unloadUnreferencedResourcesInGroup ( const String name,
bool  reloadableOnly = true 
)

Unload all resources which are not referenced by any other object.

Remarks
This method behaves like unloadResourceGroup, except that it only unloads resources in the group which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory).
Parameters
nameThe name of the group to check for unreferenced resources
reloadableOnlyIf true (the default), only unloads resources which can be subsequently automatically reloaded
void Ogre::ResourceGroupManager::clearResourceGroup ( const String name)

Clears a resource group.

Remarks
This method unloads all resources in the group, but in addition it removes all those resources from their ResourceManagers, and then clears all the members from the list. That means after calling this method, there are no resources declared as part of the named group any more. Resource locations still persist though.
Parameters
nameThe name to of the resource group to clear.
void Ogre::ResourceGroupManager::destroyResourceGroup ( const String name)

Destroys a resource group, clearing it first, destroying the resources which are part of it, and then removing it from the list of resource groups.

Parameters
nameThe name of the resource group to destroy.
bool Ogre::ResourceGroupManager::isResourceGroupInitialised ( const String name) const

Checks the status of a resource group.

Remarks
Looks at the state of a resource group. If initialiseResourceGroup has been called for the resource group return true, otherwise return false.
Parameters
nameThe name to of the resource group to access.
bool Ogre::ResourceGroupManager::isResourceGroupLoaded ( const String name) const

Checks the status of a resource group.

Remarks
Looks at the state of a resource group. If loadResourceGroup has been called for the resource group return true, otherwise return false.
Parameters
nameThe name to of the resource group to access.
bool Ogre::ResourceGroupManager::resourceGroupExists ( const String name) const
void Ogre::ResourceGroupManager::addResourceLocation ( const String name,
const String locType,
const String resGroup = DEFAULT_RESOURCE_GROUP_NAME,
bool  recursive = false,
bool  readOnly = true 
)

Method to add a resource location to for a given resource group.

Remarks
Resource locations are places which are searched to load resource files. When you choose to load a file, or to search for valid files to load, the resource locations are used.
Parameters
nameThe name of the resource location; probably a directory, zip file, URL etc.
locTypeThe codename for the resource type, which must correspond to the Archive factory which is providing the implementation.
resGroupThe name of the resource group for which this location is to apply. ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME is the default group which always exists, and can be used for resources which are unlikely to be unloaded until application shutdown. Otherwise it must be the name of a group; if it has not already been created with createResourceGroup then it is created automatically.
recursiveWhether subdirectories will be searched for files when using a pattern match (such as *.material), and whether subdirectories will be indexed. This can slow down initial loading of the archive and searches. When opening a resource you still need to use the fully qualified name, this allows duplicate names in alternate paths.
void Ogre::ResourceGroupManager::removeResourceLocation ( const String name,
const String resGroup = DEFAULT_RESOURCE_GROUP_NAME 
)

Removes a resource location from the search path.

bool Ogre::ResourceGroupManager::resourceLocationExists ( const String name,
const String resGroup = DEFAULT_RESOURCE_GROUP_NAME 
) const

Verify if a resource location exists for the given group.

void Ogre::ResourceGroupManager::declareResource ( const String name,
const String resourceType,
const String groupName = DEFAULT_RESOURCE_GROUP_NAME,
const NameValuePairList loadParameters = NameValuePairList() 
)

Declares a resource to be a part of a resource group, allowing you to load and unload it as part of the group.

Remarks
By declaring resources before you attempt to use them, you can more easily control the loading and unloading of those resources by their group. Declaring them also allows them to be enumerated, which means events can be raised to indicate the loading progress (
See also
ResourceGroupListener). Note that another way of declaring resources is to use a script specific to the resource type, if available (e.g. .material).
Declared resources are not created as Resource instances (and thus are not available through their ResourceManager) until initialiseResourceGroup is called, at which point all declared resources will become created (but unloaded) Resource instances, along with any resources declared in scripts in resource locations associated with the group.
Parameters
nameThe resource name.
resourceTypeThe type of the resource. Ogre comes preconfigured with a number of resource types: .. but more can be added by plugin ResourceManager classes.
groupNameThe name of the group to which it will belong.
loadParametersA list of name / value pairs which supply custom parameters to the resource which will be required before it can be loaded. These are specific to the resource type.
void Ogre::ResourceGroupManager::declareResource ( const String name,
const String resourceType,
const String groupName,
ManualResourceLoader loader,
const NameValuePairList loadParameters = NameValuePairList() 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
loaderPointer to a ManualResourceLoader implementation which will be called when the Resource wishes to load. If supplied, the resource is manually loaded, otherwise it'll loading from file automatic.
Note
We don't support declare manually loaded resource without loader here, since it's meaningless.
void Ogre::ResourceGroupManager::undeclareResource ( const String name,
const String groupName 
)

Undeclare a resource.

Remarks
Note that this will not cause it to be unloaded if it is already loaded, nor will it destroy a resource which has already been created if initialiseResourceGroup has been called already. Only unloadResourceGroup / clearResourceGroup / destroyResourceGroup will do that.
Parameters
nameThe name of the resource.
groupNameThe name of the group this resource was declared in.
DataStreamPtr Ogre::ResourceGroupManager::openResource ( const String resourceName,
const String groupName = DEFAULT_RESOURCE_GROUP_NAME,
Resource resourceBeingLoaded = NULL 
) const
inline

Open a single resource by name and return a DataStream pointing at the source of the data.

Parameters
resourceNameThe name of the resource to locate. Even if resource locations are added recursively, you must provide a fully qualified name to this method. You can find out the matching fully qualified names by using the find() method if you need to.
groupNameThe name of the resource group; this determines which locations are searched.
searchGroupsIfNotFoundIf true, if the resource is not found in the group specified, other groups will be searched. If you're loading a real Resource using this option, you must also provide the resourceBeingLoaded parameter to enable the group membership to be changed
resourceBeingLoadedOptional pointer to the resource being loaded, which you should supply if you want
Returns
Shared pointer to data stream containing the data, will be destroyed automatically when no longer referenced
DataStreamPtr Ogre::ResourceGroupManager::openResource ( const String resourceName,
const String groupName,
bool  searchGroupsIfNotFound,
Resource resourceBeingLoaded = 0 
) const
inline
Deprecated:
use AUTODETECT_RESOURCE_GROUP_NAME instead of searchGroupsIfNotFound

References Ogre::BLANKSTRING.

DataStreamListPtr Ogre::ResourceGroupManager::openResources ( const String pattern,
const String groupName = DEFAULT_RESOURCE_GROUP_NAME 
) const

Open all resources matching a given pattern (which can contain the character '*' as a wildcard), and return a collection of DataStream objects on them.

Parameters
patternThe pattern to look for. If resource locations have been added recursively, subdirectories will be searched too so this does not need to be fully qualified.
groupNameThe resource group; this determines which locations are searched.
Returns
Shared pointer to a data stream list , will be destroyed automatically when no longer referenced
StringVectorPtr Ogre::ResourceGroupManager::listResourceNames ( const String groupName,
bool  dirs = false 
) const

List all file or directory names in a resource group.

Note
This method only returns filenames, you can also retrieve other information using listFileInfo.
Parameters
groupNameThe name of the group
dirsIf true, directory names will be returned instead of file names
Returns
A list of filenames matching the criteria, all are fully qualified
FileInfoListPtr Ogre::ResourceGroupManager::listResourceFileInfo ( const String groupName,
bool  dirs = false 
) const

List all files in a resource group with accompanying information.

Parameters
groupNameThe name of the group
dirsIf true, directory names will be returned instead of file names
Returns
A list of structures detailing quite a lot of information about all the files in the archive.
StringVectorPtr Ogre::ResourceGroupManager::findResourceNames ( const String groupName,
const String pattern,
bool  dirs = false 
) const

Find all file or directory names matching a given pattern in a resource group.

Note
This method only returns filenames, you can also retrieve other information using findFileInfo.
Parameters
groupNameThe name of the group
patternThe pattern to search for; wildcards (*) are allowed
dirsSet to true if you want the directories to be listed instead of files
Returns
A list of filenames matching the criteria, all are fully qualified
bool Ogre::ResourceGroupManager::resourceExists ( const String group,
const String filename 
) const

Find out if the named file exists in a group.

Parameters
groupThe name of the resource group
filenameFully qualified name of the file to test for
bool Ogre::ResourceGroupManager::resourceExistsInAnyGroup ( const String filename) const

Find out if the named file exists in any group.

Parameters
filenameFully qualified name of the file to test for
const String& Ogre::ResourceGroupManager::findGroupContainingResource ( const String filename) const

Find the group in which a resource exists.

Parameters
filenameFully qualified name of the file the resource should be found as
Returns
Name of the resource group the resource was found in. An exception is thrown if the group could not be determined.
FileInfoListPtr Ogre::ResourceGroupManager::findResourceFileInfo ( const String group,
const String pattern,
bool  dirs = false 
) const

Find all files or directories matching a given pattern in a group and get some detailed information about them.

Parameters
groupThe name of the resource group
patternThe pattern to search for; wildcards (*) are allowed
dirsSet to true if you want the directories to be listed instead of files
Returns
A list of file information structures for all files matching the criteria.
time_t Ogre::ResourceGroupManager::resourceModifiedTime ( const String group,
const String filename 
) const

Retrieve the modification time of a given file.

StringVectorPtr Ogre::ResourceGroupManager::listResourceLocations ( const String groupName) const

List all resource locations in a resource group.

Parameters
groupNameThe name of the group
Returns
A list of resource locations matching the criteria
StringVectorPtr Ogre::ResourceGroupManager::findResourceLocation ( const String groupName,
const String pattern 
) const

Find all resource location names matching a given pattern in a resource group.

Parameters
groupNameThe name of the group
patternThe pattern to search for; wildcards (*) are allowed
Returns
A list of resource locations matching the criteria
DataStreamPtr Ogre::ResourceGroupManager::createResource ( const String filename,
const String groupName = DEFAULT_RESOURCE_GROUP_NAME,
bool  overwrite = false,
const String locationPattern = BLANKSTRING 
)

Create a new resource file in a given group.

Remarks
This method creates a new file in a resource group and passes you back a writeable stream.
Parameters
filenameThe name of the file to create
groupNameThe name of the group in which to create the file
overwriteIf true, an existing file will be overwritten, if false an error will occur if the file already exists
locationPatternIf the resource group contains multiple locations, then usually the file will be created in the first writable location. If you want to be more specific, you can include a location pattern here and only locations which match that pattern (as determined by StringUtil::match) will be considered candidates for creation.
void Ogre::ResourceGroupManager::deleteResource ( const String filename,
const String groupName = DEFAULT_RESOURCE_GROUP_NAME,
const String locationPattern = BLANKSTRING 
)

Delete a single resource file.

Parameters
filenameThe name of the file to delete.
groupNameThe name of the group in which to search
locationPatternIf the resource group contains multiple locations, then usually first matching file found in any location will be deleted. If you want to be more specific, you can include a location pattern here and only locations which match that pattern (as determined by StringUtil::match) will be considered candidates for deletion.
void Ogre::ResourceGroupManager::deleteMatchingResources ( const String filePattern,
const String groupName = DEFAULT_RESOURCE_GROUP_NAME,
const String locationPattern = BLANKSTRING 
)

Delete all matching resource files.

Parameters
filePatternThe pattern (see StringUtil::match) of the files to delete.
groupNameThe name of the group in which to search
locationPatternIf the resource group contains multiple locations, then usually all matching files in any location will be deleted. If you want to be more specific, you can include a location pattern here and only locations which match that pattern (as determined by StringUtil::match) will be considered candidates for deletion.
void Ogre::ResourceGroupManager::addResourceGroupListener ( ResourceGroupListener l)

Adds a ResourceGroupListener which will be called back during resource loading events.

void Ogre::ResourceGroupManager::removeResourceGroupListener ( ResourceGroupListener l)
void Ogre::ResourceGroupManager::setWorldResourceGroupName ( const String groupName)
inline

Sets the resource group that 'world' resources will use.

Remarks
This is the group which should be used by SceneManagers implementing world geometry when looking for their resources. Defaults to the DEFAULT_RESOURCE_GROUP_NAME but this can be altered.
const String& Ogre::ResourceGroupManager::getWorldResourceGroupName ( void  ) const
inline

Gets the resource group that 'world' resources will use.

void Ogre::ResourceGroupManager::linkWorldGeometryToResourceGroup ( const String group,
const String worldGeometry,
SceneManager sceneManager 
)

Associates some world geometry with a resource group, causing it to be loaded / unloaded with the resource group.

Remarks
You would use this method to essentially defer a call to SceneManager::setWorldGeometry to the time when the resource group is loaded. The advantage of this is that compatible scene managers will include the estimate of the number of loading stages for that world geometry when the resource group begins loading, allowing you to include that in a loading progress report.
Parameters
groupThe name of the resource group
worldGeometryThe parameter which should be passed to setWorldGeometry
sceneManagerThe SceneManager which should be called
void Ogre::ResourceGroupManager::unlinkWorldGeometryFromResourceGroup ( const String group)

Clear any link to world geometry from a resource group.

Remarks
Basically undoes a previous call to linkWorldGeometryToResourceGroup.
bool Ogre::ResourceGroupManager::isResourceGroupInGlobalPool ( const String name) const

Checks the status of a resource group.

Remarks
Looks at the state of a resource group. If loadResourceGroup has been called for the resource group return true, otherwise return false.
Parameters
nameThe name to of the resource group to access.
void Ogre::ResourceGroupManager::shutdownAll ( void  )

Shutdown all ResourceManagers, performed as part of clean-up.

void Ogre::ResourceGroupManager::_registerResourceManager ( const String resourceType,
ResourceManager rm 
)

Internal method for registering a ResourceManager (which should be a singleton).

Creators of plugins can register new ResourceManagers this way if they wish.

Remarks
ResourceManagers that wish to parse scripts must also call _registerScriptLoader.
Parameters
resourceTypeString identifying the resource type, must be unique.
rmPointer to the ResourceManager instance.
void Ogre::ResourceGroupManager::_unregisterResourceManager ( const String resourceType)

Internal method for unregistering a ResourceManager.

Remarks
ResourceManagers that wish to parse scripts must also call _unregisterScriptLoader.
Parameters
resourceTypeString identifying the resource type.
ResourceManagerIterator Ogre::ResourceGroupManager::getResourceManagerIterator ( )
inline

Get an iterator over the registered resource managers.

void Ogre::ResourceGroupManager::_registerScriptLoader ( ScriptLoader su)

Internal method for registering a ScriptLoader.

Remarks
ScriptLoaders parse scripts when resource groups are initialised.
Parameters
suPointer to the ScriptLoader instance.
void Ogre::ResourceGroupManager::_unregisterScriptLoader ( ScriptLoader su)

Internal method for unregistering a ScriptLoader.

Parameters
suPointer to the ScriptLoader instance.
ScriptLoader* Ogre::ResourceGroupManager::_findScriptLoader ( const String pattern) const

Method used to directly query for registered script loaders.

Parameters
patternThe specific script pattern (e.g. *.material) the script loader handles
ResourceManager* Ogre::ResourceGroupManager::_getResourceManager ( const String resourceType) const

Internal method for getting a registered ResourceManager.

Parameters
resourceTypeString identifying the resource type.
void Ogre::ResourceGroupManager::_notifyResourceCreated ( ResourcePtr res) const

Internal method called by ResourceManager when a resource is created.

Parameters
resWeak reference to resource
void Ogre::ResourceGroupManager::_notifyResourceRemoved ( const ResourcePtr res) const

Internal method called by ResourceManager when a resource is removed.

Parameters
resWeak reference to resource
void Ogre::ResourceGroupManager::_notifyResourceGroupChanged ( const String oldGroup,
Resource res 
) const

Internal method to notify the group manager that a resource has changed group (only applicable for autodetect group)

void Ogre::ResourceGroupManager::_notifyAllResourcesRemoved ( ResourceManager manager) const

Internal method called by ResourceManager when all resources for that manager are removed.

Parameters
managerPointer to the manager for which all resources are being removed
void Ogre::ResourceGroupManager::_notifyWorldGeometryStageStarted ( const String description) const

Notify this manager that one stage of world geometry loading has been started.

Remarks
Custom SceneManagers which load custom world geometry should call this method the number of times equal to the value they return from SceneManager::estimateWorldGeometry while loading their geometry.
void Ogre::ResourceGroupManager::_notifyWorldGeometryStageEnded ( void  ) const

Notify this manager that one stage of world geometry loading has been completed.

Remarks
Custom SceneManagers which load custom world geometry should call this method the number of times equal to the value they return from SceneManager::estimateWorldGeometry while loading their geometry.
StringVector Ogre::ResourceGroupManager::getResourceGroups ( void  ) const

Get a list of the currently defined resource groups.

Note
This method intentionally returns a copy rather than a reference in order to avoid any contention issues in multithreaded applications.
Returns
A copy of list of currently defined groups.
ResourceDeclarationList Ogre::ResourceGroupManager::getResourceDeclarationList ( const String groupName) const

Get the list of resource declarations for the specified group name.

Note
This method intentionally returns a copy rather than a reference in order to avoid any contention issues in multithreaded applications.
Parameters
groupNameThe name of the group
Returns
A copy of list of currently defined resources.
const LocationList& Ogre::ResourceGroupManager::getResourceLocationList ( const String groupName) const

Get the list of resource locations for the specified group name.

Parameters
groupNameThe name of the group
Returns
The list of resource locations associated with the given group.
void Ogre::ResourceGroupManager::setLoadingListener ( ResourceLoadingListener listener)

Sets a new loading listener.

ResourceLoadingListener* Ogre::ResourceGroupManager::getLoadingListener ( ) const

Returns the current loading listener.

static ResourceGroupManager& Ogre::ResourceGroupManager::getSingleton ( void  )
static

Get the singleton instance.

static ResourceGroupManager* Ogre::ResourceGroupManager::getSingletonPtr ( void  )
static

Get the singleton instance.

Member Data Documentation

Ogre::ResourceGroupManager::OGRE_AUTO_MUTEX
const String Ogre::ResourceGroupManager::INTERNAL_RESOURCE_GROUP_NAME
static

Internal resource group name (should be used by OGRE internal only)

const long Ogre::ResourceGroupManager::RESOURCE_SYSTEM_NUM_REFERENCE_COUNTS
static

The number of reference counts held per resource by the resource system.


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