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 Archive *	createInstance (const String &name)
	Creates a new object.
Archive *	createInstance (const String &name, bool readOnly)
	Creates a new object.
virtual Archive *	createInstance (const String &name, bool readOnly)=0
	Creates a new object.
void	destroyInstance (Archive *ptr)
	Destroys an object which was created by this factory.
const String &	getType (void) const
	Returns the factory type.
Public Member Functions inherited from Ogre::ArchiveFactory
virtual	~ArchiveFactory ()
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.
static void	setIgnoreHidden (bool ignore)
	Set whether filesystem enumeration will include hidden files or not.

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

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.

destroyInstance()

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

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

createInstance() [3/3]

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

inlinevirtual

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.

Reimplemented from Ogre::ArchiveFactory.

---

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

• OgreFileSystem.h