VTK  9.0.1
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 -------------------------------------------------------------------------*/
34 #ifndef vtkRenderView_h
35 #define vtkRenderView_h
36 
37 #include "vtkRenderViewBase.h"
38 #include "vtkSmartPointer.h" // For SP ivars
39 #include "vtkViewsInfovisModule.h" // For export macro
40 
42 class vtkActor2D;
43 class vtkAlgorithmOutput;
44 class vtkArrayCalculator;
48 class vtkHoverWidget;
52 class vtkSelection;
53 class vtkTextProperty;
54 class vtkTexture;
55 class vtkTexturedActor2D;
57 
58 class VTKVIEWSINFOVIS_EXPORT vtkRenderView : public vtkRenderViewBase
59 {
60 public:
61  static vtkRenderView* New();
63  void PrintSelf(ostream& os, vtkIndent indent) override;
64 
70  void SetInteractor(vtkRenderWindowInteractor* interactor) override;
71 
76 
81 
87  void SetRenderWindow(vtkRenderWindow* win) override;
88 
89  enum
90  {
93  INTERACTION_MODE_UNKNOWN
94  };
95 
97  vtkGetMacro(InteractionMode, int);
98 
104  virtual void SetInteractionModeTo2D() { this->SetInteractionMode(INTERACTION_MODE_2D); }
105  virtual void SetInteractionModeTo3D() { this->SetInteractionMode(INTERACTION_MODE_3D); }
106 
111  void Render() override;
112 
116  void ApplyViewTheme(vtkViewTheme* theme) override;
117 
119 
123  virtual void SetTransform(vtkAbstractTransform* transform);
124  vtkGetObjectMacro(Transform, vtkAbstractTransform);
126 
128 
131  virtual void SetDisplayHoverText(bool b);
132  vtkGetMacro(DisplayHoverText, bool);
133  vtkBooleanMacro(DisplayHoverText, bool);
135 
136  enum
137  {
138  SURFACE = 0,
139  FRUSTUM = 1
140  };
141 
143 
150  vtkSetClampMacro(SelectionMode, int, 0, 1);
151  vtkGetMacro(SelectionMode, int);
152  void SetSelectionModeToSurface() { this->SetSelectionMode(SURFACE); }
153  void SetSelectionModeToFrustum() { this->SetSelectionMode(FRUSTUM); }
155 
161  virtual void AddLabels(vtkAlgorithmOutput* conn);
162 
166  virtual void RemoveLabels(vtkAlgorithmOutput* conn);
167 
169 
172  virtual void SetIconTexture(vtkTexture* texture);
173  vtkGetObjectMacro(IconTexture, vtkTexture);
175 
177 
180  vtkSetVector2Macro(IconSize, int);
181  vtkGetVector2Macro(IconSize, int);
183 
185 
189  vtkSetVector2Macro(DisplaySize, int);
191  void GetDisplaySize(int& dsx, int& dsy);
193 
194  enum
195  {
197  ALL
198  };
199 
201 
208  virtual void SetLabelPlacementMode(int mode);
209  virtual int GetLabelPlacementMode();
210  virtual void SetLabelPlacementModeToNoOverlap() { this->SetLabelPlacementMode(NO_OVERLAP); }
211  virtual void SetLabelPlacementModeToAll() { this->SetLabelPlacementMode(ALL); }
213 
214  enum
215  {
217  QT
218  };
219 
221 
226  virtual void SetLabelRenderMode(int mode);
227  virtual int GetLabelRenderMode();
228  virtual void SetLabelRenderModeToFreetype() { this->SetLabelRenderMode(FREETYPE); }
229  virtual void SetLabelRenderModeToQt() { this->SetLabelRenderMode(QT); }
231 
233 
236  void SetRenderOnMouseMove(bool b);
237  vtkGetMacro(RenderOnMouseMove, bool);
238  vtkBooleanMacro(RenderOnMouseMove, bool);
240 
241 protected:
243  ~vtkRenderView() override;
244 
250  void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData) override;
251 
255  virtual void GenerateSelection(void* callData, vtkSelection* selection);
256 
260  void PrepareForRendering() override;
261 
265  virtual void UpdateHoverText();
266 
271  virtual void UpdateHoverWidgetState();
272 
278 
286 
289  int IconSize[2];
290  int DisplaySize[2];
291 
294 
301 
302 private:
303  vtkRenderView(const vtkRenderView&) = delete;
304  void operator=(const vtkRenderView&) = delete;
305 };
306 
307 #endif
vtkRenderView::SetInteractionModeTo2D
virtual void SetInteractionModeTo2D()
Set the interaction mode for the view.
Definition: vtkRenderView.h:104
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:45
vtkRenderView
A view containing a renderer.
Definition: vtkRenderView.h:59
vtkRenderView::SetLabelPlacementModeToNoOverlap
virtual void SetLabelPlacementModeToNoOverlap()
Definition: vtkRenderView.h:210
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:80
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:39
vtkRenderView::Interacting
bool Interacting
Definition: vtkRenderView.h:282
vtkRenderView::SelectionMode
int SelectionMode
Definition: vtkRenderView.h:279
vtkRenderView::INTERACTION_MODE_3D
@ INTERACTION_MODE_3D
Definition: vtkRenderView.h:92
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:77
vtkX3D::style
@ style
Definition: vtkX3D.h:498
vtkSmartPointer< vtkRenderer >
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:54
vtkLabelPlacementMapper
Places and renders non-overlapping labels.
Definition: vtkLabelPlacementMapper.h:46
vtkRenderView::UpdatePickRender
void UpdatePickRender()
Update the pick render for queries for drag selections or hover ballooons.
vtkRenderView::SetInteractionModeTo3D
virtual void SetInteractionModeTo3D()
Definition: vtkRenderView.h:105
vtkSelection
data object that represents a "selection" in VTK.
Definition: vtkSelection.h:58
vtkInteractorObserver
an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor
Definition: vtkInteractorObserver.h:60
vtkX3D::Transform
@ Transform
Definition: vtkX3D.h:47
vtkRenderView::InteractionMode
int InteractionMode
Definition: vtkRenderView.h:292
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:293
vtkRenderView::NO_OVERLAP
@ NO_OVERLAP
Definition: vtkRenderView.h:196
vtkRenderView::Selector
vtkSmartPointer< vtkHardwareSelector > Selector
Definition: vtkRenderView.h:300
vtkViewTheme
Sets theme colors for a graphical view.
Definition: vtkViewTheme.h:43
vtkRenderView::GetInteractorStyle
virtual vtkInteractorObserver * GetInteractorStyle()
Get the interactor style associated with the render view.
vtkRenderView::LabelRenderer
vtkSmartPointer< vtkRenderer > LabelRenderer
Definition: vtkRenderView.h:295
vtkRenderView::SetLabelPlacementModeToAll
virtual void SetLabelPlacementModeToAll()
Definition: vtkRenderView.h:211
vtkTexture
handles properties associated with a texture map
Definition: vtkTexture.h:66
vtkRenderView::LabelActor
vtkSmartPointer< vtkTexturedActor2D > LabelActor
Definition: vtkRenderView.h:298
vtkRenderView::UpdateHoverText
virtual void UpdateHoverText()
Called in PrepareForRendering to update the hover text.
vtkRenderView::PickRenderNeedsUpdate
bool PickRenderNeedsUpdate
Definition: vtkRenderView.h:285
vtkRenderView::UpdateHoverWidgetState
virtual void UpdateHoverWidgetState()
Enable or disable hovering based on DisplayHoverText ivar and interaction state.
vtkRenderView::LabelRenderMode
int LabelRenderMode
Definition: vtkRenderView.h:280
vtkHardwareSelector
Definition: vtkHardwareSelector.h:124
vtkTransformCoordinateSystems
transform points into different coordinate systems
Definition: vtkTransformCoordinateSystems.h:36
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:34
vtkRenderView::New
static vtkRenderView * New()
vtkRenderView::SetInteractionMode
void SetInteractionMode(int mode)
vtkSmartPointer.h
vtkRenderView::SetSelectionModeToFrustum
void SetSelectionModeToFrustum()
Definition: vtkRenderView.h:153
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:74
vtkRenderView::IconTexture
vtkTexture * IconTexture
Definition: vtkRenderView.h:288
vtkRenderView::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkRenderView::INTERACTION_MODE_2D
@ INTERACTION_MODE_2D
Definition: vtkRenderView.h:91
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:77
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:34
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:40
vtkRenderView::SetLabelRenderModeToQt
virtual void SetLabelRenderModeToQt()
Definition: vtkRenderView.h:229
vtkRenderView::Balloon
vtkSmartPointer< vtkBalloonRepresentation > Balloon
Definition: vtkRenderView.h:296
vtkRenderView::SetLabelRenderMode
virtual void SetLabelRenderMode(int mode)
Label render mode.
vtkDynamic2DLabelMapper
draw text labels at 2D dataset points
Definition: vtkDynamic2DLabelMapper.h:60
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:37
vtkRenderView::DisplayHoverText
bool DisplayHoverText
Definition: vtkRenderView.h:281
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:253
vtkRenderWindow
create a window for renderers to draw into
Definition: vtkRenderWindow.h:85
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:152
vtkRenderView::InPickRender
bool InPickRender
Definition: vtkRenderView.h:284
vtkRenderView::FREETYPE
@ FREETYPE
Definition: vtkRenderView.h:216
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:299
vtkRenderView::SetLabelRenderModeToFreetype
virtual void SetLabelRenderModeToFreetype()
Definition: vtkRenderView.h:228
vtkRenderView::InHoverTextRender
bool InHoverTextRender
Definition: vtkRenderView.h:283
vtkRenderViewBase.h
vtkRenderView::Transform
vtkAbstractTransform * Transform
Definition: vtkRenderView.h:287
vtkRenderView::LabelPlacementMapper
vtkSmartPointer< vtkLabelPlacementMapper > LabelPlacementMapper
Definition: vtkRenderView.h:297
vtkRenderView::ApplyViewTheme
void ApplyViewTheme(vtkViewTheme *theme) override
Applies a view theme to this view.