A class that specifies parameters used in animation. More...

#include <animationparams.h>

Inheritance diagram for VAPoR::AnimationParams:

Public Member Functions
long	getCurrentTimestep ()

int	setCurrentTimestep (long ts)

int	getStartTimestep ()

int	setStartTimestep (int ts)

int	getEndTimestep ()

int	setEndTimestep (int val)

int	getMinTimestep ()

int	setMinTimestep (int val)

int	getMaxTimestep ()

int	setMaxTimestep (int val)

int	getPlayDirection ()

int	setPlayDirection (int val)

int	getFrameStepSize ()

int	setFrameStepSize (int val)

double	getMaxFrameRate ()

int	setMaxFrameRate (double rate)

bool	isRepeating ()

int	setRepeating (bool onOff)

int	getMinTimeToRender ()

int	SetCaptureEnabled (bool val)

bool	GetCaptureEnabled ()

int	SetCaptureFilepath (string path)

string	GetCaptureFilepath ()

Internal
Internal methods not intended for general use
	AnimationParams (XmlNode *parent, int winnum)

	~AnimationParams ()
	Destructor. More...

Public Member Functions inherited from VAPoR::Params
	Params (const Params &p)
	Default copy constructor. More...

virtual	~Params ()

virtual const std::string	getShortName ()=0

virtual void	Validate (int type)=0

bool	isRenderParams () const

bool	isBasicParams () const

virtual void	restart ()=0

virtual int	GetVizNum ()

virtual int	SetLocal (bool lg)

virtual bool	IsLocal ()

virtual Box *	GetBox ()

	Params (XmlNode *parent, const string &name, int winNum)

	Params (int winNum, const string &name)
	Deprecated constructor, needed for built-in classes that do not have associated XML node: More...

virtual int	GetInstanceIndex ()

virtual void	SetVizNum (int vnum)

Public Member Functions inherited from VetsUtil::MyBase
	MyBase ()

const string &	getClassName () const

Public Member Functions inherited from VAPoR::ParamsBase
	ParamsBase (XmlNode *parent, const string &name)

	ParamsBase (const string &name)
	Default constructor. More...

	ParamsBase (const ParamsBase &pbase)
	Copy constructor. More...

virtual	~ParamsBase ()
	destructor..destroys the xml tree based at the root node. More...

ParamNode *	GetRootNode () const

const string	GetName () const

virtual long	GetValueLong (const string &tag, const vector< long > &defaultVal=_emptyLongVec)

virtual double	GetValueDouble (const string &tag, const vector< double > &defaultVal=_emptyDoubleVec)

virtual const string	GetValueString (const string &tag, const string &defaultVal=_emptyString)

virtual const vector< long >	GetValueLongVec (const string &tag, const vector< long > &defaultVal=_emptyLongVec)

virtual const vector< double >	GetValueDoubleVec (const string &tag, const vector< double > &defaultVal=_emptyDoubleVec)

virtual void	GetValueStringVec (const string &tag, vector< string > &vec, const vector< string > &defaultVal=_emptyStringVec)

virtual int	SetValueLong (string tag, const char description, long value, Params p)

virtual int	SetValueLong (string tag, const char description, const vector< long > &value, Params p)

virtual int	SetValueDouble (string tag, const char description, double value, Params p)

virtual int	SetValueDouble (string tag, const char description, const vector< double > &value, Params p)

virtual int	SetValueString (string tag, const char description, const string &value, Params p)

virtual int	SetValueStringVec (string tag, const char description, const vector< string > &value, Params p)

ParamsBaseType	GetParamsBaseTypeId ()

virtual void	SetRootParamNode (ParamNode *pn)

ParamsBase *	GetParamsBase (const vector< string > &path) const

int	SetParamsBase (const vector< string > &path, ParamsBase *pbase)

int	RemoveParamsBase (const vector< string > &path, ParamsBase *pbase)

void	SetParent (XmlNode *parent)

virtual bool	elementStartHandler (ExpatParseMgr pm, int depth, string &tag, const char *attribs)

virtual bool	elementEndHandler (ExpatParseMgr *pm, int depth, string &tag)

virtual ParamNode *	buildNode ()

ParamNode *	GetCurrentNode ()

ParamNode *	Push (string &tag, ParamsBase *pBase=0)

ParamNode *	Pop ()

void	Remove (const string &name)

const map< string, string > &	GetAttributes ()

void	Clear ()

Additional Inherited Members
Public Types inherited from VetsUtil::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)

typedef void(*	DiagMsgCB_T) (const char *msg)

Public Types inherited from VAPoR::ParamsBase
typedef int	ParamsBaseType

Static Public Member Functions inherited from VAPoR::Params
static bool	IsRenderingEnabled (int winnum)

static int	GetCurrentParamsInstanceIndex (int pType, int winnum)

static int	GetCurrentParamsInstanceIndex (const std::string tag, int winnum)

static void	SetCurrentParamsInstanceIndex (int pType, int winnum, int instance)

static Params *	GetParamsInstance (int pType, int winnum=-1, int instance=-1)

static Params *	GetParamsInstance (const std::string tag, int winnum=-1, int instance=-1)

static Params *	GetCurrentParamsInstance (int pType, int winnum)

static Params *	GetDefaultParams (ParamsBase::ParamsBaseType pType)

static Params *	GetDefaultParams (const string &tag)

static void	SetDefaultParams (int pType, Params *p)

static void	SetDefaultParams (const string &tag, Params *p)

static Params *	CreateDefaultParams (int pType)

static int	GetNumParamsInstances (int pType, int winnum)

static int	GetNumParamsInstances (const std::string tag, int winnum)

static void	AppendParamsInstance (int pType, int winnum, Params *p)

static void	AppendParamsInstance (const std::string tag, int winnum, Params *p)

static void	RemoveParamsInstance (int pType, int winnum, int instance)

static vector< Params * > &	GetAllParamsInstances (int pType, int winnum)

static int	GetAllParamsInstances (string tag, vector< Params * > &)

static int	DeleteVisualizer (int viznum)

static vector< Params * > &	GetAllParamsInstances (const std::string tag, int winnum)

static map< int, vector< Params * > > *	cloneAllParamsInstances (int winnum)

static vector< Params * > *	cloneAllDefaultParams ()

Static Public Member Functions inherited from VetsUtil::MyBase
static void	SetErrMsg (const char *format,...)
	Record a formatted error message. More...

static void	SetErrMsg (int errcode, const char *format,...)
	Record a formatted error message and an error code. More...

static const char *	GetErrMsg ()

static void	SetErrCode (int err_code)
	Record an error code. More...

static int	GetErrCode ()
	Retrieve the current error code. More...

static void	SetErrMsgCB (ErrMsgCB_T cb)

static ErrMsgCB_T	GetErrMsgCB ()

static void	SetErrMsgFilePtr (FILE *fp)

static const FILE *	SetErrMsgFilePtr ()

static void	SetDiagMsg (const char *format,...)
	Record a formatted diagnostic message. More...

static const char *	GetDiagMsg ()

static void	SetDiagMsgCB (DiagMsgCB_T cb)

static DiagMsgCB_T	GetDiagMsgCB ()

static void	SetDiagMsgFilePtr (FILE *fp)

static bool	EnableErrMsg (bool enable)

Static Public Member Functions inherited from VAPoR::ParamsBase
static ParamsBaseType	GetTypeFromTag (const string &tag)

static const string	GetTagFromType (ParamsBaseType t)

static ParamsBase *	CreateDefaultParamsBase (int pType)

static ParamsBase *	CreateDefaultParamsBase (const string &tag)

static int	RegisterParamsBaseClass (const string &tag, BaseCreateFcn fcn, bool isParams)

static int	ReregisterParamsBaseClass (const string &tag, const string &newtag, bool isParams)

static int	GetNumParamsClasses ()

static int	GetNumBasicParamsClasses ()

static bool	IsParamsTag (const string &tag)

Static Public Attributes inherited from VetsUtil::MyBase
static char *	ErrMsg

static int	ErrCode

static int	ErrMsgSize

static FILE *	ErrMsgFilePtr

static ErrMsgCB_T	ErrMsgCB

static char *	DiagMsg

static int	DiagMsgSize

static FILE *	DiagMsgFilePtr

static DiagMsgCB_T	DiagMsgCB

static bool	Enabled

Protected Member Functions inherited from VAPoR::Params
virtual int	SetValueLong (string tag, const char *description, long value)

virtual int	SetValueLong (string tag, const char *description, const vector< long > &value)

virtual int	SetValueDouble (string tag, const char *description, double value)

virtual int	SetValueDouble (string tag, const char *description, const vector< double > &value)

virtual int	SetValueString (string tag, const char *description, const string &value)

virtual int	SetValueStringVec (string tag, const char *description, const vector< string > &value)

Protected Member Functions inherited from VetsUtil::MyBase
void	SetClassName (const string &name)

Detailed Description

A class that specifies parameters used in animation.

Author: Alan Norton

Version: 3.0

Date: February 2014 When this class is local, it controls the time-steps in one visualizer. The global (shared) AnimationParams controls the animation in any number of visualizers.

Definition at line 46 of file animationparams.h.

Constructor & Destructor Documentation

VAPoR::AnimationParams::AnimationParams	(	XmlNode *	parent,
		int	winnum
	)

Constructor

Parameters

[in] int winnum The number of the visualizer, or -1 for a global AnimationParams

VAPoR::AnimationParams::~AnimationParams ( )

Destructor.

Member Function Documentation

bool VAPoR::AnimationParams::GetCaptureEnabled ( )

inline

Determine if capture is enabled

Returns: true if capture is enabled

Definition at line 172 of file animationparams.h.

string VAPoR::AnimationParams::GetCaptureFilepath ( )

inline

Obtain currently specified file path for animation capture

Returns: current file path for first image of capture sequence

Definition at line 184 of file animationparams.h.

long VAPoR::AnimationParams::getCurrentTimestep ( )

inline

Identify the current data timestep being used

Return values

long	current time step

Definition at line 52 of file animationparams.h.

int VAPoR::AnimationParams::getEndTimestep ( )

inline

Identify the ending time step used during playback

Return values

int	ending timestep

Definition at line 78 of file animationparams.h.

int VAPoR::AnimationParams::getFrameStepSize ( )

inline

Get the maximum frame step size for skipping

Return values

int	current frame step size.

Definition at line 128 of file animationparams.h.

double VAPoR::AnimationParams::getMaxFrameRate ( )

inline

Determine max frames per second

Return values

double max frames per second

Definition at line 139 of file animationparams.h.

int VAPoR::AnimationParams::getMaxTimestep ( )

inline

Identify the maximum time step

Return values

int	maximum timestep

Definition at line 103 of file animationparams.h.

int VAPoR::AnimationParams::getMinTimestep ( )

inline

Identify the minimum time step (bound on setting start/end)

Return values

int	minimum frame number.

Definition at line 91 of file animationparams.h.

int VAPoR::AnimationParams::getMinTimeToRender ( )

inline

Determine the shortest time (in milliseconds) for a render

Return values

int	minimum render time.

Definition at line 162 of file animationparams.h.

int VAPoR::AnimationParams::getPlayDirection ( )

inline

Get the current play direction (-1,0,1)

Return values

int	0 play direction

Definition at line 116 of file animationparams.h.

int VAPoR::AnimationParams::getStartTimestep ( )

inline

Identify the starting time step currently set in the UI.

Return values

int	starting frame number.

Definition at line 65 of file animationparams.h.

bool VAPoR::AnimationParams::isRepeating ( )

inline

Determine if repeat play is on

Return values

bool	true if repeating

Definition at line 150 of file animationparams.h.

int VAPoR::AnimationParams::SetCaptureEnabled ( bool val )

inline

Enable/disable animation capture

Parameters

[in] val true if capture is being enabled

Returns: 0 if successful

Definition at line 167 of file animationparams.h.

int VAPoR::AnimationParams::SetCaptureFilepath ( string path )

inline

Specify the filepath that will begin the next animation capture sequence Can be the name of a tif or jpg file

Parameters

[in] path is full path to file, including digits

Returns: zero if successful

Definition at line 179 of file animationparams.h.

int VAPoR::AnimationParams::setCurrentTimestep ( long ts )

inline

Set the current data timestep being used

Parameters

long	current time step

Return values

int	0 if successful

Definition at line 58 of file animationparams.h.

int VAPoR::AnimationParams::setEndTimestep ( int val )

inline

set the ending time step

Parameters

int	ending timestep

Return values

int	0 if success

Definition at line 84 of file animationparams.h.

int VAPoR::AnimationParams::setFrameStepSize ( int val )

inline

Set the frame step size (for skipping)

Parameters

int	val step size

Return values

int	0 if successful

Definition at line 134 of file animationparams.h.

int VAPoR::AnimationParams::setMaxFrameRate ( double rate )

inline

Set max frames per second

Parameters

double fps

Return values

int	0 if successful

Definition at line 145 of file animationparams.h.

int VAPoR::AnimationParams::setMaxTimestep ( int val )

inline

Set the maximum time step

Parameters

int	maximum timestep

Return values

int	0 if successful

Definition at line 110 of file animationparams.h.

int VAPoR::AnimationParams::setMinTimestep ( int val )

inline

Set the minimum time step (bound on setting start/end)

Parameters

int	minimum timestep

Return values

int	0 if successful

Definition at line 97 of file animationparams.h.

int VAPoR::AnimationParams::setPlayDirection ( int val )

inline

Set the play direction

Parameters

int	play direction

Return values

int	0 if successful

Definition at line 123 of file animationparams.h.

int VAPoR::AnimationParams::setRepeating ( bool onOff )

inline

Set the whether repeat play is on

Parameters

bool	repeat is on if true

Return values

int	0 if successful

Definition at line 156 of file animationparams.h.

int VAPoR::AnimationParams::setStartTimestep ( int ts )

inline

set the starting time step

Parameters

int	starting timestep

Return values

int	0 if successful

Definition at line 71 of file animationparams.h.

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

/Users/clyne/src/vapor-3.0/lib/params/animationparams.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation