ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkTextSourceRepresentation Class Reference

#include <vtkTextSourceRepresentation.h>

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

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void MarkModified ()
virtual void SetVisibility (bool)
void SetInteractivity (bool)
void SetTextWidgetRepresentation (vtk3DWidgetRepresentation *widget)
virtual vtk3DWidgetRepresentationGetTextWidgetRepresentation ()
int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)

Static Public Member Functions

static
vtkTextSourceRepresentation
New ()
static int IsTypeOf (const char *type)
static
vtkTextSourceRepresentation
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTextSourceRepresentation ()
 ~vtkTextSourceRepresentation ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual bool AddToView (vtkView *view)
virtual bool RemoveFromView (vtkView *view)
virtual bool IsCached (double cache_key)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

vtkPVCacheKeeperCacheKeeper
vtkUnstructuredDataDeliveryFilterDataCollector
vtkPolyDataDummyPolyData
vtk3DWidgetRepresentationTextWidgetRepresentation
vtkTimeStamp DeliveryTimeStamp

Detailed Description

vtkTextSourceRepresentation is a representation to show text. The input is expected to a vtkTable with a single row and column (atleast on the data server nodes). The content of this entry in the table is shown as text on the rendering nodes.

Definition at line 33 of file vtkTextSourceRepresentation.h.


Constructor & Destructor Documentation

vtkTextSourceRepresentation::vtkTextSourceRepresentation ( ) [protected]
vtkTextSourceRepresentation::~vtkTextSourceRepresentation ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkDataRepresentation.

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

Reimplemented from vtkPVDataRepresentation.

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

Reimplemented from vtkPVDataRepresentation.

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

Reimplemented from vtkPVDataRepresentation.

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

Reimplemented from vtkPVDataRepresentation.

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

Reimplemented from vtkPVDataRepresentation.

void vtkTextSourceRepresentation::SetTextWidgetRepresentation ( vtk3DWidgetRepresentation widget)

Set the text widget.

virtual vtk3DWidgetRepresentation* vtkTextSourceRepresentation::GetTextWidgetRepresentation ( ) [virtual]

Set the text widget.

virtual void vtkTextSourceRepresentation::MarkModified ( ) [virtual]

This is one of the most important functions. In VTK pipelines, it's very easy for the pipeline to decide when it needs to re-execute. vtkAlgorithm::Update() can go up the entire pipeline to see if any filters MTime changed (among other things) and if so, it can re-execute the pipeline. However in case of representations, the real input connection may only be present on the data-server nodes. In that case the vtkPVDataRepresentation::RequestData() will only get called on the data-server nodes. That means that representations won't be able to any data-delivery in RequestData(). We'd need some other mechanisms to synchronize data-delivery among processes. To avoid that conundrum, the vtkSMRepresentationProxy calls MarkModified() on all processes whenever any filter in the pipeline is modified. In this method, the vtkPVDataRepresentation subclasses should ensure that they mark all delivery related filters dirty in their RequestData to ensure they execute then next time they are updated. The vtkPVDataRepresentation also uses a special executive which avoids updating the representation unless MarkModified() was called since the last Update(), thus acting as a update-suppressor.

Reimplemented from vtkPVDataRepresentation.

virtual void vtkTextSourceRepresentation::SetVisibility ( bool  ) [virtual]

Set the visibility.

Reimplemented from vtkPVDataRepresentation.

void vtkTextSourceRepresentation::SetInteractivity ( bool  )

Set the interactivity.

int vtkTextSourceRepresentation::ProcessViewRequest ( vtkInformationRequestKey request_type,
vtkInformation inInfo,
vtkInformation outInfo 
) [virtual]

vtkAlgorithm::ProcessRequest() equivalent for rendering passes. This is typically called by the vtkView to request meta-data from the representations or ask them to perform certain tasks e.g. PrepareForRendering.

Reimplemented from vtkPVDataRepresentation.

virtual int vtkTextSourceRepresentation::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill input port information.

Reimplemented from vtkDataRepresentation.

virtual int vtkTextSourceRepresentation::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkPVDataRepresentation.

virtual bool vtkTextSourceRepresentation::AddToView ( vtkView view) [protected, virtual]

Adds the representation to the view. This is called from vtkView::AddRepresentation(). Subclasses should override this method. Returns true if the addition succeeds.

Reimplemented from vtkPVDataRepresentation.

virtual bool vtkTextSourceRepresentation::RemoveFromView ( vtkView view) [protected, virtual]

Removes the representation to the view. This is called from vtkView::RemoveRepresentation(). Subclasses should override this method. Returns true if the removal succeeds.

Reimplemented from vtkPVDataRepresentation.

virtual bool vtkTextSourceRepresentation::IsCached ( double  cache_key) [protected, virtual]

Overridden to check with the vtkPVCacheKeeper to see if the key is cached.

Reimplemented from vtkPVDataRepresentation.


Member Data Documentation

Definition at line 92 of file vtkTextSourceRepresentation.h.

Definition at line 93 of file vtkTextSourceRepresentation.h.

Definition at line 94 of file vtkTextSourceRepresentation.h.

Definition at line 95 of file vtkTextSourceRepresentation.h.

Definition at line 97 of file vtkTextSourceRepresentation.h.


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