OGRE 14.2
Object-Oriented Graphics Rendering Engine
Loading...
Searching...
No Matches
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 ()
 
ArchivecreateInstance (const String &name) override
 Creates a new object.
 
ArchivecreateInstance (const String &name, bool readOnly) override
 Creates a new object.
 
virtual ArchivecreateInstance (const String &name, bool readOnly)=0
 Creates a new object.
 
const StringgetType (void) const override
 Returns the factory type.
 
- Public Member Functions inherited from Ogre::ArchiveFactory
virtual ~ArchiveFactory ()
 
ArchivecreateInstance (const String &name) override
 Creates a new object.
 
virtual ArchivecreateInstance (const String &name, bool readOnly)=0
 Creates a new object.
 
- Public Member Functions inherited from Ogre::FactoryObj< Archive >
virtual ~FactoryObj ()
 
virtual ArchivecreateInstance (const String &name)=0
 Creates a new object.
 
virtual void destroyInstance (Archive *ptr)
 Destroys an object which was created by this factory.
 
virtual const StringgetType () const=0
 Returns the factory type.
 

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
overridevirtual

Returns the factory type.

Returns
The factory type.

Implements Ogre::FactoryObj< Archive >.

Reimplemented in Ogre::EmbeddedZipArchiveFactory.

◆ createInstance() [1/3]

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

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.

Reimplemented in Ogre::EmbeddedZipArchiveFactory, and Ogre::EmbeddedZipArchiveFactory.

◆ createInstance() [2/3]

virtual Archive * Ogre::ArchiveFactory::createInstance ( const String name,
bool  readOnly 
)
virtual

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.

Reimplemented in Ogre::EmbeddedZipArchiveFactory.

◆ createInstance() [3/3]

Archive * Ogre::ArchiveFactory::createInstance ( const String name)
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::ArchiveFactory.

Reimplemented in Ogre::EmbeddedZipArchiveFactory.


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