OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::FileSystemArchiveFactory Class Reference

Specialisation of the ArchiveFactory to allow reading of files from filesystem folders / directories. More...

#include <OgreFileSystem.h>

+ Inheritance diagram for Ogre::FileSystemArchiveFactory:

Public Member Functions

virtual ArchivecreateInstance (const String &name)
 
ArchivecreateInstance (const String &name, bool readOnly)
 Creates a new object. More...
 
virtual ArchivecreateInstance (const String &name, bool readOnly)=0
 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...
 
- Public Member Functions inherited from Ogre::ArchiveFactory
virtual ~ArchiveFactory ()
 
virtual ArchivecreateInstance (const String &name)
 Creates a new object. More...
 
- Public Member Functions inherited from Ogre::FactoryObj< Archive >
virtual ~FactoryObj ()
 

Static Public Member Functions

static bool getIgnoreHidden ()
 Get whether hidden files are ignored during filesystem enumeration. More...
 
static void setIgnoreHidden (bool ignore)
 Set whether filesystem enumeration will include hidden files or not. More...
 

Detailed Description

Specialisation of the ArchiveFactory to allow reading of files from filesystem folders / directories.

Member Function Documentation

◆ getType()

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

Returns the factory type.

Returns
The factory type.

Implements Ogre::FactoryObj< Archive >.

◆ createInstance() [1/3]

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

◆ destroyInstance()

void Ogre::FileSystemArchiveFactory::destroyInstance ( Archive ptr)
inlinevirtual

Destroys an object which was created by this factory.

Parameters
ptrPointer to the object to destroy

Implements Ogre::FactoryObj< Archive >.

◆ setIgnoreHidden()

static void Ogre::FileSystemArchiveFactory::setIgnoreHidden ( bool  ignore)
static

Set whether filesystem enumeration will include hidden files or not.

This should be called prior to declaring and/or initializing filesystem resource locations. The default is true (ignore hidden files).

◆ getIgnoreHidden()

static bool Ogre::FileSystemArchiveFactory::getIgnoreHidden ( )
static

Get whether hidden files are ignored during filesystem enumeration.

◆ createInstance() [2/3]

virtual Archive* Ogre::ArchiveFactory::createInstance

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.

◆ createInstance() [3/3]

virtual Archive* Ogre::ArchiveFactory::createInstance
inline

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