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

Specialisation of ArchiveFactory for FileSystem files. More...

#include <OgreFileSystem.h>

+ Inheritance diagram for Ogre::FileSystemArchiveFactory:

Public Member Functions

virtual ~FileSystemArchiveFactory ()
 
virtual void convertPath (String &inOutPath) const
 Some implementations (i.e. More...
 
virtual ArchivecreateInstance (const String &name)
 Creates a new object. More...
 
ArchivecreateInstance (const String &name, bool readOnly)
 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...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 

Detailed Description

Specialisation of ArchiveFactory for FileSystem files.

Constructor & Destructor Documentation

◆ ~FileSystemArchiveFactory()

virtual Ogre::FileSystemArchiveFactory::~FileSystemArchiveFactory ( )
inlinevirtual

Member Function Documentation

◆ convertPath()

virtual void Ogre::ArchiveFactory::convertPath ( String inOutPath) const
inlinevirtualinherited

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 in Ogre::APKFileSystemArchiveFactory, and Ogre::APKZipArchiveFactory.

◆ createInstance() [1/2]

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

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::FactoryObj< Archive >.

References Ogre::ArchiveFactory::createInstance().

Referenced by Ogre::ArchiveFactory::createInstance().

◆ createInstance() [2/2]

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

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

References OGRE_DELETE.

◆ getType()

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

Returns the factory type.

Returns
The factory type.

Implements Ogre::FactoryObj< Archive >.

◆ operator delete() [1/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

◆ operator delete() [2/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

◆ operator delete() [3/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

◆ operator new() [1/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

◆ operator new() [2/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

◆ operator new() [3/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

◆ operator new[]() [2/2]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

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