vtkPVComparativeAnimationCue Class Reference

cue used for parameter animation by the comparative view. More...

#include <vtkPVComparativeAnimationCue.h>

Inheritance diagram for vtkPVComparativeAnimationCue:

Collaboration diagram for vtkPVComparativeAnimationCue:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	UpdateAnimatedValue (int x, int y, int dx, int dy)
double *	GetValues (int x, int y, int dx, int dy, unsigned int &numValues)
vtkPVXMLElement *	AppendCommandInfo (vtkPVXMLElement *proxyElem)
int	LoadCommandInfo (vtkPVXMLElement *proxyElement)
void	SetAnimatedProxy (vtkSMProxy *)
virtual vtkSMProxy *	GetAnimatedProxy ()
void	RemoveAnimatedProxy ()
virtual void	SetAnimatedPropertyName (const char *)
virtual char *	GetAnimatedPropertyName ()
virtual void	SetAnimatedDomainName (const char *)
virtual char *	GetAnimatedDomainName ()
virtual void	SetAnimatedElement (int)
virtual int	GetAnimatedElement ()
virtual void	SetEnabled (bool)
virtual bool	GetEnabled ()
virtual void	EnabledOn ()
virtual void	EnabledOff ()
void	UpdateXRange (int y, double minx, double maxx)
void	UpdateYRange (int x, double miny, double maxy)
void	UpdateWholeRange (double mint, double maxt)
void	UpdateValue (int x, int y, double value)
void	UpdateXRange (int y, double *minx, double *maxx, unsigned int numvalues)
void	UpdateYRange (int x, double *minx, double *maxx, unsigned int numvalues)
void	UpdateWholeRange (double *mint, double *maxt, unsigned int numValues)
void	UpdateWholeRange (double *mint, double *maxt, unsigned int numValues, bool vertical_first)
void	UpdateValue (int x, int y, double *value, unsigned int numValues)
double	GetValue (int x, int y, int dx, int dy)
Static Public Member Functions
static vtkPVComparativeAnimationCue *	New ()
static int	IsTypeOf (const char *type)
static vtkPVComparativeAnimationCue *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPVComparativeAnimationCue ()
	~vtkPVComparativeAnimationCue ()
vtkSMProperty *	GetAnimatedProperty ()
vtkSMDomain *	GetAnimatedDomain ()
Protected Attributes
vtkSMProxy *	AnimatedProxy
int	AnimatedElement
char *	AnimatedPropertyName
char *	AnimatedDomainName
double *	Values
bool	Enabled

---

Detailed Description

cue used for parameter animation by the comparative view.

vtkPVComparativeAnimationCue is a animation cue used for parameter animation by the ComparativeView. It provides a non-conventional API i.e. without using properties to allow the user to setup parameter values over the comparative grid.

Definition at line 35 of file vtkPVComparativeAnimationCue.h.

---

Constructor & Destructor Documentation

vtkPVComparativeAnimationCue::vtkPVComparativeAnimationCue

(

)

[protected]

vtkPVComparativeAnimationCue::~vtkPVComparativeAnimationCue

(

)

[protected]

---

Member Function Documentation

static vtkPVComparativeAnimationCue* vtkPVComparativeAnimationCue::New

(

)

[static]

Reimplemented from vtkObject.

virtual const char* vtkPVComparativeAnimationCue::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkPVComparativeAnimationCue::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkObject.

virtual int vtkPVComparativeAnimationCue::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkObject.

static vtkPVComparativeAnimationCue* vtkPVComparativeAnimationCue::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkObject.

void vtkPVComparativeAnimationCue::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Reimplemented from vtkObject.

void vtkPVComparativeAnimationCue::SetAnimatedProxy

(

vtkSMProxy *

)

Set/Get the animated proxy.

virtual vtkSMProxy* vtkPVComparativeAnimationCue::GetAnimatedProxy

(

)

[virtual]

Set/Get the animated proxy.

void vtkPVComparativeAnimationCue::RemoveAnimatedProxy

(

)

Set/Get the animated proxy.

virtual void vtkPVComparativeAnimationCue::SetAnimatedPropertyName

(

const char *

)

[virtual]

Set/Get the animated property name.

virtual char* vtkPVComparativeAnimationCue::GetAnimatedPropertyName

(

)

[virtual]

Set/Get the animated property name.

virtual void vtkPVComparativeAnimationCue::SetAnimatedDomainName

(

const char *

)

[virtual]

Set/Get the animated domain name.

virtual char* vtkPVComparativeAnimationCue::GetAnimatedDomainName

(

)

[virtual]

Set/Get the animated domain name.

virtual void vtkPVComparativeAnimationCue::SetAnimatedElement

(

int

)

[virtual]

The index of the element of the property this cue animates. If the index is -1, the cue will animate all the elements of the animated property.

virtual int vtkPVComparativeAnimationCue::GetAnimatedElement

(

)

[virtual]

The index of the element of the property this cue animates. If the index is -1, the cue will animate all the elements of the animated property.

virtual void vtkPVComparativeAnimationCue::SetEnabled

(

bool

)

[virtual]

Enable/Disable the cue.

virtual bool vtkPVComparativeAnimationCue::GetEnabled

(

)

[virtual]

Enable/Disable the cue.

virtual void vtkPVComparativeAnimationCue::EnabledOn

(

)

[virtual]

Enable/Disable the cue.

virtual void vtkPVComparativeAnimationCue::EnabledOff

(

)

[virtual]

Enable/Disable the cue.

void vtkPVComparativeAnimationCue::UpdateXRange	(	int	y,
		double	minx,
		double	maxx
	)		[inline]

Methods use to fill up the values for the parameter over the comparative grid. These are order dependent methods i.e. the result of calling UpdateXRange() and then UpdateYRange() are different from calling UpdateYRange() and then UpdateXRange(). These methods are convenience methods when the value can only be a single value.

Definition at line 82 of file vtkPVComparativeAnimationCue.h.

void vtkPVComparativeAnimationCue::UpdateYRange	(	int	x,
		double	miny,
		double	maxy
	)		[inline]

Methods use to fill up the values for the parameter over the comparative grid. These are order dependent methods i.e. the result of calling UpdateXRange() and then UpdateYRange() are different from calling UpdateYRange() and then UpdateXRange(). These methods are convenience methods when the value can only be a single value.

Definition at line 84 of file vtkPVComparativeAnimationCue.h.

void vtkPVComparativeAnimationCue::UpdateWholeRange	(	double	mint,
		double	maxt
	)		[inline]

Methods use to fill up the values for the parameter over the comparative grid. These are order dependent methods i.e. the result of calling UpdateXRange() and then UpdateYRange() are different from calling UpdateYRange() and then UpdateXRange(). These methods are convenience methods when the value can only be a single value.

Definition at line 86 of file vtkPVComparativeAnimationCue.h.

void vtkPVComparativeAnimationCue::UpdateValue	(	int	x,
		int	y,
		double	value
	)		[inline]

Methods use to fill up the values for the parameter over the comparative grid. These are order dependent methods i.e. the result of calling UpdateXRange() and then UpdateYRange() are different from calling UpdateYRange() and then UpdateXRange(). These methods are convenience methods when the value can only be a single value.

Definition at line 88 of file vtkPVComparativeAnimationCue.h.

void vtkPVComparativeAnimationCue::UpdateXRange	(	int	y,
		double *	minx,
		double *	maxx,
		unsigned int	numvalues
	)

Use these methods when the parameter can have multiple values eg. IsoValues for the Contour filter. The "AnimatedElement" for such properties must be set to -1, otherwise UpdateAnimatedValue() will raise an error.

void vtkPVComparativeAnimationCue::UpdateYRange	(	int	x,
		double *	minx,
		double *	maxx,
		unsigned int	numvalues
	)

Use these methods when the parameter can have multiple values eg. IsoValues for the Contour filter. The "AnimatedElement" for such properties must be set to -1, otherwise UpdateAnimatedValue() will raise an error.

void vtkPVComparativeAnimationCue::UpdateWholeRange	(	double *	mint,
		double *	maxt,
		unsigned int	numValues
	)		[inline]

Use these methods when the parameter can have multiple values eg. IsoValues for the Contour filter. The "AnimatedElement" for such properties must be set to -1, otherwise UpdateAnimatedValue() will raise an error.

Definition at line 99 of file vtkPVComparativeAnimationCue.h.

void vtkPVComparativeAnimationCue::UpdateWholeRange	(	double *	mint,
		double *	maxt,
		unsigned int	numValues,
		bool	vertical_first
	)

Use these methods when the parameter can have multiple values eg. IsoValues for the Contour filter. The "AnimatedElement" for such properties must be set to -1, otherwise UpdateAnimatedValue() will raise an error.

void vtkPVComparativeAnimationCue::UpdateValue	(	int	x,
		int	y,
		double *	value,
		unsigned int	numValues
	)

Use these methods when the parameter can have multiple values eg. IsoValues for the Contour filter. The "AnimatedElement" for such properties must be set to -1, otherwise UpdateAnimatedValue() will raise an error.

void vtkPVComparativeAnimationCue::UpdateAnimatedValue	(	int	x,
		int	y,
		int	dx,
		int	dy
	)

Update the animated property's value based on those specified using the Update.* methods. (x,y) is the location in the comparative grid, while (dx, dy) are the dimensions of the comparative grid.

double vtkPVComparativeAnimationCue::GetValue	(	int	x,
		int	y,
		int	dx,
		int	dy
	)		[inline]

Computes the value for a particular location in the comparative grid. (x,y) is the location in the comparative grid, while (dx, dy) are the dimensions of the comparative grid.

Definition at line 117 of file vtkPVComparativeAnimationCue.h.

double* vtkPVComparativeAnimationCue::GetValues	(	int	x,
		int	y,
		int	dx,
		int	dy,
		unsigned int &	numValues
	)

NOTE: Returned values is only valid until the next call to this method. Return value is only valid when numValues > 0.

vtkPVXMLElement* vtkPVComparativeAnimationCue::AppendCommandInfo

(

vtkPVXMLElement *

proxyElem

)

int vtkPVComparativeAnimationCue::LoadCommandInfo

(

vtkPVXMLElement *

proxyElement

)

vtkSMProperty* vtkPVComparativeAnimationCue::GetAnimatedProperty

(

)

[protected]

Get the property being animated.

vtkSMDomain* vtkPVComparativeAnimationCue::GetAnimatedDomain

(

)

[protected]

Get the domain being animated.

---

Member Data Documentation

vtkSMProxy* vtkPVComparativeAnimationCue::AnimatedProxy [protected]

Definition at line 147 of file vtkPVComparativeAnimationCue.h.

int vtkPVComparativeAnimationCue::AnimatedElement [protected]

Definition at line 148 of file vtkPVComparativeAnimationCue.h.

char* vtkPVComparativeAnimationCue::AnimatedPropertyName [protected]

Definition at line 149 of file vtkPVComparativeAnimationCue.h.

char* vtkPVComparativeAnimationCue::AnimatedDomainName [protected]

Definition at line 150 of file vtkPVComparativeAnimationCue.h.

double* vtkPVComparativeAnimationCue::Values [protected]

Definition at line 151 of file vtkPVComparativeAnimationCue.h.

bool vtkPVComparativeAnimationCue::Enabled [protected]

Definition at line 152 of file vtkPVComparativeAnimationCue.h.

---

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

• dox/ParaViewCore/ServerManager/vtkPVComparativeAnimationCue.h