vtkView Class Reference

#include <vtkView.h>

Inheritance diagram for vtkView:

Inheritance graph
[legend]
Collaboration diagram for vtkView:

Collaboration graph
[legend]

List of all members.


Detailed Description

The superclass for all views.

vtkView is the superclass for views. A view is generally an area of an application's canvas devoted to displaying one or more VTK data objects. Associated representations (subclasses of vtkDataRepresentation) are responsible for converting the data into a displayable format. These representations are then added to the view.

For views which display only one data object at a time you may set a data object or pipeline connection directly on the view itself (e.g. vtkGraphLayoutView, vtkLandscapeView, vtkTreeMapView). The view will internally create a vtkDataRepresentation for the data.

A view has the concept of linked selection. If the same data is displayed in multiple views, their selections may be linked by setting the same vtkAnnotationLink on their representations (see vtkDataRepresentation).

Events:
vtkCommand::ViewProgressEvent
Examples:
vtkView (Examples)
Tests:
vtkView (Tests)

Definition at line 61 of file vtkView.h.

bool ReuseSingleRepresentation
virtual void SetReuseSingleRepresentation (bool)
virtual bool GetReuseSingleRepresentation ()
virtual void ReuseSingleRepresentationOn ()
virtual void ReuseSingleRepresentationOff ()

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 AddRepresentation (vtkDataRepresentation *rep)
void SetRepresentation (vtkDataRepresentation *rep)
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationSetRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
vtkDataRepresentationSetRepresentationFromInput (vtkDataObject *input)
void RemoveRepresentation (vtkDataRepresentation *rep)
void RemoveRepresentation (vtkAlgorithmOutput *rep)
void RemoveAllRepresentations ()
int GetNumberOfRepresentations ()
vtkDataRepresentationGetRepresentation (int index=0)
bool IsRepresentationPresent (vtkDataRepresentation *rep)
virtual void Update ()
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
vtkCommandGetObserver ()
void RegisterProgress (vtkObject *algorithm, const char *message=NULL)
void UnRegisterProgress (vtkObject *algorithm)

Static Public Member Functions

static vtkViewNew ()
static int IsTypeOf (const char *type)
static vtkViewSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkView ()
 ~vtkView ()
virtual vtkDataRepresentationCreateDefaultRepresentation (vtkAlgorithmOutput *conn)
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
virtual void AddRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))
virtual void RemoveRepresentationInternal (vtkDataRepresentation *vtkNotUsed(rep))

Friends

class Command

Classes

class  ViewProgressEventCallData

Member Typedef Documentation


Constructor & Destructor Documentation

vtkView::vtkView (  )  [protected]

vtkView::~vtkView (  )  [protected]


Member Function Documentation

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

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

static int vtkView::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkContextView, vtkGeoView, vtkGeoView2D, vtkQtAnnotationView, vtkQtBarChartView, vtkQtChartView, vtkQtLineChartView, vtkQtListView, vtkQtRecordView, vtkQtRichTextView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, vtkQtTableView, vtkQtTreeView, vtkQtView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkParallelCoordinatesView, vtkRenderView, vtkRenderViewBase, vtkTreeAreaView, vtkTreeMapView, and vtkTreeRingView.

virtual int vtkView::IsA ( const char *  name  )  [virtual]

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

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkContextView, vtkGeoView, vtkGeoView2D, vtkQtAnnotationView, vtkQtBarChartView, vtkQtChartView, vtkQtLineChartView, vtkQtListView, vtkQtRecordView, vtkQtRichTextView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, vtkQtTableView, vtkQtTreeView, vtkQtView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkParallelCoordinatesView, vtkRenderView, vtkRenderViewBase, vtkTreeAreaView, vtkTreeMapView, and vtkTreeRingView.

void vtkView::AddRepresentation ( vtkDataRepresentation rep  ) 

Adds the representation to the view.

void vtkView::SetRepresentation ( vtkDataRepresentation rep  ) 

Set the representation to the view.

vtkDataRepresentation* vtkView::AddRepresentationFromInputConnection ( vtkAlgorithmOutput conn  ) 

Convenience method which creates a simple representation with the connection and adds it to the view. Returns the representation internally created. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

vtkDataRepresentation* vtkView::SetRepresentationFromInputConnection ( vtkAlgorithmOutput conn  ) 

Convenience method which sets the representation with the connection and adds it to the view. Returns the representation internally created. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

vtkDataRepresentation* vtkView::AddRepresentationFromInput ( vtkDataObject input  ) 

Convenience method which creates a simple representation with the specified input and adds it to the view. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

vtkDataRepresentation* vtkView::SetRepresentationFromInput ( vtkDataObject input  ) 

Convenience method which sets the representation to the specified input and adds it to the view. NOTE: The returned representation pointer is not reference-counted, so you MUST call Register() on the representation if you want to keep a reference to it.

void vtkView::RemoveRepresentation ( vtkDataRepresentation rep  ) 

Removes the representation from the view.

void vtkView::RemoveRepresentation ( vtkAlgorithmOutput rep  ) 

Removes any representation with this connection from the view.

void vtkView::RemoveAllRepresentations (  ) 

Removes all representations from the view.

int vtkView::GetNumberOfRepresentations (  ) 

Returns the number of representations from first port(0) in this view.

vtkDataRepresentation* vtkView::GetRepresentation ( int  index = 0  ) 

The representation at a specified index.

bool vtkView::IsRepresentationPresent ( vtkDataRepresentation rep  ) 

Check to see if a representation is present in the view.

virtual void vtkView::Update (  )  [virtual]

virtual void vtkView::ApplyViewTheme ( vtkViewTheme vtkNotUsedtheme  )  [inline, virtual]

Apply a theme to the view.

Definition at line 124 of file vtkView.h.

vtkCommand* vtkView::GetObserver (  ) 

Returns the observer that the subclasses can use to listen to additional events. Additionally these subclasses should override ProcessEvents() to handle these events.

void vtkView::RegisterProgress ( vtkObject algorithm,
const char *  message = NULL 
)

Meant for use by subclasses and vtkRepresentation subclasses. Call this method to register vtkObjects (generally vtkAlgorithm subclasses) which fire vtkCommand::ProgressEvent with the view. The view listens to vtkCommand::ProgressEvent and fires ViewProgressEvent with ViewProgressEventCallData containing the message and the progress amount. If message is not provided, then the class name for the algorithm is used.

void vtkView::UnRegisterProgress ( vtkObject algorithm  ) 

Unregister objects previously registered with RegisterProgress.

virtual void vtkView::ProcessEvents ( vtkObject caller,
unsigned long  eventId,
void *  callData 
) [protected, virtual]

Called to process events. The superclass processes selection changed events from its representations. This may be overridden by subclasses to process additional events.

Reimplemented in vtkGraphLayoutView, vtkParallelCoordinatesView, and vtkRenderView.

virtual vtkDataRepresentation* vtkView::CreateDefaultRepresentation ( vtkAlgorithmOutput conn  )  [protected, virtual]

Create a default vtkDataRepresentation for the given vtkAlgorithmOutput. View subclasses may override this method to create custom representations. This method is called by Add/SetRepresentationFromInputConnection. NOTE, the caller must delete the returned vtkDataRepresentation.

Reimplemented in vtkQtChartView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkParallelCoordinatesView, and vtkTreeAreaView.

virtual void vtkView::AddRepresentationInternal ( vtkDataRepresentation vtkNotUsedrep  )  [inline, protected, virtual]

Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed. Override these methods to perform custom actions.

Definition at line 202 of file vtkView.h.

virtual void vtkView::RemoveRepresentationInternal ( vtkDataRepresentation vtkNotUsedrep  )  [inline, protected, virtual]

Subclass "hooks" for notifying subclasses of vtkView when representations are added or removed. Override these methods to perform custom actions.

Definition at line 203 of file vtkView.h.

virtual void vtkView::SetReuseSingleRepresentation ( bool   )  [protected, virtual]

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.

virtual bool vtkView::GetReuseSingleRepresentation (  )  [protected, virtual]

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.

virtual void vtkView::ReuseSingleRepresentationOn (  )  [protected, virtual]

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.

virtual void vtkView::ReuseSingleRepresentationOff (  )  [protected, virtual]

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.


Friends And Related Function Documentation

friend class Command [friend]

Definition at line 222 of file vtkView.h.


Member Data Documentation

True if the view takes a single representation that should be reused on Add/SetRepresentationFromInput(Connection) calls. Default is off.

Definition at line 211 of file vtkView.h.


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

Generated on Wed Aug 24 12:17:32 2011 for VTK by  doxygen 1.5.6