OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::EmbeddedZipArchiveFactory Class Reference

Specialisation of ZipArchiveFactory for embedded Zip files. More...

#include <OgreZip.h>

+ Inheritance diagram for Ogre::EmbeddedZipArchiveFactory:

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

 EmbeddedZipArchiveFactory ()
 
 ~EmbeddedZipArchiveFactory () override
 
ArchivecreateInstance (const String &name, bool readOnly) override
 Creates a new object. More...
 
const StringgetType () const override
 Returns the factory type. More...
 
- Public Member Functions inherited from Ogre::ZipArchiveFactory
 ~ZipArchiveFactory () override
 
void destroyInstance (Archive *ptr) override
 Destroys an object which was created by this factory. More...
 
- Public Member Functions inherited from Ogre::ArchiveFactory
 ~ArchiveFactory () override
 
virtual void convertPath (String &inOutPath) const
 Some implementations (i.e. More...
 
ArchivecreateInstance (const String &name) override
 Creates a new object. More...
 
- Public Member Functions inherited from Ogre::FactoryObj< Archive >
virtual ~FactoryObj ()
 

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...
 

Detailed Description

Specialisation of ZipArchiveFactory for embedded Zip files.

Member Typedef Documentation

◆ DecryptEmbeddedZipFileFunc

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

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

◆ EmbeddedZipArchiveFactory()

Ogre::EmbeddedZipArchiveFactory::EmbeddedZipArchiveFactory ( )

◆ ~EmbeddedZipArchiveFactory()

Ogre::EmbeddedZipArchiveFactory::~EmbeddedZipArchiveFactory ( )
override

Member Function Documentation

◆ addEmbbeddedFile()

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

Add an embedded file to the embedded file list.

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

◆ createInstance()

Archive* Ogre::EmbeddedZipArchiveFactory::createInstance ( const String name,
bool  readOnly 
)
inlineoverridevirtual

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.

Reimplemented from Ogre::ZipArchiveFactory.

References OGRE_NEW.

◆ getType()

const String& Ogre::EmbeddedZipArchiveFactory::getType ( ) const
overridevirtual

Returns the factory type.

Returns
The factory type.

Reimplemented from Ogre::ZipArchiveFactory.

◆ removeEmbbeddedFile()

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

Remove an embedded file to the embedded file list.


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