Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::ArchiveManager Class Reference

ResourceManager specialization to handle Archive plug-ins. More...

#include <OgreArchiveManager.h>

Inheritance diagram for Ogre::ArchiveManager:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::map< ResourceHandle,
Resource * > 
ResourceHandleMap
typedef MapIterator< ResourceHandleMapResourceMapIterator

Public Methods

 ArchiveManager ()
 Default constructor - should never get called by a client app.

virtual ~ArchiveManager ()
 Default destructor.

ArchiveExload (const String &filename, const String &archiveType, int priority=1)
 Opens an archive for file reading.

Resourcecreate (const String &name)
 Overloaded from ResourceManager.

void addArchiveFactory (ArchiveFactory *factory)
 Adds a new ArchiveFactory to the list of available factories.

virtual void setMemoryBudget (size_t bytes)
 Set a limit on the amount of memory this resource handler may use.

virtual void load (Resource *res, int priority)
 Load a resource.

virtual void add (Resource *res)
 Add a resource to this manager; normally only done by subclasses.

virtual void unload (Resource *res)
 Unloads a Resource from the managed resources list, calling it's unload() method.

virtual void unloadAndDestroyAll (void)
 Unloads all Resources from memory.

virtual ResourcegetByName (const String &name)
 Retrieves a pointer to a resource by name, or null if the resource does not exist.

virtual ResourcegetByHandle (ResourceHandle handle)
 Retrieves a pointer to a resource by handle, or null if the resource does not exist.

void addSearchPath (const String &path)
 Adds a relative path to search for resources of this type.

void addArchiveEx (const String &strName, const String &strDriverName)
 Adds an archive to the search path for this type of resource.

bool _findResourceData (const String &filename, DataChunk &refChunk)
 Internal method, used for locating resource data in the file system / archives.

std::set< String_getAllNamesLike (const String &startPath, const String &extension)
 Returns a collection of files with the given extension in all resource paths, common and specific to this resource type.

ResourceMapIterator getResourceIterator (void)
 Returns an iterator over all resources in this manager.


Static Public Methods

ArchiveManager & getSingleton (void)
 Override standard Singleton retrieval.

ArchiveManager * getSingletonPtr (void)
 Override standard Singleton retrieval.

void addCommonSearchPath (const String &path)
 Adds a relative search path for resources of ALL types.

void addCommonArchiveEx (const String &strName, const String &strDriverName)
 Adds an archive to the search path for all resources.

std::set< String_getAllCommonNamesLike (const String &startPath, const String &extension)
 Returns a collection of files with the given extension in the common resource paths.

bool _findCommonResourceData (const String &filename, DataChunk &refChunk)
 Internal method, used for locating common resource data in the file system / archives.

void cleanupCommonArchive ()
 Cleans up the statics 'mCommonVFS' and 'mCommonArchiveFiles'.


Protected Types

typedef std::map< String,
ArchiveFactory * > 
ArchiveFactoryMap
typedef HashMap< String, ArchiveEx * > FileMap
typedef HashMap< String, Resource * > ResourceMap

Protected Methods

ResourceHandle getNextHandle (void)
 Allocates the next handle.

void checkUsage (void)
 Checks memory usage and pages out if required.


Protected Attributes

ArchiveFactoryMap mArchFactories
 Factories available to create archives, indexed by archive type (String identifier e.g. 'Zip').

FileMap mArchiveFiles
ResourceHandleMap mResourcesByHandle
ResourceMap mResources
ResourceHandle mNextHandle
size_t mMemoryBudget
size_t mMemoryUsage
std::vector< ArchiveEx * > mVFS
 Collection of searchable ArchiveEx classes (virtual file system) for this resource type.


Static Protected Attributes

FileMap mCommonArchiveFiles
std::vector< ArchiveEx * > mCommonVFS
 Collection of searchable ArchiveEx classes (virtual file system) for all resource types.

ArchiveManager * ms_Singleton = 0

Detailed Description

ResourceManager specialization to handle Archive plug-ins.

See also:
ResourceManager

Definition at line 39 of file OgreArchiveManager.h.


Member Typedef Documentation

typedef std::map<String, ArchiveFactory*> Ogre::ArchiveManager::ArchiveFactoryMap [protected]
 

Definition at line 43 of file OgreArchiveManager.h.

typedef HashMap< String, ArchiveEx * > Ogre::ResourceManager::FileMap [protected, inherited]
 

Definition at line 200 of file OgreResourceManager.h.

typedef std::map<ResourceHandle, Resource*> Ogre::ResourceManager::ResourceHandleMap [inherited]
 

Definition at line 208 of file OgreResourceManager.h.

typedef HashMap< String, Resource* > Ogre::ResourceManager::ResourceMap [protected, inherited]
 

Definition at line 201 of file OgreResourceManager.h.

typedef MapIterator<ResourceHandleMap> Ogre::ResourceManager::ResourceMapIterator [inherited]
 

Definition at line 229 of file OgreResourceManager.h.


Constructor & Destructor Documentation

Ogre::ArchiveManager::ArchiveManager  
 

Default constructor - should never get called by a client app.

Definition at line 50 of file OgreArchiveManager.h.

Ogre::ArchiveManager::~ArchiveManager   [virtual]
 

Default destructor.

Definition at line 75 of file OgreArchiveManager.cpp.

References Ogre::ResourceManager::mResources, and Ogre::ArchiveEx::unload().


Member Function Documentation

bool Ogre::ResourceManager::_findCommonResourceData const String   filename,
DataChunk   refChunk
[static, inherited]
 

Internal method, used for locating common resource data in the file system / archives.

Remarks:
This is a static version of _findResourceData specifically designed to only search in the common resource archives, and is therefore usable from non-ResourceManager subclasses.
Parameters:
filename  File to find
refChunk  Reference to a DataChunk object to fill with the data from the file
Returns:
On success, true is returned

On failiure, false is returned

Definition at line 294 of file OgreResourceManager.cpp.

References Except, Ogre::ResourceManager::mCommonArchiveFiles, Ogre::ResourceManager::mCommonVFS, and Ogre::String.

bool Ogre::ResourceManager::_findResourceData const String   filename,
DataChunk   refChunk
[inherited]
 

Internal method, used for locating resource data in the file system / archives.

Parameters:
filename  File to find
refChunk  Reference to a DataChunk object to fill with the data from the file
Returns:
On success, true is returned

On failiure, false is returnec

Definition at line 212 of file OgreResourceManager.cpp.

References Except, Ogre::ResourceManager::mArchiveFiles, Ogre::ResourceManager::mCommonArchiveFiles, Ogre::ResourceManager::mCommonVFS, Ogre::ResourceManager::mVFS, and Ogre::String.

std::set< String > Ogre::ResourceManager::_getAllCommonNamesLike const String   startPath,
const String   extension
[static, inherited]
 

Returns a collection of files with the given extension in the common resource paths.

Remarks:
This is a convenience method to allow non-subclasses to search for files in the common paths.
Parameters:
startPath  The path, relative to each common resource start, to search in (use "./" for the root)
extension  The extension of file to search for.
Returns:
A set of String filenames (it is a set because duplicates will be ignored)

Definition at line 255 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::mCommonVFS, Ogre::String, and Ogre::StringVector.

std::set< String > Ogre::ResourceManager::_getAllNamesLike const String   startPath,
const String   extension
[inherited]
 

Returns a collection of files with the given extension in all resource paths, common and specific to this resource type.

Parameters:
startPath  The path, relative to each common resource start, to search in (use "./" for the root)
extension  The extension of file to search for.
Returns:
A set of String filenames (it is a set because duplicates will be ignored)

Definition at line 274 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::mVFS, Ogre::String, and Ogre::StringVector.

void Ogre::ResourceManager::add Resource   res [virtual, inherited]
 

Add a resource to this manager; normally only done by subclasses.

Definition at line 75 of file OgreResourceManager.cpp.

References Except, Ogre::Resource::getName(), Ogre::ResourceManager::getNextHandle(), Ogre::Resource::mHandle, Ogre::ResourceManager::mResources, and Ogre::ResourceManager::mResourcesByHandle.

Referenced by Ogre::Quake3ShaderManager::create(), Ogre::MaterialManager::create(), Ogre::MeshManager::createManual(), Ogre::HighLevelGpuProgramManager::createProgram(), and Ogre::ResourceManager::load().

void Ogre::ResourceManager::addArchiveEx const String   strName,
const String   strDriverName
[inherited]
 

Adds an archive to the search path for this type of resource.

Remarks:
Ogre can load resources from archives. This method adds the named archive to the search path for the type of resource managed by the specific resource manager. Archives are not searched for themselves so a complete path must be specified here (or relative to the current path). Archives take precedence over files in the filesystem.

Definition at line 188 of file OgreResourceManager.cpp.

References Ogre::ArchiveEx::getAllNamesLike(), Ogre::ResourceManager::mArchiveFiles, Ogre::ResourceManager::mVFS, Ogre::String, and Ogre::StringVector.

Referenced by Ogre::ResourceManager::addSearchPath().

void Ogre::ArchiveManager::addArchiveFactory ArchiveFactory   factory
 

Adds a new ArchiveFactory to the list of available factories.

Remarks:
Plugin developers who add new archive codecs need to call this after defining their ArchiveFactory subclass and ArchiveEx subclasses for their archive type.

Definition at line 87 of file OgreArchiveManager.cpp.

References Ogre::ArchiveFactory::getType(), and mArchFactories.

void Ogre::ResourceManager::addCommonArchiveEx const String   strName,
const String   strDriverName
[static, inherited]
 

Adds an archive to the search path for all resources.

Remarks:
As ResourceManager::addArchive, except this archive is used for all types of resources, not just the type managed by the resource manager in question.

Definition at line 200 of file OgreResourceManager.cpp.

References Ogre::ArchiveEx::getAllNamesLike(), Ogre::ResourceManager::mCommonArchiveFiles, Ogre::ResourceManager::mCommonVFS, Ogre::String, and Ogre::StringVector.

Referenced by Ogre::ResourceManager::addCommonSearchPath().

void Ogre::ResourceManager::addCommonSearchPath const String   path [static, inherited]
 

Adds a relative search path for resources of ALL types.

This method has the same effect as ResourceManager::addSearchPath, except that the path added applies to ALL resources, not just the one managed by the subclass in question.

Definition at line 182 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::addCommonArchiveEx(), Ogre::convertPath(), and Ogre::String.

void Ogre::ResourceManager::addSearchPath const String   path [inherited]
 

Adds a relative path to search for resources of this type.

Remarks:
This method adds the supplied path to the list of relative locations that that will be searched for a single type of resource only. Each subclass of ResourceManager will maintain it's own list of specific subpaths, which it will append to the current path as it searches for matching files.

Definition at line 176 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::addArchiveEx(), Ogre::convertPath(), and Ogre::String.

void Ogre::ResourceManager::checkUsage void    [protected, inherited]
 

Checks memory usage and pages out if required.

Definition at line 170 of file OgreResourceManager.cpp.

Referenced by Ogre::ResourceManager::setMemoryBudget().

void Ogre::ResourceManager::cleanupCommonArchive   [static, inherited]
 

Cleans up the statics 'mCommonVFS' and 'mCommonArchiveFiles'.

Required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. MaterialManager) initializes.

Definition at line 326 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::mCommonArchiveFiles, and Ogre::ResourceManager::mCommonVFS.

Resource * Ogre::ArchiveManager::create const String   name [virtual]
 

Overloaded from ResourceManager.

See also:
ResourceManager::create

Implements Ogre::ResourceManager.

Definition at line 70 of file OgreArchiveManager.cpp.

References Ogre::String.

Resource * Ogre::ResourceManager::getByHandle ResourceHandle    handle [virtual, inherited]
 

Retrieves a pointer to a resource by handle, or null if the resource does not exist.

Definition at line 151 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::mResourcesByHandle, and Ogre::ResourceHandle.

Resource * Ogre::ResourceManager::getByName const String   name [virtual, inherited]
 

Retrieves a pointer to a resource by name, or null if the resource does not exist.

Definition at line 139 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::mResources, and Ogre::String.

Referenced by Ogre::MaterialManager::create(), Ogre::FontManager::create(), Ogre::MeshManager::createBezierPatch(), Ogre::MeshManager::createManual(), Ogre::SceneManager::createSkyboxPlane(), Ogre::SceneManager::createSkydomePlane(), Ogre::TextureManager::load(), Ogre::SkeletonManager::load(), Ogre::MeshManager::load(), Ogre::DynLibManager::load(), load(), Ogre::SceneManager::setSkyBox(), and Ogre::TextureManager::unload().

ResourceHandle Ogre::ResourceManager::getNextHandle void    [protected, inherited]
 

Allocates the next handle.

Definition at line 165 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::mNextHandle, and Ogre::ResourceHandle.

Referenced by Ogre::ResourceManager::add().

ResourceMapIterator Ogre::ResourceManager::getResourceIterator void    [inherited]
 

Returns an iterator over all resources in this manager.

Definition at line 231 of file OgreResourceManager.h.

ArchiveManager & Ogre::ArchiveManager::getSingleton void    [static]
 

Override standard Singleton retrieval.

Remarks:
Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< ArchiveManager >.

Definition at line 43 of file OgreArchiveManager.cpp.

References Ogre::Singleton< ArchiveManager >::ms_Singleton.

ArchiveManager * Ogre::ArchiveManager::getSingletonPtr void    [static]
 

Override standard Singleton retrieval.

Remarks:
Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< ArchiveManager >.

Definition at line 39 of file OgreArchiveManager.cpp.

References Ogre::Singleton< ArchiveManager >::ms_Singleton.

void Ogre::ResourceManager::load Resource   res,
int    priority
[virtual, inherited]
 

Load a resource.

Resources will be subclasses.

Reimplemented in Ogre::TextureManager.

Definition at line 67 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::add(), Ogre::Resource::load(), and Ogre::Resource::touch().

Referenced by Ogre::OverlayManager::create().

ArchiveEx * Ogre::ArchiveManager::load const String   filename,
const String   archiveType,
int    priority = 1
 

Opens an archive for file reading.

Remarks:
The archives are created using class factories within extension libraries.
Parameters:
filename  The filename that will be opened
refLibrary  The library that contains the data-handling code
priority  The priority of the archive (not yet used)
Returns:
If the function succeeds, a valid pointer to an ArchiveEx object is returened.

If the function fails, an exception is thrown.

Definition at line 50 of file OgreArchiveManager.cpp.

References Except, Ogre::ResourceManager::getByName(), mArchFactories, and Ogre::String.

void Ogre::ResourceManager::setMemoryBudget size_t    bytes [virtual, inherited]
 

Set a limit on the amount of memory this resource handler may use.

Remarks:
If, when asked to load a new resource, the manager believes it will exceed this memory budget, it will temporarily unload a resource to make room for the new one. This unloading is not permanent and the Resource is not destroyed; it simply needs to be reloaded when next used.

Definition at line 97 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::checkUsage(), and Ogre::ResourceManager::mMemoryBudget.

void Ogre::ResourceManager::unload Resource   res [virtual, inherited]
 

Unloads a Resource from the managed resources list, calling it's unload() method.

Remarks:
This method removes a resource from the list maintained by this manager, and unloads it from memory. It does NOT destroy the resource itself, although the memory used by it will be largely freed up. This would allow you to reload the resource again if you wished.

Permanently destroying the resource is, as mentioned in ResourceManager::create, the library user's responsibility.

Definition at line 105 of file OgreResourceManager.cpp.

References Ogre::Resource::getHandle(), Ogre::Resource::getName(), Ogre::Resource::getSize(), Ogre::ResourceManager::mMemoryUsage, Ogre::ResourceManager::mResources, Ogre::ResourceManager::mResourcesByHandle, and Ogre::Resource::unload().

Referenced by Ogre::SceneManager::createSkyboxPlane(), and Ogre::SceneManager::createSkydomePlane().

void Ogre::ResourceManager::unloadAndDestroyAll void    [virtual, inherited]
 

Unloads all Resources from memory.

Remarks:
Note that unlike ResourceManager::unload, Resource objects are DESTROYED as well as unloaded. This is because you are unlikely to be managing the deletion of the objects individually in this case.

Reimplemented in Ogre::D3D9TextureManager, and Ogre::GLTextureManager.

Definition at line 122 of file OgreResourceManager.cpp.

References Ogre::ResourceManager::mResources, and Ogre::ResourceManager::mResourcesByHandle.

Referenced by Ogre::BspResourceManager::load(), Ogre::D3DTextureManager::~D3DTextureManager(), and Ogre::ResourceManager::~ResourceManager().


Member Data Documentation

ArchiveFactoryMap Ogre::ArchiveManager::mArchFactories [protected]
 

Factories available to create archives, indexed by archive type (String identifier e.g. 'Zip').

Definition at line 45 of file OgreArchiveManager.h.

Referenced by addArchiveFactory(), and load().

FileMap Ogre::ResourceManager::mArchiveFiles [protected, inherited]
 

Definition at line 205 of file OgreResourceManager.h.

Referenced by Ogre::ResourceManager::_findResourceData(), and Ogre::ResourceManager::addArchiveEx().

ResourceManager::FileMap Ogre::ResourceManager::mCommonArchiveFiles [static, protected, inherited]
 

Definition at line 37 of file OgreResourceManager.cpp.

Referenced by Ogre::ResourceManager::_findCommonResourceData(), Ogre::ResourceManager::_findResourceData(), Ogre::ResourceManager::addCommonArchiveEx(), and Ogre::ResourceManager::cleanupCommonArchive().

std::vector< ArchiveEx * > Ogre::ResourceManager::mCommonVFS [static, protected, inherited]
 

Collection of searchable ArchiveEx classes (virtual file system) for all resource types.

Definition at line 36 of file OgreResourceManager.cpp.

Referenced by Ogre::ResourceManager::_findCommonResourceData(), Ogre::ResourceManager::_findResourceData(), Ogre::ResourceManager::_getAllCommonNamesLike(), Ogre::ResourceManager::addCommonArchiveEx(), Ogre::ResourceManager::cleanupCommonArchive(), Ogre::OverlayManager::loadAndParseOverlayFile(), Ogre::Quake3ShaderManager::parseAllSources(), Ogre::OverlayManager::parseAllSources(), Ogre::MaterialManager::parseAllSources(), and Ogre::FontManager::parseAllSources().

size_t Ogre::ResourceManager::mMemoryBudget [protected, inherited]
 

Definition at line 215 of file OgreResourceManager.h.

Referenced by Ogre::ResourceManager::ResourceManager(), and Ogre::ResourceManager::setMemoryBudget().

size_t Ogre::ResourceManager::mMemoryUsage [protected, inherited]
 

Definition at line 216 of file OgreResourceManager.h.

Referenced by Ogre::ResourceManager::ResourceManager(), and Ogre::ResourceManager::unload().

ResourceHandle Ogre::ResourceManager::mNextHandle [protected, inherited]
 

Definition at line 213 of file OgreResourceManager.h.

Referenced by Ogre::ResourceManager::getNextHandle(), and Ogre::ResourceManager::ResourceManager().

ResourceMap Ogre::ResourceManager::mResources [protected, inherited]
 

Definition at line 211 of file OgreResourceManager.h.

Referenced by Ogre::OverlayManager::_queueOverlaysForRendering(), Ogre::ResourceManager::add(), Ogre::FontManager::create(), Ogre::MeshManager::createPrefabPlane(), Ogre::TextureManager::enable32BitTextures(), Ogre::ResourceManager::getByName(), Ogre::OverlayManager::getPositionTargetAt(), Ogre::TextureManager::loadImage(), Ogre::TextureManager::loadRawData(), Ogre::ResourceManager::unload(), Ogre::ResourceManager::unloadAndDestroyAll(), Ogre::GLTextureManager::unloadAndDestroyAll(), Ogre::D3D9TextureManager::unloadAndDestroyAll(), ~ArchiveManager(), and Ogre::DynLibManager::~DynLibManager().

ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle [protected, inherited]
 

Definition at line 210 of file OgreResourceManager.h.

Referenced by Ogre::ResourceManager::add(), Ogre::ResourceManager::getByHandle(), Ogre::ResourceManager::unload(), and Ogre::ResourceManager::unloadAndDestroyAll().

ArchiveManager * Ogre::Singleton< ArchiveManager >::ms_Singleton = 0 [static, protected, inherited]
 

Definition at line 38 of file OgreArchiveManager.cpp.

Referenced by getSingleton(), and getSingletonPtr().

std::vector<ArchiveEx*> Ogre::ResourceManager::mVFS [protected, inherited]
 

Collection of searchable ArchiveEx classes (virtual file system) for this resource type.

Definition at line 226 of file OgreResourceManager.h.

Referenced by Ogre::ResourceManager::_findResourceData(), Ogre::ResourceManager::_getAllNamesLike(), Ogre::ResourceManager::addArchiveEx(), Ogre::OverlayManager::loadAndParseOverlayFile(), Ogre::Quake3ShaderManager::parseAllSources(), Ogre::OverlayManager::parseAllSources(), Ogre::MaterialManager::parseAllSources(), and Ogre::FontManager::parseAllSources().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:50:47 2004