ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVComparativeAnimationCue Class Reference

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

#include <vtkPVComparativeAnimationCue.h>

Inherits vtkObject.

Collaboration diagram for vtkPVComparativeAnimationCue:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void UpdateXRange (int y, double minx, double maxx)
 Methods use to fill up the values for the parameter over the comparative grid. More...
 
void UpdateYRange (int x, double miny, double maxy)
 
void UpdateWholeRange (double mint, double maxt)
 
void UpdateValue (int x, int y, double value)
 
void UpdateAnimatedValue (int x, int y, int dx, int dy)
 Update the animated property's value based on those specified using the Update. More...
 
double * 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. More...
 
vtkPVXMLElementAppendCommandInfo (vtkPVXMLElement *proxyElem)
 
int LoadCommandInfo (vtkPVXMLElement *proxyElement)
 
void SetAnimatedProxy (vtkSMProxy *)
 Set/Get the animated proxy. More...
 
virtual vtkSMProxyGetAnimatedProxy ()
 Set/Get the animated proxy. More...
 
void RemoveAnimatedProxy ()
 Set/Get the animated proxy. More...
 
virtual void SetAnimatedPropertyName (const char *)
 Set/Get the animated property name. More...
 
virtual char * GetAnimatedPropertyName ()
 Set/Get the animated property name. More...
 
virtual void SetAnimatedDomainName (const char *)
 Set/Get the animated domain name. More...
 
virtual char * GetAnimatedDomainName ()
 Set/Get the animated domain name. More...
 
virtual void SetAnimatedElement (int)
 The index of the element of the property this cue animates. More...
 
virtual int GetAnimatedElement ()
 The index of the element of the property this cue animates. More...
 
virtual void SetEnabled (bool)
 Enable/Disable the cue. More...
 
virtual bool GetEnabled ()
 Enable/Disable the cue. More...
 
virtual void EnabledOn ()
 Enable/Disable the cue. More...
 
virtual void EnabledOff ()
 Enable/Disable the cue. More...
 
void UpdateXRange (int y, double *minx, double *maxx, unsigned int numvalues)
 Use these methods when the parameter can have multiple values eg. More...
 
void UpdateYRange (int x, double *minx, double *maxx, unsigned int numvalues)
 Use these methods when the parameter can have multiple values eg. More...
 
void UpdateWholeRange (double *mint, double *maxt, unsigned int numValues)
 Use these methods when the parameter can have multiple values eg. More...
 
void UpdateWholeRange (double *mint, double *maxt, unsigned int numValues, bool vertical_first)
 Use these methods when the parameter can have multiple values eg. More...
 
void UpdateValue (int x, int y, double *value, unsigned int numValues)
 Use these methods when the parameter can have multiple values eg. More...
 
double GetValue (int x, int y, int dx, int dy)
 Computes the value for a particular location in the comparative grid. More...
 

Static Public Member Functions

static vtkPVComparativeAnimationCueNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVComparativeAnimationCueSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVComparativeAnimationCue ()
 
 ~vtkPVComparativeAnimationCue ()
 
vtkSMPropertyGetAnimatedProperty ()
 Get the property being animated. More...
 
vtkSMDomainGetAnimatedDomain ()
 Get the domain being animated. More...
 

Protected Attributes

vtkSMProxyAnimatedProxy
 
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 37 of file vtkPVComparativeAnimationCue.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkPVComparativeAnimationCue.h.

Constructor & Destructor Documentation

◆ vtkPVComparativeAnimationCue()

vtkPVComparativeAnimationCue::vtkPVComparativeAnimationCue ( )
protected

◆ ~vtkPVComparativeAnimationCue()

vtkPVComparativeAnimationCue::~vtkPVComparativeAnimationCue ( )
protected

Member Function Documentation

◆ New()

static vtkPVComparativeAnimationCue* vtkPVComparativeAnimationCue::New ( )
static

◆ GetClassName()

virtual const char* vtkPVComparativeAnimationCue::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkPVComparativeAnimationCue::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVComparativeAnimationCue::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkPVComparativeAnimationCue* vtkPVComparativeAnimationCue::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

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

◆ SetAnimatedProxy()

void vtkPVComparativeAnimationCue::SetAnimatedProxy ( vtkSMProxy )

Set/Get the animated proxy.

◆ GetAnimatedProxy()

virtual vtkSMProxy* vtkPVComparativeAnimationCue::GetAnimatedProxy ( )
virtual

Set/Get the animated proxy.

◆ RemoveAnimatedProxy()

void vtkPVComparativeAnimationCue::RemoveAnimatedProxy ( )

Set/Get the animated proxy.

◆ SetAnimatedPropertyName()

virtual void vtkPVComparativeAnimationCue::SetAnimatedPropertyName ( const char *  )
virtual

Set/Get the animated property name.

◆ GetAnimatedPropertyName()

virtual char* vtkPVComparativeAnimationCue::GetAnimatedPropertyName ( )
virtual

Set/Get the animated property name.

◆ SetAnimatedDomainName()

virtual void vtkPVComparativeAnimationCue::SetAnimatedDomainName ( const char *  )
virtual

Set/Get the animated domain name.

◆ GetAnimatedDomainName()

virtual char* vtkPVComparativeAnimationCue::GetAnimatedDomainName ( )
virtual

Set/Get the animated domain name.

◆ SetAnimatedElement()

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.

◆ GetAnimatedElement()

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.

◆ SetEnabled()

virtual void vtkPVComparativeAnimationCue::SetEnabled ( bool  )
virtual

Enable/Disable the cue.

◆ GetEnabled()

virtual bool vtkPVComparativeAnimationCue::GetEnabled ( )
virtual

Enable/Disable the cue.

◆ EnabledOn()

virtual void vtkPVComparativeAnimationCue::EnabledOn ( )
virtual

Enable/Disable the cue.

◆ EnabledOff()

virtual void vtkPVComparativeAnimationCue::EnabledOff ( )
virtual

Enable/Disable the cue.

◆ UpdateXRange() [1/2]

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 96 of file vtkPVComparativeAnimationCue.h.

◆ UpdateYRange() [1/2]

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

Definition at line 97 of file vtkPVComparativeAnimationCue.h.

◆ UpdateWholeRange() [1/3]

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

Definition at line 98 of file vtkPVComparativeAnimationCue.h.

◆ UpdateValue() [1/2]

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

Definition at line 99 of file vtkPVComparativeAnimationCue.h.

◆ UpdateXRange() [2/2]

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.

◆ UpdateYRange() [2/2]

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.

◆ UpdateWholeRange() [2/3]

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 109 of file vtkPVComparativeAnimationCue.h.

◆ UpdateWholeRange() [3/3]

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.

◆ UpdateValue() [2/2]

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.

◆ UpdateAnimatedValue()

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.

◆ GetValue()

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 130 of file vtkPVComparativeAnimationCue.h.

◆ GetValues()

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.

◆ AppendCommandInfo()

vtkPVXMLElement* vtkPVComparativeAnimationCue::AppendCommandInfo ( vtkPVXMLElement proxyElem)

◆ LoadCommandInfo()

int vtkPVComparativeAnimationCue::LoadCommandInfo ( vtkPVXMLElement proxyElement)

◆ GetAnimatedProperty()

vtkSMProperty* vtkPVComparativeAnimationCue::GetAnimatedProperty ( )
protected

Get the property being animated.

◆ GetAnimatedDomain()

vtkSMDomain* vtkPVComparativeAnimationCue::GetAnimatedDomain ( )
protected

Get the domain being animated.

Member Data Documentation

◆ AnimatedProxy

vtkSMProxy* vtkPVComparativeAnimationCue::AnimatedProxy
protected

Definition at line 165 of file vtkPVComparativeAnimationCue.h.

◆ AnimatedElement

int vtkPVComparativeAnimationCue::AnimatedElement
protected

Definition at line 166 of file vtkPVComparativeAnimationCue.h.

◆ AnimatedPropertyName

char* vtkPVComparativeAnimationCue::AnimatedPropertyName
protected

Definition at line 167 of file vtkPVComparativeAnimationCue.h.

◆ AnimatedDomainName

char* vtkPVComparativeAnimationCue::AnimatedDomainName
protected

Definition at line 168 of file vtkPVComparativeAnimationCue.h.

◆ Values

double* vtkPVComparativeAnimationCue::Values
protected

Definition at line 169 of file vtkPVComparativeAnimationCue.h.

◆ Enabled

bool vtkPVComparativeAnimationCue::Enabled
protected

Definition at line 170 of file vtkPVComparativeAnimationCue.h.


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