vtkSMComparativeVisProxy Class Reference

Comparative visualization. More...

#include <vtkSMComparativeVisProxy.h>

Inheritance diagram for vtkSMComparativeVisProxy:

[legend]Collaboration diagram for vtkSMComparativeVisProxy:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkSMComparativeVisProxy, vtkSMProxy)
void	PrintSelf (ostream &os,vtkIndent indent)
void	Generate ()
int	Show ()
void	Hide ()
void	RemoveAllCues ()
void	Initialize ()
void	RemoveAllCache ()
unsigned int	GetNumberOfCues ()
unsigned int	GetNumberOfFramesInCue (unsigned int idx)
vtkSMAnimationCueProxy *	GetCue (unsigned int idx)
virtual int	GetIsGenerated ()
void	AddCue (vtkSMProxy *cueProxy)
void	SetCue (unsigned int idx, vtkSMProxy *cueProxy)
void	SetNumberOfCues (unsigned int num)
void	SetNumberOfFramesInCue (unsigned int idx, unsigned int numValues)
virtual vtkSMProxy *	GetMultiActorHelper ()
virtual void	SetName (const char *)
virtual char *	GetName ()
virtual void	SetShouldAbort (int)
virtual int	GetShouldAbort ()
void	SetRenderModule (vtkSMRenderModuleProxy *ren)
virtual vtkSMRenderModuleProxy *	GetRenderModule ()
void	SetSourceName (unsigned int idx, const char *sourceName)
const char *	GetSourceName (unsigned int idx)
void	SetSourceTclName (unsigned int idx, const char *sourceName)
const char *	GetSourceTclName (unsigned int idx)
virtual void	SetNumberOfXFrames (unsigned int)
virtual unsigned int	GetNumberOfXFrames ()
virtual void	SetNumberOfYFrames (unsigned int)
virtual unsigned int	GetNumberOfYFrames ()
Static Public Member Functions
vtkSMComparativeVisProxy *	New ()
Protected Member Functions
	vtkSMComparativeVisProxy ()
	~vtkSMComparativeVisProxy ()
void	PlayOne (unsigned int idx)
void	StoreGeometry ()
void	ComputeIndices (unsigned int gidx)
void	ComputeIndex (unsigned int paramIdx, unsigned int gidx)
void	ExecuteEvent (vtkObject *, unsigned long event, unsigned int paramIdx)
void	UpdateProgress (double progress)
Static Protected Member Functions
void	AddBounds (double bounds[6], double totalB[6])
Protected Attributes
vtkSMProxy *	MultiActorHelper
char *	Name
char *	SourceName
int	InFirstShow
int	IsGenerated
unsigned int	NumberOfXFrames
unsigned int	NumberOfYFrames
vtkSMRenderModuleProxy *	RenderModule
Friends
class	vtkCVAnimationSceneObserver

---

Detailed Description

Comparative visualization.

vtkSMComparativeVisProxy objects store comparative visualization information including the definition and the geometry. The definition consists of the names of properties, how they are to be varied and the number of values for each property. The comparative visualization is generated by keeping all parameters but one constant, changing that parameter value and storing the geometry for each case. This is repeated for every parameter. The resulting "frames" are then presented to the user in a way to allow comparing them easily. Usually, the properties correspond to some (simulation or experiment) parameters and the user wants to compare the results obtained by varying these parameters. Currently, the "frames" (or cells) are presented in a two dimensional, uniform grid. One or more actors are placed in each frame and the user interaction is passed to all. For example, rotation is applied to all frames equally. This class uses the animation framework present in VTK and ParaView. In this framework, the variation of a property over time is described with the help of cues. Each cue describes the variation of the property over time. "Key frames" are used for this purpose. A key frame describe the value of the property at a given time. For frames between key frames, the property value is computed using an interpolation scheme described by the surrounding key frames. In comparative vis, time is replaced by frame number.

See also:

vtkPVSimpleAnimationCue

Definition at line 57 of file vtkSMComparativeVisProxy.h.

---

Constructor & Destructor Documentation

vtkSMComparativeVisProxy::vtkSMComparativeVisProxy (   )  [protected]

vtkSMComparativeVisProxy::~vtkSMComparativeVisProxy (   )  [protected]

---

Member Function Documentation

vtkSMComparativeVisProxy* vtkSMComparativeVisProxy::New (   )  [static]

Reimplemented from vtkSMProxy.

vtkSMComparativeVisProxy::vtkTypeRevisionMacro (  vtkSMComparativeVisProxy  , vtkSMProxy  )

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

Reimplemented from vtkSMProxy.

void vtkSMComparativeVisProxy::Generate (   )

Given properties, generate comparative visualization. This actually generates each frame by creating appropriate animation objects and playing different cases. As a result, new geometry is created and stored.

virtual int vtkSMComparativeVisProxy::GetIsGenerated (   )  [virtual]

Returns false if comparative vis cannot be shown without calling Generate().

int vtkSMComparativeVisProxy::Show (   )

Puts all displays on the window. Returns 0 on failure. Only call after Generate().

void vtkSMComparativeVisProxy::Hide (   )

Remove all displays from the window. Has no effect if Generate() and Show() has not been called before.

void vtkSMComparativeVisProxy::AddCue (  vtkSMProxy *  cueProxy  )

Add a cue to be used in comparative vis. The used to create the visualization. While all other properties are kept constant, this cue is run for generate one "row" of the comparative visualization. The number of values determines the number of frames in one "row".

void vtkSMComparativeVisProxy::SetCue (  unsigned int  idx, vtkSMProxy *  cueProxy )

Add a cue to be used in comparative vis. The used to create the visualization. While all other properties are kept constant, this cue is run for generate one "row" of the comparative visualization. The number of values determines the number of frames in one "row".

void vtkSMComparativeVisProxy::SetNumberOfCues (  unsigned int  num  )

Add a cue to be used in comparative vis. The used to create the visualization. While all other properties are kept constant, this cue is run for generate one "row" of the comparative visualization. The number of values determines the number of frames in one "row".

void vtkSMComparativeVisProxy::SetNumberOfFramesInCue (  unsigned int  idx, unsigned int  numValues )

Add a cue to be used in comparative vis. The used to create the visualization. While all other properties are kept constant, this cue is run for generate one "row" of the comparative visualization. The number of values determines the number of frames in one "row".

void vtkSMComparativeVisProxy::RemoveAllCues (   )

Removes all cues.

void vtkSMComparativeVisProxy::Initialize (   )

Removes all properties and initializes internal data structures. Hide() is called before releasing the reference to the geometry.

void vtkSMComparativeVisProxy::RemoveAllCache (   )

Delete all cached data: geometry, displays etc... Does not delete the cues (i.e. the comparative vis description). Therefore, it is possible to call Generate() after Initialize() and recover the comparative visualization.

unsigned int vtkSMComparativeVisProxy::GetNumberOfCues (   )

Returns the number of assigned cues (parameters).

unsigned int vtkSMComparativeVisProxy::GetNumberOfFramesInCue (  unsigned int  idx  )

Returns the number of values (frames) of a given property.

vtkSMAnimationCueProxy* vtkSMComparativeVisProxy::GetCue (  unsigned int  idx  )

Returns the cue associated with a property. This is the cue used in generating the vis.

virtual vtkSMProxy* vtkSMComparativeVisProxy::GetMultiActorHelper (   )  [virtual]

MultiActorHelper stores pointer to all actors in the scene. The interactor later transforms these.

virtual void vtkSMComparativeVisProxy::SetName (  const char *   )  [virtual]

Set/Get the comparative vis name. Used by the comparative vis manager. Reimplemented from vtkSMProxy.

virtual char* vtkSMComparativeVisProxy::GetName (   )  [virtual]

Set/Get the comparative vis name. Used by the comparative vis manager. Reimplemented from vtkSMProxy.

virtual void vtkSMComparativeVisProxy::SetShouldAbort (  int   )  [virtual]

Set this to 1 to abort before generating next frame. Automatically resetted to 0 once aborted.

virtual int vtkSMComparativeVisProxy::GetShouldAbort (   )  [virtual]

Set this to 1 to abort before generating next frame. Automatically resetted to 0 once aborted.

void vtkSMComparativeVisProxy::SetRenderModule (  vtkSMRenderModuleProxy *  ren  )

RenderModule is needed to render.

virtual vtkSMRenderModuleProxy* vtkSMComparativeVisProxy::GetRenderModule (   )  [virtual]

RenderModule is needed to render.

void vtkSMComparativeVisProxy::SetSourceName (  unsigned int  idx, const char *  sourceName )

Stored to help gui select sources.

const char* vtkSMComparativeVisProxy::GetSourceName (  unsigned int  idx  )

Stored to help gui select sources.

void vtkSMComparativeVisProxy::SetSourceTclName (  unsigned int  idx, const char *  sourceName )

Stored to help gui save scripts.

const char* vtkSMComparativeVisProxy::GetSourceTclName (  unsigned int  idx  )

Stored to help gui save scripts.

virtual void vtkSMComparativeVisProxy::SetNumberOfXFrames (  unsigned  int  )  [virtual]

Set the number of frames in X

virtual unsigned int vtkSMComparativeVisProxy::GetNumberOfXFrames (   )  [virtual]

Set the number of frames in X

virtual void vtkSMComparativeVisProxy::SetNumberOfYFrames (  unsigned  int  )  [virtual]

Set the number of frames in Y

virtual unsigned int vtkSMComparativeVisProxy::GetNumberOfYFrames (   )  [virtual]

Set the number of frames in Y

void vtkSMComparativeVisProxy::PlayOne (  unsigned int  idx  )  [protected]

void vtkSMComparativeVisProxy::StoreGeometry (   )  [protected]

void vtkSMComparativeVisProxy::ComputeIndices (  unsigned int  gidx  )  [protected]

void vtkSMComparativeVisProxy::ComputeIndex (  unsigned int  paramIdx, unsigned int  gidx )  [protected]

void vtkSMComparativeVisProxy::ExecuteEvent (  vtkObject *  , unsigned long  event, unsigned int  paramIdx )  [protected]

void vtkSMComparativeVisProxy::AddBounds (  double  bounds[6], double  totalB[6] )  [static, protected]

void vtkSMComparativeVisProxy::UpdateProgress (  double  progress  )  [protected]

---

Friends And Related Function Documentation

friend class vtkCVAnimationSceneObserver [friend]

Definition at line 213 of file vtkSMComparativeVisProxy.h.

---

Member Data Documentation

vtkSMProxy* vtkSMComparativeVisProxy::MultiActorHelper [protected]

Definition at line 195 of file vtkSMComparativeVisProxy.h.

char* vtkSMComparativeVisProxy::Name [protected]

Reimplemented from vtkSMProxy. Definition at line 197 of file vtkSMComparativeVisProxy.h.

char* vtkSMComparativeVisProxy::SourceName [protected]

Definition at line 199 of file vtkSMComparativeVisProxy.h.

int vtkSMComparativeVisProxy::InFirstShow [protected]

Definition at line 201 of file vtkSMComparativeVisProxy.h.

int vtkSMComparativeVisProxy::IsGenerated [protected]

Definition at line 203 of file vtkSMComparativeVisProxy.h.

unsigned int vtkSMComparativeVisProxy::NumberOfXFrames [protected]

Definition at line 205 of file vtkSMComparativeVisProxy.h.

unsigned int vtkSMComparativeVisProxy::NumberOfYFrames [protected]

Definition at line 206 of file vtkSMComparativeVisProxy.h.

vtkSMRenderModuleProxy* vtkSMComparativeVisProxy::RenderModule [protected]

Definition at line 210 of file vtkSMComparativeVisProxy.h.

---

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

• Servers/ServerManager/vtkSMComparativeVisProxy.h

---