view for comparative visualization/ film-strips. More...

#include <vtkPVComparativeView.h>

Inheritance diagram for vtkPVComparativeView:

Collaboration diagram for vtkPVComparativeView:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	Initialize (unsigned int)
void	StillRender ()
void	InteractiveRender ()
void	Initialize (vtkSMViewProxy *rootView)
void	Build (int dx, int dy)
void	AddRepresentation (vtkSMProxy *)
void	RemoveRepresentation (vtkSMProxy *)
void	RemoveAllRepresentations ()
void	Update ()
void	GetViews (vtkCollection *collection)

void	SetOverlayAllComparisons (bool)
virtual bool	GetOverlayAllComparisons ()

virtual int *	GetDimensions ()
virtual void	GetDimensions (int &, int &)
virtual void	GetDimensions (int[2])

void	GetRepresentationsForView (vtkSMViewProxy , vtkCollection )
void	GetRepresentations (int x, int y, vtkCollection *)

virtual vtkSMViewProxy *	GetRootView ()

void	SetViewSize (int x, int y)

void	SetViewPosition (int x, int y)

virtual void	SetSpacing (int, int)
void	SetSpacing (int[2])
virtual int *	GetSpacing ()
virtual void	GetSpacing (int &, int &)
virtual void	GetSpacing (int[2])

void	AddCue (vtkSMComparativeAnimationCueProxy *)
void	RemoveCue (vtkSMComparativeAnimationCueProxy *)

virtual void	SetViewTime (double)
virtual double	GetViewTime ()

void	MarkOutdated ()
Static Public Member Functions
static vtkPVComparativeView *	New ()
static int	IsTypeOf (const char *type)
static vtkPVComparativeView *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPVComparativeView ()
	~vtkPVComparativeView ()
void	AddNewView ()
void	RemoveView (vtkSMViewProxy *remove)
void	UpdateViewLayout ()
void	UpdateAllRepresentations (int x, int y)
void	ClearDataCaches ()
void	SetRootView (vtkSMViewProxy *)
Protected Attributes
int	Dimensions [2]
int	ViewSize [2]
int	ViewPosition [2]
int	Spacing [2]
double	ViewTime
bool	OverlayAllComparisons
bool	Outdated
vtkSMViewProxy *	RootView

Detailed Description

view for comparative visualization/ film-strips.

vtkPVComparativeView is the view used to generate/view comparative visualizations/film-strips. This is not a proxy

Definition at line 33 of file vtkPVComparativeView.h.

Constructor & Destructor Documentation

vtkPVComparativeView::vtkPVComparativeView ( ) [protected]

vtkPVComparativeView::~vtkPVComparativeView ( ) [protected]

Member Function Documentation

static vtkPVComparativeView* vtkPVComparativeView::New ( ) [static]

Reimplemented from vtkObject.

virtual const char* vtkPVComparativeView::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

static int vtkPVComparativeView::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkObject.

virtual int vtkPVComparativeView::IsA ( const char * type ) [virtual]

Reimplemented from vtkObject.

static vtkPVComparativeView* vtkPVComparativeView::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

void vtkPVComparativeView::Initialize ( unsigned int ) [inline]

Provides empty handlers to simulate the vtkPVView API.

Definition at line 41 of file vtkPVComparativeView.h.

void vtkPVComparativeView::StillRender ( )

Call StillRender() on the root view.

void vtkPVComparativeView::InteractiveRender ( )

Call InteractiveRender() on the root view.

void vtkPVComparativeView::Initialize ( vtkSMViewProxy * rootView )

Initialize the vtkPVComparativeView giving the root view proxy to be used to create the comparative views.

void vtkPVComparativeView::Build	(	int	dx,
		int	dy
	)

Builds the MxN views. This method simply creates the MxN internal view modules. It does not generate the visualization i.e. play the animation scene(s). This method does nothing unless the dimensions have changed, in which case it creates new internal view modules (or destroys extra ones). Note that the it's the responsibility of the application to lay the views out so that they form a MxN grid.

void vtkPVComparativeView::SetOverlayAllComparisons ( bool )

When set to true, all comparisons are shown in the same view. Otherwise, they are tiled in separate views.

virtual bool vtkPVComparativeView::GetOverlayAllComparisons ( ) [virtual]

When set to true, all comparisons are shown in the same view. Otherwise, they are tiled in separate views.

virtual int* vtkPVComparativeView::GetDimensions ( ) [virtual]

Returns the dimensions used by the most recent Build() request.

virtual void vtkPVComparativeView::GetDimensions	(	int &	,
		int &
	)		`[virtual]`

Returns the dimensions used by the most recent Build() request.

virtual void vtkPVComparativeView::GetDimensions ( int [2] ) [virtual]

Returns the dimensions used by the most recent Build() request.

void vtkPVComparativeView::AddRepresentation ( vtkSMProxy * )

Adds a representation proxy to this view.

void vtkPVComparativeView::RemoveRepresentation ( vtkSMProxy * )

Removes a representation proxy from this view.

void vtkPVComparativeView::RemoveAllRepresentations ( )

Removes all added representations from this view. Simply calls RemoveRepresentation() on all added representations one by one.

void vtkPVComparativeView::Update ( )

Updates the data pipelines for all visible representations.

void vtkPVComparativeView::GetViews ( vtkCollection * collection )

Get all the internal views. The views should only be used to be layed out by the GUI. It's not recommended to directly change the properties of the views.

void vtkPVComparativeView::GetRepresentationsForView	(	vtkSMViewProxy *	,
		vtkCollection *
	)

Get all internal vtkSMRepresentations for a given view. If the given view is not managed by this comparative view it will be ignored. The representations should only be used by the GUI for creating representation clones. It is not recommended to directly change the properties of the returned representations.

void vtkPVComparativeView::GetRepresentations	(	int	x,
		int	y,
		vtkCollection *
	)

Get all internal vtkSMRepresentations for a given view. If the given view is not managed by this comparative view it will be ignored. The representations should only be used by the GUI for creating representation clones. It is not recommended to directly change the properties of the returned representations.

virtual vtkSMViewProxy* vtkPVComparativeView::GetRootView ( ) [virtual]

Returns the root view proxy.

void vtkPVComparativeView::SetViewSize	(	int	x,
		int	y
	)		`[inline]`

ViewSize, ViewPosition need to split up among all the component views correctly.

Definition at line 109 of file vtkPVComparativeView.h.

void vtkPVComparativeView::SetViewPosition	(	int	x,
		int	y
	)		`[inline]`

ViewSize, ViewPosition need to split up among all the component views correctly.

Definition at line 120 of file vtkPVComparativeView.h.

virtual void vtkPVComparativeView::SetSpacing	(	int	,
		int
	)		`[virtual]`

Set spacing between views.

void vtkPVComparativeView::SetSpacing ( int [2] )

Set spacing between views.

virtual int* vtkPVComparativeView::GetSpacing ( ) [virtual]

Set spacing between views.

virtual void vtkPVComparativeView::GetSpacing	(	int &	,
		int &
	)		`[virtual]`

Set spacing between views.

virtual void vtkPVComparativeView::GetSpacing ( int [2] ) [virtual]

Set spacing between views.

void vtkPVComparativeView::AddCue ( vtkSMComparativeAnimationCueProxy * )

Add/Remove parameter cues.

void vtkPVComparativeView::RemoveCue ( vtkSMComparativeAnimationCueProxy * )

Add/Remove parameter cues.

virtual void vtkPVComparativeView::SetViewTime ( double ) [virtual]

Get/Set the view time.

virtual double vtkPVComparativeView::GetViewTime ( ) [virtual]

Get/Set the view time.

void vtkPVComparativeView::MarkOutdated ( ) [inline]

Marks the view dirty i.e. on next Update() it needs to regenerate the comparative vis by replaying the animation(s).

Definition at line 149 of file vtkPVComparativeView.h.

void vtkPVComparativeView::AddNewView ( ) [protected]

Creates and appends a new internal view. This not only creates a new view but also new copies of representations for all the representations in the view and adds them to the new view.

void vtkPVComparativeView::RemoveView ( vtkSMViewProxy * remove ) [protected]

Removes an internal view and all the representations in that view.

void vtkPVComparativeView::UpdateViewLayout ( ) [protected]

Update layout for internal views.