Assimp  v3.1.1 (June 2014)
Assimp::Q3BSP::Q3BSPZipArchive Class Reference

IMplements a zip archive like the WinZip archives. Will be also used to import data from a P3K archive ( Quake level format ). More...

Inherits Assimp::IOSystem.

Public Member Functions

void Close (IOStream *pFile)
 Closes the given file and releases all resources associated with it. More...
 
bool Exists (const char *pFile) const
 Tests for the existence of a file at the given path. More...
 
void getFileList (std::vector< std::string > &rFileList)
 
char getOsSeparator () const
 Returns the system specific directory separator. More...
 
bool isOpen () const
 
IOStreamOpen (const char *pFile, const char *pMode="rb")
 Open a new file with a given path. More...
 
 Q3BSPZipArchive (IOSystem *pIOHandler, const std::string &rFile)
 
 ~Q3BSPZipArchive ()
 
- Public Member Functions inherited from Assimp::IOSystem
virtual bool ComparePaths (const char *one, const char *second) const
 Compares two paths and check whether the point to identical files. More...
 
bool ComparePaths (const std::string &one, const std::string &second) const
 For backward compatibility. More...
 
virtual const std::string & CurrentDirectory () const
 Returns the top directory from the stack. More...
 
AI_FORCE_INLINE bool Exists (const std::string &pFile) const
 For backward compatibility. More...
 
 IOSystem ()
 Default constructor. More...
 
IOStreamOpen (const std::string &pFile, const std::string &pMode=std::string("rb"))
 For backward compatibility. More...
 
virtual bool PopDirectory ()
 Pops the top directory from the stack. More...
 
virtual bool PushDirectory (const std::string &path)
 Pushes a new directory onto the directory stack. More...
 
virtual size_t StackSize () const
 Returns the number of directories stored on the stack. More...
 
virtual ~IOSystem ()
 Virtual destructor. More...
 

Static Public Attributes

static const unsigned int FileNameSize = 256
 

Detailed Description

IMplements a zip archive like the WinZip archives. Will be also used to import data from a P3K archive ( Quake level format ).

::

Constructor & Destructor Documentation

◆ Q3BSPZipArchive()

Assimp::Q3BSP::Q3BSPZipArchive::Q3BSPZipArchive ( IOSystem pIOHandler,
const std::string &  rFile 
)

◆ ~Q3BSPZipArchive()

Assimp::Q3BSP::Q3BSPZipArchive::~Q3BSPZipArchive ( )

Member Function Documentation

◆ Close()

void Assimp::Q3BSP::Q3BSPZipArchive::Close ( IOStream pFile)
virtual

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

Parameters
pFileThe file instance previously created by Open().

Implements Assimp::IOSystem.

◆ Exists()

bool Assimp::Q3BSP::Q3BSPZipArchive::Exists ( const char *  pFile) const
virtual

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

Parameters
pFilePath to the file
Returns
true if there is a file with this path, else false.

Implements Assimp::IOSystem.

◆ getFileList()

void Assimp::Q3BSP::Q3BSPZipArchive::getFileList ( std::vector< std::string > &  rFileList)

◆ getOsSeparator()

char Assimp::Q3BSP::Q3BSPZipArchive::getOsSeparator ( ) const
virtual

Returns the system specific directory separator.

Returns
System specific directory separator

Implements Assimp::IOSystem.

◆ isOpen()

bool Assimp::Q3BSP::Q3BSPZipArchive::isOpen ( ) const

◆ Open()

IOStream * Assimp::Q3BSP::Q3BSPZipArchive::Open ( const char *  pFile,
const char *  pMode = "rb" 
)
virtual

Open a new file with a given path.

When the access to the file is finished, call Close() to release all associated resources (or the virtual dtor of the IOStream).

Parameters
pFilePath to the file
pModeDesired file I/O mode. Required are: "wb", "w", "wt", "rb", "r", "rt".
Returns
New IOStream interface allowing the lib to access the underlying file.
Note
When implementing this class to provide custom IO handling, you probably have to supply an own implementation of IOStream as well.

Implements Assimp::IOSystem.

Member Data Documentation

◆ FileNameSize

const unsigned int Assimp::Q3BSP::Q3BSPZipArchive::FileNameSize = 256
static

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