OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::EmbeddedZipArchiveFactory Class Reference

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

#include <OgreZip.h>

+ Inheritance diagram for Ogre::EmbeddedZipArchiveFactory:
+ Collaboration 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 ()
 
virtual ~EmbeddedZipArchiveFactory ()
 
virtual ArchivecreateInstance (const String &name)
 Creates a new object. More...
 
ArchivecreateInstance (const String &name, bool readOnly)
 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...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 

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

Static Protected Attributes

static zzip_plugin_io_handlersmPluginIo
 A static pointer to file io alternative implementation for the embedded files. More...
 

Detailed Description

Specialisation of ZipArchiveFactory for embedded Zip files.

Definition at line 133 of file OgreZip.h.

Member Typedef Documentation

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

Definition at line 156 of file OgreZip.h.

Constructor & Destructor Documentation

Ogre::EmbeddedZipArchiveFactory::EmbeddedZipArchiveFactory ( )
virtual Ogre::EmbeddedZipArchiveFactory::~EmbeddedZipArchiveFactory ( )
virtual

Member Function Documentation

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

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

Definition at line 71 of file OgreArchiveFactory.h.

References Ogre::ArchiveFactory::createInstance().

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

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

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.

Definition at line 144 of file OgreZip.h.

References OGRE_NEW.

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

Definition at line 129 of file OgreZip.h.

References OGRE_DELETE.

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

Returns the factory type.

Returns
The factory type.

Reimplemented from Ogre::ZipArchiveFactory.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

Remove an embedded file to the embedded file list.

Member Data Documentation

zzip_plugin_io_handlers* Ogre::EmbeddedZipArchiveFactory::mPluginIo
staticprotected

A static pointer to file io alternative implementation for the embedded files.

Definition at line 137 of file OgreZip.h.

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


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