---

TxqMovieParams Class Reference

This class create a movie menu and helper methods for the movie parameters. More...

#include <TxqMovieParams.h>

Inheritance diagram for TxqMovieParams::

List of all members.

Public Slots
void	getIterPerMovieUpdate ()
	slot to get the number of iterations per movie update The default is 0, which will cause no movie frames to be generated. More...
void	getMaxMovieIters ()
	slot to get the maximum number of movie frames. More...
QString	getMovieConfigFileDlog ()
	slot to get the output movie config filename and directory. More...
void	getMovieImageFileDlog ()
	slot to get the movie image file output directory and type. More...
Public Methods
	TxqMovieParams (TxqMasterIoFrame *parent)
	The TxqMovieParams constructor takes a TxqMasterIoFrame parent in order to acces txcout and txcerr and in order for the dialog widgets to have a parent widget. More...
virtual	~TxqMovieParams ()
	The TxqMovieParams destructor. More...
QPopupMenu*	getMovieMenu ()
	Get the movie menu. More...
bool	getMovieFlag ()
	Get the movie flag. More...
void	setBaseName (QString b)
	Set the base name for the movie files, For example, if an input file 'dring.inp' is used, then the baseName is 'dring'. More...
QString	getMovieImageFileName (QString windowName, int currentStep=0)
	Get the movie image filename. More...
void	writeMovieConfig (TxqMovieConfigSet &movieConfigSet)
	Write the movie config file. More...
int	getMaxMovieItersValue ()
	Get the maximum movie iterations. More...
int	getIterPerMovieUpdateValue ()
	Get the iterations per movie update, the number of iterations before a movie file can be written. More...
QString	getImageExt ()
	Get the image extension value. More...
Protected Methods
void	createMovieMenu ()
	Create the Movie menu. More...
QString	getMovieDir (QString ext)
	Get the movie directory. More...
Protected Attributes
int	iterPerMovieUpdate
	The number of iterations per movie output the default is 0 which is 0 frame output. More...
int	maxMovieIters
	The maximum number of move frames. More...
Private Methods
	TxqMovieParams ()
	The default constructor is private in order to not be used. More...
Private Attributes
TxqMasterIoFrame*	parent
	The parent widget. More...
TxqLog*	txcerr
	The output error widget. More...
TxqLog*	txcout
	The output widget. More...
QPopupMenu*	movieMenu
	The Movies popup menu. More...
QString	movieConfigFileName
	The movie config filename. More...
QString	imageFileName
	The movie image filename. More...
QString	imageExt
	The movie image filename extension in upper case, for example ".PPM". More...
QString	imagePrefix
	The movie image filename prefix including absolute path directory. More...
QString	baseName
	The base name of the input filename. More...
bool	movie
	The movie flag. More...
int	movieFrameCount
	The movie frame count. More...
int	frameNumber
	The frame number. More...

---

Detailed Description

This class create a movie menu and helper methods for the movie parameters.

Copyright 2000 by Tech-X Corporation

Author:

Kelly G. Luetkemeyer

Version:

Id:

TxqMovieParams.h,v 1.5 2001/10/16 17:11:50 kgl Exp

Definition at line 40 of file TxqMovieParams.h.

---

Constructor & Destructor Documentation

TxqMovieParams::TxqMovieParams ( TxqMasterIoFrame * parent )

The TxqMovieParams constructor takes a TxqMasterIoFrame parent in order to acces txcout and txcerr and in order for the dialog widgets to have a parent widget. Parameters: parent   The parent Qt widget which is used as in input to the dialog widgets.

TxqMovieParams::~TxqMovieParams ( ) [virtual]

The TxqMovieParams destructor.

TxqMovieParams::TxqMovieParams ( ) [private]

The default constructor is private in order to not be used.

---

Member Function Documentation

void TxqMovieParams::createMovieMenu ( ) [protected]

Create the Movie menu.

QString TxqMovieParams::getImageExt ( )

Get the image extension value. Returns: the image filename extension.

void TxqMovieParams::getIterPerMovieUpdate ( ) [slot]

slot to get the number of iterations per movie update The default is 0, which will cause no movie frames to be generated. Set to a value greater than 0 for movies frames to be produced, for example, a value of 2 will create a frame at every other iteration.

int TxqMovieParams::getIterPerMovieUpdateValue ( )

Get the iterations per movie update, the number of iterations before a movie file can be written. Returns: the number of iterations before updating.

void TxqMovieParams::getMaxMovieIters ( ) [slot]

slot to get the maximum number of movie frames. The default is 0 which set the frame count to unlimited and will be terminated only when the application quits or movie generation is turned off.

int TxqMovieParams::getMaxMovieItersValue ( )

Get the maximum movie iterations. Returns: the maximum number of movie iterations.

QString TxqMovieParams::getMovieConfigFileDlog ( ) [slot]

slot to get the output movie config filename and directory.

QString TxqMovieParams::getMovieDir ( QString ext ) [protected]

Get the movie directory. Parameters: ext   the movie directory extension, ie "_movie" Returns: the QString name of the movie directory.

bool TxqMovieParams::getMovieFlag ( )

Get the movie flag. The movie flag must be set to true to output any movie frames. Returns: the movie flag

void TxqMovieParams::getMovieImageFileDlog ( ) [slot]

slot to get the movie image file output directory and type.

QString TxqMovieParams::getMovieImageFileName ( QString windowName, int currentStep = 0 )

Get the movie image filename. Parameters: windowName   the input window name to construct the image filename currentStep   the current step defaulted to 0

QPopupMenu * TxqMovieParams::getMovieMenu ( )

Get the movie menu.

void TxqMovieParams::setBaseName ( QString b )

Set the base name for the movie files, For example, if an input file 'dring.inp' is used, then the baseName is 'dring'. Parameters: b   the base name

void TxqMovieParams::writeMovieConfig ( TxqMovieConfigSet & movieConfigSet )

Write the movie config file. Parameters: movieConfigSet   the movie config set to write out.

---

Member Data Documentation

QString TxqMovieParams::baseName [private]

The base name of the input filename. Definition at line 223 of file TxqMovieParams.h.

int TxqMovieParams::frameNumber [private]

The frame number. Definition at line 240 of file TxqMovieParams.h.

QString TxqMovieParams::imageExt [private]

The movie image filename extension in upper case, for example ".PPM". Definition at line 213 of file TxqMovieParams.h.

QString TxqMovieParams::imageFileName [private]

The movie image filename. Definition at line 207 of file TxqMovieParams.h.

QString TxqMovieParams::imagePrefix [private]

The movie image filename prefix including absolute path directory. Definition at line 218 of file TxqMovieParams.h.

int TxqMovieParams::iterPerMovieUpdate [protected]

The number of iterations per movie output the default is 0 which is 0 frame output. Definition at line 164 of file TxqMovieParams.h.

int TxqMovieParams::maxMovieIters [protected]

The maximum number of move frames. The default 0 which is unlimited. Definition at line 170 of file TxqMovieParams.h.

bool TxqMovieParams::movie [private]

The movie flag. The movie flag is set to true if the application is saving frames in order to animate. Definition at line 230 of file TxqMovieParams.h.

QString TxqMovieParams::movieConfigFileName [private]

The movie config filename. Definition at line 202 of file TxqMovieParams.h.

int TxqMovieParams::movieFrameCount [private]

The movie frame count. Definition at line 235 of file TxqMovieParams.h.

QPopupMenu * TxqMovieParams::movieMenu [private]

The Movies popup menu. Definition at line 197 of file TxqMovieParams.h.

TxqMasterIoFrame * TxqMovieParams::parent [private]

The parent widget. Definition at line 182 of file TxqMovieParams.h.

TxqLog * TxqMovieParams::txcerr [private]

The output error widget. Definition at line 187 of file TxqMovieParams.h.

TxqLog * TxqMovieParams::txcout [private]

The output widget. Definition at line 192 of file TxqMovieParams.h.

---

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

• TxqMovieParams.h

Copyright Tech-X Corporation, all rights reserved.