Raytrix Light Field SDK  4.0
Logo
Public Member Functions | Protected Attributes | List of all members
Rx::FileIO::CRxGFFReader Class Reference

Detailed Description

Raytrix General File Format Reader.

Public Member Functions

 CRxGFFReader ()
 Default constructor. More...
 
 ~CRxGFFReader ()
 Destructor. More...
 
void Close ()
 Closes the file read operation. More...
 
size_t CountContentNodes (const CRxString &sxXPath) const
 Count nodes. More...
 
unsigned GetVersion () const
 
bool Open (const CRxString &sxFilename, const CRxString &sxGUID)
 Open a file in read mode. More...
 
void ReadContent (Interop::Runtime28::IImage *pxImg, const CRxString &sxXPath)
 
void ReadContent (CRxMapping3D &pxMapping, const CRxString &sxXPath)
 Reads a 3D Mapping present at the given file format. More...
 
void ReadContent (float &fX, float &fY, float &fZ, const CRxString &sxXPath)
 Reads a content containing of three floats. More...
 
void ReadContent (int &iX, int &iY, int &iZ, const CRxString &sxXPath)
 Reads a content containing of thee integer. More...
 
float ReadFloatAttribute (const CRxString &sxXPath)
 

Protected Attributes

xmlDocPtr m_pXML
 
xmlNodePtr m_pXmlContentNode
 
xmlNodePtr m_pXmlMetaNode
 
unsigned m_uHeaderLength
 
CFileStream m_xFile
 

Constructor & Destructor Documentation

Rx::FileIO::CRxGFFReader::CRxGFFReader ( )

Default constructor.

Rx::FileIO::CRxGFFReader::~CRxGFFReader ( )

Destructor.

Member Function Documentation

void Rx::FileIO::CRxGFFReader::Close ( )

Closes the file read operation.

size_t Rx::FileIO::CRxGFFReader::CountContentNodes ( const CRxString sxXPath) const

Count nodes.

Parameters
sxXPathXPath.
Returns
The total number of nodes.
unsigned Rx::FileIO::CRxGFFReader::GetVersion ( ) const
bool Rx::FileIO::CRxGFFReader::Open ( const CRxString sxFilename,
const CRxString sxGUID 
)

Open a file in read mode.

Parameters
sxFilenameFilename.
sxGUIDGUID of the file type.
Returns
True if file has given GUID, false if not, exception on error.
void Rx::FileIO::CRxGFFReader::ReadContent ( Interop::Runtime28::IImage pxImg,
const CRxString sxXPath 
)
void Rx::FileIO::CRxGFFReader::ReadContent ( CRxMapping3D pxMapping,
const CRxString sxXPath 
)

Reads a 3D Mapping present at the given file format.

Parameters
pxMapping[out] The mapping 3d data.
sxXPathFull pathname of the mapping 3D.
void Rx::FileIO::CRxGFFReader::ReadContent ( float &  fX,
float &  fY,
float &  fZ,
const CRxString sxXPath 
)

Reads a content containing of three floats.

Parameters
fX[out] First double.
fY[out] Second double.
fZ[out] Third double.
sxXPathFull pathname of the three components.
void Rx::FileIO::CRxGFFReader::ReadContent ( int &  iX,
int &  iY,
int &  iZ,
const CRxString sxXPath 
)

Reads a content containing of thee integer.

Parameters
iX[out] First int.
iY[out] Second int.
iZ[out] Third int.
sxXPathFull pathname of the three components.
float Rx::FileIO::CRxGFFReader::ReadFloatAttribute ( const CRxString sxXPath)

Member Data Documentation

xmlDocPtr Rx::FileIO::CRxGFFReader::m_pXML
protected
xmlNodePtr Rx::FileIO::CRxGFFReader::m_pXmlContentNode
protected
xmlNodePtr Rx::FileIO::CRxGFFReader::m_pXmlMetaNode
protected
unsigned Rx::FileIO::CRxGFFReader::m_uHeaderLength
protected
CFileStream Rx::FileIO::CRxGFFReader::m_xFile
protected