OgreArchiveManager.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef _ArchiveManager_H__
29 #define _ArchiveManager_H__
30 
31 #include "OgrePrerequisites.h"
32 
33 #include "OgreResourceManager.h"
34 #include "OgreSingleton.h"
35 #include "OgreHeaderPrefix.h"
36 
37 namespace Ogre {
38 
47  class _OgreExport ArchiveManager : public Singleton<ArchiveManager>, public ArchiveAlloc
48  {
49  protected:
56 
57  public:
63  virtual ~ArchiveManager();
64 
79  Archive* load( const String& filename, const String& archiveType, bool readOnly);
80 
85  void unload(Archive* arch);
90  void unload(const String& filename);
94 
134  };
138 }
139 
140 #include "OgreHeaderSuffix.h"
141 
142 #endif
#define _OgreExport
Definition: OgrePlatform.h:257
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Abstract factory class, archive codec plugins can register concrete subclasses of this.
This class manages the available ArchiveFactory plugins.
void unload(const String &filename)
Unloads an archive by name.
virtual ~ArchiveManager()
Default destructor.
map< String, ArchiveFactory * >::type ArchiveFactoryMap
map< String, Archive * >::type ArchiveMap
Currently loaded archives.
static ArchiveManager * getSingletonPtr(void)
Override standard Singleton retrieval.
ArchiveManager()
Default constructor - should never get called by a client app.
MapIterator< ArchiveMap > ArchiveMapIterator
void addArchiveFactory(ArchiveFactory *factory)
Adds a new ArchiveFactory to the list of available factories.
ArchiveMapIterator getArchiveIterator(void)
Get an iterator over the Archives in this Manager.
ArchiveFactoryMap mArchFactories
Factories available to create archives, indexed by archive type (String identifier e....
static ArchiveManager & getSingleton(void)
Override standard Singleton retrieval.
Archive * load(const String &filename, const String &archiveType, bool readOnly)
Opens an archive for file reading.
void unload(Archive *arch)
Unloads an archive.
Archive-handling class.
Definition: OgreArchive.h:89
Concrete IteratorWrapper for nonconst access to the underlying key-value container.
Template class for creating single-instance global classes.
Definition: OgreSingleton.h:65
_StringBase String

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.