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

#include <vtkPVComparativeView.h>

Inheritance diagram for vtkPVComparativeView:

Collaboration diagram for vtkPVComparativeView:

[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	Initialize (unsigned int)
	Provides empty handlers to simulate the vtkPVView API. More...

void	StillRender ()
	Call StillRender() on the root view. More...

void	InteractiveRender ()
	Call InteractiveRender() on the root view. More...

void	Initialize (vtkSMViewProxy *rootView)
	Initialize the vtkPVComparativeView giving the root view proxy to be used to create the comparative views. More...

void	Build (int dx, int dy)
	Builds the MxN views. More...

void	AddRepresentation (vtkSMProxy *)
	Adds a representation proxy to this view. More...

void	RemoveRepresentation (vtkSMProxy *)
	Removes a representation proxy from this view. More...

void	Update ()
	Updates the data pipelines for all visible representations. More...

void	GetViews (vtkCollection *collection)
	Get all the internal views. More...

void	SetPPI (int)
	Satisfying vtkPVView API. More...

void	MarkOutdated ()
	Marks the view dirty i.e. More...

void	PrepareForScreenshot ()
	These methods mimic the vtkPVView API. More...

void	CleanupAfterScreenshot ()

vtkImageData *	CaptureWindow (int magX, int magY)


void	SetOverlayAllComparisons (bool)
	When set to true, all comparisons are shown in the same view. More...

virtual bool	GetOverlayAllComparisons ()
	When set to true, all comparisons are shown in the same view. More...


virtual int *	GetDimensions ()
	Returns the dimensions used by the most recent Build() request. More...

virtual void	GetDimensions (int &, int &)
	Returns the dimensions used by the most recent Build() request. More...

virtual void	GetDimensions (int [2])
	Returns the dimensions used by the most recent Build() request. More...


virtual vtkSMViewProxy *	GetRootView ()
	Returns the root view proxy. More...


void	SetViewSize (int x, int y)
	ViewSize, ViewPosition need to split up among all the component views correctly. More...


void	SetViewPosition (int x, int y)
	ViewSize, ViewPosition need to split up among all the component views correctly. More...


void	SetTileScale (int x, int y)
	When saving screenshots with tiling, these methods get called. More...

void	SetTileViewport (double x0, double y0, double x1, double y1)
	When saving screenshots with tiling, these methods get called. More...


virtual void	SetSpacing (int, int)
	Set spacing between views. More...

void	SetSpacing (int [2])
	Set spacing between views. More...

virtual int *	GetSpacing ()
	Set spacing between views. More...

virtual void	GetSpacing (int &, int &)
	Set spacing between views. More...

virtual void	GetSpacing (int [2])
	Set spacing between views. More...


void	AddCue (vtkSMComparativeAnimationCueProxy *)
	Add/Remove parameter cues. More...

void	RemoveCue (vtkSMComparativeAnimationCueProxy *)
	Add/Remove parameter cues. More...


virtual double	GetViewTime ()
	Get/Set the view time. More...

void	SetViewTime (double time)
	Get/Set the view time. 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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkPVComparativeView *	New ()

static int	IsTypeOf (const char *type)

static vtkPVComparativeView *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVComparativeView ()

	~vtkPVComparativeView () override

void	UpdateViewLayout ()
	Update layout for internal views. More...

void	SetRootView (vtkSMViewProxy *)

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
int	Dimensions [2]

int	ViewSize [2]

int	ViewPosition [2]

int	Spacing [2]

double	ViewTime

bool	OverlayAllComparisons

bool	Outdated

vtkSMViewProxy *	RootView

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 24 of file vtkPVComparativeView.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVComparativeView::Superclass

Definition at line 28 of file vtkPVComparativeView.h.

Constructor & Destructor Documentation

◆ vtkPVComparativeView()

vtkPVComparativeView::vtkPVComparativeView ( )

protected

◆ ~vtkPVComparativeView()

vtkPVComparativeView::~vtkPVComparativeView ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVComparativeView* vtkPVComparativeView::New ( )

static

◆ GetClassName()

virtual const char* vtkPVComparativeView::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ Initialize() [1/2]

void vtkPVComparativeView::Initialize ( unsigned int )

inline

Provides empty handlers to simulate the vtkPVView API.

Definition at line 34 of file vtkPVComparativeView.h.

◆ StillRender()

void vtkPVComparativeView::StillRender ( )

Call StillRender() on the root view.

◆ InteractiveRender()

void vtkPVComparativeView::InteractiveRender ( )

Call InteractiveRender() on the root view.

◆ Initialize() [2/2]

void vtkPVComparativeView::Initialize ( vtkSMViewProxy * rootView )

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

◆ Build()

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.

◆ SetOverlayAllComparisons()

void vtkPVComparativeView::SetOverlayAllComparisons ( bool )

When set to true, all comparisons are shown in the same view.

Otherwise, they are tiled in separate views.

◆ GetOverlayAllComparisons()

virtual bool vtkPVComparativeView::GetOverlayAllComparisons ( )

virtual

When set to true, all comparisons are shown in the same view.

Otherwise, they are tiled in separate views.

◆ GetDimensions() [1/3]

virtual int* vtkPVComparativeView::GetDimensions ( )

virtual

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

◆ GetDimensions() [2/3]

virtual void vtkPVComparativeView::GetDimensions	(	int &	,
		int &
	)

virtual

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

◆ GetDimensions() [3/3]

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

virtual

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

◆ AddRepresentation()

void vtkPVComparativeView::AddRepresentation ( vtkSMProxy * )

Adds a representation proxy to this view.

◆ RemoveRepresentation()

void vtkPVComparativeView::RemoveRepresentation ( vtkSMProxy * )

Removes a representation proxy from this view.

◆ Update()

void vtkPVComparativeView::Update ( )

Updates the data pipelines for all visible representations.

◆ GetViews()

void vtkPVComparativeView::GetViews ( vtkCollection * collection )

Get all the internal views.

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

◆ GetRootView()

virtual vtkSMViewProxy* vtkPVComparativeView::GetRootView ( )

virtual

Returns the root view proxy.

◆ SetViewSize()

void vtkPVComparativeView::SetViewSize	(	int	x,
		int	y
	)

inline

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

Definition at line 112 of file vtkPVComparativeView.h.

◆ SetViewPosition()

void vtkPVComparativeView::SetViewPosition	(	int	x,
		int	y
	)

inline

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

Definition at line 125 of file vtkPVComparativeView.h.

◆ SetTileScale()

void vtkPVComparativeView::SetTileScale	(	int	x,
		int	y
	)

When saving screenshots with tiling, these methods get called.

Not to be confused with tile scale and viewport setup on tile display.

See also: vtkViewLayout::UpdateLayoutForTileDisplay

◆ SetTileViewport()

void vtkPVComparativeView::SetTileViewport	(	double	x0,
		double	y0,
		double	x1,
		double	y1
	)

When saving screenshots with tiling, these methods get called.

Not to be confused with tile scale and viewport setup on tile display.

See also: vtkViewLayout::UpdateLayoutForTileDisplay

◆ SetPPI()

void vtkPVComparativeView::SetPPI ( int )

inline

Satisfying vtkPVView API.

We don't need to do anything here since the subviews have their own PPI settings.

Definition at line 148 of file vtkPVComparativeView.h.

◆ SetSpacing() [1/2]

virtual void vtkPVComparativeView::SetSpacing	(	int	,
		int
	)

virtual

Set spacing between views.

◆ SetSpacing() [2/2]

void vtkPVComparativeView::SetSpacing ( int [2] )

Set spacing between views.

◆ GetSpacing() [1/3]

virtual int* vtkPVComparativeView::GetSpacing ( )

virtual

Set spacing between views.

◆ GetSpacing() [2/3]

virtual void vtkPVComparativeView::GetSpacing	(	int &	,
		int &
	)

virtual

Set spacing between views.

◆ GetSpacing() [3/3]

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

virtual

Set spacing between views.

◆ AddCue()

void vtkPVComparativeView::AddCue ( vtkSMComparativeAnimationCueProxy * )

Add/Remove parameter cues.

◆ RemoveCue()

void vtkPVComparativeView::RemoveCue ( vtkSMComparativeAnimationCueProxy * )

Add/Remove parameter cues.

◆ GetViewTime()

virtual double vtkPVComparativeView::GetViewTime ( )

virtual

Get/Set the view time.

◆ SetViewTime()

void vtkPVComparativeView::SetViewTime ( double time )

inline

Get/Set the view time.

Definition at line 171 of file vtkPVComparativeView.h.

◆ MarkOutdated()

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 186 of file vtkPVComparativeView.h.

◆ PrepareForScreenshot()

void vtkPVComparativeView::PrepareForScreenshot ( )

inline

These methods mimic the vtkPVView API.

They do nothing here since each view internal view will call PrepareForScreenshot and CleanupAfterScreenshot explicitly when we capture the images from each of them as needed.

Definition at line 193 of file vtkPVComparativeView.h.

◆ CleanupAfterScreenshot()

void vtkPVComparativeView::CleanupAfterScreenshot ( )

inline

Definition at line 194 of file vtkPVComparativeView.h.

◆ CaptureWindow()

vtkImageData* vtkPVComparativeView::CaptureWindow	(	int	magX,
		int	magY
	)

◆ UpdateViewLayout()

void vtkPVComparativeView::UpdateViewLayout ( )

protected

Update layout for internal views.

◆ SetRootView()

void vtkPVComparativeView::SetRootView ( vtkSMViewProxy * )

protected

Member Data Documentation

◆ Dimensions

int vtkPVComparativeView::Dimensions[2]

protected

Definition at line 206 of file vtkPVComparativeView.h.

◆ ViewSize

int vtkPVComparativeView::ViewSize[2]

protected

Definition at line 207 of file vtkPVComparativeView.h.

◆ ViewPosition

int vtkPVComparativeView::ViewPosition[2]

protected

Definition at line 208 of file vtkPVComparativeView.h.

◆ Spacing

int vtkPVComparativeView::Spacing[2]

protected

Definition at line 209 of file vtkPVComparativeView.h.

◆ ViewTime

double vtkPVComparativeView::ViewTime

protected

Definition at line 210 of file vtkPVComparativeView.h.

◆ OverlayAllComparisons

bool vtkPVComparativeView::OverlayAllComparisons

protected

Definition at line 211 of file vtkPVComparativeView.h.

◆ Outdated

bool vtkPVComparativeView::Outdated

protected

Definition at line 212 of file vtkPVComparativeView.h.

◆ RootView

vtkSMViewProxy* vtkPVComparativeView::RootView

protected

Definition at line 215 of file vtkPVComparativeView.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkPVComparativeView.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVComparativeView()

◆ ~vtkPVComparativeView()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Initialize() [1/2]

◆ StillRender()

◆ InteractiveRender()

◆ Initialize() [2/2]

◆ Build()

◆ SetOverlayAllComparisons()

◆ GetOverlayAllComparisons()

◆ GetDimensions() [1/3]

◆ GetDimensions() [2/3]

◆ GetDimensions() [3/3]

◆ AddRepresentation()

◆ RemoveRepresentation()

◆ Update()

◆ GetViews()

◆ GetRootView()

◆ SetViewSize()

◆ SetViewPosition()

◆ SetTileScale()

◆ SetTileViewport()

◆ SetPPI()

◆ SetSpacing() [1/2]

◆ SetSpacing() [2/2]

◆ GetSpacing() [1/3]

◆ GetSpacing() [2/3]

◆ GetSpacing() [3/3]

◆ AddCue()

◆ RemoveCue()

◆ GetViewTime()

◆ SetViewTime()

◆ MarkOutdated()

◆ PrepareForScreenshot()

◆ CleanupAfterScreenshot()

◆ CaptureWindow()

◆ UpdateViewLayout()

◆ SetRootView()

Member Data Documentation

◆ Dimensions

◆ ViewSize

◆ ViewPosition

◆ Spacing

◆ ViewTime

◆ OverlayAllComparisons

◆ Outdated

◆ RootView