OGRE  1.10.12
Object-Oriented Graphics Rendering Engine
Ogre::APKZipArchiveFactory Class Reference

#include <OgreAPKZipArchive.h>

+ Inheritance diagram for Ogre::APKZipArchiveFactory:

Public Types

typedef bool(* DecryptEmbeddedZipFileFunc) (size_t pos, void *buf, size_t len)
 a function type to decrypt embedded zip file More...
 

Public Member Functions

 APKZipArchiveFactory (AAssetManager *assetMgr)
 
virtual ~APKZipArchiveFactory ()
 
ArchivecreateInstance (const String &name, bool readOnly)
 Creates a new object. More...
 
virtual ArchivecreateInstance (const String &name)
 Creates a new object. More...
 
void destroyInstance (Archive *ptr)
 Destroys an object which was created by this factory. More...
 
const StringgetType (void) const
 Returns the factory type. More...
 

Static Public Member Functions

static void addEmbbeddedFile (const String &name, const uint8 *fileData, size_t fileSize, DecryptEmbeddedZipFileFunc decryptFunc)
 Add an embedded file to the embedded file list. More...
 
static void removeEmbbeddedFile (const String &name)
 Remove an embedded file to the embedded file list. More...
 

Member Typedef Documentation

◆ DecryptEmbeddedZipFileFunc

typedef bool(* Ogre::EmbeddedZipArchiveFactory::DecryptEmbeddedZipFileFunc) (size_t pos, void *buf, size_t len)
inherited

a function type to decrypt embedded zip file

Parameters
pospos in file
bufcurrent buffer to decrypt
len- length of buffer
Returns
success

Constructor & Destructor Documentation

◆ APKZipArchiveFactory()

Ogre::APKZipArchiveFactory::APKZipArchiveFactory ( AAssetManager *  assetMgr)
inline

◆ ~APKZipArchiveFactory()

virtual Ogre::APKZipArchiveFactory::~APKZipArchiveFactory ( )
inlinevirtual

References getType().

Member Function Documentation

◆ getType()

const String& Ogre::APKZipArchiveFactory::getType ( void  ) const
virtual

Returns the factory type.

Returns
The factory type.

Implements Ogre::FactoryObj< Archive >.

Referenced by ~APKZipArchiveFactory().

◆ createInstance() [1/2]

Archive* Ogre::APKZipArchiveFactory::createInstance ( const String name,
bool  readOnly 
)
inlinevirtual

Creates a new object.

Parameters
nameName of the object to create
readOnlywhether the Archive is read only
Returns
An object created by the factory. The type of the object depends on the factory.

Implements Ogre::ArchiveFactory.

References Ogre::EmbeddedZipArchiveFactory::addEmbbeddedFile(), and OGRE_NEW.

◆ createInstance() [2/2]

virtual Archive* Ogre::ArchiveFactory::createInstance ( const String name)
inlinevirtualinherited

Creates a new object.

Parameters
nameName of the object to create
Returns
An object created by the factory. The type of the object depends on the factory.

Implements Ogre::FactoryObj< Archive >.

References Ogre::ArchiveFactory::createInstance().

Referenced by Ogre::ArchiveFactory::createInstance().

◆ addEmbbeddedFile()

static void Ogre::EmbeddedZipArchiveFactory::addEmbbeddedFile ( const String name,
const uint8 fileData,
size_t  fileSize,
DecryptEmbeddedZipFileFunc  decryptFunc 
)
staticinherited

Add an embedded file to the embedded file list.

Referenced by createInstance().

◆ removeEmbbeddedFile()

static void Ogre::EmbeddedZipArchiveFactory::removeEmbbeddedFile ( const String name)
staticinherited

Remove an embedded file to the embedded file list.

◆ destroyInstance()

void Ogre::ZipArchiveFactory::destroyInstance ( Archive ptr)
inlinevirtualinherited

Destroys an object which was created by this factory.

Parameters
ptrPointer to the object to destroy

Implements Ogre::FactoryObj< Archive >.

References OGRE_DELETE.


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