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-------------------------------------------------------------------------*/
53#ifndef vtkRenderView_h
54#define vtkRenderView_h
55
56#include "vtkRenderViewBase.h"
57#include "vtkSmartPointer.h" // For SP ivars
58#include "vtkViewsInfovisModule.h" // For export macro
59
61class vtkActor2D;
67class vtkHoverWidget;
71class vtkSelection;
72class vtkTextProperty;
73class vtkTexture;
76
77class VTKVIEWSINFOVIS_EXPORT vtkRenderView : public vtkRenderViewBase
78{
79public:
80 static vtkRenderView* New();
82 void PrintSelf(ostream& os, vtkIndent indent) override;
83
89 void SetInteractor(vtkRenderWindowInteractor* interactor) override;
90
95
100
106 void SetRenderWindow(vtkRenderWindow* win) override;
107
108 enum
109 {
112 INTERACTION_MODE_UNKNOWN
113 };
114
116 vtkGetMacro(InteractionMode, int);
117
123 virtual void SetInteractionModeTo2D() { this->SetInteractionMode(INTERACTION_MODE_2D); }
124 virtual void SetInteractionModeTo3D() { this->SetInteractionMode(INTERACTION_MODE_3D); }
125
130 void Render() override;
131
135 void ApplyViewTheme(vtkViewTheme* theme) override;
136
138
142 virtual void SetTransform(vtkAbstractTransform* transform);
143 vtkGetObjectMacro(Transform, vtkAbstractTransform);
145
147
150 virtual void SetDisplayHoverText(bool b);
151 vtkGetMacro(DisplayHoverText, bool);
152 vtkBooleanMacro(DisplayHoverText, bool);
154
155 enum
156 {
157 SURFACE = 0,
158 FRUSTUM = 1
159 };
160
162
169 vtkSetClampMacro(SelectionMode, int, 0, 1);
170 vtkGetMacro(SelectionMode, int);
171 void SetSelectionModeToSurface() { this->SetSelectionMode(SURFACE); }
172 void SetSelectionModeToFrustum() { this->SetSelectionMode(FRUSTUM); }
174
180 virtual void AddLabels(vtkAlgorithmOutput* conn);
181
185 virtual void RemoveLabels(vtkAlgorithmOutput* conn);
186
188
191 virtual void SetIconTexture(vtkTexture* texture);
192 vtkGetObjectMacro(IconTexture, vtkTexture);
194
196
199 vtkSetVector2Macro(IconSize, int);
200 vtkGetVector2Macro(IconSize, int);
202
204
208 vtkSetVector2Macro(DisplaySize, int);
210 void GetDisplaySize(int& dsx, int& dsy);
212
213 enum
214 {
216 ALL
217 };
218
220
227 virtual void SetLabelPlacementMode(int mode);
229 virtual void SetLabelPlacementModeToNoOverlap() { this->SetLabelPlacementMode(NO_OVERLAP); }
230 virtual void SetLabelPlacementModeToAll() { this->SetLabelPlacementMode(ALL); }
232
233 enum
234 {
236 QT
237 };
238
240
245 virtual void SetLabelRenderMode(int mode);
246 virtual int GetLabelRenderMode();
247 virtual void SetLabelRenderModeToFreetype() { this->SetLabelRenderMode(FREETYPE); }
248 virtual void SetLabelRenderModeToQt() { this->SetLabelRenderMode(QT); }
250
252
256 vtkGetMacro(RenderOnMouseMove, bool);
257 vtkBooleanMacro(RenderOnMouseMove, bool);
259
260protected:
262 ~vtkRenderView() override;
263
269 void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData) override;
270
274 virtual void GenerateSelection(void* callData, vtkSelection* selection);
275
279 void PrepareForRendering() override;
280
284 virtual void UpdateHoverText();
285
291
297
305
308 int IconSize[2];
309 int DisplaySize[2];
310
313
320
321private:
322 vtkRenderView(const vtkRenderView&) = delete;
323 void operator=(const vtkRenderView&) = delete;
324};
325
326#endif
superclass for all geometric transformations
a actor that draws 2D data
Definition: vtkActor2D.h:149
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:113
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:73
draw vtkPolyData onto the image plane
A base view containing a renderer.
A view containing a renderer.
Definition: vtkRenderView.h:78
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:163
represent text properties.
handles properties associated with a texture map
Definition: vtkTexture.h:175
actor that draws 2D data with texture support
transform points into different coordinate systems
Sets theme colors for a graphical view.
Definition: vtkViewTheme.h:132
@ Transform
Definition: vtkX3D.h:47
@ mode
Definition: vtkX3D.h:253
@ style
Definition: vtkX3D.h:498