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, vtkTreeLayoutView, 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 vtkSelectionLink on their representations (see vtkDataRepresentation).

Examples:
vtkView (Examples)
Tests:
vtkView (Tests)

Definition at line 60 of file vtkView.h.


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)
vtkDataRepresentationAddRepresentationFromInputConnection (vtkAlgorithmOutput *conn)
vtkDataRepresentationAddRepresentationFromInput (vtkDataObject *input)
void RemoveRepresentation (vtkDataRepresentation *rep)
void RemoveRepresentation (vtkAlgorithmOutput *rep)
void RemoveAllRepresentations ()
int GetNumberOfRepresentations ()
vtkDataRepresentationGetRepresentation (int index=0)
virtual void Update ()
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
vtkCommandGetObserver ()

Static Public Member Functions

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

Protected Member Functions

 vtkView ()
 ~vtkView ()
virtual void AddInputConnection (vtkAlgorithmOutput *vtkNotUsed(conn))
virtual void RemoveInputConnection (vtkAlgorithmOutput *vtkNotUsed(conn))
virtual void SetSelectionLink (vtkSelectionLink *vtkNotUsed(link))
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)

Protected Attributes

vtkCollectionRepresentations

Friends

class Command

Member Typedef Documentation


Constructor & Destructor Documentation

vtkView::vtkView (  )  [protected]

vtkView::~vtkView (  )  [protected]


Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

Reimplemented in vtkQtItemView, vtkQtListView, vtkQtTableView, vtkQtTreeView, vtkGraphLayoutView, vtkRenderView, vtkTreeLayoutView, and vtkTreeMapView.

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkQtItemView, vtkQtListView, vtkQtTableView, vtkQtTreeView, vtkGraphLayoutView, vtkRenderView, vtkTreeLayoutView, and vtkTreeMapView.

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

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

Reimplemented from vtkObject.

Reimplemented in vtkQtItemView, vtkQtListView, vtkQtTableView, vtkQtTreeView, vtkGraphLayoutView, vtkRenderView, vtkTreeLayoutView, and vtkTreeMapView.

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 vtkQtItemView, vtkQtListView, vtkQtTableView, vtkQtTreeView, vtkGraphLayoutView, vtkRenderView, vtkTreeLayoutView, and vtkTreeMapView.

void vtkView::AddRepresentation ( vtkDataRepresentation rep  ) 

Adds 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::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.

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 (  ) 

The number of representations in this view.

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

The representation at a specified index.

virtual void vtkView::Update (  )  [inline, virtual]

Update the view.

Reimplemented in vtkQtItemView, and vtkRenderView.

Definition at line 100 of file vtkView.h.

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

Apply a theme to the view.

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

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 vtkQtItemView, vtkGraphLayoutView, vtkRenderView, vtkTreeLayoutView, and vtkTreeMapView.

virtual void vtkView::AddInputConnection ( vtkAlgorithmOutput vtkNotUsedconn  )  [inline, protected, virtual]

Connects to the internal pipeline. Subclasses that handle tight integration between view and representation should override this method.

Definition at line 129 of file vtkView.h.

virtual void vtkView::RemoveInputConnection ( vtkAlgorithmOutput vtkNotUsedconn  )  [inline, protected, virtual]

Disconnects the internal pipeline. Subclasses that handle tight integration between view and representation should override this method.

Definition at line 134 of file vtkView.h.

virtual void vtkView::SetSelectionLink ( vtkSelectionLink vtkNotUsedlink  )  [inline, protected, virtual]

Is called when the representation's selection link changes. Subclasses that handle tight integration between view and representation should override this method.

Definition at line 139 of file vtkView.h.


Friends And Related Function Documentation

friend class Command [friend]

Definition at line 148 of file vtkView.h.


Member Data Documentation

Definition at line 141 of file vtkView.h.


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

Generated on Sat Dec 27 13:57:27 2008 for VTK by  doxygen 1.5.6