This class manages the available ArchiveFactory plugins. More...

#include <OgreArchiveManager.h>

Inheritance diagram for Ogre::ArchiveManager:

Public Types
typedef MapIterator< ArchiveMap >	ArchiveMapIterator

Public Member Functions
	ArchiveManager ()
	Default constructor - should never get called by a client app. More...

virtual	~ArchiveManager ()
	Default destructor. More...

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

ArchiveMapIterator	getArchiveIterator ()
	Get an iterator over the Archives in this Manager. More...

Archive *	load (const String &filename, const String &archiveType, bool readOnly)
	Opens an archive for file reading. More...

void	unload (Archive *arch)
	Unloads an archive. More...

void	unload (const String &filename)
	Unloads an archive by name. More...

Public Member Functions inherited from Ogre::Singleton< ArchiveManager >
	Singleton ()

	~Singleton ()

Static Public Member Functions
static ArchiveManager &	getSingleton ()
	Override standard Singleton retrieval. More...

static ArchiveManager *	getSingletonPtr ()
	Override standard Singleton retrieval. More...

Static Public Member Functions inherited from Ogre::Singleton< ArchiveManager >
static ArchiveManager &	getSingleton ()

static ArchiveManager *	getSingletonPtr ()

Detailed Description

This class manages the available ArchiveFactory plugins.

Member Typedef Documentation

◆ ArchiveMapIterator

typedef MapIterator<ArchiveMap> Ogre::ArchiveManager::ArchiveMapIterator

Constructor & Destructor Documentation

◆ ArchiveManager()

Ogre::ArchiveManager::ArchiveManager ( )

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

◆ ~ArchiveManager()

virtual Ogre::ArchiveManager::~ArchiveManager ( )

virtual

Default destructor.

Member Function Documentation

◆ addArchiveFactory()

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 Archive subclasses for their archive type.

◆ getArchiveIterator()

ArchiveMapIterator Ogre::ArchiveManager::getArchiveIterator ( )

Get an iterator over the Archives in this Manager.

◆ getSingleton()

static ArchiveManager& Ogre::ArchiveManager::getSingleton ( )

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.

◆ getSingletonPtr()

static ArchiveManager* Ogre::ArchiveManager::getSingletonPtr ( )

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.

◆ load()

Archive* Ogre::ArchiveManager::load	(	const String &	filename,
		const String &	archiveType,
		bool	readOnly
	)

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
archiveType	The type of archive that this is. For example: "Zip".

Returns: If the function succeeds, a valid pointer to an Archive object is returned.

: If the function fails, an exception is thrown.

◆ unload() [1/2]

void Ogre::ArchiveManager::unload ( Archive * arch )

Unloads an archive.

Remarks: You must ensure that this archive is not being used before removing it.

◆ unload() [2/2]

void Ogre::ArchiveManager::unload ( const String & filename )

Unloads an archive by name.

Remarks: You must ensure that this archive is not being used before removing it.

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

OgreArchiveManager.h

Public Types

Public Member Functions

Static Public Member Functions