#include <OgreFileSystem.h>
Public Member Functions | ||||||||||
FileSystemArchive (const String &name, const String &archType) | ||||||||||
~FileSystemArchive () | ||||||||||
bool | isCaseSensitive (void) const | |||||||||
Returns whether this archive is case sensitive in the way it matches files. | ||||||||||
void | load () | |||||||||
Loads the archive.
| ||||||||||
void | unload () | |||||||||
Unloads the archive.
| ||||||||||
DataStreamPtr | open (const String &filename) const | |||||||||
Open a stream on a given file.
| ||||||||||
StringVectorPtr | list (bool recursive=true, bool dirs=false) | |||||||||
List all file names in the archive.
| ||||||||||
FileInfoListPtr | listFileInfo (bool recursive=true, bool dirs=false) | |||||||||
List all files in the archive with accompanying information.
| ||||||||||
StringVectorPtr | find (const String &pattern, bool recursive=true, bool dirs=false) | |||||||||
Find all file or directory names matching a given pattern in this archive.
| ||||||||||
FileInfoListPtr | findFileInfo (const String &pattern, bool recursive=true, bool dirs=false) | |||||||||
Find all files or directories matching a given pattern in this archive and get some detailed information about them.
| ||||||||||
bool | exists (const String &filename) | |||||||||
Find out if the named file exists (note: fully qualified filename required). | ||||||||||
const String & | getName (void) const | |||||||||
Get the name of this archive. | ||||||||||
const String & | getType (void) const | |||||||||
Return the type code of this Archive. | ||||||||||
Protected Member Functions | ||||||||||
void | findFiles (const String &pattern, bool recursive, bool dirs, StringVector *simpleList, FileInfoList *detailList) | |||||||||
Utility method to retrieve all files in a directory matching pattern. | ||||||||||
Protected Attributes | ||||||||||
String | mName | |||||||||
Archive name. | ||||||||||
String | mType | |||||||||
Archive type code. |
Definition at line 42 of file OgreFileSystem.h.
Ogre::FileSystemArchive::~FileSystemArchive | ( | ) |
void Ogre::FileSystemArchive::findFiles | ( | const String & | pattern, | |
bool | recursive, | |||
bool | dirs, | |||
StringVector * | simpleList, | |||
FileInfoList * | detailList | |||
) | [protected] |
Utility method to retrieve all files in a directory matching pattern.
pattern | File pattern | |
recursive | Whether to cascade down directories | |
dirs | Set to true if you want the directories to be listed instead of files | |
simpleList | Populated if retrieving a simple list | |
detailList | Populated if retrieving a detailed list | |
currentDir | The current directory relative to the base of the archive, for file naming |
bool Ogre::FileSystemArchive::isCaseSensitive | ( | void | ) | const [virtual] |
Returns whether this archive is case sensitive in the way it matches files.
Implements Ogre::Archive.
void Ogre::FileSystemArchive::load | ( | ) | [virtual] |
Loads the archive.
Implements Ogre::Archive.
void Ogre::FileSystemArchive::unload | ( | ) | [virtual] |
Unloads the archive.
Implements Ogre::Archive.
DataStreamPtr Ogre::FileSystemArchive::open | ( | const String & | filename | ) | const [virtual] |
Open a stream on a given file.
filename | The fully qualified name of the file |
Implements Ogre::Archive.
StringVectorPtr Ogre::FileSystemArchive::list | ( | bool | recursive = true , |
|
bool | dirs = false | |||
) | [virtual] |
List all file names in the archive.
recursive | Whether all paths of the archive are searched (if the archive has a concept of that) | |
dirs | Set to true if you want the directories to be listed instead of files |
Implements Ogre::Archive.
FileInfoListPtr Ogre::FileSystemArchive::listFileInfo | ( | bool | recursive = true , |
|
bool | dirs = false | |||
) | [virtual] |
List all files in the archive with accompanying information.
recursive | Whether all paths of the archive are searched (if the archive has a concept of that) | |
dirs | Set to true if you want the directories to be listed instead of files |
Implements Ogre::Archive.
StringVectorPtr Ogre::FileSystemArchive::find | ( | const String & | pattern, | |
bool | recursive = true , |
|||
bool | dirs = false | |||
) | [virtual] |
Find all file or directory names matching a given pattern in this archive.
pattern | The pattern to search for; wildcards (*) are allowed | |
recursive | Whether all paths of the archive are searched (if the archive has a concept of that) | |
dirs | Set to true if you want the directories to be listed instead of files |
Implements Ogre::Archive.
FileInfoListPtr Ogre::FileSystemArchive::findFileInfo | ( | const String & | pattern, | |
bool | recursive = true , |
|||
bool | dirs = false | |||
) | [virtual] |
Find all files or directories matching a given pattern in this archive and get some detailed information about them.
pattern | The pattern to search for; wildcards (*) are allowed | |
recursive | Whether all paths of the archive are searched (if the archive has a concept of that) | |
dirs | Set to true if you want the directories to be listed instead of files |
Implements Ogre::Archive.
bool Ogre::FileSystemArchive::exists | ( | const String & | filename | ) | [virtual] |
Find out if the named file exists (note: fully qualified filename required).
Implements Ogre::Archive.
const String& Ogre::Archive::getName | ( | void | ) | const [inherited] |
const String& Ogre::Archive::getType | ( | void | ) | const [inherited] |
String Ogre::Archive::mName [protected, inherited] |
String Ogre::Archive::mType [protected, inherited] |
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:49:41 2008