VTK  9.1.0
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-------------------------------------------------------------------------*/
49#ifndef vtkRenderView_h
50#define vtkRenderView_h
51
52#include "vtkRenderViewBase.h"
53#include "vtkSmartPointer.h" // For SP ivars
54#include "vtkViewsInfovisModule.h" // For export macro
55
57class vtkActor2D;
63class vtkHoverWidget;
67class vtkSelection;
68class vtkTextProperty;
69class vtkTexture;
72
73class VTKVIEWSINFOVIS_EXPORT vtkRenderView : public vtkRenderViewBase
74{
75public:
76 static vtkRenderView* New();
78 void PrintSelf(ostream& os, vtkIndent indent) override;
79
85 void SetInteractor(vtkRenderWindowInteractor* interactor) override;
86
91
96
102 void SetRenderWindow(vtkRenderWindow* win) override;
103
104 enum
105 {
108 INTERACTION_MODE_UNKNOWN
109 };
110
111 void SetInteractionMode(int mode);
112 vtkGetMacro(InteractionMode, int);
113
119 virtual void SetInteractionModeTo2D() { this->SetInteractionMode(INTERACTION_MODE_2D); }
120 virtual void SetInteractionModeTo3D() { this->SetInteractionMode(INTERACTION_MODE_3D); }
121
126 void Render() override;
127
131 void ApplyViewTheme(vtkViewTheme* theme) override;
132
134
138 virtual void SetTransform(vtkAbstractTransform* transform);
139 vtkGetObjectMacro(Transform, vtkAbstractTransform);
141
143
146 virtual void SetDisplayHoverText(bool b);
147 vtkGetMacro(DisplayHoverText, bool);
148 vtkBooleanMacro(DisplayHoverText, bool);
150
151 enum
152 {
153 SURFACE = 0,
154 FRUSTUM = 1
155 };
156
158
165 vtkSetClampMacro(SelectionMode, int, 0, 1);
166 vtkGetMacro(SelectionMode, int);
167 void SetSelectionModeToSurface() { this->SetSelectionMode(SURFACE); }
168 void SetSelectionModeToFrustum() { this->SetSelectionMode(FRUSTUM); }
170
176 virtual void AddLabels(vtkAlgorithmOutput* conn);
177
181 virtual void RemoveLabels(vtkAlgorithmOutput* conn);
182
184
187 virtual void SetIconTexture(vtkTexture* texture);
188 vtkGetObjectMacro(IconTexture, vtkTexture);
190
192
195 vtkSetVector2Macro(IconSize, int);
196 vtkGetVector2Macro(IconSize, int);
198
200
204 vtkSetVector2Macro(DisplaySize, int);
206 void GetDisplaySize(int& dsx, int& dsy);
208
209 enum
210 {
212 ALL
213 };
214
216
223 virtual void SetLabelPlacementMode(int mode);
225 virtual void SetLabelPlacementModeToNoOverlap() { this->SetLabelPlacementMode(NO_OVERLAP); }
226 virtual void SetLabelPlacementModeToAll() { this->SetLabelPlacementMode(ALL); }
228
229 enum
230 {
232 QT
233 };
234
236
241 virtual void SetLabelRenderMode(int mode);
242 virtual int GetLabelRenderMode();
243 virtual void SetLabelRenderModeToFreetype() { this->SetLabelRenderMode(FREETYPE); }
244 virtual void SetLabelRenderModeToQt() { this->SetLabelRenderMode(QT); }
246
248
252 vtkGetMacro(RenderOnMouseMove, bool);
253 vtkBooleanMacro(RenderOnMouseMove, bool);
255
256protected:
258 ~vtkRenderView() override;
259
265 void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData) override;
266
270 virtual void GenerateSelection(void* callData, vtkSelection* selection);
271
275 void PrepareForRendering() override;
276
280 virtual void UpdateHoverText();
281
287
293
301
304 int IconSize[2];
305 int DisplaySize[2];
306
309
316
317private:
318 vtkRenderView(const vtkRenderView&) = delete;
319 void operator=(const vtkRenderView&) = delete;
320};
321
322#endif
superclass for all geometric transformations
a actor that draws 2D data
Definition: vtkActor2D.h:49
Proxy object to connect input/output ports.
perform mathematical operations on data in field data arrays
represent the vtkBalloonWidget
draw text labels at 2D dataset points
invoke a vtkTimerEvent when hovering
a simple class to control print indentation
Definition: vtkIndent.h:43
an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor
Places and renders non-overlapping labels.
abstract base class for most VTK objects
Definition: vtkObject.h:72
draw vtkPolyData onto the image plane
A base view containing a renderer.
A view containing a renderer.
Definition: vtkRenderView.h:74
vtkTexture * IconTexture
virtual void SetInteractionModeTo3D()
virtual void SetLabelRenderModeToFreetype()
Label render mode.
virtual void UpdateHoverWidgetState()
Enable or disable hovering based on DisplayHoverText ivar and interaction state.
vtkSmartPointer< vtkHoverWidget > HoverWidget
virtual vtkInteractorObserver * GetInteractorStyle()
Get the interactor style associated with the render view.
bool InHoverTextRender
void PrepareForRendering() override
Called by the view when the renderer is about to render.
void ApplyViewTheme(vtkViewTheme *theme) override
Applies a view theme to this view.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSmartPointer< vtkTexturedActor2D > LabelActor
void ProcessEvents(vtkObject *caller, unsigned long eventId, void *callData) override
Called to process events.
virtual void GenerateSelection(void *callData, vtkSelection *selection)
Generates the selection based on the view event and the selection mode.
virtual void SetInteractionModeTo2D()
Set the interaction mode for the view.
int * GetDisplaySize()
Set the display size of the icon (which may be different from the icon size).
void Render() override
Updates the representations, then calls Render() on the render window associated with this view.
virtual void SetDisplayHoverText(bool b)
Whether the view should display hover text.
virtual void SetTransform(vtkAbstractTransform *transform)
Set the view's transform.
virtual void SetLabelRenderMode(int mode)
Label render mode.
virtual void SetLabelPlacementModeToAll()
Label placement mode.
virtual int GetLabelPlacementMode()
Label placement mode.
virtual int GetLabelRenderMode()
Label render mode.
void SetSelectionModeToSurface()
Sets the selection mode for the render view.
static vtkRenderView * New()
virtual void SetLabelRenderModeToQt()
Label render mode.
void SetInteractor(vtkRenderWindowInteractor *interactor) override
The render window interactor.
bool PickRenderNeedsUpdate
void SetInteractionMode(int mode)
~vtkRenderView() override
virtual void SetIconTexture(vtkTexture *texture)
Set the icon sheet to use for rendering icons.
vtkSmartPointer< vtkRenderer > LabelRenderer
void UpdatePickRender()
Update the pick render for queries for drag selections or hover ballooons.
void SetRenderWindow(vtkRenderWindow *win) override
Set the render window for this view.
vtkSmartPointer< vtkBalloonRepresentation > Balloon
void SetSelectionModeToFrustum()
Sets the selection mode for the render view.
virtual void AddLabels(vtkAlgorithmOutput *conn)
Add labels from an input connection with an associated text property.
vtkSmartPointer< vtkLabelPlacementMapper > LabelPlacementMapper
bool RenderOnMouseMove
void GetDisplaySize(int &dsx, int &dsy)
Set the display size of the icon (which may be different from the icon size).
virtual void SetLabelPlacementMode(int mode)
Label placement mode.
vtkSmartPointer< vtkHardwareSelector > Selector
vtkAbstractTransform * Transform
void SetRenderOnMouseMove(bool b)
Whether to render on every mouse move.
virtual void RemoveLabels(vtkAlgorithmOutput *conn)
Remove labels from an input connection.
virtual void UpdateHoverText()
Called in PrepareForRendering to update the hover text.
virtual void SetLabelPlacementModeToNoOverlap()
Label placement mode.
virtual void SetInteractorStyle(vtkInteractorObserver *style)
The interactor style associated with the render view.
platform-independent render window interaction including picking and frame rate control.
create a window for renderers to draw into
data object that represents a "selection" in VTK.
Definition: vtkSelection.h:63
Hold a reference to a vtkObjectBase instance.
represent text properties.
handles properties associated with a texture map
Definition: vtkTexture.h:75
actor that draws 2D data with texture support
transform points into different coordinate systems
Sets theme colors for a graphical view.
Definition: vtkViewTheme.h:52