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

#include <OgreAPKFileSystemArchive.h>

+ Inheritance diagram for Ogre::APKFileSystemArchiveFactory:

Public Member Functions

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

Constructor & Destructor Documentation

◆ APKFileSystemArchiveFactory()

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

◆ ~APKFileSystemArchiveFactory()

virtual Ogre::APKFileSystemArchiveFactory::~APKFileSystemArchiveFactory ( )
inlinevirtual

Member Function Documentation

◆ convertPath()

virtual void Ogre::APKFileSystemArchiveFactory::convertPath ( String inOutPath) const
virtual

Some implementations (i.e.

APKFileSystemArchive) usually modify the filename. For example in APKFileSystemArchive, "/path/to/localfile.mesh" gets internally stored as "path/to/localfile.mesh" (no leading slash), but across the platform the leading slash is required. The ArchiveManager needs to be aware of this.

Parameters
inOutPathGiven the input path, converts it to the final path.

Reimplemented from Ogre::ArchiveFactory.

◆ createInstance()

Archive* Ogre::APKFileSystemArchiveFactory::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.

Implements Ogre::ArchiveFactory.

References getType(), and OGRE_NEW.

◆ destroyInstance()

void Ogre::APKFileSystemArchiveFactory::destroyInstance ( Archive arch)
inlinevirtual

Destroys an object which was created by this factory.

Parameters
ptrPointer to the object to destroy

Implements Ogre::FactoryObj< Archive >.

References OGRE_DELETE.

◆ getType()

const String& Ogre::APKFileSystemArchiveFactory::getType ( ) const
virtual

Returns the factory type.

Returns
The factory type.

Implements Ogre::FactoryObj< Archive >.

Referenced by createInstance().


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