VTK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkView Class Reference

The superclass for all views. More...

#include <vtkView.h>

Inheritance diagram for vtkView:
[legend]

Classes

class  ViewProgressEventCallData
 

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkViewNewInstance () const
 
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))
 
vtkCommand * GetObserver ()
 
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 (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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
 
bool ReuseSingleRepresentation
 
virtual void SetReuseSingleRepresentation (bool)
 
virtual bool GetReuseSingleRepresentation ()
 
virtual void ReuseSingleRepresentationOn ()
 
virtual void ReuseSingleRepresentationOff ()
 

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 62 of file vtkView.h.

Member Typedef Documentation

typedef vtkObject vtkView::Superclass

Definition at line 66 of file vtkView.h.

Constructor & Destructor Documentation

vtkView::vtkView ( )
protected
vtkView::~vtkView ( )
protected

Member Function Documentation

static vtkView* vtkView::New ( )
static
static int vtkView::IsTypeOf ( const char *  type)
static
virtual int vtkView::IsA ( const char *  type)
virtual
static vtkView* vtkView::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkView::NewInstanceInternal ( ) const
protectedvirtual
vtkView* vtkView::NewInstance ( ) const
void vtkView::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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)
inlinevirtual

Apply a theme to the view.

Definition at line 125 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 
)
protectedvirtual

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, vtkRenderView, and vtkParallelCoordinatesView.

virtual vtkDataRepresentation* vtkView::CreateDefaultRepresentation ( vtkAlgorithmOutput *  conn)
protectedvirtual

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 vtkGraphLayoutView, vtkTreeAreaView, vtkHierarchicalGraphView, and vtkParallelCoordinatesView.

virtual void vtkView::AddRepresentationInternal ( vtkDataRepresentation vtkNotUsedrep)
inlineprotectedvirtual

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::RemoveRepresentationInternal ( vtkDataRepresentation vtkNotUsedrep)
inlineprotectedvirtual

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

Definition at line 204 of file vtkView.h.

virtual void vtkView::SetReuseSingleRepresentation ( bool  )
protectedvirtual

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

virtual bool vtkView::GetReuseSingleRepresentation ( )
protectedvirtual

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

virtual void vtkView::ReuseSingleRepresentationOn ( )
protectedvirtual

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

virtual void vtkView::ReuseSingleRepresentationOff ( )
protectedvirtual

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 223 of file vtkView.h.

Member Data Documentation

bool vtkView::ReuseSingleRepresentation
protected

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

Definition at line 212 of file vtkView.h.


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