xoreos  0.0.5
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Aurora::SACFile Class Reference

A SAC file is basically a GFF3 file with some bytes extra header. More...

#include <sacfile.h>

Inheritance diagram for Aurora::SACFile:
Inheritance graph
[legend]
Collaboration diagram for Aurora::SACFile:
Collaboration graph
[legend]

Public Member Functions

 SACFile (Common::SeekableReadStream *stream)
 
Common::UString getLevelFile () const
 
- Public Member Functions inherited from Aurora::GFF3File
 GFF3File (Common::SeekableReadStream *gff3, uint32 id=0xFFFFFFFF, bool repairNWNPremium=false)
 Take over this stream and read a GFF3 file out of it. More...
 
 GFF3File (const Common::UString &gff3, FileType type, uint32 id=0xFFFFFFFF, bool repairNWNPremium=false)
 Request this resource from the ResourceManager and read a GFF3 file out of it. More...
 
virtual ~GFF3File ()
 
uint32 getType () const
 Return the GFF3's specific type. More...
 
const GFF3StructgetTopLevel () const
 Returns the top-level struct. More...
 
- Public Member Functions inherited from Aurora::AuroraFile
 AuroraFile ()
 
void clear ()
 
uint32 getID () const
 Return the file's ID. More...
 
uint32 getVersion () const
 Return the file's version. More...
 
bool isUTF16LE () const
 Were the ID and version encoded in little-endian UTF-16 in the file? More...
 

Private Member Functions

Common::SeekableReadStreamload (Common::SeekableReadStream *stream)
 

Private Attributes

Common::UString _levelFile
 
Common::ScopedPtr< Common::SeekableReadStream_stream
 

Additional Inherited Members

- Static Public Member Functions inherited from Aurora::AuroraFile
static void readHeader (Common::ReadStream &stream, uint32 &id, uint32 &version, bool &utf16le)
 Read the header out of a stream. More...
 
static void readHeader (Common::ReadStream &stream, uint32 &id, uint32 &version)
 Read the ID and version out of a stream. More...
 
static uint32 readHeaderID (Common::ReadStream &stream)
 Read the ID out of a stream. More...
 
- Protected Member Functions inherited from Aurora::AuroraFile
void readHeader (Common::ReadStream &stream)
 
- Static Protected Member Functions inherited from Aurora::AuroraFile
static uint32 convertUTF16LE (uint32 x1, uint32 x2)
 
- Protected Attributes inherited from Aurora::AuroraFile
uint32 _id
 The file's ID. More...
 
uint32 _version
 The file's version. More...
 
bool _utf16le
 The file's ID and version are in little-endian UTF-16. More...
 

Detailed Description

A SAC file is basically a GFF3 file with some bytes extra header.

This class inherits from the GFF3File class to offer all GFF access methods while providing also information about the SAC header.

Definition at line 39 of file sacfile.h.

Constructor & Destructor Documentation

◆ SACFile()

Aurora::SACFile::SACFile ( Common::SeekableReadStream stream)

Definition at line 32 of file sacfile.cpp.

References Aurora::GFF3File::getType(), and MKTAG.

Here is the call graph for this function:

Member Function Documentation

◆ getLevelFile()

Common::UString Aurora::SACFile::getLevelFile ( ) const

Definition at line 37 of file sacfile.cpp.

References _levelFile.

◆ load()

Common::SeekableReadStream * Aurora::SACFile::load ( Common::SeekableReadStream stream)
private

Member Data Documentation

◆ _levelFile

Common::UString Aurora::SACFile::_levelFile
private

Definition at line 46 of file sacfile.h.

Referenced by getLevelFile(), and load().

◆ _stream

Common::ScopedPtr<Common::SeekableReadStream> Aurora::SACFile::_stream
private

Definition at line 47 of file sacfile.h.


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