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

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

#include <vtkPVComparativeView.h>

Inherits vtkObject.

Collaboration diagram for vtkPVComparativeView:
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 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 RemoveAllRepresentations ()
 Removes all added representations 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 MarkOutdated ()
 Marks the view dirty i.e. More...
 
void PrepareForScreenshot ()
 These methods mimic the vtkPVView API. More...
 
void CleanupAfterScreenshot ()
 
vtkImageData * CaptureWindow (int magnification)
 
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...
 
void GetRepresentationsForView (vtkSMViewProxy *, vtkCollection *)
 Get all internal vtkSMRepresentations for a given view. More...
 
void GetRepresentations (int x, int y, vtkCollection *)
 Get all internal vtkSMRepresentations for a given view. More...
 
virtual vtkSMViewProxyGetRootView ()
 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...
 
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...
 

Static Public Member Functions

static vtkPVComparativeViewNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVComparativeViewSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVComparativeView ()
 
 ~vtkPVComparativeView ()
 
void AddNewView ()
 Creates and appends a new internal view. More...
 
void RemoveView (vtkSMViewProxy *remove)
 Removes an internal view and all the representations in that view. More...
 
void UpdateViewLayout ()
 Update layout for internal views. More...
 
void UpdateAllRepresentations (int x, int y)
 Update all representations belonging for the indicated position. More...
 
void ClearDataCaches (int x, int y)
 Clears the cached data for representations belonging to the indicated position. More...
 
void SetRootView (vtkSMViewProxy *)
 

Protected Attributes

int Dimensions [2]
 
int ViewSize [2]
 
int ViewPosition [2]
 
int Spacing [2]
 
double ViewTime
 
bool OverlayAllComparisons
 
bool Outdated
 
vtkSMViewProxyRootView
 

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

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkPVComparativeView.h.

Constructor & Destructor Documentation

◆ vtkPVComparativeView()

vtkPVComparativeView::vtkPVComparativeView ( )
protected

◆ ~vtkPVComparativeView()

vtkPVComparativeView::~vtkPVComparativeView ( )
protected

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ Initialize() [1/2]

void vtkPVComparativeView::Initialize ( unsigned  int)
inline

Provides empty handlers to simulate the vtkPVView API.

Definition at line 46 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.

◆ RemoveAllRepresentations()

void vtkPVComparativeView::RemoveAllRepresentations ( )

Removes all added representations from this view.

Simply calls RemoveRepresentation() on all added representations one by one.

◆ 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 layed out by the GUI. It's not recommended to directly change the properties of the views.

◆ GetRepresentationsForView()

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.

◆ GetRepresentations()

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.

◆ 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 143 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 156 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 185 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 200 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 207 of file vtkPVComparativeView.h.

◆ CleanupAfterScreenshot()

void vtkPVComparativeView::CleanupAfterScreenshot ( )
inline

Definition at line 208 of file vtkPVComparativeView.h.

◆ CaptureWindow()

vtkImageData* vtkPVComparativeView::CaptureWindow ( int  magnification)

◆ AddNewView()

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.

◆ RemoveView()

void vtkPVComparativeView::RemoveView ( vtkSMViewProxy remove)
protected

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

◆ UpdateViewLayout()

void vtkPVComparativeView::UpdateViewLayout ( )
protected

Update layout for internal views.

◆ UpdateAllRepresentations()

void vtkPVComparativeView::UpdateAllRepresentations ( int  x,
int  y 
)
protected

Update all representations belonging for the indicated position.

◆ ClearDataCaches()

void vtkPVComparativeView::ClearDataCaches ( int  x,
int  y 
)
protected

Clears the cached data for representations belonging to the indicated position.

◆ SetRootView()

void vtkPVComparativeView::SetRootView ( vtkSMViewProxy )
protected

Member Data Documentation

◆ Dimensions

int vtkPVComparativeView::Dimensions[2]
protected

Definition at line 243 of file vtkPVComparativeView.h.

◆ ViewSize

int vtkPVComparativeView::ViewSize[2]
protected

Definition at line 244 of file vtkPVComparativeView.h.

◆ ViewPosition

int vtkPVComparativeView::ViewPosition[2]
protected

Definition at line 245 of file vtkPVComparativeView.h.

◆ Spacing

int vtkPVComparativeView::Spacing[2]
protected

Definition at line 246 of file vtkPVComparativeView.h.

◆ ViewTime

double vtkPVComparativeView::ViewTime
protected

Definition at line 247 of file vtkPVComparativeView.h.

◆ OverlayAllComparisons

bool vtkPVComparativeView::OverlayAllComparisons
protected

Definition at line 248 of file vtkPVComparativeView.h.

◆ Outdated

bool vtkPVComparativeView::Outdated
protected

Definition at line 249 of file vtkPVComparativeView.h.

◆ RootView

vtkSMViewProxy* vtkPVComparativeView::RootView
protected

Definition at line 252 of file vtkPVComparativeView.h.


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