This class manages the available ArchiveFactory plugins.
More...
#include <OgreArchiveManager.h>
This class manages the available ArchiveFactory plugins.
◆ ArchiveMapIterator
◆ ArchiveManager()
Ogre::ArchiveManager::ArchiveManager |
( |
| ) |
|
Default constructor - should never get called by a client app.
◆ ~ArchiveManager()
virtual Ogre::ArchiveManager::~ArchiveManager |
( |
| ) |
|
|
virtual |
◆ load()
Archive* Ogre::ArchiveManager::load |
( |
const String & |
filename, |
|
|
const String & |
archiveType, |
|
|
bool |
readOnly |
|
) |
| |
Opens an archive for file reading.
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". |
readOnly | Whether the Archive is read only |
- 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.
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.
You must ensure that this archive is not being used before removing it.
◆ getArchiveIterator()
Get an iterator over the Archives in this Manager.
◆ addArchiveFactory()
void Ogre::ArchiveManager::addArchiveFactory |
( |
ArchiveFactory * |
factory | ) |
|
Adds a new ArchiveFactory to the list of available factories.
Plugin developers who add new archive codecs need to call
this after defining their ArchiveFactory subclass and
Archive subclasses for their archive type.
◆ getSingleton()
Get the singleton instance.
◆ getSingletonPtr()
Get the singleton instance.
The documentation for this class was generated from the following file: