Computer Assisted Medical Intervention Tool Kit  version 5.1
InteractiveViewer.h
Go to the documentation of this file.
1/*****************************************************************************
2 * $CAMITK_LICENCE_BEGIN$
3 *
4 * CamiTK - Computer Assisted Medical Intervention ToolKit
5 * (c) 2001-2023 Univ. Grenoble Alpes, CNRS, Grenoble INP, TIMC, 38000 Grenoble, France
6 *
7 * Visit http://camitk.imag.fr for more information
8 *
9 * This file is part of CamiTK.
10 *
11 * CamiTK is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * CamiTK is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License version 3 for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22 *
23 * $CAMITK_LICENCE_END$
24 ****************************************************************************/
25
26
27#ifndef INTERACTIVE_VIEWER_H
28#define INTERACTIVE_VIEWER_H
29
30// -- Core stuff
31#include "CamiTKAPI.h"
32#include "Component.h"
33#include "Viewer.h"
34#include "RendererWidget.h"
36
37//-- QT stuff
38#include <QPushButton>
39#include <QWidgetAction>
40#include <QComboBox>
41class QToolBar;
42class QFrame;
43
44//-- vtk stuff
45#include <vtkType.h>
46#include <vtkSmartPointer.h>
47
48//-- vtk stuff classes
49class vtkActor;
50class vtkPicker;
51class vtkProp;
52class vtkObject;
53class vtkCamera;
54class vtkEventQtSlotConnect;
55
56namespace camitk {
57// -- Core stuff classes
58class SliderSpinBoxWidget;
59class GeometricObject;
60class InterfaceGeometry;
61class InterfaceBitMap;
62class InteractiveViewer;
63class MeshDataFilterModel;
64class PropertyObject;
65class Property;
66
67using vtkSmartPointerCamera = vtkSmartPointer<vtkCamera>;
68
113 Q_OBJECT
114 Q_ENUMS(HighlightMode RendererWidget::ControlMode RendererWidget::CameraOrientation); // so that it can be used in property editor
115
116public:
120 GEOMETRY_VIEWER
121 };
122
131 NO_PICKING
132 };
133
141 SELECTION_ONLY
142 };
143
145
149 Q_INVOKABLE InteractiveViewer(QString& name, camitk::InteractiveViewer::ViewerType type);
150
152 virtual ~InteractiveViewer() override;
153
155 QString getName() const;
157
162 void refresh(Viewer* whoIsAsking = nullptr) override;
163
165 QWidget* getWidget() override;
166
168 QObject* getPropertyObject() override;
169
171 QMenu* getMenu() override;
172
174 QToolBar* getToolBar() override;
176
180
182 void refreshRenderer();
183
185 void resetCamera();
186
188 void setActiveCamera(QString cameraName);
189
193 vtkSmartPointer<vtkCamera> getCamera(QString cameraName = "default");
194
196 void screenshot(QString);
197
198public slots:
200 void screenshot();
202
203public:
205 virtual void setGradientBackground(bool);
206
208 virtual void setBackgroundColor(QColor);
209
210public slots:
215 void setBackfaceCulling(bool);
216
221 void setFxaaAntialiasing(bool);
222
224 void setScreenshotAction(bool);
225
233 void setLinesAsTubes(bool tubes);
234
235public:
237 void keyPressEvent(QKeyEvent* e);
238
240 virtual void setHighlightMode();
241
244 return rendererWidget;
245 }
246
248
252 void setColorScale(bool);
253
255 bool getColorScale() const;
256
262 void setColorScaleMinMax(double m, double M);
263
267 void setColorScaleTitle(QString t);
268
270 void initPicking(PickingMode);
271
273 void getBoundsOfSelected(double* bound);
274
276 void getBounds(double* bound);
277
279 void setSideFrameVisible(bool);
281
282public slots:
283
286
288 void sliderChanged(int);
289
291 void xAngleChanged(double angle);
292
294 void yAngleChanged(double angle);
295
297 void zAngleChanged(double angle);
298
300 void toggleLogo(bool);
302
303protected:
304
306 void init();
307
319
321 void initSettings();
322
325
327 void toggleInterpolation();
328
330 void resetLUT();
331
333 void updateSelectionDisplay(Component*);
334
336 QMultiMap<Component*, vtkSmartPointer<vtkProp> > actorMap;
337
339 void addActor(Component*, vtkSmartPointer<vtkProp>);
340
342 void removeAllActors(Component*);
343
346
348 QMap<QString, vtkSmartPointerCamera> cameraMap;
350
355
359
362
364 QFrame* sideFrame;
365
368
370 friend void InteractiveViewerFrame::keyPressEvent(QKeyEvent* e);
371
374
376 QToolBar* viewerToolbar;
377
380
382
384 void initActions();
385
387 void updateActions();
388
391
396 QAction* pointsAction;
397 QAction* colorAction;
398 QAction* glyphAction;
399 QWidgetAction* scalarDataColorAction;
400
405
409
414
417
420
423
426
429
432
435
438
441
447
449
453
457 std::vector <Component*> pickedComponent;
458
461
464
467
470
473
474 vtkSmartPointer<vtkEventQtSlotConnect> connector;
475
477
482 QString whatsThis;
483
486
488 void initWhatsThis();
489
491 void startWhatsThisSection(const QString& title = "");
492
494 void endWhatsThisSection();
495
497 void addWhatsThisItem(const QString& key, const QString& description);
499
504
508
513
518
523
528
533
538
543
548
552 void createProperties();
553
560 bool eventFilter(QObject* object, QEvent* event) override;
561
563
564protected slots:
569 void renderingActorsChanged();
570
571 void highlightModeChanged(QAction* selectedAction);
572
573 void cameraOrientationChanged(QAction* selectedAction);
574
575 void viewControlModeChanged(QAction*);
576
577 void backgroundColor();
578
579 void toggleAxes(bool);
580
582
583 void pickingModeChanged(QAction*);
584
586 void picked();
587
588 void rightClick();
589
591 void setLabel(bool);
592
593 void setGlyph(bool);
594
596
597
598
599};
600
601}
602
604
605#endif
606
607//**************************************************************************
#define CAMITK_API
Definition: CamiTKAPI.h:49
const char * description
Definition: applications/cepgenerator/main.cpp:38
A Component represents something that could be included in the explorer view, the interactive 3D view...
Definition: sdk/libraries/core/component/Component.h:302
InteractiveViewerFrame is the basic container for the InteractiveViewer widget.
Definition: InteractiveViewerFrame.h:50
void keyPressEvent(QKeyEvent *) override
Handle keyboard events in the scene frame, just send everything to InteractiveViewer!
Definition: InteractiveViewerFrame.cpp:37
InteractiveViewer is used to view 3D objects and slices (anything that provides either a InterfaceBit...
Definition: InteractiveViewer.h:112
QToolBar * viewerToolbar
the QToolBar for the InteractiveViewer
Definition: InteractiveViewer.h:376
QAction * toggleAxesAction
button allows one to display the Axes in the InteractiveViewer
Definition: InteractiveViewer.h:419
Property * screenshotActionProperty
Property that tells whether the screenshot action is visible or not.
Definition: InteractiveViewer.h:542
QAction * glyphAction
Definition: InteractiveViewer.h:398
QAction * cameraOrientationLeftUpAction
Definition: InteractiveViewer.h:412
QToolBar * screenshotActionMenu
the screenshot action is inside this menu (in the slice viewer side bar)
Definition: InteractiveViewer.h:367
QAction * highlightSelectionAction
display mode
Definition: InteractiveViewer.h:402
Property * backfaceCullingProperty
Property that tells whether the viewer uses the backface culling option or not.
Definition: InteractiveViewer.h:532
QWidgetAction * scalarDataColorAction
Definition: InteractiveViewer.h:399
bool isPicking
Indicates that this viewer is picking.
Definition: InteractiveViewer.h:463
QAction * cameraOrientationRightUpAction
Definition: InteractiveViewer.h:413
PickingMode
Different kind of picking must be available: pixel in slice, a point, a cell, ... So far,...
Definition: InteractiveViewer.h:125
@ AREA_CELL_PICKING
pick cells that are inside a rectangular area in the VTK representation of an Geometry
Definition: InteractiveViewer.h:129
@ CELL_PICKING
pick a cell in the VTK representation of an Geometry
Definition: InteractiveViewer.h:128
@ AREA_POINT_PICKING
pick points that are inside a rectangular area in the VTK representation of an Geometry
Definition: InteractiveViewer.h:130
@ POINT_PICKING
pick a point in the VTK representation of an Geometry
Definition: InteractiveViewer.h:127
@ PIXEL_PICKING
pick a pixel on a Slice
Definition: InteractiveViewer.h:126
QString whatsThis
Definition: InteractiveViewer.h:482
bool oddWhatsThis
are we currently in a odd table line
Definition: InteractiveViewer.h:485
RendererWidget * rendererWidget
Definition: InteractiveViewer.h:354
QAction * toggleLabelAction
button allows one to display the labels of the object3D
Definition: InteractiveViewer.h:428
QAction * backgroundColorAction
background color
Definition: InteractiveViewer.h:416
InteractiveViewerFrame * frame
the InteractiveViewer frame
Definition: InteractiveViewer.h:361
MeshDataFilterModel * scalarDataModel
Definition: InteractiveViewer.h:381
bool isChangingSlice
Indicates that this viewer is changing the slice by the slice slider.
Definition: InteractiveViewer.h:466
vtkSmartPointer< vtkEventQtSlotConnect > connector
Definition: InteractiveViewer.h:474
ViewerType myType
type of InteractiveViewer (display slice or geometry)
Definition: InteractiveViewer.h:324
QAction * wireframeAction
Definition: InteractiveViewer.h:395
QAction * highlightOffAction
Definition: InteractiveViewer.h:404
Property * highlightModeProperty
The property that stands for the type of highlight mode of the 3D viewer.
Definition: InteractiveViewer.h:512
Property * linesAsTubesProperty
Property that tells whether the viewer uses lines as tubes or not.
Definition: InteractiveViewer.h:527
Property * backgroundColorProperty
The property that stands for the background color of the viewer.
Definition: InteractiveViewer.h:517
bool pickingEffectUpdated
was the picking effect updated (it has to be updated with the first picking for a given button down s...
Definition: InteractiveViewer.h:472
SliderSpinBoxWidget * sliceSlider
Slider used to control the slice index in a InteractiveViewer.
Definition: InteractiveViewer.h:358
QAction * toggleFxaaAntialiasingAction
FXAA antialiasing.
Definition: InteractiveViewer.h:437
QAction * colorAction
Definition: InteractiveViewer.h:397
QAction * screenshotAction
Screenshot.
Definition: InteractiveViewer.h:390
Property * fxaaAntialiasingProperty
Property that tells whether the viewer uses the backface culling option or not.
Definition: InteractiveViewer.h:537
PropertyObject * propertyObject
The property object that holds the properties of this viewer.
Definition: InteractiveViewer.h:507
QAction * surfaceAction
Definition: InteractiveViewer.h:394
QMenu * renderingMenu
Rendering.
Definition: InteractiveViewer.h:393
QAction * pointsAction
Definition: InteractiveViewer.h:396
QAction * pickPointRegionAction
Definition: InteractiveViewer.h:446
QAction * pickCellAction
Definition: InteractiveViewer.h:444
QAction * cameraOrientationRightDownAction
to change the axes view mode
Definition: InteractiveViewer.h:411
QAction * controlModeJoystickAction
Definition: InteractiveViewer.h:408
bool pickingEffectIsSelecting
picking effect while mouse button is kept pressed is selecting (depends on the selection state of the...
Definition: InteractiveViewer.h:469
Property * backgroundGradientColorProperty
Property that tells whether the viewer use a gradient background color or not.
Definition: InteractiveViewer.h:522
QAction * toggleLogoAction
button to remove the copyright
Definition: InteractiveViewer.h:425
QAction * toggleBackfaceCullingAction
back face culling
Definition: InteractiveViewer.h:434
QAction * toggleOrientationDecorationsAction
button allows one to display orientation decoration in SLICE_VIEWER mode
Definition: InteractiveViewer.h:422
QAction * toggleLinesAsTubesAction
button allows one to display the lines as tubes (the lines are to be in vtkPolyData)
Definition: InteractiveViewer.h:431
PickingMode pickingMode
Current picking mode, NO_PICKING be default.
Definition: InteractiveViewer.h:460
unsigned int displayedTopLevelComponents
number of top-level component that are currently displayed
Definition: InteractiveViewer.h:345
QAction * pickCellRegionAction
Definition: InteractiveViewer.h:445
RendererWidget * getRendererWidget()
return interactiveViewer RendererWidget
Definition: InteractiveViewer.h:243
HighlightMode
describes the current mode of display.
Definition: InteractiveViewer.h:138
@ SELECTION
the selected Components are in default mode, the non-selected Components are shaded
Definition: InteractiveViewer.h:140
@ OFF
both selected and non-selected Components are in default mode
Definition: InteractiveViewer.h:139
QAction * controlModeTrackballAction
to change the camera control mode
Definition: InteractiveViewer.h:407
QAction * pickPointAction
action of the picking menu
Definition: InteractiveViewer.h:443
QComboBox * scalarDataComboBox
the ComboBox for mesh scalar data
Definition: InteractiveViewer.h:379
QAction * highlightSelectionOnlyAction
Definition: InteractiveViewer.h:403
QMap< QString, vtkSmartPointerCamera > cameraMap
all the available camera
Definition: InteractiveViewer.h:348
Property * pointSizeProperty
Property which defines the point size of each point in the 3D viewer.
Definition: InteractiveViewer.h:547
QFrame * sideFrame
the right side frame (this is where the slider and screenshot buttons are shown)
Definition: InteractiveViewer.h:364
QMenu * viewerMenu
the QMenu for the InteractiveViewer
Definition: InteractiveViewer.h:373
QMultiMap< Component *, vtkSmartPointer< vtkProp > > actorMap
the map containing all the actors in the InteractiveViewer
Definition: InteractiveViewer.h:336
std::vector< Component * > pickedComponent
list of Component that are currently picked, correctly displayed in the InteractiveViewer,...
Definition: InteractiveViewer.h:457
ViewerType
there is two possibilities: this InteractiveViewer is used to display slices or geometry
Definition: InteractiveViewer.h:118
@ SLICE_VIEWER
display slices (the view is blocked in 2D and the slider is available)
Definition: InteractiveViewer.h:119
QAction * toggleScreenshotAction
visibility of the screenshot action in the side toolbar of slice viewer
Definition: InteractiveViewer.h:440
CamiTK intern class to help automatically sort or show specific data.
Definition: MeshDataModel.h:108
This class describes a property object.
Definition: PropertyObject.h:71
This class describes a property that can be used in components and actions or any class that needs to...
Definition: Property.h:280
A utility class to have QSpinBox and QSlider synchronized.
Definition: SliderSpinBoxWidget.h:45
Viewer is an abstract class that is the base class for all viewers.
Definition: Viewer.h:180
CameraOrientation
RendererWidget implements all support methods to use camiTK with Qt interface.
Definition: RendererWidget.h:155
Definition: Action.cpp:35
void setBackfaceCulling(bool)
void setColorScale(bool)
display the color scale in the viewport, use setColorScaleMinMax to change the displayed values
void setGradientBackground(bool)
set the gradient background
void setColorScaleMinMax(double m, double M)
set the min and max values.
void setFxaaAntialiasing(bool)
Set/unset FXAA Antialiasing in renderer.
void setColorScaleTitle(QString t)
set the color scale title.
setBackgroundColor(0.0, 0.0, 0.0)
void toggleLogo(bool)
toggle logo
vtkSmartPointer< vtkCamera > vtkSmartPointerCamera
Definition: InteractiveViewer.h:67
void toggleOrientationDecorations(bool)
display orientation decorations
void toggleAxes(bool)
display the axes
void keyPressEvent(QKeyEvent *e) override
key events (do nothing but pass on e to the parent widget), please do not add any shortcut management...
RendererWidget(QWidget *parent=nullptr, ControlMode mode=RendererWidget::TRACKBALL)
constructors.
bool getColorScale() const
get the color display state
void refresh()
refresh the display
void resetCamera()
reset the camera to the default position, default FOV.
void screenshot(QString filename)
save the screenshot in a file
void setActiveCamera(vtkCamera *cam)
set active camera