vtkView Class Reference
#include <vtkView.h>
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).
- Tests:
- vtkView (Tests)
Definition at line 60 of file vtkView.h.
Member Typedef Documentation
| typedef vtkObject vtkView::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkGeoView, vtkGeoView2D, vtkQtBarChartView, vtkQtChartView, vtkQtChartViewBase, vtkQtItemView, vtkQtLineChartView, vtkQtListView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, vtkQtTableView, vtkQtTreeView, vtkQtView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkRenderView, vtkTreeAreaView, vtkTreeLayoutView, vtkTreeMapView, and vtkTreeRingView.
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 vtkGeoView, vtkGeoView2D, vtkQtBarChartView, vtkQtChartView, vtkQtChartViewBase, vtkQtItemView, vtkQtLineChartView, vtkQtListView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, vtkQtTableView, vtkQtTreeView, vtkQtView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkRenderView, vtkTreeAreaView, vtkTreeLayoutView, vtkTreeMapView, and vtkTreeRingView.
| virtual const char* vtkView::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkGeoView, vtkGeoView2D, vtkQtBarChartView, vtkQtChartView, vtkQtChartViewBase, vtkQtItemView, vtkQtLineChartView, vtkQtListView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, vtkQtTableView, vtkQtTreeView, vtkQtView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkRenderView, vtkTreeAreaView, vtkTreeLayoutView, vtkTreeMapView, and vtkTreeRingView.
| 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 vtkGeoView, vtkGeoView2D, vtkQtBarChartView, vtkQtChartView, vtkQtChartViewBase, vtkQtItemView, vtkQtLineChartView, vtkQtListView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, vtkQtTableView, vtkQtTreeView, vtkQtView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkRenderView, vtkTreeAreaView, vtkTreeLayoutView, vtkTreeMapView, and vtkTreeRingView.
| 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 vtkGeoView, vtkGeoView2D, vtkQtBarChartView, vtkQtChartView, vtkQtChartViewBase, vtkQtItemView, vtkQtLineChartView, vtkQtListView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, vtkQtTableView, vtkQtTreeView, vtkQtView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkRenderView, vtkTreeAreaView, vtkTreeLayoutView, vtkTreeMapView, and vtkTreeRingView.
Reimplemented from vtkObject.
Reimplemented in vtkGeoView, vtkGeoView2D, vtkQtBarChartView, vtkQtChartView, vtkQtChartViewBase, vtkQtItemView, vtkQtLineChartView, vtkQtListView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, vtkQtTableView, vtkQtTreeView, vtkQtView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkRenderView, vtkTreeAreaView, vtkTreeLayoutView, vtkTreeMapView, and vtkTreeRingView.
| 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 vtkGeoView, vtkGeoView2D, vtkQtBarChartView, vtkQtChartView, vtkQtChartViewBase, vtkQtItemView, vtkQtLineChartView, vtkQtListView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, vtkQtTableView, vtkQtTreeView, vtkQtView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkRenderView, vtkTreeAreaView, vtkTreeLayoutView, vtkTreeMapView, and vtkTreeRingView.
| void vtkView::AddRepresentation | ( | vtkDataRepresentation * | rep | ) |
Adds the representation to the view.
| void vtkView::AddRepresentation | ( | int | port, | |
| vtkDataRepresentation * | rep | |||
| ) |
Adds a representation to the specific port on the view
| void vtkView::SetRepresentation | ( | vtkDataRepresentation * | rep | ) |
Set the representation to the view.
| void vtkView::SetRepresentation | ( | int | port, | |
| vtkDataRepresentation * | rep | |||
| ) |
Sets a representation of a specific port on the view NOTE: This will remove any existing representations on the specified port.
| void vtkView::SetRepresentation | ( | int | port, | |
| int | index, | |||
| vtkDataRepresentation * | rep | |||
| ) |
Sets a representation of a specific port, for a specific index on the view. NOTE: This will remove any existing representations on the specified port, at the specific index.
| 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: Implicitly adds a representation to the first port(0), first index(0). 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::AddRepresentationFromInputConnection | ( | int | port, | |
| vtkAlgorithmOutput * | conn | |||
| ) |
Convenience method which creates a simple representation with the connection and adds it to the view. Returns the representation internally created. NOTE: Implicitly adds a representation to the first index(0) of the specified port. 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: Implicitly sets the representation to the first port(0), first index(0). 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 | ( | int | port, | |
| vtkAlgorithmOutput * | conn | |||
| ) |
Convenience method which sets the first representation on the specified port. Returns the representation internally created. NOTE: Implicitly sets the representation to the first index(0) of the specified port. 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 | ( | int | port, | |
| int | index, | |||
| vtkAlgorithmOutput * | conn | |||
| ) |
Convenience method which sets the representation for the index on the specified port 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::AddRepresentationFromInput | ( | int | port, | |
| vtkDataObject * | input | |||
| ) |
Convenience method which creates a simple representation with the specified input and adds it to the view. NOTE: Implicitly adds a representation to the first index(0) of the specified port. 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: Implicitly sets the representation to the first port(0), first index(0). 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 | ( | int | port, | |
| vtkDataObject * | input | |||
| ) |
Convenience method which sets the first representation on the specified port. Returns the representation internally created. NOTE: Implicitly sets the representation to the first index(0) of the specified port. 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 | ( | int | port, | |
| int | index, | |||
| vtkDataObject * | input | |||
| ) |
Convenience method which sets the representation for the index on the specified port 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.
| void vtkView::RemoveAllRepresentations | ( | int | port | ) |
Removes all representations from the port.
| int vtkView::GetNumberOfRepresentations | ( | ) |
Returns the number of representations from first port(0) in this view.
| int vtkView::GetNumberOfRepresentations | ( | int | port | ) |
The number of representations from the port.
| vtkDataRepresentation* vtkView::GetRepresentation | ( | int | index = 0 |
) |
The representation at a specified index.
| vtkDataRepresentation* vtkView::GetRepresentation | ( | int | port, | |
| int | index | |||
| ) |
The representation at a specified port and index.
| bool vtkView::IsItemPresent | ( | vtkDataRepresentation * | rep | ) |
Check to see if a representation is present in the view.
| bool vtkView::IsItemPresent | ( | int | port, | |
| vtkDataRepresentation * | rep | |||
| ) |
Check to see if a representation is present in the specified port.
| void vtkView::RemoveItem | ( | vtkDataRepresentation * | rep | ) |
Remove a representation from the view (FIXME).
| virtual void vtkView::Update | ( | ) | [inline, virtual] |
Update the view.
Reimplemented in vtkQtBarChartView, vtkQtChartView, vtkQtChartViewBase, vtkQtItemView, vtkQtLineChartView, vtkQtStackedChartView, vtkQtStatisticalBoxChartView, and vtkRenderView.
| virtual void vtkView::ApplyViewTheme | ( | vtkViewTheme * | vtkNotUsedtheme | ) | [inline, virtual] |
| virtual void vtkView::SetSelectionType | ( | int | ) | [virtual] |
Set the selection type produced by this view. This should be one of the content type constants defined in vtkSelection.h. Common values are vtkSelection::INDICES vtkSelection::PEDIGREEIDS vtkSelection::VALUES
| virtual int vtkView::GetSelectionType | ( | ) | [virtual] |
Set the selection type produced by this view. This should be one of the content type constants defined in vtkSelection.h. Common values are vtkSelection::INDICES vtkSelection::PEDIGREEIDS vtkSelection::VALUES
| virtual void vtkView::SetSelectionArrayNames | ( | vtkStringArray * | names | ) | [virtual] |
If a VALUES selection, the arrays used to produce a selection.
| virtual vtkStringArray* vtkView::GetSelectionArrayNames | ( | ) | [virtual] |
If a VALUES selection, the arrays used to produce a selection.
| virtual void vtkView::SetSelectionArrayName | ( | const char * | name | ) | [virtual] |
If a VALUES selection, the array used to produce a selection.
| virtual const char* vtkView::GetSelectionArrayName | ( | ) | [virtual] |
If a VALUES selection, the array used to produce a selection.
| 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 vtkQtItemView, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkRenderView, vtkTreeAreaView, and vtkTreeLayoutView.
| virtual void vtkView::AddInputConnection | ( | int | vtkNotUsedport, | |
| int | vtkNotUseditem, | |||
| vtkAlgorithmOutput * | vtkNotUsedconn, | |||
| vtkAlgorithmOutput * | vtkNotUsedselectionConn | |||
| ) | [inline, protected, virtual] |
| virtual void vtkView::RemoveInputConnection | ( | int | vtkNotUsedport, | |
| int | vtkNotUseditem, | |||
| vtkAlgorithmOutput * | vtkNotUsedconn, | |||
| vtkAlgorithmOutput * | vtkNotUsedselectionConn | |||
| ) | [inline, protected, virtual] |
| void vtkView::SizePort | ( | int | i, | |
| int | j | |||
| ) | [protected] |
If the Ports is not large enough to accomodate the port indicated, then resize Ports. If Ports sizing is adequate, do nothing.
| bool vtkView::CheckPort | ( | int | i, | |
| int | j | |||
| ) | [protected] |
Check to see if the port specified exists given current Ports sizes.
| 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 vtkQtChartViewBase.
| virtual void vtkView::AddRepresentationInternal | ( | vtkDataRepresentation * | vtkNotUsedrep | ) | [inline, protected, virtual] |
| virtual void vtkView::RemoveRepresentationInternal | ( | vtkDataRepresentation * | vtkNotUsedrep | ) | [inline, protected, virtual] |
Friends And Related Function Documentation
Member Data Documentation
int vtkView::SelectionType [protected] |
vtkStringArray* vtkView::SelectionArrayNames [protected] |
The documentation for this class was generated from the following file:
- dox/Views/vtkView.h
