ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVContextView Class Referenceabstract

vtkPVContextView adopts vtkContextView so that it can be used in ParaView configurations. More...

#include <vtkPVContextView.h>

Inheritance diagram for vtkPVContextView:
Inheritance graph
[legend]
Collaboration diagram for vtkPVContextView:
Collaboration graph
[legend]

Public Types

typedef vtkPVView Superclass
 
- Public Types inherited from vtkPVView
enum  { ViewTimeChangedEvent = 9000 }
 
typedef vtkView Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void StillRender ()
 Triggers a high-resolution render. More...
 
virtual void InteractiveRender ()
 Triggers a interactive render. More...
 
virtual vtkAbstractContextItem * GetContextItem ()=0
 Get the context item. More...
 
virtual void Initialize (unsigned int id)
 Initialize the view with an identifier. More...
 
virtual void Update ()
 Overridden to ensure that in multi-client configurations, same set of representations are "dirty" on all processes to avoid race conditions. More...
 
virtual void SetSelection (vtkChartRepresentation *repr, vtkSelection *selection)=0
 Representations can use this method to set the selection for a particular representation. More...
 
vtkSelection * GetSelection ()
 Get the current selection created in the view. More...
 
virtual bool Export (vtkCSVExporter *exporter)
 Export the contents of this view using the exporter. More...
 
virtual vtkContextView * GetContextView ()
 Get the context view. More...
 
virtual vtkRenderWindow * GetRenderWindow ()
 
virtual void SetupInteractor (vtkRenderWindowInteractor *)
 Set the interactor. More...
 
vtkRenderWindowInteractor * GetInteractor ()
 Set the interactor. More...
 
virtual void SetUseOffscreenRenderingForScreenshots (bool)
 Set or get whether offscreen rendering should be used during CaptureWindow calls. More...
 
virtual void UseOffscreenRenderingForScreenshotsOn ()
 Set or get whether offscreen rendering should be used during CaptureWindow calls. More...
 
virtual void UseOffscreenRenderingForScreenshotsOff ()
 Set or get whether offscreen rendering should be used during CaptureWindow calls. More...
 
virtual bool GetUseOffscreenRenderingForScreenshots ()
 Set or get whether offscreen rendering should be used during CaptureWindow calls. More...
 
virtual void SetUseOffscreenRendering (bool)
 Get/Set whether to use offscreen rendering for all rendering. More...
 
virtual void UseOffscreenRenderingOn ()
 Get/Set whether to use offscreen rendering for all rendering. More...
 
virtual void UseOffscreenRenderingOff ()
 Get/Set whether to use offscreen rendering for all rendering. More...
 
virtual bool GetUseOffscreenRendering ()
 Get/Set whether to use offscreen rendering for all rendering. More...
 
- Public Member Functions inherited from vtkPVView
void PrintSelf (ostream &os, vtkIndent indent)
 
bool InTileDisplayMode ()
 Returns true if the application is currently in tile display mode. More...
 
bool InCaveDisplayMode ()
 Returns true if the application is currently in cave/immersive display mode. More...
 
bool GetLocalProcessSupportsInteraction ()
 Returns true if the local process can support interaction. More...
 
virtual unsigned int GetIdentifier ()
 
virtual void SetPosition (int, int)
 Set the position on this view in the multiview configuration. More...
 
virtual int * GetPosition ()
 Set the position on this view in the multiview configuration. More...
 
virtual void GetPosition (int &, int &)
 Set the position on this view in the multiview configuration. More...
 
virtual void GetPosition (int [2])
 Set the position on this view in the multiview configuration. More...
 
virtual void SetSize (int, int)
 Set the size of this view in the multiview configuration. More...
 
virtual int * GetSize ()
 Set the size of this view in the multiview configuration. More...
 
virtual void GetSize (int &, int &)
 Set the size of this view in the multiview configuration. More...
 
virtual void GetSize (int [2])
 Set the size of this view in the multiview configuration. More...
 
bool SynchronizeBounds (double bounds[6])
 This encapsulates a whole lot of logic for communication between processes. More...
 
bool SynchronizeSize (double &size)
 This encapsulates a whole lot of logic for communication between processes. More...
 
bool SynchronizeSize (unsigned int &size)
 This encapsulates a whole lot of logic for communication between processes. More...
 
virtual void SetViewTime (double value)
 Get/Set the time this view is showing. More...
 
virtual double GetViewTime ()
 Get/Set the time this view is showing. More...
 
virtual void SetCacheKey (double)
 Get/Set the cache key. More...
 
virtual double GetCacheKey ()
 Get/Set the cache key. More...
 
virtual void SetUseCache (bool)
 Get/Set whether caching is enabled. More...
 
virtual bool GetUseCache ()
 Get/Set whether caching is enabled. More...
 
virtual void PrepareForScreenshot ()
 These methods are used to setup the view for capturing screen shots. More...
 
virtual void CleanupAfterScreenshot ()
 These methods are used to setup the view for capturing screen shots. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVContextViewSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVView
static int IsTypeOf (const char *type)
 
static vtkPVViewSafeDownCast (vtkObject *o)
 
static void SetEnableStreaming (bool)
 
static bool GetEnableStreaming ()
 
static vtkInformationObjectBaseKey * VIEW ()
 Key used to pass the vtkPVView pointer to the representation during any of the view passes such as REQUEST_UPDATE(), REQUEST_UPDATE_LOD(), REQUEST_RENDER(), etc. More...
 
static vtkInformationRequestKey * REQUEST_UPDATE ()
 This is a Update-Data pass. More...
 
static vtkInformationRequestKey * REQUEST_UPDATE_LOD ()
 This is a Update-LOD-Data pass. More...
 
static vtkInformationRequestKey * REQUEST_RENDER ()
 This is a render pass. More...
 

Protected Member Functions

 vtkPVContextView ()
 
 ~vtkPVContextView ()
 
virtual void Render (bool interactive)
 Actual rendering implementation. More...
 
virtual bool MapSelectionToInput (vtkSelection *)
 Called to transform the selection. More...
 
void OnStartRender ()
 Callbacks called when the primary "renderer" in the vtkContextView starts/ends rendering. More...
 
void OnEndRender ()
 Callbacks called when the primary "renderer" in the vtkContextView starts/ends rendering. More...
 
- Protected Member Functions inherited from vtkPVView
 vtkPVView ()
 
 ~vtkPVView ()
 
virtual void AddRepresentationInternal (vtkDataRepresentation *rep)
 Overridden to check that the representation has View setup properly. More...
 
void CallProcessViewRequest (vtkInformationRequestKey *passType, vtkInformation *request, vtkInformationVector *reply)
 Subclasses can use this method to trigger a pass on all representations. More...
 

Protected Attributes

vtkContextView * ContextView
 
vtkRenderWindow * RenderWindow
 
bool UseOffscreenRenderingForScreenshots
 
bool UseOffscreenRendering
 
- Protected Attributes inherited from vtkPVView
vtkPVSynchronizedRenderWindowsSynchronizedWindows
 
unsigned int Identifier
 Every view gets a unique identifier that it uses to register itself with the SynchronizedWindows. More...
 
double CacheKey
 
bool UseCache
 
int Size [2]
 
int Position [2]
 
vtkInformation * RequestInformation
 These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
 
vtkInformationVector * ReplyInformationVector
 These are passed as arguments to vtkDataRepresentation::ProcessViewRequest(). More...
 
double ViewTime
 Subclasses can use this method to trigger a pass on all representations. More...
 

Detailed Description

vtkPVContextView adopts vtkContextView so that it can be used in ParaView configurations.

Definition at line 41 of file vtkPVContextView.h.

Member Typedef Documentation

§ Superclass

Definition at line 44 of file vtkPVContextView.h.

Constructor & Destructor Documentation

§ vtkPVContextView()

vtkPVContextView::vtkPVContextView ( )
protected

§ ~vtkPVContextView()

vtkPVContextView::~vtkPVContextView ( )
protected

Member Function Documentation

§ GetClassName()

virtual const char* vtkPVContextView::GetClassName ( )
virtual

Reimplemented from vtkPVView.

Reimplemented in vtkPVXYChartView, and vtkPVPlotMatrixView.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkPVView.

Reimplemented in vtkPVXYChartView, and vtkPVPlotMatrixView.

§ SafeDownCast()

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

§ PrintSelf()

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

§ StillRender()

virtual void vtkPVContextView::StillRender ( )
virtual

Triggers a high-resolution render.

Implements vtkPVView.

§ InteractiveRender()

virtual void vtkPVContextView::InteractiveRender ( )
virtual

Triggers a interactive render.

Based on the settings on the view, this may result in a low-resolution rendering or a simplified geometry rendering.

Implements vtkPVView.

§ GetContextView()

virtual vtkContextView* vtkPVContextView::GetContextView ( )
virtual

Get the context view.

§ GetContextItem()

virtual vtkAbstractContextItem* vtkPVContextView::GetContextItem ( )
pure virtual

Get the context item.

Implemented in vtkPVXYChartView, and vtkPVPlotMatrixView.

§ GetRenderWindow()

virtual vtkRenderWindow* vtkPVContextView::GetRenderWindow ( )
virtual

§ SetupInteractor()

virtual void vtkPVContextView::SetupInteractor ( vtkRenderWindowInteractor *  )
virtual

Set the interactor.

Client applications must set the interactor to enable interactivity. Note this method will also change the interactor styles set on the interactor.

§ GetInteractor()

vtkRenderWindowInteractor* vtkPVContextView::GetInteractor ( )

Set the interactor.

Client applications must set the interactor to enable interactivity. Note this method will also change the interactor styles set on the interactor.

§ Initialize()

virtual void vtkPVContextView::Initialize ( unsigned int  id)
virtual

Initialize the view with an identifier.

Unless noted otherwise, this method must be called before calling any other methods on this class.

Reimplemented from vtkPVView.

§ Update()

virtual void vtkPVContextView::Update ( )
virtual

Overridden to ensure that in multi-client configurations, same set of representations are "dirty" on all processes to avoid race conditions.

Reimplemented from vtkPVView.

Reimplemented in vtkPVXYChartView.

§ SetUseOffscreenRenderingForScreenshots()

virtual void vtkPVContextView::SetUseOffscreenRenderingForScreenshots ( bool  )
virtual

Set or get whether offscreen rendering should be used during CaptureWindow calls.

On Apple machines, this flag has no effect.

§ UseOffscreenRenderingForScreenshotsOn()

virtual void vtkPVContextView::UseOffscreenRenderingForScreenshotsOn ( )
virtual

Set or get whether offscreen rendering should be used during CaptureWindow calls.

On Apple machines, this flag has no effect.

§ UseOffscreenRenderingForScreenshotsOff()

virtual void vtkPVContextView::UseOffscreenRenderingForScreenshotsOff ( )
virtual

Set or get whether offscreen rendering should be used during CaptureWindow calls.

On Apple machines, this flag has no effect.

§ GetUseOffscreenRenderingForScreenshots()

virtual bool vtkPVContextView::GetUseOffscreenRenderingForScreenshots ( )
virtual

Set or get whether offscreen rendering should be used during CaptureWindow calls.

On Apple machines, this flag has no effect.

§ SetUseOffscreenRendering()

virtual void vtkPVContextView::SetUseOffscreenRendering ( bool  )
virtual

Get/Set whether to use offscreen rendering for all rendering.

This is merely a suggestion. If –use-offscreen-rendering command line option is specified, then setting this flag to 0 on that process has no effect. Setting it to true, however, will ensure that even is –use-offscreen-rendering is not specified, it will use offscreen rendering.

§ UseOffscreenRenderingOn()

virtual void vtkPVContextView::UseOffscreenRenderingOn ( )
virtual

Get/Set whether to use offscreen rendering for all rendering.

This is merely a suggestion. If –use-offscreen-rendering command line option is specified, then setting this flag to 0 on that process has no effect. Setting it to true, however, will ensure that even is –use-offscreen-rendering is not specified, it will use offscreen rendering.

§ UseOffscreenRenderingOff()

virtual void vtkPVContextView::UseOffscreenRenderingOff ( )
virtual

Get/Set whether to use offscreen rendering for all rendering.

This is merely a suggestion. If –use-offscreen-rendering command line option is specified, then setting this flag to 0 on that process has no effect. Setting it to true, however, will ensure that even is –use-offscreen-rendering is not specified, it will use offscreen rendering.

§ GetUseOffscreenRendering()

virtual bool vtkPVContextView::GetUseOffscreenRendering ( )
virtual

Get/Set whether to use offscreen rendering for all rendering.

This is merely a suggestion. If –use-offscreen-rendering command line option is specified, then setting this flag to 0 on that process has no effect. Setting it to true, however, will ensure that even is –use-offscreen-rendering is not specified, it will use offscreen rendering.

§ SetSelection()

virtual void vtkPVContextView::SetSelection ( vtkChartRepresentation repr,
vtkSelection *  selection 
)
pure virtual

Representations can use this method to set the selection for a particular representation.

Subclasses override this method to pass on the selection to the chart using annotation link. Note this is meant to pass selection for the local process alone. The view does not manage data movement for the selection.

Implemented in vtkPVXYChartView, and vtkPVPlotMatrixView.

§ GetSelection()

vtkSelection* vtkPVContextView::GetSelection ( )

Get the current selection created in the view.

This will call this->MapSelectionToInput() to transform the selection every time a new selection is available. Subclasses should override MapSelectionToInput() to convert the selection, as appropriate.

§ Export()

virtual bool vtkPVContextView::Export ( vtkCSVExporter exporter)
virtual

Export the contents of this view using the exporter.

Called vtkChartRepresentation::Export() on all visible representations. This is expected to called only on the client side after a render/update. Thus all data is expected to available on the local process.

§ Render()

virtual void vtkPVContextView::Render ( bool  interactive)
protectedvirtual

Actual rendering implementation.

Reimplemented in vtkPVXYChartView.

§ MapSelectionToInput()

virtual bool vtkPVContextView::MapSelectionToInput ( vtkSelection *  )
protectedvirtual

Called to transform the selection.

This is only called on the client-side. Subclasses should transform the selection in place as needed. Default implementation simply goes to the first visible representation and asks it to transform (by calling vtkChartRepresentation::MapSelectionToInput()). We need to extend the infrastructrue to work properly when making selections in views showing multiple representations, but until that happens, this naive approach works for most cases. Return false on failure.

§ OnStartRender()

void vtkPVContextView::OnStartRender ( )
protected

Callbacks called when the primary "renderer" in the vtkContextView starts/ends rendering.

Note that this is called on the renderer, hence before the rendering cleanup calls like SwapBuffers called by the render-window.

§ OnEndRender()

void vtkPVContextView::OnEndRender ( )
protected

Callbacks called when the primary "renderer" in the vtkContextView starts/ends rendering.

Note that this is called on the renderer, hence before the rendering cleanup calls like SwapBuffers called by the render-window.

Member Data Documentation

§ ContextView

vtkContextView* vtkPVContextView::ContextView
protected

Definition at line 180 of file vtkPVContextView.h.

§ RenderWindow

vtkRenderWindow* vtkPVContextView::RenderWindow
protected

Definition at line 181 of file vtkPVContextView.h.

§ UseOffscreenRenderingForScreenshots

bool vtkPVContextView::UseOffscreenRenderingForScreenshots
protected

Definition at line 183 of file vtkPVContextView.h.

§ UseOffscreenRendering

bool vtkPVContextView::UseOffscreenRendering
protected

Definition at line 184 of file vtkPVContextView.h.


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