ciMoviePlayer Class Reference

Public Member Functions
double	getFrameRate ()
void	setFrameRate (double rate)
int	getOpenFrameCount ()
void	setOpenFrameCount (int framecount)
char *	getOpenFile ()
void	setOpenFile (char *openFile)
int	getCurrentFrame ()
void	setCurrentFrame (int currentFrame)
bool	archive (std::ofstream &outf)
bool	serialize (char *filepath)
bool	loadXML (clXMLNode *trackNode)
bool	parseXML (clXML &xmlDocument)
bool	loadXMLNode (std::string tag, char *nodeString)
bool	loadXMLNode (std::string tag, bool *nodeBool)
bool	loadXMLNode (std::string tag, int *nodeBool)
bool	loadXMLNode (std::string tag, double *nodeBool)
void	saveXML (clXML *xmlDocument)
ciMoviePlayer	operator= (ciMoviePlayer &obj)
	ciMoviePlayer ()
	ciMoviePlayer (ciMoviePlayer &obj)
virtual	~ciMoviePlayer ()
	destructor

Protected Attributes
double	m_frameRate
int	m_currentFrame
int	m_openFrameCount
char	m_openFile [256]
clXMLNode *	m_parentNode

Detailed Description

ciTrack class declaration

Constructor & Destructor Documentation

ciMoviePlayer::ciMoviePlayer

(

)

Default constructor.

ciMoviePlayer::ciMoviePlayer

(

ciMoviePlayer &

obj

)

Copy constructor.

Parameters

obj	- ciTrack object to be copied.

virtual ciMoviePlayer::~ciMoviePlayer ( )

virtual

destructor

Member Function Documentation

double ciMoviePlayer::getFrameRate ( )

inline

gets the frame rate that used in movie playback

Returns

The frame rate amount.

void ciMoviePlayer::setFrameRate ( double  rate )

inline

sets the frame rate that used in movie playback

Parameters

rate	- The frame rate to be assigned.

Returns

void.

int ciMoviePlayer::getOpenFrameCount ( )

inline

Returns

int

void ciMoviePlayer::setOpenFrameCount ( int  framecount )

inline

Parameters

int	framecount

char* ciMoviePlayer::getOpenFile

(

)

Returns

char

void ciMoviePlayer::setOpenFile

(

char *

openFile

)

Parameters

char*

openFile

int ciMoviePlayer::getCurrentFrame ( )

inline

Returns

int

void ciMoviePlayer::setCurrentFrame ( int  currentFrame )

inline

Parameters

int	currentFrame

bool ciMoviePlayer::archive

(

std::ofstream &

outf

)

Description:

Saves the ciTrack object to file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

bool ciMoviePlayer::serialize

(

char *

filepath

)

Description:

Loads the ciTrack object from file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

bool ciMoviePlayer::loadXML

(

clXMLNode *

trackNode

)

bool ciMoviePlayer::parseXML

(

clXML &

xmlDocument

)

bool ciMoviePlayer::loadXMLNode	(	std::string	tag,
		char *	nodeString
	)

Parameters

std::string	tag
char	*nodeString

Returns

bool

bool ciMoviePlayer::loadXMLNode	(	std::string	tag,
		bool *	nodeBool
	)

Parameters

std::string	tag
bool	*nodeBool

Returns

bool

bool ciMoviePlayer::loadXMLNode	(	std::string	tag,
		int *	nodeBool
	)

Parameters

std::string	tag
int	*nodeBool

Returns

bool

bool ciMoviePlayer::loadXMLNode	(	std::string	tag,
		double *	nodeBool
	)

Parameters

std::string	tag
double	*nodeBool

Returns

bool

void ciMoviePlayer::saveXML

(

clXML *

xmlDocument

)

ciMoviePlayer ciMoviePlayer::operator=

(

ciMoviePlayer &

obj

)

Assignment operator.

Parameters

obj	- ciTrack object to be assigned.

Returns

The assigned ciTrack object.

Member Data Documentation

double ciMoviePlayer::m_frameRate

protected

Movie Player file frame rate time

int ciMoviePlayer::m_currentFrame

protected

int ciMoviePlayer::m_openFrameCount

protected

simulation framecount

char ciMoviePlayer::m_openFile[256]

protected

clXMLNode* ciMoviePlayer::m_parentNode

protected

---

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

• ciMoviePlayer.h