VTK  9.3.0
vtkRenderView.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
30#ifndef vtkRenderView_h
31#define vtkRenderView_h
32
33#include "vtkRenderViewBase.h"
34#include "vtkSmartPointer.h" // For SP ivars
35#include "vtkViewsInfovisModule.h" // For export macro
36
37VTK_ABI_NAMESPACE_BEGIN
39class vtkActor2D;
45class vtkHoverWidget;
49class vtkSelection;
50class vtkTextProperty;
51class vtkTexture;
54
55class VTKVIEWSINFOVIS_EXPORT vtkRenderView : public vtkRenderViewBase
56{
57public:
58 static vtkRenderView* New();
60 void PrintSelf(ostream& os, vtkIndent indent) override;
61
67 void SetInteractor(vtkRenderWindowInteractor* interactor) override;
68
73
78
84 void SetRenderWindow(vtkRenderWindow* win) override;
85
86 enum
87 {
90 INTERACTION_MODE_UNKNOWN
91 };
92
93 void SetInteractionMode(int mode);
94 vtkGetMacro(InteractionMode, int);
95
101 virtual void SetInteractionModeTo2D() { this->SetInteractionMode(INTERACTION_MODE_2D); }
102 virtual void SetInteractionModeTo3D() { this->SetInteractionMode(INTERACTION_MODE_3D); }
103
108 void Render() override;
109
113 void ApplyViewTheme(vtkViewTheme* theme) override;
114
116
120 virtual void SetTransform(vtkAbstractTransform* transform);
121 vtkGetObjectMacro(Transform, vtkAbstractTransform);
123
125
128 virtual void SetDisplayHoverText(bool b);
129 vtkGetMacro(DisplayHoverText, bool);
130 vtkBooleanMacro(DisplayHoverText, bool);
132
133 enum
134 {
135 SURFACE = 0,
136 FRUSTUM = 1
137 };
138
140
147 vtkSetClampMacro(SelectionMode, int, 0, 1);
148 vtkGetMacro(SelectionMode, int);
149 void SetSelectionModeToSurface() { this->SetSelectionMode(SURFACE); }
150 void SetSelectionModeToFrustum() { this->SetSelectionMode(FRUSTUM); }
152
158 virtual void AddLabels(vtkAlgorithmOutput* conn);
159
163 virtual void RemoveLabels(vtkAlgorithmOutput* conn);
164
166
169 virtual void SetIconTexture(vtkTexture* texture);
170 vtkGetObjectMacro(IconTexture, vtkTexture);
172
174
177 vtkSetVector2Macro(IconSize, int);
178 vtkGetVector2Macro(IconSize, int);
180
182
186 vtkSetVector2Macro(DisplaySize, int);
188 void GetDisplaySize(int& dsx, int& dsy);
190
191 enum
192 {
194 ALL
195 };
196
198
205 virtual void SetLabelPlacementMode(int mode);
207 virtual void SetLabelPlacementModeToNoOverlap() { this->SetLabelPlacementMode(NO_OVERLAP); }
208 virtual void SetLabelPlacementModeToAll() { this->SetLabelPlacementMode(ALL); }
210
211 enum
212 {
214 QT
215 };
216
218
223 virtual void SetLabelRenderMode(int mode);
224 virtual int GetLabelRenderMode();
225 virtual void SetLabelRenderModeToFreetype() { this->SetLabelRenderMode(FREETYPE); }
226 virtual void SetLabelRenderModeToQt() { this->SetLabelRenderMode(QT); }
228
230
234 vtkGetMacro(RenderOnMouseMove, bool);
235 vtkBooleanMacro(RenderOnMouseMove, bool);
237
238protected:
240 ~vtkRenderView() override;
241
247 void ProcessEvents(vtkObject* caller, unsigned long eventId, void* callData) override;
248
252 virtual void GenerateSelection(void* callData, vtkSelection* selection);
253
257 void PrepareForRendering() override;
258
262 virtual void UpdateHoverText();
263
269
275
283
286 int IconSize[2];
287 int DisplaySize[2];
288
291
298
299private:
300 vtkRenderView(const vtkRenderView&) = delete;
301 void operator=(const vtkRenderView&) = delete;
302};
303
304VTK_ABI_NAMESPACE_END
305#endif
superclass for all geometric transformations
a actor that draws 2D data
Definition vtkActor2D.h:44
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:38
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:58
draw vtkPolyData onto the image plane
A base view containing a renderer.
A view containing a renderer.
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.
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
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.
Hold a reference to a vtkObjectBase instance.
represent text properties.
handles properties associated with a texture map
Definition vtkTexture.h:67
actor that draws 2D data with texture support
transform points into different coordinate systems
Sets theme colors for a graphical view.