![]() |
OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
|
Specialisation of the Archive class to allow reading of files from filesystem folders / directories. More...
#include <OgreFileSystem.h>
Public Member Functions | |
FileSystemArchive (const String &name, const String &archType, bool readOnly) | |
~FileSystemArchive () override | |
DataStreamPtr | create (const String &filename) override |
Create a new file (or overwrite one already there). | |
bool | exists (const String &filename) override |
Find out if the named file exists (note: fully qualified filename required) | |
StringVectorPtr | find (const String &pattern, bool recursive=true, bool dirs=false) override |
Find all file or directory names matching a given pattern in this archive. | |
FileInfoListPtr | findFileInfo (const String &pattern, bool recursive=true, bool dirs=false) override |
Find all files or directories matching a given pattern in this archive and get some detailed information about them. | |
time_t | getModifiedTime (const String &filename) override |
Retrieve the modification time of a given file. | |
bool | isCaseSensitive () const override |
Returns whether this archive is case sensitive in the way it matches files. | |
StringVectorPtr | list (bool recursive=true, bool dirs=false) override |
List all file names in the archive. | |
FileInfoListPtr | listFileInfo (bool recursive=true, bool dirs=false) override |
List all files in the archive with accompanying information. | |
void | load () override |
Loads the archive. | |
DataStreamPtr | open (const String &filename, bool readOnly=true) override |
Open a stream on a given file. | |
void | remove (const String &filename) override |
Delete a named file. | |
void | unload () override |
Unloads the archive. | |
![]() | |
Archive (const String &name, const String &archType) | |
Constructor - don't call direct, used by ArchiveFactory. | |
virtual | ~Archive () |
Default destructor. | |
virtual DataStreamPtr | create (const String &filename) |
Create a new file (or overwrite one already there). | |
virtual bool | exists (const String &filename)=0 |
Find out if the named file exists (note: fully qualified filename required) | |
virtual StringVectorPtr | find (const String &pattern, bool recursive=true, bool dirs=false)=0 |
Find all file or directory names matching a given pattern in this archive. | |
virtual FileInfoListPtr | findFileInfo (const String &pattern, bool recursive=true, bool dirs=false)=0 |
Find all files or directories matching a given pattern in this archive and get some detailed information about them. | |
virtual time_t | getModifiedTime (const String &filename)=0 |
Retrieve the modification time of a given file. | |
const String & | getName () const |
Get the name of this archive. | |
const String & | getType () const |
Return the type code of this Archive. | |
virtual bool | isCaseSensitive () const =0 |
Returns whether this archive is case sensitive in the way it matches files. | |
virtual bool | isReadOnly () const |
Reports whether this Archive is read-only, or whether the contents can be updated. | |
virtual StringVectorPtr | list (bool recursive=true, bool dirs=false)=0 |
List all file names in the archive. | |
virtual FileInfoListPtr | listFileInfo (bool recursive=true, bool dirs=false)=0 |
List all files in the archive with accompanying information. | |
virtual void | load ()=0 |
Loads the archive. | |
virtual DataStreamPtr | open (const String &filename, bool readOnly=true)=0 |
Open a stream on a given file. | |
virtual void | remove (const String &filename) |
Delete a named file. | |
virtual void | unload ()=0 |
Unloads the archive. | |
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. | |
Static Public Attributes | |
static bool | msIgnoreHidden |
Specialisation of the Archive class to allow reading of files from filesystem folders / directories.
Ogre::FileSystemArchive::FileSystemArchive | ( | const String & | name, |
const String & | archType, | ||
bool | readOnly | ||
) |
|
override |
|
overridevirtual |
Create a new file (or overwrite one already there).
filename | The fully qualified name of the file |
Reimplemented from Ogre::Archive.
|
overridevirtual |
Find out if the named file exists (note: fully qualified filename required)
Implements Ogre::Archive.
|
overridevirtual |
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.
|
overridevirtual |
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.
|
inlinestatic |
Get whether hidden files are ignored during filesystem enumeration.
|
overridevirtual |
Retrieve the modification time of a given file.
Implements Ogre::Archive.
|
overridevirtual |
Returns whether this archive is case sensitive in the way it matches files.
Implements Ogre::Archive.
|
overridevirtual |
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.
|
overridevirtual |
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.
|
overridevirtual |
Loads the archive.
Implements Ogre::Archive.
|
overridevirtual |
Open a stream on a given file.
filename | The fully qualified name of the file |
readOnly | Whether to open the file in read-only mode or not (note, if the archive is read-only then this cannot be set to false) |
Implements Ogre::Archive.
|
overridevirtual |
Delete a named file.
filename | The fully qualified name of the file |
Reimplemented from Ogre::Archive.
|
inlinestatic |
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).
|
overridevirtual |
Unloads the archive.
Implements Ogre::Archive.
|
static |