VTK
vtkRenderView.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkRenderView.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
37 #ifndef vtkRenderView_h
38 #define vtkRenderView_h
39 
40 #include "vtkViewsInfovisModule.h" // For export macro
41 #include "vtkRenderViewBase.h"
42 #include "vtkSmartPointer.h" // For SP ivars
43 
45 class vtkActor2D;
46 class vtkAlgorithmOutput;
47 class vtkArrayCalculator;
51 class vtkHoverWidget;
55 class vtkSelection;
56 class vtkTextProperty;
57 class vtkTexture;
58 class vtkTexturedActor2D;
60 
61 class VTKVIEWSINFOVIS_EXPORT vtkRenderView : public vtkRenderViewBase
62 {
63 public:
64  static vtkRenderView* New();
66  void PrintSelf(ostream& os, vtkIndent indent) override;
67 
73  void SetInteractor(vtkRenderWindowInteractor *interactor) override;
74 
79 
84 
90  void SetRenderWindow(vtkRenderWindow *win) override;
91 
92  enum
93  {
96  INTERACTION_MODE_UNKNOWN
97  };
98 
100  vtkGetMacro(InteractionMode, int);
101 
107  virtual void SetInteractionModeTo2D()
108  { this->SetInteractionMode(INTERACTION_MODE_2D); }
109  virtual void SetInteractionModeTo3D()
110  { this->SetInteractionMode(INTERACTION_MODE_3D); }
111 
116  void Render() override;
117 
121  void ApplyViewTheme(vtkViewTheme* theme) override;
122 
124 
128  virtual void SetTransform(vtkAbstractTransform* transform);
129  vtkGetObjectMacro(Transform, vtkAbstractTransform);
131 
133 
136  virtual void SetDisplayHoverText(bool b);
137  vtkGetMacro(DisplayHoverText, bool);
138  vtkBooleanMacro(DisplayHoverText, bool);
140 
141  enum {
142  SURFACE = 0,
143  FRUSTUM = 1
144  };
145 
147 
154  vtkSetClampMacro(SelectionMode, int, 0, 1);
155  vtkGetMacro(SelectionMode, int);
156  void SetSelectionModeToSurface() { this->SetSelectionMode(SURFACE); }
157  void SetSelectionModeToFrustum() { this->SetSelectionMode(FRUSTUM); }
159 
165  virtual void AddLabels(vtkAlgorithmOutput* conn);
166 
170  virtual void RemoveLabels(vtkAlgorithmOutput* conn);
171 
173 
176  virtual void SetIconTexture(vtkTexture* texture);
177  vtkGetObjectMacro(IconTexture, vtkTexture);
179 
181 
184  vtkSetVector2Macro(IconSize, int);
185  vtkGetVector2Macro(IconSize, int);
187 
189 
193  vtkSetVector2Macro(DisplaySize, int);
195  void GetDisplaySize(int &dsx, int &dsy);
197 
198  enum
199  {
201  ALL
202  };
203 
205 
212  virtual void SetLabelPlacementMode(int mode);
213  virtual int GetLabelPlacementMode();
215  { this->SetLabelPlacementMode(NO_OVERLAP); }
217  { this->SetLabelPlacementMode(ALL); }
219 
220  enum
221  {
223  QT
224  };
225 
227 
232  virtual void SetLabelRenderMode(int mode);
233  virtual int GetLabelRenderMode();
235  { this->SetLabelRenderMode(FREETYPE); }
236  virtual void SetLabelRenderModeToQt()
237  { this->SetLabelRenderMode(QT); }
239 
241 
244  void SetRenderOnMouseMove(bool b);
245  vtkGetMacro(RenderOnMouseMove, bool);
246  vtkBooleanMacro(RenderOnMouseMove, bool);
248 
249 protected:
251  ~vtkRenderView() override;
252 
258  void ProcessEvents(vtkObject* caller, unsigned long eventId,
259  void* callData) override;
260 
264  virtual void GenerateSelection(
265  void* callData, vtkSelection* selection);
266 
270  void PrepareForRendering() override;
271 
275  virtual void UpdateHoverText();
276 
281  virtual void UpdateHoverWidgetState();
282 
288 
296 
299  int IconSize[2];
300  int DisplaySize[2];
301 
304 
311 
312 private:
313  vtkRenderView(const vtkRenderView&) = delete;
314  void operator=(const vtkRenderView&) = delete;
315 };
316 
317 #endif
vtkRenderView::SetInteractionModeTo2D
virtual void SetInteractionModeTo2D()
Set the interaction mode for the view.
Definition: vtkRenderView.h:107
vtkRenderView::FREETYPE
@ FREETYPE
Definition: vtkRenderView.h:222
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:52
vtkRenderView
A view containing a renderer.
Definition: vtkRenderView.h:62
vtkRenderView::SetLabelPlacementModeToNoOverlap
virtual void SetLabelPlacementModeToNoOverlap()
Definition: vtkRenderView.h:214
vtkAbstractTransform
superclass for all geometric transformations
Definition: vtkAbstractTransform.h:51
vtkRenderView::GetDisplaySize
int * GetDisplaySize()
vtkArrayCalculator
perform mathematical operations on data in field data arrays
Definition: vtkArrayCalculator.h:86
vtkRenderView::SetIconTexture
virtual void SetIconTexture(vtkTexture *texture)
Set the icon sheet to use for rendering icons.
vtkRenderView::SetRenderOnMouseMove
void SetRenderOnMouseMove(bool b)
Whether to render on every mouse move.
vtkTexturedActor2D
actor that draws 2D data with texture support
Definition: vtkTexturedActor2D.h:42
vtkRenderView::Interacting
bool Interacting
Definition: vtkRenderView.h:292
vtkRenderView::SelectionMode
int SelectionMode
Definition: vtkRenderView.h:289
vtkRenderView::Render
void Render() override
Updates the representations, then calls Render() on the render window associated with this view.
vtkHoverWidget
invoke a vtkTimerEvent when hovering
Definition: vtkHoverWidget.h:81
vtkRenderView::INTERACTION_MODE_3D
@ INTERACTION_MODE_3D
Definition: vtkRenderView.h:95
vtkX3D::style
@ style
Definition: vtkX3D.h:492
vtkSmartPointer< vtkRenderer >
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkLabelPlacementMapper
Places and renders non-overlapping labels.
Definition: vtkLabelPlacementMapper.h:52
vtkRenderView::UpdatePickRender
void UpdatePickRender()
Update the pick render for queries for drag selections or hover ballooons.
vtkRenderView::SetInteractionModeTo3D
virtual void SetInteractionModeTo3D()
Definition: vtkRenderView.h:109
vtkSelection
data object that represents a "selection" in VTK.
Definition: vtkSelection.h:64
vtkInteractorObserver
an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor
Definition: vtkInteractorObserver.h:60
vtkRenderView::InteractionMode
int InteractionMode
Definition: vtkRenderView.h:302
vtkRenderView::ProcessEvents
void ProcessEvents(vtkObject *caller, unsigned long eventId, void *callData) override
Called to process events.
vtkRenderView::GetLabelPlacementMode
virtual int GetLabelPlacementMode()
vtkRenderView::SetInteractor
void SetInteractor(vtkRenderWindowInteractor *interactor) override
The render window interactor.
vtkRenderView::RenderOnMouseMove
bool RenderOnMouseMove
Definition: vtkRenderView.h:303
vtkRenderView::Selector
vtkSmartPointer< vtkHardwareSelector > Selector
Definition: vtkRenderView.h:310
vtkViewTheme
Sets theme colors for a graphical view.
Definition: vtkViewTheme.h:49
vtkRenderView::GetInteractorStyle
virtual vtkInteractorObserver * GetInteractorStyle()
Get the interactor style associated with the render view.
vtkRenderView::NO_OVERLAP
@ NO_OVERLAP
Definition: vtkRenderView.h:200
vtkRenderView::LabelRenderer
vtkSmartPointer< vtkRenderer > LabelRenderer
Definition: vtkRenderView.h:305
vtkRenderView::SetLabelPlacementModeToAll
virtual void SetLabelPlacementModeToAll()
Definition: vtkRenderView.h:216
vtkTexture
handles properties associated with a texture map
Definition: vtkTexture.h:72
vtkRenderView::LabelActor
vtkSmartPointer< vtkTexturedActor2D > LabelActor
Definition: vtkRenderView.h:308
vtkRenderView::UpdateHoverText
virtual void UpdateHoverText()
Called in PrepareForRendering to update the hover text.
ADIOS::Transform
Transform
Definition: ADIOSDefs.h:41
vtkRenderView::PickRenderNeedsUpdate
bool PickRenderNeedsUpdate
Definition: vtkRenderView.h:295
vtkRenderView::UpdateHoverWidgetState
virtual void UpdateHoverWidgetState()
Enable or disable hovering based on DisplayHoverText ivar and interaction state.
vtkRenderView::LabelRenderMode
int LabelRenderMode
Definition: vtkRenderView.h:290
vtkHardwareSelector
Definition: vtkHardwareSelector.h:124
vtkTransformCoordinateSystems
transform points into different coordinate systems
Definition: vtkTransformCoordinateSystems.h:39
vtkRenderView::SetDisplayHoverText
virtual void SetDisplayHoverText(bool b)
Whether the view should display hover text.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkRenderView::New
static vtkRenderView * New()
vtkRenderView::SetInteractionMode
void SetInteractionMode(int mode)
vtkSmartPointer.h
vtkRenderView::SetSelectionModeToFrustum
void SetSelectionModeToFrustum()
Definition: vtkRenderView.h:157
vtkRenderView::vtkRenderView
vtkRenderView()
vtkRenderViewBase
A base view containing a renderer.
Definition: vtkRenderViewBase.h:42
vtkRenderView::PrepareForRendering
void PrepareForRendering() override
Called by the view when the renderer is about to render.
vtkRenderWindowInteractor
platform-independent render window interaction including picking and frame rate control.
Definition: vtkRenderWindowInteractor.h:79
vtkRenderView::IconTexture
vtkTexture * IconTexture
Definition: vtkRenderView.h:298
vtkRenderView::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkRenderView::SetLabelPlacementMode
virtual void SetLabelPlacementMode(int mode)
Label placement mode.
vtkRenderView::GetDisplaySize
void GetDisplaySize(int &dsx, int &dsy)
vtkBalloonRepresentation
represent the vtkBalloonWidget
Definition: vtkBalloonRepresentation.h:83
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:40
vtkRenderView::SetInteractorStyle
virtual void SetInteractorStyle(vtkInteractorObserver *style)
The interactor style associated with the render view.
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:46
vtkRenderView::SetLabelRenderModeToQt
virtual void SetLabelRenderModeToQt()
Definition: vtkRenderView.h:236
vtkRenderView::Balloon
vtkSmartPointer< vtkBalloonRepresentation > Balloon
Definition: vtkRenderView.h:306
vtkRenderView::SetLabelRenderMode
virtual void SetLabelRenderMode(int mode)
Label render mode.
vtkDynamic2DLabelMapper
draw text labels at 2D dataset points
Definition: vtkDynamic2DLabelMapper.h:66
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:40
vtkRenderView::DisplayHoverText
bool DisplayHoverText
Definition: vtkRenderView.h:291
vtkRenderView::~vtkRenderView
~vtkRenderView() override
vtkRenderView::RemoveLabels
virtual void RemoveLabels(vtkAlgorithmOutput *conn)
Remove labels from an input connection.
vtkRenderView::SetTransform
virtual void SetTransform(vtkAbstractTransform *transform)
Set the view's transform.
vtkRenderView::GetLabelRenderMode
virtual int GetLabelRenderMode()
vtkX3D::mode
@ mode
Definition: vtkX3D.h:247
vtkRenderView::INTERACTION_MODE_2D
@ INTERACTION_MODE_2D
Definition: vtkRenderView.h:94
vtkRenderWindow
create a window for renderers to draw into
Definition: vtkRenderWindow.h:88
vtkRenderView::GenerateSelection
virtual void GenerateSelection(void *callData, vtkSelection *selection)
Generates the selection based on the view event and the selection mode.
vtkRenderView::SetSelectionModeToSurface
void SetSelectionModeToSurface()
Definition: vtkRenderView.h:156
vtkRenderView::InPickRender
bool InPickRender
Definition: vtkRenderView.h:294
vtkRenderView::AddLabels
virtual void AddLabels(vtkAlgorithmOutput *conn)
Add labels from an input connection with an associated text property.
vtkRenderView::SetRenderWindow
void SetRenderWindow(vtkRenderWindow *win) override
Set the render window for this view.
vtkRenderView::HoverWidget
vtkSmartPointer< vtkHoverWidget > HoverWidget
Definition: vtkRenderView.h:309
vtkRenderView::SetLabelRenderModeToFreetype
virtual void SetLabelRenderModeToFreetype()
Definition: vtkRenderView.h:234
vtkRenderView::InHoverTextRender
bool InHoverTextRender
Definition: vtkRenderView.h:293
vtkRenderViewBase.h
vtkRenderView::Transform
vtkAbstractTransform * Transform
Definition: vtkRenderView.h:297
vtkRenderView::LabelPlacementMapper
vtkSmartPointer< vtkLabelPlacementMapper > LabelPlacementMapper
Definition: vtkRenderView.h:307
vtkRenderView::ApplyViewTheme
void ApplyViewTheme(vtkViewTheme *theme) override
Applies a view theme to this view.