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>

Inheritance diagram for vtkPVComparativeAnimationCue:
Inheritance graph
[legend]
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) override
 
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...
 
doubleGetValues (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...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkPVComparativeAnimationCueNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVComparativeAnimationCueSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVComparativeAnimationCue ()
 
 ~vtkPVComparativeAnimationCue () override
 
vtkSMPropertyGetAnimatedProperty ()
 Get the property being animated. More...
 
vtkSMDomainGetAnimatedDomain ()
 Get the domain being animated. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSMProxyAnimatedProxy
 
int AnimatedElement
 
char * AnimatedPropertyName
 
char * AnimatedDomainName
 
doubleValues
 
bool Enabled
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkPVComparativeAnimationCue.h.

Constructor & Destructor Documentation

◆ vtkPVComparativeAnimationCue()

vtkPVComparativeAnimationCue::vtkPVComparativeAnimationCue ( )
protected

◆ ~vtkPVComparativeAnimationCue()

vtkPVComparativeAnimationCue::~vtkPVComparativeAnimationCue ( )
overrideprotected

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

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

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

◆ UpdateYRange() [1/2]

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

Definition at line 85 of file vtkPVComparativeAnimationCue.h.

◆ UpdateWholeRange() [1/3]

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

Definition at line 86 of file vtkPVComparativeAnimationCue.h.

◆ UpdateValue() [1/2]

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

Definition at line 87 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 97 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 118 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 153 of file vtkPVComparativeAnimationCue.h.

◆ AnimatedElement

int vtkPVComparativeAnimationCue::AnimatedElement
protected

Definition at line 154 of file vtkPVComparativeAnimationCue.h.

◆ AnimatedPropertyName

char* vtkPVComparativeAnimationCue::AnimatedPropertyName
protected

Definition at line 155 of file vtkPVComparativeAnimationCue.h.

◆ AnimatedDomainName

char* vtkPVComparativeAnimationCue::AnimatedDomainName
protected

Definition at line 156 of file vtkPVComparativeAnimationCue.h.

◆ Values

double* vtkPVComparativeAnimationCue::Values
protected

Definition at line 157 of file vtkPVComparativeAnimationCue.h.

◆ Enabled

bool vtkPVComparativeAnimationCue::Enabled
protected

Definition at line 158 of file vtkPVComparativeAnimationCue.h.


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