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

#include <animationparams.h>

Inheritance diagram for VAPoR::AnimationParams:

Public Member Functions
	AnimationParams (int winnum)

	~AnimationParams ()
	Destructor. More...

int	getCurrentFrameNumber ()

int	getCurrentTimestep ()

int	getStartFrameNumber ()

int	getEndFrameNumber ()

int	getMinTimestep ()

int	getMaxTimestep ()

int	getMinFrame ()

int	getMaxFrame ()

void	setMinTimestep (int minF)

void	setMaxTimestep (int maxF)

Keyframe *	getAnyKeyframe (int index)

void	setAnyKeyframe (int index, Keyframe *k)

Keyframe *	getEditableKeyframe (int editableIndex)

vector< Keyframe * > &	getAllKeyframes ()

void	deleteAnyKeyframe (int index)

void	deleteEditableKeyframe (int editableIndex)

void	rescaleKeyframes (const float ratio[3])

void	insertEditableKeyframe (int editableIndex, Keyframe *keyframe)

void	insertHiddenKeyframe (int index, Keyframe *keyframe)

int	getTotalKeyframeIndex (int editableIndex)

int	getEditableIndex (int index)

int	getTotalNumKeyframes ()

bool	keyframingEnabled ()

void	enableKeyframing (bool onoff)

int	getNumEditableKeyframes ()

Public Member Functions inherited from VAPoR::Params
	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...

	Params (const Params &p)
	Default copy constructor. More...

virtual	~Params ()

virtual const std::string &	getShortName ()=0

virtual bool	isRenderParams ()

virtual Params *	deepCopy (ParamNode *nd=0)

virtual void	restart ()=0
	Pure virtual method, sets a Params instance to its default state. More...

virtual int	getVizNum ()

virtual void	setLocal (bool lg)

bool	isLocal ()

virtual void	setVizNum (int vnum)

virtual void	SetVisualizerNum (int viznum)

virtual int	GetVisualizerNum ()

virtual bool	reinit (bool)

virtual Box *	GetBox ()

virtual int	getOrientation ()

virtual void	calcContainingStretchedBoxExtentsInCube (float extents[6], bool rotated=false)

void	calcRotatedStretchedBoxExtentsInCube (float extents[6])

virtual bool	isDomainConstrained ()

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 ()

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)

ParamNode *	GetRootNode ()

virtual ParamNode *	buildNode ()

void	SetFlagDirty (const string &flag)

const string &	GetName ()

ParamsBaseType	GetParamsBaseTypeId ()

virtual void	SetRootParamNode (ParamNode *pn)

Public Member Functions inherited from VAPoR::ParsedXml
virtual	~ParsedXml ()

virtual bool	elementStartHandler (ExpatParseMgr , int, std::string &, const char *)=0

virtual bool	elementEndHandler (ExpatParseMgr *, int, std::string &)=0

virtual bool	charHandler (ExpatParseMgr , const XML_Char , int)

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 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 void	InsertParamsInstance (int pType, int winnum, int posn, Params *dp)

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

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

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

static vector< Params * > *	cloneAllDefaultParams ()

static bool	IsRenderingEnabled (int winnum)

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 bool	IsParamsTag (const string &tag)

Public Attributes inherited from VAPoR::ParsedXml
ParsedXml *	previousClass

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 VetsUtil::MyBase
void	SetClassName (const string &name)

Protected Member Functions inherited from VAPoR::ParamsBase
virtual ParamNode *	getCurrentParamNode ()

virtual void	setCurrentParamNode (ParamNode *pn)

ParamNode *	GetCurrentNode ()

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

ParamNode *	Pop ()

void	Remove (const string &name)

const map< string, string > &	GetAttributes ()

void	Clear ()

Protected Attributes inherited from VAPoR::ParamsBase
string	_paramsBaseName

int	_parseDepth

Static Protected Attributes inherited from VAPoR::ParamsBase
static vector< ParamsBase * >	dummyParamsBaseInstances

static const string	_emptyString

static map< string, int >	classIdFromTagMap

static map< int, string >	tagFromClassIdMap

static map< int, BaseCreateFcn >	createDefaultFcnMap

static int	numParamsClasses

static int	numEmbedClasses

Static Protected Attributes inherited from VAPoR::ParsedXml
static const string	_stringType

static const string	_longType

static const string	_doubleType

static const string	_typeAttr

Detailed Description

A class that specifies parameters used in animation.

Author: Alan Norton

Version: $Revision$

Date: $Date$ 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 44 of file animationparams.h.

Constructor & Destructor Documentation

VAPoR::AnimationParams::AnimationParams ( 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

void VAPoR::AnimationParams::deleteAnyKeyframe ( int index )

void VAPoR::AnimationParams::deleteEditableKeyframe ( int editableIndex )

void VAPoR::AnimationParams::enableKeyframing ( bool onoff )

vector<Keyframe*>& VAPoR::AnimationParams::getAllKeyframes ( )

inline

Definition at line 119 of file animationparams.h.

Keyframe* VAPoR::AnimationParams::getAnyKeyframe ( int index )

inline

Definition at line 116 of file animationparams.h.

int VAPoR::AnimationParams::getCurrentFrameNumber ( )

inline

Identify the current frame being rendered

Return values

int	current frame number

Definition at line 55 of file animationparams.h.

int VAPoR::AnimationParams::getCurrentTimestep ( )

inline

Identify the current data timestep being used

Return values

size_t current time step

Definition at line 64 of file animationparams.h.

int VAPoR::AnimationParams::getEditableIndex ( int index )

Keyframe* VAPoR::AnimationParams::getEditableKeyframe ( int editableIndex )

inline

Definition at line 118 of file animationparams.h.

int VAPoR::AnimationParams::getEndFrameNumber ( )

inline

Identify the ending frame number as currently set in the UI.

Return values

int	ending frame number.

Definition at line 80 of file animationparams.h.

int VAPoR::AnimationParams::getMaxFrame ( )

inline

Identify the maximum frame number

Return values

int	maximum frame number.

Definition at line 102 of file animationparams.h.

int VAPoR::AnimationParams::getMaxTimestep ( )

inline

Identify the maximum frame number

Return values

int	maximum frame number.

Definition at line 91 of file animationparams.h.

int VAPoR::AnimationParams::getMinFrame ( )

inline

Identify the minimum frame number

Return values

int	minimum frame number.

Definition at line 95 of file animationparams.h.

int VAPoR::AnimationParams::getMinTimestep ( )

inline

Identify the minimum frame number

Return values

int	minimum frame number.

Definition at line 87 of file animationparams.h.

int VAPoR::AnimationParams::getNumEditableKeyframes ( )

inline

Definition at line 139 of file animationparams.h.

int VAPoR::AnimationParams::getStartFrameNumber ( )

inline

Identify the starting frame number currently set in the UI.

Return values

int	starting frame number.

Definition at line 73 of file animationparams.h.

int VAPoR::AnimationParams::getTotalKeyframeIndex ( int editableIndex )

inline

Definition at line 129 of file animationparams.h.

int VAPoR::AnimationParams::getTotalNumKeyframes ( )

inline

Definition at line 136 of file animationparams.h.

void VAPoR::AnimationParams::insertEditableKeyframe	(	int	editableIndex,
		Keyframe *	keyframe
	)

void VAPoR::AnimationParams::insertHiddenKeyframe	(	int	index,
		Keyframe *	keyframe
	)

bool VAPoR::AnimationParams::keyframingEnabled ( )

inline

Definition at line 137 of file animationparams.h.

void VAPoR::AnimationParams::rescaleKeyframes ( const float ratio[3] )

void VAPoR::AnimationParams::setAnyKeyframe	(	int	index,
		Keyframe *	k
	)

inline

Definition at line 117 of file animationparams.h.

void VAPoR::AnimationParams::setMaxTimestep ( int maxF )

inline

Identify the maximum frame number

Parameters

[in] int maximum frame number.

Definition at line 114 of file animationparams.h.

void VAPoR::AnimationParams::setMinTimestep ( int minF )

inline

Set the minimum frame number

Parameters

[in] int minimum frame number.

Definition at line 110 of file animationparams.h.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation