Ogre::ZipArchiveFactory Class Reference

Specialisation to allow reading of files from a zip format source archive. More...

#include <OgreZip.h>

Inheritance diagram for Ogre::ZipArchiveFactory:

Public Member Functions
virtual	~ZipArchiveFactory ()
virtual Archive *	createInstance (const String &name) OGRE_NODISCARD
virtual Archive *	createInstance (const String &name) OGRE_NODISCARD
	Creates a new object. More...
Archive *	createInstance (const String &name, bool readOnly)
	Creates a new object. More...
virtual Archive *	createInstance (const String &name, bool readOnly) OGRE_NODISCARD=0
	Creates a new object. More...
void	destroyInstance (Archive *ptr)
	Destroys an object which was created by this factory. More...
const String &	getType (void) const
	Returns the factory type. More...

Detailed Description

Specialisation to allow reading of files from a zip format source archive.

This archive format supports all archives compressed in the standard zip format, including iD pk3 files.

Constructor & Destructor Documentation

~ZipArchiveFactory()

virtual Ogre::ZipArchiveFactory::~ZipArchiveFactory ( )

inlinevirtual

Member Function Documentation

getType()

const String& Ogre::ZipArchiveFactory::getType ( void  ) const

virtual

Returns the factory type.

Returns

The factory type.

Implements Ogre::FactoryObj< Archive >.

Reimplemented in Ogre::EmbeddedZipArchiveFactory.

createInstance() [1/4]

Archive* Ogre::ZipArchiveFactory::createInstance ( const String &  name, bool  readOnly  )

virtual

Creates a new object.

Parameters

name	Name of the object to create
readOnly	whether the Archive is read only

Returns

An object created by the factory. The type of the object depends on the factory.

Implements Ogre::ArchiveFactory.

Reimplemented in Ogre::EmbeddedZipArchiveFactory.

destroyInstance()

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

inlinevirtual

Destroys an object which was created by this factory.

Parameters

ptr	Pointer to the object to destroy

Implements Ogre::FactoryObj< Archive >.

References OGRE_DELETE.

createInstance() [2/4]

virtual Archive* Ogre::ArchiveFactory::createInstance

Creates a new object.

Parameters

name	Name of the object to create
readOnly	whether the Archive is read only

Returns

An object created by the factory. The type of the object depends on the factory.

createInstance() [3/4]

virtual Archive* Ogre::ArchiveFactory::createInstance

inline

createInstance() [4/4]

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

inlinevirtualinherited

Creates a new object.

Parameters

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

---

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

• OgreZip.h