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

vtkTextSourceRepresentation is a representation to show text. More...

#include <vtkTextSourceRepresentation.h>

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

Public Types

typedef vtkPVDataRepresentation Superclass
 
- Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void MarkModified ()
 This is one of the most important functions. More...
 
virtual void SetVisibility (bool)
 Set the visibility. More...
 
void SetInteractivity (bool)
 Set the interactivity. More...
 
int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
void SetTextWidgetRepresentation (vtk3DWidgetRepresentation *widget)
 Set the text widget. More...
 
virtual vtk3DWidgetRepresentationGetTextWidgetRepresentation ()
 Set the text widget. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual unsigned int Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
 Initialize the representation with an identifier range so each internal representation can own a unique ID. More...
 
unsigned int GetUniqueIdentifier ()
 Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...
 
virtual bool GetVisibility ()
 
virtual vtkDataObject * GetRenderedDataObject (int vtkNotUsed(port))
 Returns the data object that is rendered from the given input port. More...
 
virtual void SetForcedCacheKey (double val)
 Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More...
 
virtual void SetForceUseCache (bool val)
 
bool GetUsingCacheForUpdate ()
 Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More...
 
virtual bool GetNeedUpdate ()
 
virtual vtkAlgorithmOutput * GetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port, int conn)
 
vtkView * GetView () const
 Provides access to the view. More...
 
virtual void SetUpdateTime (double time)
 Set the update time. More...
 
virtual double GetUpdateTime ()
 Set the update time. More...
 
virtual bool GetUpdateTimeValid ()
 Set whether the UpdateTime is valid. More...
 
virtual void SetUseCache (bool)
 
virtual void SetCacheKey (double val)
 
virtual double GetCacheKey ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool GetUseCache ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 

Static Public Member Functions

static vtkTextSourceRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTextSourceRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkTextSourceRepresentation ()
 
 ~vtkTextSourceRepresentation ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill input port information. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Overridden to invoke vtkCommand::UpdateDataEvent. More...
 
virtual bool AddToView (vtkView *view)
 Adds the representation to the view. More...
 
virtual bool RemoveFromView (vtkView *view)
 Removes the representation to the view. More...
 
virtual bool IsCached (double cache_key)
 Overridden to check with the vtkPVCacheKeeper to see if the key is cached. More...
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

vtkPVCacheKeeperCacheKeeper
 
vtkPolyData * DummyPolyData
 
vtk3DWidgetRepresentationTextWidgetRepresentation
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

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 34 of file vtkTextSourceRepresentation.h.

Member Typedef Documentation

§ Superclass

Definition at line 39 of file vtkTextSourceRepresentation.h.

Constructor & Destructor Documentation

§ vtkTextSourceRepresentation()

vtkTextSourceRepresentation::vtkTextSourceRepresentation ( )
protected

§ ~vtkTextSourceRepresentation()

vtkTextSourceRepresentation::~vtkTextSourceRepresentation ( )
protected

Member Function Documentation

§ New()

static vtkTextSourceRepresentation* vtkTextSourceRepresentation::New ( )
static

§ GetClassName()

virtual const char* vtkTextSourceRepresentation::GetClassName ( )
virtual

Reimplemented from vtkPVDataRepresentation.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkPVDataRepresentation.

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetTextWidgetRepresentation()

void vtkTextSourceRepresentation::SetTextWidgetRepresentation ( vtk3DWidgetRepresentation widget)

Set the text widget.

§ GetTextWidgetRepresentation()

virtual vtk3DWidgetRepresentation* vtkTextSourceRepresentation::GetTextWidgetRepresentation ( )
virtual

Set the text widget.

§ MarkModified()

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.

§ SetVisibility()

virtual void vtkTextSourceRepresentation::SetVisibility ( bool  )
virtual

Set the visibility.

Reimplemented from vtkPVDataRepresentation.

§ SetInteractivity()

void vtkTextSourceRepresentation::SetInteractivity ( bool  )

Set the interactivity.

§ ProcessViewRequest()

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.

§ FillInputPortInformation()

virtual int vtkTextSourceRepresentation::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Fill input port information.

§ RequestData()

virtual int vtkTextSourceRepresentation::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkPVDataRepresentation.

§ AddToView()

virtual bool vtkTextSourceRepresentation::AddToView ( vtkView *  view)
protectedvirtual

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.

§ RemoveFromView()

virtual bool vtkTextSourceRepresentation::RemoveFromView ( vtkView *  view)
protectedvirtual

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.

§ IsCached()

virtual bool vtkTextSourceRepresentation::IsCached ( double  cache_key)
protectedvirtual

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

Reimplemented from vtkPVDataRepresentation.

Member Data Documentation

§ CacheKeeper

vtkPVCacheKeeper* vtkTextSourceRepresentation::CacheKeeper
protected

Definition at line 104 of file vtkTextSourceRepresentation.h.

§ DummyPolyData

vtkPolyData* vtkTextSourceRepresentation::DummyPolyData
protected

Definition at line 105 of file vtkTextSourceRepresentation.h.

§ TextWidgetRepresentation

vtk3DWidgetRepresentation* vtkTextSourceRepresentation::TextWidgetRepresentation
protected

Definition at line 106 of file vtkTextSourceRepresentation.h.


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