vtkRenderView Class Reference

#include <vtkRenderView.h>

Inheritance diagram for vtkRenderView:

Inheritance graph
[legend]
Collaboration diagram for vtkRenderView:

Collaboration graph
[legend]

List of all members.


Detailed Description

A view containing a renderer.

vtkRenderView is a view which contains a vtkRenderer. You may add vtkActors directly to the renderer, or add certain vtkDataRepresentation subclasses to the renderer. The render view supports drag selection with the mouse to select cells.

This class is also the parent class for any more specialized view which uses a renderer.

Events:
vtkCommand::HoverEvent
Tests:
vtkRenderView (Tests)

Definition at line 62 of file vtkRenderView.h.

void SetRenderOnMouseMove (bool b)
virtual bool GetRenderOnMouseMove ()
virtual void RenderOnMouseMoveOn ()
virtual void RenderOnMouseMoveOff ()
 vtkRenderView ()
 ~vtkRenderView ()

Public Types

enum  { INTERACTION_MODE_2D, INTERACTION_MODE_3D, INTERACTION_MODE_UNKNOWN }
enum  { SURFACE = 0, FRUSTUM = 1 }
enum  { NO_OVERLAP, ALL }
enum  { FREETYPE, QT }
typedef vtkRenderViewBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetInteractor (vtkRenderWindowInteractor *interactor)
virtual void SetInteractorStyle (vtkInteractorObserver *style)
virtual vtkInteractorObserverGetInteractorStyle ()
virtual void SetRenderWindow (vtkRenderWindow *win)
void SetInteractionMode (int mode)
virtual int GetInteractionMode ()
virtual void Render ()
virtual void ApplyViewTheme (vtkViewTheme *theme)
virtual void AddLabels (vtkAlgorithmOutput *conn)
virtual void RemoveLabels (vtkAlgorithmOutput *conn)
virtual void SetInteractionModeTo2D ()
virtual void SetInteractionModeTo3D ()
virtual void SetTransform (vtkAbstractTransform *transform)
virtual vtkAbstractTransformGetTransform ()
virtual void SetDisplayHoverText (bool b)
virtual bool GetDisplayHoverText ()
virtual void DisplayHoverTextOn ()
virtual void DisplayHoverTextOff ()
virtual void SetSelectionMode (int)
virtual int GetSelectionMode ()
void SetSelectionModeToSurface ()
void SetSelectionModeToFrustum ()
virtual void SetIconTexture (vtkTexture *texture)
virtual vtkTextureGetIconTexture ()
virtual void SetIconSize (int, int)
void SetIconSize (int[2])
virtual int * GetIconSize ()
virtual void GetIconSize (int &, int &)
virtual void GetIconSize (int[2])
virtual void SetDisplaySize (int, int)
void SetDisplaySize (int[2])
int * GetDisplaySize ()
void GetDisplaySize (int &dsx, int &dsy)
virtual void SetLabelPlacementMode (int mode)
virtual int GetLabelPlacementMode ()
virtual void SetLabelPlacementModeToNoOverlap ()
virtual void SetLabelPlacementModeToAll ()
virtual void SetLabelRenderMode (int mode)
virtual int GetLabelRenderMode ()
virtual void SetLabelRenderModeToFreetype ()
virtual void SetLabelRenderModeToQt ()

Static Public Member Functions

static vtkRenderViewNew ()
static int IsTypeOf (const char *type)
static vtkRenderViewSafeDownCast (vtkObject *o)

Protected Member Functions

virtual void PrepareForRendering ()
virtual void UpdateHoverText ()
virtual void UpdateHoverWidgetState ()
void UpdatePickRender ()
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
virtual void GenerateSelection (void *callData, vtkSelection *selection)

Protected Attributes

int SelectionMode
int LabelRenderMode
bool DisplayHoverText
bool Interacting
bool InHoverTextRender
bool InPickRender
bool PickRenderNeedsUpdate
vtkAbstractTransformTransform
vtkTextureIconTexture
int IconSize [2]
int DisplaySize [2]
int InteractionMode
bool RenderOnMouseMove
vtkSmartPointer< vtkRendererLabelRenderer
vtkSmartPointer
< vtkBalloonRepresentation
Balloon
vtkSmartPointer
< vtkLabelPlacementMapper
LabelPlacementMapper
vtkSmartPointer
< vtkTexturedActor2D
LabelActor
vtkSmartPointer< vtkHoverWidgetHoverWidget
vtkSmartPointer
< vtkHardwareSelector
Selector

Member Typedef Documentation


Member Enumeration Documentation

anonymous enum

Enumerator:
INTERACTION_MODE_2D 
INTERACTION_MODE_3D 
INTERACTION_MODE_UNKNOWN 

Definition at line 86 of file vtkRenderView.h.

anonymous enum

Enumerator:
SURFACE 
FRUSTUM 

Definition at line 128 of file vtkRenderView.h.

anonymous enum

Enumerator:
NO_OVERLAP 
ALL 

Definition at line 175 of file vtkRenderView.h.

anonymous enum

Enumerator:
FREETYPE 
QT 

Definition at line 196 of file vtkRenderView.h.


Constructor & Destructor Documentation

vtkRenderView::vtkRenderView (  )  [protected]

Whether to render on every mouse move.

vtkRenderView::~vtkRenderView (  )  [protected]

Whether to render on every mouse move.


Member Function Documentation

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

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

Reimplemented from vtkRenderViewBase.

Reimplemented in vtkGeoView, vtkGeoView2D, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkParallelCoordinatesView, vtkTreeAreaView, vtkTreeMapView, and vtkTreeRingView.

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

static int vtkRenderView::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 vtkRenderViewBase.

Reimplemented in vtkGeoView, vtkGeoView2D, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkParallelCoordinatesView, vtkTreeAreaView, vtkTreeMapView, and vtkTreeRingView.

virtual int vtkRenderView::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkRenderViewBase.

Reimplemented in vtkGeoView, vtkGeoView2D, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkParallelCoordinatesView, vtkTreeAreaView, vtkTreeMapView, and vtkTreeRingView.

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

void vtkRenderView::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 vtkRenderViewBase.

Reimplemented in vtkGeoView, vtkGeoView2D, vtkGraphLayoutView, vtkHierarchicalGraphView, vtkIcicleView, vtkParallelCoordinatesView, vtkTreeAreaView, vtkTreeMapView, and vtkTreeRingView.

virtual void vtkRenderView::SetInteractor ( vtkRenderWindowInteractor interactor  )  [virtual]

The render window interactor. Note that this requires special handling in order to do correctly - see the notes in the detailed description of vtkRenderViewBase.

Reimplemented from vtkRenderViewBase.

virtual void vtkRenderView::SetInteractorStyle ( vtkInteractorObserver style  )  [virtual]

The interactor style associated with the render view.

virtual vtkInteractorObserver* vtkRenderView::GetInteractorStyle (  )  [virtual]

Get the interactor style associated with the render view.

virtual void vtkRenderView::SetRenderWindow ( vtkRenderWindow win  )  [virtual]

Set the render window for this view. Note that this requires special handling in order to do correctly - see the notes in the detailed description of vtkRenderViewBase.

Reimplemented from vtkRenderViewBase.

void vtkRenderView::SetInteractionMode ( int  mode  ) 

virtual int vtkRenderView::GetInteractionMode (  )  [virtual]

virtual void vtkRenderView::SetInteractionModeTo2D (  )  [inline, virtual]

Set the interaction mode for the view. Choices are: vtkRenderView::INTERACTION_MODE_2D - 2D interactor vtkRenderView::INTERACTION_MODE_3D - 3D interactor

Definition at line 100 of file vtkRenderView.h.

virtual void vtkRenderView::SetInteractionModeTo3D (  )  [inline, virtual]

Set the interaction mode for the view. Choices are: vtkRenderView::INTERACTION_MODE_2D - 2D interactor vtkRenderView::INTERACTION_MODE_3D - 3D interactor

Definition at line 102 of file vtkRenderView.h.

virtual void vtkRenderView::Render (  )  [virtual]

Updates the representations, then calls Render() on the render window associated with this view.

Reimplemented from vtkRenderViewBase.

Reimplemented in vtkGeoView, and vtkGeoView2D.

virtual void vtkRenderView::ApplyViewTheme ( vtkViewTheme theme  )  [virtual]

Applies a view theme to this view.

Reimplemented in vtkGeoView2D, and vtkParallelCoordinatesView.

virtual void vtkRenderView::SetTransform ( vtkAbstractTransform transform  )  [virtual]

Set the view's transform. All vtkRenderedRepresentations added to this view should use this transform.

virtual vtkAbstractTransform* vtkRenderView::GetTransform (  )  [virtual]

Set the view's transform. All vtkRenderedRepresentations added to this view should use this transform.

Reimplemented in vtkGeoView2D.

virtual void vtkRenderView::SetDisplayHoverText ( bool  b  )  [virtual]

Whether the view should display hover text.

virtual bool vtkRenderView::GetDisplayHoverText (  )  [virtual]

Whether the view should display hover text.

virtual void vtkRenderView::DisplayHoverTextOn (  )  [virtual]

Whether the view should display hover text.

virtual void vtkRenderView::DisplayHoverTextOff (  )  [virtual]

Whether the view should display hover text.

virtual void vtkRenderView::SetSelectionMode ( int   )  [virtual]

Sets the selection mode for the render view. SURFACE selection uses vtkHardwareSelector to perform a selection of visible cells. FRUSTUM selection just creates a view frustum selection, which will select everything in the frustum.

virtual int vtkRenderView::GetSelectionMode (  )  [virtual]

Sets the selection mode for the render view. SURFACE selection uses vtkHardwareSelector to perform a selection of visible cells. FRUSTUM selection just creates a view frustum selection, which will select everything in the frustum.

void vtkRenderView::SetSelectionModeToSurface (  )  [inline]

Sets the selection mode for the render view. SURFACE selection uses vtkHardwareSelector to perform a selection of visible cells. FRUSTUM selection just creates a view frustum selection, which will select everything in the frustum.

Definition at line 141 of file vtkRenderView.h.

void vtkRenderView::SetSelectionModeToFrustum (  )  [inline]

Sets the selection mode for the render view. SURFACE selection uses vtkHardwareSelector to perform a selection of visible cells. FRUSTUM selection just creates a view frustum selection, which will select everything in the frustum.

Definition at line 142 of file vtkRenderView.h.

virtual void vtkRenderView::AddLabels ( vtkAlgorithmOutput conn  )  [virtual]

Add labels from an input connection with an associated text property. The output must be a vtkLabelHierarchy (normally the output of vtkPointSetToLabelHierarchy).

virtual void vtkRenderView::RemoveLabels ( vtkAlgorithmOutput conn  )  [virtual]

Remove labels from an input connection.

virtual void vtkRenderView::SetIconTexture ( vtkTexture texture  )  [virtual]

Set the icon sheet to use for rendering icons.

virtual vtkTexture* vtkRenderView::GetIconTexture (  )  [virtual]

Set the icon sheet to use for rendering icons.

virtual void vtkRenderView::SetIconSize ( int  ,
int   
) [virtual]

Set the size of each icon in the icon texture.

void vtkRenderView::SetIconSize ( int  [2]  ) 

Set the size of each icon in the icon texture.

virtual int* vtkRenderView::GetIconSize (  )  [virtual]

Set the size of each icon in the icon texture.

virtual void vtkRenderView::GetIconSize ( int &  ,
int &   
) [virtual]

Set the size of each icon in the icon texture.

virtual void vtkRenderView::GetIconSize ( int  [2]  )  [virtual]

Set the size of each icon in the icon texture.

virtual void vtkRenderView::SetDisplaySize ( int  ,
int   
) [virtual]

Set the display size of the icon (which may be different from the icon size). By default, if this value is not set, the the IconSize is used.

void vtkRenderView::SetDisplaySize ( int  [2]  ) 

Set the display size of the icon (which may be different from the icon size). By default, if this value is not set, the the IconSize is used.

int* vtkRenderView::GetDisplaySize (  ) 

Set the display size of the icon (which may be different from the icon size). By default, if this value is not set, the the IconSize is used.

void vtkRenderView::GetDisplaySize ( int &  dsx,
int &  dsy 
)

Set the display size of the icon (which may be different from the icon size). By default, if this value is not set, the the IconSize is used.

virtual void vtkRenderView::SetLabelPlacementMode ( int  mode  )  [virtual]

Label placement mode. NO_OVERLAP uses vtkLabelPlacementMapper, which has a faster startup time and works with 2D or 3D labels. ALL displays all labels (Warning: This may cause incredibly slow render times on datasets with more than a few hundred labels).

virtual int vtkRenderView::GetLabelPlacementMode (  )  [virtual]

Label placement mode. NO_OVERLAP uses vtkLabelPlacementMapper, which has a faster startup time and works with 2D or 3D labels. ALL displays all labels (Warning: This may cause incredibly slow render times on datasets with more than a few hundred labels).

virtual void vtkRenderView::SetLabelPlacementModeToNoOverlap (  )  [inline, virtual]

Label placement mode. NO_OVERLAP uses vtkLabelPlacementMapper, which has a faster startup time and works with 2D or 3D labels. ALL displays all labels (Warning: This may cause incredibly slow render times on datasets with more than a few hundred labels).

Definition at line 189 of file vtkRenderView.h.

virtual void vtkRenderView::SetLabelPlacementModeToAll (  )  [inline, virtual]

Label placement mode. NO_OVERLAP uses vtkLabelPlacementMapper, which has a faster startup time and works with 2D or 3D labels. ALL displays all labels (Warning: This may cause incredibly slow render times on datasets with more than a few hundred labels).

Definition at line 191 of file vtkRenderView.h.

virtual void vtkRenderView::SetLabelRenderMode ( int  mode  )  [virtual]

Label render mode. FREETYPE uses the freetype label rendering. QT uses more advanced Qt-based label rendering.

virtual int vtkRenderView::GetLabelRenderMode (  )  [virtual]

Label render mode. FREETYPE uses the freetype label rendering. QT uses more advanced Qt-based label rendering.

virtual void vtkRenderView::SetLabelRenderModeToFreetype (  )  [inline, virtual]

Label render mode. FREETYPE uses the freetype label rendering. QT uses more advanced Qt-based label rendering.

Definition at line 208 of file vtkRenderView.h.

virtual void vtkRenderView::SetLabelRenderModeToQt (  )  [inline, virtual]

Label render mode. FREETYPE uses the freetype label rendering. QT uses more advanced Qt-based label rendering.

Definition at line 210 of file vtkRenderView.h.

void vtkRenderView::SetRenderOnMouseMove ( bool  b  ) 

Whether to render on every mouse move.

virtual bool vtkRenderView::GetRenderOnMouseMove (  )  [virtual]

Whether to render on every mouse move.

virtual void vtkRenderView::RenderOnMouseMoveOn (  )  [virtual]

Whether to render on every mouse move.

virtual void vtkRenderView::RenderOnMouseMoveOff (  )  [virtual]

Whether to render on every mouse move.

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

Called to process events. Captures StartEvent events from the renderer and calls Update(). This may be overridden by subclasses to process additional events.

Reimplemented from vtkView.

Reimplemented in vtkGraphLayoutView, and vtkParallelCoordinatesView.

virtual void vtkRenderView::GenerateSelection ( void *  callData,
vtkSelection selection 
) [protected, virtual]

Generates the selection based on the view event and the selection mode.

virtual void vtkRenderView::PrepareForRendering (  )  [protected, virtual]

Called by the view when the renderer is about to render.

Reimplemented from vtkRenderViewBase.

Reimplemented in vtkGeoView, vtkGeoView2D, and vtkParallelCoordinatesView.

virtual void vtkRenderView::UpdateHoverText (  )  [protected, virtual]

Called in PrepareForRendering to update the hover text.

virtual void vtkRenderView::UpdateHoverWidgetState (  )  [protected, virtual]

Enable or disable hovering based on DisplayHoverText ivar and interaction state.

void vtkRenderView::UpdatePickRender (  )  [protected]

Update the pick render for queries for drag selections or hover ballooons.


Member Data Documentation

Definition at line 253 of file vtkRenderView.h.

Definition at line 254 of file vtkRenderView.h.

Definition at line 255 of file vtkRenderView.h.

bool vtkRenderView::Interacting [protected]

Definition at line 256 of file vtkRenderView.h.

Definition at line 257 of file vtkRenderView.h.

bool vtkRenderView::InPickRender [protected]

Definition at line 258 of file vtkRenderView.h.

Definition at line 259 of file vtkRenderView.h.

Definition at line 261 of file vtkRenderView.h.

Definition at line 262 of file vtkRenderView.h.

int vtkRenderView::IconSize[2] [protected]

Definition at line 263 of file vtkRenderView.h.

int vtkRenderView::DisplaySize[2] [protected]

Definition at line 264 of file vtkRenderView.h.

Definition at line 266 of file vtkRenderView.h.

Definition at line 267 of file vtkRenderView.h.

Definition at line 270 of file vtkRenderView.h.

Definition at line 271 of file vtkRenderView.h.

Definition at line 272 of file vtkRenderView.h.

Definition at line 273 of file vtkRenderView.h.

Definition at line 274 of file vtkRenderView.h.

Definition at line 275 of file vtkRenderView.h.


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

Generated on Wed Aug 24 12:03:42 2011 for VTK by  doxygen 1.5.6