Assimp  v4.1. (December 2018)
Assimp::FileSystemFilter Class Reference

File system filter. More...

Inherits Assimp::IOSystem.

Public Member Functions

bool ChangeDirectory (const std::string &path)
 Will change the current directory to the given path. More...
 
void Close (IOStream *pFile)
 Closes the given file and releases all resources associated with it. More...
 
bool ComparePaths (const char *one, const char *second) const
 Compare two paths. More...
 
bool CreateDirectory (const std::string &path)
 Creates an new directory at the given path. More...
 
const std::string & CurrentDirectory () const
 Returns the top directory from the stack. More...
 
bool DeleteFile (const std::string &file)
 Delete file. More...
 
bool Exists (const char *pFile) const
 Tests for the existence of a file at the given path. More...
 
 FileSystemFilter (const std::string &file, IOSystem *old)
 Constructor. More...
 
char getOsSeparator () const
 Returns the directory separator. More...
 
IOStreamOpen (const char *pFile, const char *pMode="rb")
 Open a new file with a given path. More...
 
bool PopDirectory ()
 Pops the top directory from the stack. More...
 
bool PushDirectory (const std::string &path)
 Pushes a new directory onto the directory stack. More...
 
size_t StackSize () const
 Returns the number of directories stored on the stack. More...
 
 ~FileSystemFilter ()
 Destructor. More...
 
- Public Member Functions inherited from Assimp::IOSystem
bool ComparePaths (const std::string &one, const std::string &second) const
 For backward compatibility. More...
 
AI_FORCE_INLINE bool Exists (const std::string &pFile) const
 For backward compatibility. More...
 
 IOSystem () AI_NO_EXCEPT
 Default constructor. More...
 
IOStreamOpen (const std::string &pFile, const std::string &pMode=std::string("rb"))
 For backward compatibility. More...
 
virtual ~IOSystem ()
 Virtual destructor. More...
 

Detailed Description

File system filter.

Constructor & Destructor Documentation

◆ FileSystemFilter()

Assimp::FileSystemFilter::FileSystemFilter ( const std::string &  file,
IOSystem old 
)
inline

Constructor.

◆ ~FileSystemFilter()

Assimp::FileSystemFilter::~FileSystemFilter ( )
inline

Destructor.

Member Function Documentation

◆ ChangeDirectory()

bool Assimp::FileSystemFilter::ChangeDirectory ( const std::string &  path)
inlinevirtual

Will change the current directory to the given path.

Reimplemented from Assimp::IOSystem.

◆ Close()

void Assimp::FileSystemFilter::Close ( IOStream pFile)
inlinevirtual

Closes the given file and releases all resources associated with it.

Implements Assimp::IOSystem.

◆ ComparePaths()

bool Assimp::FileSystemFilter::ComparePaths ( const char *  one,
const char *  second 
) const
inlinevirtual

Compare two paths.

Reimplemented from Assimp::IOSystem.

◆ CreateDirectory()

bool Assimp::FileSystemFilter::CreateDirectory ( const std::string &  path)
inlinevirtual

Creates an new directory at the given path.

Reimplemented from Assimp::IOSystem.

◆ CurrentDirectory()

const std::string& Assimp::FileSystemFilter::CurrentDirectory ( ) const
inlinevirtual

Returns the top directory from the stack.

Reimplemented from Assimp::IOSystem.

◆ DeleteFile()

bool Assimp::FileSystemFilter::DeleteFile ( const std::string &  file)
inlinevirtual

Delete file.

Reimplemented from Assimp::IOSystem.

◆ Exists()

bool Assimp::FileSystemFilter::Exists ( const char *  pFile) const
inlinevirtual

Tests for the existence of a file at the given path.

Implements Assimp::IOSystem.

◆ getOsSeparator()

char Assimp::FileSystemFilter::getOsSeparator ( ) const
inlinevirtual

Returns the directory separator.

Implements Assimp::IOSystem.

◆ Open()

IOStream* Assimp::FileSystemFilter::Open ( const char *  pFile,
const char *  pMode = "rb" 
)
inlinevirtual

Open a new file with a given path.

Implements Assimp::IOSystem.

◆ PopDirectory()

bool Assimp::FileSystemFilter::PopDirectory ( )
inlinevirtual

Pops the top directory from the stack.

Reimplemented from Assimp::IOSystem.

◆ PushDirectory()

bool Assimp::FileSystemFilter::PushDirectory ( const std::string &  path)
inlinevirtual

Pushes a new directory onto the directory stack.

Reimplemented from Assimp::IOSystem.

◆ StackSize()

size_t Assimp::FileSystemFilter::StackSize ( ) const
inlinevirtual

Returns the number of directories stored on the stack.

Reimplemented from Assimp::IOSystem.


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