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 (CRxImage &xImg, 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

CRxGFFReader()

Rx::FileIO::CRxGFFReader::CRxGFFReader

(

)

Default constructor.

~CRxGFFReader()

Rx::FileIO::CRxGFFReader::~CRxGFFReader

(

)

Destructor.

Member Function Documentation

Close()

void Rx::FileIO::CRxGFFReader::Close

(

)

Closes the file read operation.

CountContentNodes()

size_t Rx::FileIO::CRxGFFReader::CountContentNodes

(

const CRxString &

sxXPath

)

const

Count nodes.

Parameters

sxXPath

XPath.

Returns

The total number of nodes.

GetVersion()

unsigned Rx::FileIO::CRxGFFReader::GetVersion

(

)

const

Open()

bool Rx::FileIO::CRxGFFReader::Open	(	const CRxString &	sxFilename,
		const CRxString &	sxGUID
	)

Open a file in read mode.

Parameters

sxFilename	Filename.
sxGUID	GUID of the file type.

Returns

True if file has given GUID, false if not, exception on error.

ReadContent() [1/4]

void Rx::FileIO::CRxGFFReader::ReadContent	(	CRxImage &	xImg,
		const CRxString &	sxXPath
	)

ReadContent() [2/4]

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.
sxXPath	Full pathname of the mapping 3D.

ReadContent() [3/4]

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.
sxXPath	Full pathname of the three components.

ReadContent() [4/4]

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.
sxXPath	Full pathname of the three components.

ReadFloatAttribute()

float Rx::FileIO::CRxGFFReader::ReadFloatAttribute

(

const CRxString &

sxXPath

)

Member Data Documentation

m_pXML

xmlDocPtr Rx::FileIO::CRxGFFReader::m_pXML

protected

m_pXmlContentNode

xmlNodePtr Rx::FileIO::CRxGFFReader::m_pXmlContentNode

protected

m_pXmlMetaNode

xmlNodePtr Rx::FileIO::CRxGFFReader::m_pXmlMetaNode

protected

m_uHeaderLength

unsigned Rx::FileIO::CRxGFFReader::m_uHeaderLength

protected

m_xFile

CFileStream Rx::FileIO::CRxGFFReader::m_xFile

protected