Computer Assited Medical Intervention Tool Kit  version 4.1
Public Slots | Public Member Functions | Private Types | List of all members
camitk::InteractiveViewer Class Reference

InteractiveViewer is used to view 3D objects and slices (anything that provides either a InterfaceBitMap or a InterfaceGeometry). More...

#include <InteractiveViewer.h>

Inherits camitk::Viewer.

Public Slots

void sliderChanged (int)
 Slot called when the InteractiveViewer slider has been changed. More...
 
void toggleCopyright (bool)
 show/hide the copyright in 3D More...
 
void xAngleChanged (double angle)
 Slot called when the InteractiveViewer x angle update has been changed. More...
 
void yAngleChanged (double angle)
 Slot called when the InteractiveViewer y angle update has been changed. More...
 
void zAngleChanged (double angle)
 Slot called when the InteractiveViewer z angle update has been changed. More...
 

Public Member Functions

virtual void setBackgroundColor (QColor)
 set background color More...
 
virtual void setGradientBackground (bool)
 set gradient background on/off More...
 
Misc
void setColorScale (bool)
 
bool getColorScale () const
 get the current value of the color scale property. More...
 
void setColorScaleMinMax (double m, double M)
 set the min and max values. More...
 
void setColorScaleTitle (QString t)
 set the color scale title. More...
 
void initPicking (PickingMode)
 Init the picker with a given picking mode. More...
 
void getBoundsOfSelected (double *bound)
 Compute the bounding box of the selected elements [xmin,xmax, ymin,ymax, zmin,zmax]. More...
 
void getBounds (double *bound)
 Compute the bounding box of all displayed Component. More...
 
void setSideFrameVisible (bool)
 set the slice viewer side bar+screenshot button visibility More...
 
- Public Member Functions inherited from camitk::Viewer
virtual void refreshInterfaceNode (Component *comp)
 Update the whole tree of the representation of the Component. More...
 
 Viewer (QString name)
 default constructor More...
 
 ~Viewer () override=default
 default destructor More...
 

Protected Slots

All the slots called by the menu actions
void renderingActorsChanged ()
 
void highlightModeChanged (QAction *selectedAction)
 
void cameraOrientationChanged (QAction *selectedAction)
 
void viewControlModeChanged (QAction *)
 
void backgroundColor ()
 
void toggleAxes (bool)
 
void toggleOrientationDecorations (bool)
 
void pickingModeChanged (QAction *)
 
void picked ()
 get the picker and populate the picked component with the picked stuff More...
 
void rightClick ()
 
void setLabel (bool)
 if true currently selected Components label will have their label on (shown) More...
 
void setGlyph (bool)
 

Protected Attributes

Picking management
std::vector< Component * > pickedComponent
 list of Component that are currently picked, correctly displayed in the InteractiveViewer, but for speed optimization that are not yet selected in the explorer. More...
 
PickingMode pickingMode
 Current picking mode, NO_PICKING be default. More...
 
bool isPicking
 Indicates that this viewer is picking. More...
 
bool isChangingSlice
 Indicates that this viewer is changing the slice by the slice slider. More...
 
bool pickingEffectIsSelecting
 picking effect while mouse button is kept pressed is selecting (depends on the selection state of the first component picked) More...
 
bool pickingEffectUpdated
 was the picking effect updated (it has to be updated with the first picking for a given button down session) More...
 
vtkSmartPointer< vtkEventQtSlotConnect > connector
 

Private Types

enum  HighlightMode { OFF, SELECTION, SELECTION_ONLY }
 describes the current mode of display. More...
 
enum  PickingMode {
  PIXEL_PICKING, POINT_PICKING, CELL_PICKING, AREA_CELL_PICKING,
  AREA_POINT_PICKING, NO_PICKING
}
 Different kind of picking must be available: pixel in slice, a point, a cell, ... More...
 

Private Member Functions

Inherited from Viewer
unsigned int numberOfViewedComponent () override
 
void refresh (Viewer *whoIsAsking=nullptr) override
 Refresh the display. More...
 
QWidget * getWidget (QWidget *parent) override
 get the InteractiveViewer widget (QTreeWidget). More...
 
QObject * getPropertyObject () override
 get the InteractiveViewer propertyObject (only non-null for GEOMETRY_VIEWER) More...
 
QMenu * getMenu () override
 get the explorer menu More...
 
QToolBar * getToolBar () override
 get the viewer toolbar More...
 

General/Singleton

static QMap< QString, InteractiveViewer * > viewers
 the map containing all the InteractiveViewer instances More...
 
static QString defaultNames [5] = {QString("3DViewer"), QString("axialViewer"), QString("coronalViewer"), QString("sagittalViewer"), QString("arbitraryViewer") }
 the QString array containing all InteractiveViewer instance default names More...
 
static InteractiveViewergetNewViewer (QString, ViewerType type)
 Use this method to create a new custom instance of this class. More...
 
static InteractiveViewergetViewer (QString)
 get a viewer by its name (return NULL if no instance has the given name, use getNewViewer to create one viewer) More...
 
static InteractiveViewerget3DViewer ()
 get the 3D viewer default InteractiveViewer (provided for convenience, equivalent to getViewer("3DViewer") More...
 
static InteractiveViewergetAxialViewer ()
 get the axial default InteractiveViewer (provided for convenience, equivalent to getViewer("axialViewer") More...
 
static InteractiveViewergetCoronalViewer ()
 get the coronal default InteractiveViewer (provided for convenience, equivalent to getViewer("coronalViewer") More...
 
static InteractiveViewergetSagittalViewer ()
 get the sagittal default InteractiveViewer (provided for convenience, equivalent to getViewer("sagittalViewer") More...
 
static InteractiveViewergetArbitraryViewer ()
 get the arbitrary default InteractiveViewer (provided for convenience, equivalent to getViewer("arbitraryViewer") More...
 
 ~InteractiveViewer () override
 Destructor. More...
 
QString getName () const
 get the scene name More...
 
 InteractiveViewer (QString &name, ViewerType type)
 Construtor. More...
 

Refresh/screenshot

void refreshRenderer ()
 just refresh the renderer More...
 
void resetCamera ()
 Reset scene camera. More...
 
void setActiveCamera (QString cameraName)
 Set the active virtual camera. More...
 
vtkSmartPointer< vtkCamera > getCamera (QString cameraName="default")
 get a camera by its name, creates one if it does not exist already. More...
 
void screenshot (QString)
 call this method to take a screenshot using the given filename (the extension must be a supported format extension, see class RendererWindow) More...
 
void screenshot ()
 call this method to take a screenshot in various format and write the resulting image to a file More...
 

Viewing/Interaction Property

void setBackfaceCulling (bool)
 set the backface culling mode (default is true). More...
 
void setScreenshotAction (bool)
 visibility of the screenshot in slice viewers More...
 
void setLinesAsTubes (bool tubes)
 get the backface current culling mode. More...
 
void keyPressEvent (QKeyEvent *e)
 Handle keyboard events in the scene, let to the parent widget if not processed here. This method is a friend of class InteractiveViewerFrame. More...
 
virtual void setHighlightMode (InteractiveViewer::HighlightMode)
 Set the current highlighting mode. More...
 
RendererWidgetgetRendererWidget ()
 return interactiveViewer RendererWidget More...
 

Display properties

Properties that can be managed without the knowledge/intervention of the InterfaceGeometry:

  • pointSize (the user preferred value is stored here, the access to the actor needs InterfaceGeometry knowledge)
  • interpolation (toggle, this is a boolean state, kept by each vtkImageActor interpolate property)

Properties that need to be managed by the InterfaceGeometry itself (not boolean state managed somewhere by vtk, not integer/float value manage in InteractiveViewer as a user-preference)

  • linesAsTubes (the InterfaceGeometry needs to add/manage a filter before the mapper)
ViewerType myType
 type of InteractiveViewer (display slice or geometry) More...
 
QMultiMap< Component *, vtkSmartPointer< vtkProp > > actorMap
 the map containing all the actors in the InteractiveViewer More...
 
unsigned int displayedTopLevelComponents
 number of top-level component that are currently displayed More...
 
QMap< QString, vtkSmartPointerCameracameraMap
 all the available camera More...
 
void initSettings ()
 initialize the property object and state using the user settings (user preferences system files .config/.ini) More...
 
void toggleInterpolation ()
 for InterfaceBitMap, toggle the interpolation mode (intern method, not a property because it can only be modified by the keyboard interaction) More...
 
void updateSelectionDisplay (Component *)
 Update the display of the given Component, according to its selection state and the current HighlightMode. More...
 
void addActor (Component *, vtkSmartPointer< vtkProp >)
 add the given actor of the given Component to the renderer and insert it in the map More...
 
void removeAllActors (Component *)
 remove all the given Component actors from the renderer and delete comp from the map More...
 

Widget/Action management

RendererWidgetrendererWidget
 
SliderSpinBoxWidgetsliceSlider
 Slider used to control the slice index in a InteractiveViewer. More...
 
InteractiveViewerFrameframe
 the InteractiveViewer frame More...
 
QFrame * sideFrame
 the right side frame (this is where the slider and screenshot buttons are shown) More...
 
QToolBar * screenshotActionMenu
 the screenshot action is inside this menu (in the slice viewer side bar) More...
 
QMenu * viewerMenu
 the QMenu for the InteractiveViewer More...
 
QToolBar * viewerToolBar
 the QToolBar for the InteractiveViewer More...
 
QComboBox * scalarDataComboBox
 the ComboBox for mesh scalar data More...
 
MeshDataFilterModelscalarDataModel
 
QAction * screenshotAction
 Screenshot. More...
 
QMenu * renderingMenu
 Rendering. More...
 
QAction * surfaceAction
 
QAction * wireframeAction
 
QAction * pointsAction
 
QAction * colorAction
 
QAction * glyphAction
 
QWidgetAction * scalarDataColorAction
 
QAction * highlightSelectionAction
 display mode More...
 
QAction * highlightSelectionOnlyAction
 
QAction * highlightOffAction
 
QAction * controlModeTrackballAction
 to change the camera control mode More...
 
QAction * controlModeJoystickAction
 
QAction * cameraOrientationRightDownAction
 to change the axes view mode More...
 
QAction * cameraOrientationLeftUpAction
 
QAction * cameraOrientationRightUpAction
 
QAction * backgroundColorAction
 background color More...
 
QAction * toggleAxesAction
 button allows one to display the Axes in the InteractiveViewer More...
 
QAction * toggleOrientationDecorationsAction
 button allows one to display orientation decoration in SLICE_VIEWER mode More...
 
QAction * toggleCopyrightAction
 button to remove the copyright More...
 
QAction * toggleLabelAction
 button allows one to display the labels of the object3D More...
 
QAction * toggleLinesAsTubesAction
 button allows one to display the lines as tubes (the lines are to be in vtkPolyData) More...
 
QAction * toggleBackfaceCullingAction
 back face culling More...
 
QAction * toggleScreenshotAction
 visibility of the screenshot action in the side toolbar of slice viewer More...
 
QAction * pickPointAction
 action of the picking menu More...
 
QAction * pickCellAction
 
QAction * pickCellRegionAction
 
QAction * pickPointRegionAction
 
void initActions ()
 init all the actions (called only once in the getWidget() method) More...
 
void updateActions ()
 update the viewer menu depending on the selection,... More...
 
void InteractiveViewerFrame::keyPressEvent (QKeyEvent *e)
 the InteractiveViewerFrame keyPressEvent is a good friend of InteractiveViewer More...
 

Help Whats This Utility

QString whatsThis
 
bool oddWhatsThis
 are we currently in a odd table line More...
 
void initWhatsThis ()
 initialize the what's this html string More...
 
void startWhatsThisSection (const QString &title="")
 start a table (section) in the what's this message More...
 
void endWhatsThisSection ()
 end a table (section) in the what's this message More...
 
void addWhatsThisItem (const QString &key, const QString &description)
 add an item (row) in the the what's this message (to describe a shortcut) More...
 

CamiTK Properties of this viewer

PropertyObjectpropertyObject
 The property object that holds the properties of this viewer. More...
 
PropertyhighlightModeProperty
 The property that stands for the type of highlight mode of the 3D viewer. More...
 
PropertybackgroundColorProperty
 The property that stands for the background color of the viewer. More...
 
PropertybackgroundGradientColorProperty
 Property that tells whether the viewer use a gradient background color or not. More...
 
PropertylinesAsTubesProperty
 Property that tells whether the viewer uses lines as tubes or not. More...
 
PropertybackfaceCullingProperty
 Property that tells whether the viewer uses the backface culling option or not. More...
 
PropertyscreenshotActionProperty
 Property that tells whether the screenshot action is visible or not. More...
 
PropertypointSizeProperty
 Property which defines the point size of each point in the 3D viewer. More...
 
void createProperties ()
 Create and handle the CamiTK properties of this viewer. More...
 
bool eventFilter (QObject *object, QEvent *event) override
 Event filter of this class instance to watch its properties instances. More...
 

Additional Inherited Members

- Signals inherited from camitk::Viewer
void selectionChanged ()
 this signal is emitted when the current selection was changed by the viewer More...
 
- Protected Member Functions inherited from camitk::Viewer
void clearSelection ()
 clear the selection More...
 
void selectionChanged (ComponentList &compSet)
 The selection has changed to the given ComponentList. More...
 
void selectionChanged (Component *comp)
 the selection has changed to be just one comp More...
 

Detailed Description

InteractiveViewer is used to view 3D objects and slices (anything that provides either a InterfaceBitMap or a InterfaceGeometry).

It contains a renderer (class RendererWidget) that combines VTK and QT. The RendererWidget instance manage all the display at the VTK level. InteractiveViewer delegates all pure VTK level stuff to the renderer. All things that needs InterfaceBitMap/InterfaceGeometry interaction/knowledge/access are manage at this level. The keyboard events are all managed in InteractiveViewer as well. Keyboard/Mouse interactions: check "what's this?" on the scene 3D to get all interaction shortcuts.

There are five default InteractiveViewer "singleton" instances named:

InteractiveViewer class is completely independent from MainWindow application skeleton (and please keep it that way!)

InteractiveViewer manages a list of cameras. Each camera has a name. Use getCamera(QString) to create a new camera, or get the default camera and setActiveCamera(QString) to change the active camera. The default camera is called "default".

InteractiveViewer manages picking session. A picking session starts when the control key is pressed and the left mouse button is clicked and ends when the mouse button is released. A picking session is a nice/quick way to do a lot of picking by simply moving the mouse, without the need to click for each picking. At the start of a picking session, the picking action is determined: it is either selection or unselection. If one of the first picked components was already selected, then the user wants to unselect, therefore picking action is "unselection", and all subsequently calls to pickPoint(..) or pickCell(..) will use pickingIsSelecting=false (2nd parameter of the method). If the first picked component was not selected, then the picking session is going to select any picked component.

See also
InterfaceGeometry::pickPoint() InterfaceGeometry::pickCell()

The following help is for InteractiveViewer/RendererWidget developers, please read if you want/need to change anything in one of this two class. It should help you in your coding decisions (hopefully!).

  1. Keyboard shortcut policy: for keyboard shortcuts do not use the Ctrl key modifier for letters/digit (e.g Alt-P is ok, Ctrl+Arrows is ok, but Ctrl-P is not). Ctrl-Letter/Digit shortcuts should only be used for the application shortcuts.
  2. That's it for now!

Member Enumeration Documentation

◆ HighlightMode

describes the current mode of display.

It is useful to change the way the currently selected Components look compared to the unselected ones. In the default mode a Component is not highlighted, not shaded and not hidden.

Enumerator
OFF 

both selected and non-selected Components are in default mode

SELECTION 

the selected Components are in default mode, the non-selected Components are shaded

SELECTION_ONLY 

the selected Components are in default mode, the non-selected are hidden

◆ PickingMode

Different kind of picking must be available: pixel in slice, a point, a cell, ...

So far, only pixel picking is implemented.

Enumerator
PIXEL_PICKING 

pick a pixel on a Slice

POINT_PICKING 

pick a point in the VTK representation of an Geometry

CELL_PICKING 

pick a cell in the VTK representation of an Geometry

AREA_CELL_PICKING 

pick cells that are inside a rectangular area in the VTK representation of an Geometry

AREA_POINT_PICKING 

pick points that are inside a rectangular area in the VTK representation of an Geometry

NO_PICKING 

no picking possible

Constructor & Destructor Documentation

◆ ~InteractiveViewer()

camitk::InteractiveViewer::~InteractiveViewer ( )
overrideprivate

Destructor.

References frame, getName(), viewerMenu, viewers, and viewerToolBar.

◆ InteractiveViewer()

camitk::InteractiveViewer::InteractiveViewer ( QString &  name,
ViewerType  type 
)
protected

Construtor.

Parameters
namethe name of the scene is mandatory, it is used as an identifier (e.g. in MedicalImageViewer)
typetype of the InteractiveViewer, depending on which it will behave as slice viewer, i.e. with no rotation interactions are possible, or 3D viewer

References cameraMap, connector, createProperties(), displayedTopLevelComponents, frame, camitk::RendererWidget::getActiveCamera(), initPicking(), initSettings(), isChangingSlice, isPicking, myType, NO_PICKING, picked(), pickingEffectIsSelecting, PIXEL_PICKING, rendererWidget, screenshotActionMenu, sliceSlider, camitk::RendererWidget::TRACKBALL_2D, viewerMenu, and viewerToolBar.

Referenced by getNewViewer().

Member Function Documentation

◆ addActor()

void camitk::InteractiveViewer::addActor ( Component comp,
vtkSmartPointer< vtkProp >  a 
)
protected

add the given actor of the given Component to the renderer and insert it in the map

References actorMap, camitk::RendererWidget::addProp(), and rendererWidget.

Referenced by refresh().

◆ addWhatsThisItem()

void camitk::InteractiveViewer::addWhatsThisItem ( const QString &  key,
const QString &  description 
)
protected

add an item (row) in the the what's this message (to describe a shortcut)

References oddWhatsThis, and whatsThis.

Referenced by getWidget().

◆ backgroundColor

void camitk::InteractiveViewer::backgroundColor ( )
protectedslot

◆ cameraOrientationChanged

void camitk::InteractiveViewer::cameraOrientationChanged ( QAction *  selectedAction)
protectedslot

◆ createProperties()

void camitk::InteractiveViewer::createProperties ( )
protected

◆ endWhatsThisSection()

void camitk::InteractiveViewer::endWhatsThisSection ( )
protected

end a table (section) in the what's this message

References whatsThis.

Referenced by getWidget().

◆ eventFilter()

bool camitk::InteractiveViewer::eventFilter ( QObject *  object,
QEvent *  event 
)
overrideprotected

◆ get3DViewer()

InteractiveViewer * camitk::InteractiveViewer::get3DViewer ( )
staticprivate

◆ getArbitraryViewer()

InteractiveViewer * camitk::InteractiveViewer::getArbitraryViewer ( )
staticprivate

get the arbitrary default InteractiveViewer (provided for convenience, equivalent to getViewer("arbitraryViewer")

References defaultNames, and getViewer().

Referenced by camitk::MedicalImageViewer::getWidget(), and camitk::SingleImageComponent::initRepresentation().

◆ getAxialViewer()

InteractiveViewer * camitk::InteractiveViewer::getAxialViewer ( )
staticprivate

get the axial default InteractiveViewer (provided for convenience, equivalent to getViewer("axialViewer")

References defaultNames, and getViewer().

Referenced by camitk::MedicalImageViewer::getWidget(), camitk::SingleImageComponent::initRepresentation(), and camitk::MedicalImageViewer::refresh().

◆ getBounds()

void camitk::InteractiveViewer::getBounds ( double *  bound)

Compute the bounding box of all displayed Component.

References camitk::RendererWidget::computeVisiblePropBounds(), and rendererWidget.

◆ getBoundsOfSelected()

void camitk::InteractiveViewer::getBoundsOfSelected ( double *  bound)

Compute the bounding box of the selected elements [xmin,xmax, ymin,ymax, zmin,zmax].

References actorMap, camitk::Component::getBounds(), and camitk::Component::isSelected().

Referenced by keyPressEvent().

◆ getCamera()

vtkSmartPointer< vtkCamera > camitk::InteractiveViewer::getCamera ( QString  cameraName = "default")
private

get a camera by its name, creates one if it does not exist already.

This method does not activate the given camera, please use setActiveCamera for this.

References cameraMap.

◆ getColorScale()

bool camitk::InteractiveViewer::getColorScale ( ) const

get the current value of the color scale property.

References camitk::RendererWidget::getColorScale(), and rendererWidget.

◆ getCoronalViewer()

InteractiveViewer * camitk::InteractiveViewer::getCoronalViewer ( )
staticprivate

get the coronal default InteractiveViewer (provided for convenience, equivalent to getViewer("coronalViewer")

References defaultNames, and getViewer().

Referenced by camitk::MedicalImageViewer::getWidget(), camitk::SingleImageComponent::initRepresentation(), and camitk::MedicalImageViewer::refresh().

◆ getMenu()

QMenu * camitk::InteractiveViewer::getMenu ( )
overrideprivatevirtual

◆ getName()

QString camitk::InteractiveViewer::getName ( ) const
private

get the scene name

Referenced by createProperties(), keyPressEvent(), and ~InteractiveViewer().

◆ getNewViewer()

InteractiveViewer * camitk::InteractiveViewer::getNewViewer ( QString  name,
ViewerType  type 
)
staticprivate

Use this method to create a new custom instance of this class.

Of course you can create as many InteractiveViewer instance as you like, but if you try to create a InteractiveViewer with a name that match one of the default InteractiveViewer name, getNewViewer(..) automatically will return the corresponding default InteractiveViewer instance.

References InteractiveViewer(), and viewers.

Referenced by getViewer().

◆ getPropertyObject()

QObject * camitk::InteractiveViewer::getPropertyObject ( )
overrideprivatevirtual

get the InteractiveViewer propertyObject (only non-null for GEOMETRY_VIEWER)

Reimplemented from camitk::Viewer.

References myType, and propertyObject.

Referenced by camitk::MedicalImageViewer::getPropertyObject().

◆ getRendererWidget()

RendererWidget* camitk::InteractiveViewer::getRendererWidget ( )
inline

◆ getSagittalViewer()

InteractiveViewer * camitk::InteractiveViewer::getSagittalViewer ( )
staticprivate

get the sagittal default InteractiveViewer (provided for convenience, equivalent to getViewer("sagittalViewer")

References defaultNames, and getViewer().

Referenced by camitk::MedicalImageViewer::getWidget(), camitk::SingleImageComponent::initRepresentation(), and camitk::MedicalImageViewer::refresh().

◆ getToolBar()

QToolBar * camitk::InteractiveViewer::getToolBar ( )
overrideprivatevirtual

◆ getViewer()

InteractiveViewer * camitk::InteractiveViewer::getViewer ( QString  name)
staticprivate

◆ getWidget()

QWidget * camitk::InteractiveViewer::getWidget ( QWidget *  parent)
overrideprivatevirtual

◆ highlightModeChanged

void camitk::InteractiveViewer::highlightModeChanged ( QAction *  selectedAction)
protectedslot

◆ initActions()

void camitk::InteractiveViewer::initActions ( )
protected

init all the actions (called only once in the getWidget() method)

References backfaceCullingProperty, backgroundColor(), backgroundColorAction, cameraOrientationChanged(), cameraOrientationLeftUpAction, cameraOrientationRightDownAction, cameraOrientationRightUpAction, camitk::MeshComponent::CELLS, colorAction, controlModeJoystickAction, controlModeTrackballAction, camitk::Application::getAction(), camitk::RendererWidget::getCameraOrientation(), camitk::Property::getName(), camitk::Action::getQAction(), glyphAction, highlightModeChanged(), highlightOffAction, highlightSelectionAction, highlightSelectionOnlyAction, camitk::RendererWidget::LEFT_UP, linesAsTubesProperty, myType, pickCellAction, pickCellRegionAction, pickingModeChanged(), pickPointAction, pickPointRegionAction, camitk::MeshComponent::POINTS, pointsAction, propertyObject, rendererWidget, renderingActorsChanged(), renderingMenu, camitk::RendererWidget::RIGHT_DOWN, camitk::RendererWidget::RIGHT_UP, scalarDataColorAction, scalarDataComboBox, scalarDataModel, camitk::MeshComponent::SCALARS, screenshot(), screenshotAction, screenshotActionProperty, setBackfaceCulling(), setGlyph(), setLabel(), setLinesAsTubes(), setScreenshotAction(), surfaceAction, toggleAxes(), toggleAxesAction, toggleBackfaceCullingAction, toggleCopyright(), toggleCopyrightAction, toggleLabelAction, toggleLinesAsTubesAction, toggleOrientationDecorations(), toggleOrientationDecorationsAction, toggleScreenshotAction, viewControlModeChanged(), viewerToolBar, and wireframeAction.

Referenced by getWidget().

◆ initPicking()

void camitk::InteractiveViewer::initPicking ( PickingMode  pickingMode)

◆ initSettings()

void camitk::InteractiveViewer::initSettings ( )
protected

◆ initWhatsThis()

void camitk::InteractiveViewer::initWhatsThis ( )
protected

initialize the what's this html string

References whatsThis.

Referenced by getWidget().

◆ keyPressEvent()

void camitk::InteractiveViewer::keyPressEvent ( QKeyEvent *  e)

Handle keyboard events in the scene, let to the parent widget if not processed here. This method is a friend of class InteractiveViewerFrame.

NOTE:

PLEASE, PLEASE, PLEASE, PLEASE, PLEASE, PLEASE

DO NOT FORGET TO ADD A NEW LINE IN THE "WHAT'S THIS" MESSAGE (see constructor)

The call to methods startWhatsThisSection and addWhatsThisItem is a good comment line to add here (see below!). Please use the same order here than in the what's this help (by category, then by function, then by key name)

(PLEASE)

startWhatsThisSection("Keyboard bindings (upper or lower case)");

startWhatsThisSection();

startWhatsThisSection("Other Shortcuts");

NOTE:

PLEASE, PLEASE, PLEASE, PLEASE, PLEASE, PLEASE?

DO NOT FORGET TO ADD A NEW LINE IN THE "WHAT'S THIS" MESSAGE (see constructor)

The call to methods startWhatsThisSection and addWhatsThisItem is a good comment line to add here (see below!). Please use the same order here than in the what's this help (by category, then by function, then by key name)

(PLEASE)

References actorMap, camitk::SliderSpinBoxWidget::addPageStep(), camitk::SliderSpinBoxWidget::addSingleStep(), CAMITK_INFO, camitk::Viewer::clearSelection(), camitk::RendererWidget::computeVisiblePropBounds(), camitk::Component::GEOMETRY, camitk::InterfaceBitMap::get2DImageActor(), camitk::Component::getActor, camitk::RendererWidget::getBackfaceCulling(), getBoundsOfSelected(), camitk::RendererWidget::getCameraSettings(), camitk::RendererWidget::getColorScale(), camitk::RendererWidget::getLightFollowCamera(), getName(), camitk::Component::getName(), camitk::Component::getNumberOfProp(), camitk::InterfaceBitMap::getPickPlaneActor(), camitk::Component::getPixelActor, camitk::Component::getProp(), camitk::Component::getRenderingModes(), camitk::Component::getRepresentation(), camitk::Application::getSelectedComponents(), camitk::Component::getVisibility(), camitk::RendererWidget::JOYSTICK, myType, camitk::RendererWidget::pick(), camitk::InterfaceGeometry::Points, refresh(), camitk::RendererWidget::refresh(), rendererWidget, resetCamera(), camitk::RendererWidget::rotateCamera(), screenshot(), camitk::RendererWidget::setBackfaceCulling(), setColorScale(), camitk::RendererWidget::setControlMode(), camitk::RendererWidget::setLightFollowCamera(), camitk::Component::setRenderingModes, sliceSlider, camitk::SliderSpinBoxWidget::subPageStep(), camitk::SliderSpinBoxWidget::subSingleStep(), camitk::InterfaceGeometry::Surface, toggleAxesAction, toggleInterpolation(), toggleLabelAction, camitk::RendererWidget::toogle3DRedBlue(), camitk::RendererWidget::TRACKBALL, whatsThis, and camitk::InterfaceGeometry::Wireframe.

◆ numberOfViewedComponent()

unsigned int camitk::InteractiveViewer::numberOfViewedComponent ( )
overrideprivatevirtual

returns the number of Component that are displayed by this viewer

Implements camitk::Viewer.

References actorMap.

◆ picked

void camitk::InteractiveViewer::picked ( )
protectedslot

◆ pickingModeChanged

void camitk::InteractiveViewer::pickingModeChanged ( QAction *  selectedAction)
protectedslot

◆ refresh()

void camitk::InteractiveViewer::refresh ( Viewer whoIsAsking = nullptr)
overrideprivatevirtual

Refresh the display.

Implements camitk::Viewer.

References actorMap, addActor(), displayedTopLevelComponents, frame, camitk::Component::GEOMETRY, camitk::InterfaceBitMap::get2DImageActor(), camitk::Component::get3DImageActor, camitk::Component::getActor, camitk::Application::getAllComponents(), camitk::InterfaceFrame::getFrameAxisActor(), camitk::InterfaceFrame::getFrameVisibility(), camitk::Property::getName(), camitk::Component::getNumberOfProp(), camitk::InterfaceBitMap::getNumberOfSlices(), camitk::InterfaceBitMap::getPickPlaneActor(), camitk::Component::getPixelActor, camitk::Component::getProp(), camitk::Component::getRepresentation(), camitk::Application::getSelectedComponents(), camitk::Component::getSlice(), camitk::Application::getTopLevelComponents(), camitk::Component::getVisibility(), camitk::Application::isAlive(), isChangingSlice, isPicking, linesAsTubesProperty, myType, camitk::InterfaceGeometry::Points, propertyObject, camitk::RendererWidget::refresh(), removeAllActors(), rendererWidget, resetCamera(), camitk::RendererWidget::resetClippingPlanes(), camitk::InterfaceGeometry::setLinesAsTubes(), camitk::SliderSpinBoxWidget::setRange(), camitk::SliderSpinBoxWidget::setValue(), camitk::Component::SLICE, sliceSlider, camitk::InterfaceGeometry::Surface, updateActions(), camitk::RendererWidget::updateAxes(), updateSelectionDisplay(), and camitk::InterfaceGeometry::Wireframe.

Referenced by cameraOrientationChanged(), eventFilter(), highlightModeChanged(), ReorientImage::initDialog(), keyPressEvent(), ReorientImage::modelChanged(), picked(), renderingActorsChanged(), screenshot(), ReorientImage::setAxesOrientation(), setGlyph(), setHighlightMode(), and setLabel().

◆ refreshRenderer()

void camitk::InteractiveViewer::refreshRenderer ( )
private

just refresh the renderer

References camitk::RendererWidget::refresh(), and rendererWidget.

◆ removeAllActors()

void camitk::InteractiveViewer::removeAllActors ( Component comp)
protected

remove all the given Component actors from the renderer and delete comp from the map

References a, actorMap, camitk::RendererWidget::removeProp(), and rendererWidget.

Referenced by refresh().

◆ renderingActorsChanged

void camitk::InteractiveViewer::renderingActorsChanged ( )
protectedslot

◆ resetCamera()

void camitk::InteractiveViewer::resetCamera ( )
private

Reset scene camera.

Use a trick (when this is a SLICE_VIEWER) for scaling up to max size in the viewer

References actorMap, myType, rendererWidget, and camitk::RendererWidget::resetCamera().

Referenced by cameraOrientationChanged(), keyPressEvent(), refresh(), and toggleAxes().

◆ rightClick

void camitk::InteractiveViewer::rightClick ( )
protectedslot

References getMenu(), and rendererWidget.

Referenced by getWidget().

◆ screenshot() [1/2]

void camitk::InteractiveViewer::screenshot ( QString  filename)
private

call this method to take a screenshot using the given filename (the extension must be a supported format extension, see class RendererWindow)

References refresh(), rendererWidget, and camitk::RendererWidget::screenshot().

◆ screenshot [2/2]

void camitk::InteractiveViewer::screenshot ( )
slot

◆ setActiveCamera()

void camitk::InteractiveViewer::setActiveCamera ( QString  cameraName)
private

Set the active virtual camera.

References cameraMap, rendererWidget, and camitk::RendererWidget::setActiveCamera().

◆ setBackfaceCulling

void camitk::InteractiveViewer::setBackfaceCulling ( bool  b)
slot

set the backface culling mode (default is true).

References backfaceCullingProperty, camitk::Property::getName(), and propertyObject.

Referenced by initActions().

◆ setBackgroundColor()

void camitk::InteractiveViewer::setBackgroundColor ( QColor  c)
virtual

set background color

References backgroundColorProperty, camitk::Property::getName(), and propertyObject.

◆ setColorScale()

void camitk::InteractiveViewer::setColorScale ( bool  state)

set the color scale in the viewport, use setColorScaleMinMax / setColorScaleTitle to change the displayed values.

References rendererWidget, and camitk::RendererWidget::setColorScale().

Referenced by keyPressEvent(), camitk::MeshComponent::setDataRepresentationOff(), and camitk::MeshComponent::setScalarDataRepresentationOn().

◆ setColorScaleMinMax()

void camitk::InteractiveViewer::setColorScaleMinMax ( double  m,
double  M 
)

set the min and max values.

Automatically turns setColorScale to true.

Parameters
mminimum value (blue)
Mmaximum value (red)

References rendererWidget, and camitk::RendererWidget::setColorScaleMinMax().

Referenced by camitk::MeshComponent::setScalarDataRepresentationOn().

◆ setColorScaleTitle()

void camitk::InteractiveViewer::setColorScaleTitle ( QString  t)

◆ setGlyph

void camitk::InteractiveViewer::setGlyph ( bool  b)
protectedslot

◆ setGradientBackground()

void camitk::InteractiveViewer::setGradientBackground ( bool  g)
virtual

set gradient background on/off

References backgroundGradientColorProperty, camitk::Property::getName(), and propertyObject.

◆ setHighlightMode()

void camitk::InteractiveViewer::setHighlightMode ( InteractiveViewer::HighlightMode  h)
virtual

◆ setLabel

void camitk::InteractiveViewer::setLabel ( bool  b)
protectedslot

◆ setLinesAsTubes

void camitk::InteractiveViewer::setLinesAsTubes ( bool  tubes)
slot

get the backface current culling mode.

Update the visualization of lines (for all the InterfaceGeometry of the scene).

Note
it is only possible to transform lines to tubes if you build an Geometry using lines.
Parameters
tubesif true, then the lines have to be displayed as tube

References camitk::Property::getName(), linesAsTubesProperty, and propertyObject.

Referenced by initActions().

◆ setScreenshotAction

void camitk::InteractiveViewer::setScreenshotAction ( bool  b)
slot

visibility of the screenshot in slice viewers

References camitk::Property::getName(), propertyObject, screenshotActionMenu, and screenshotActionProperty.

Referenced by initActions().

◆ setSideFrameVisible()

void camitk::InteractiveViewer::setSideFrameVisible ( bool  visibility)

set the slice viewer side bar+screenshot button visibility

References sideFrame.

◆ sliderChanged

void camitk::InteractiveViewer::sliderChanged ( int  i)
slot

Slot called when the InteractiveViewer slider has been changed.

If there is a InterfaceBitMap in the scene, set the slice index with the new slider value.

References actorMap, isChangingSlice, myType, and camitk::Viewer::selectionChanged().

Referenced by getWidget().

◆ startWhatsThisSection()

void camitk::InteractiveViewer::startWhatsThisSection ( const QString &  title = "")
protected

start a table (section) in the what's this message

References oddWhatsThis, and whatsThis.

Referenced by getWidget().

◆ toggleAxes

void camitk::InteractiveViewer::toggleAxes ( bool  f)
protectedslot

◆ toggleCopyright

void camitk::InteractiveViewer::toggleCopyright ( bool  c)
slot

◆ toggleInterpolation()

void camitk::InteractiveViewer::toggleInterpolation ( )
protected

for InterfaceBitMap, toggle the interpolation mode (intern method, not a property because it can only be modified by the keyboard interaction)

References actorMap, camitk::InterfaceBitMap::get2DImageActor(), camitk::Component::get3DImageActor, camitk::Component::getRepresentation(), camitk::Component::refresh(), and camitk::Component::SLICE.

Referenced by keyPressEvent().

◆ toggleOrientationDecorations

void camitk::InteractiveViewer::toggleOrientationDecorations ( bool  f)
protectedslot

◆ updateActions()

void camitk::InteractiveViewer::updateActions ( )
protected

◆ updateSelectionDisplay()

void camitk::InteractiveViewer::updateSelectionDisplay ( Component comp)
protected

◆ viewControlModeChanged

void camitk::InteractiveViewer::viewControlModeChanged ( QAction *  selectedAction)
protectedslot

◆ xAngleChanged

void camitk::InteractiveViewer::xAngleChanged ( double  angle)
slot

Slot called when the InteractiveViewer x angle update has been changed.

References actorMap, and myType.

◆ yAngleChanged

void camitk::InteractiveViewer::yAngleChanged ( double  angle)
slot

Slot called when the InteractiveViewer y angle update has been changed.

References actorMap, and myType.

◆ zAngleChanged

void camitk::InteractiveViewer::zAngleChanged ( double  angle)
slot

Slot called when the InteractiveViewer z angle update has been changed.

References actorMap, and myType.

Friends And Related Function Documentation

◆ InteractiveViewerFrame::keyPressEvent

void InteractiveViewerFrame::keyPressEvent ( QKeyEvent *  e)
friend

the InteractiveViewerFrame keyPressEvent is a good friend of InteractiveViewer

Member Data Documentation

◆ actorMap

QMultiMap<Component*, vtkSmartPointer<vtkProp> > camitk::InteractiveViewer::actorMap
protected

◆ backfaceCullingProperty

Property* camitk::InteractiveViewer::backfaceCullingProperty
protected

Property that tells whether the viewer uses the backface culling option or not.

Referenced by createProperties(), eventFilter(), initActions(), initSettings(), and setBackfaceCulling().

◆ backgroundColorAction

QAction* camitk::InteractiveViewer::backgroundColorAction
protected

background color

Referenced by getMenu(), and initActions().

◆ backgroundColorProperty

Property* camitk::InteractiveViewer::backgroundColorProperty
protected

The property that stands for the background color of the viewer.

Referenced by backgroundColor(), createProperties(), eventFilter(), initSettings(), and setBackgroundColor().

◆ backgroundGradientColorProperty

Property* camitk::InteractiveViewer::backgroundGradientColorProperty
protected

Property that tells whether the viewer use a gradient background color or not.

Referenced by createProperties(), eventFilter(), initSettings(), and setGradientBackground().

◆ cameraMap

QMap<QString, vtkSmartPointerCamera> camitk::InteractiveViewer::cameraMap
protected

all the available camera

Referenced by getCamera(), InteractiveViewer(), and setActiveCamera().

◆ cameraOrientationLeftUpAction

QAction* camitk::InteractiveViewer::cameraOrientationLeftUpAction
protected

◆ cameraOrientationRightDownAction

QAction* camitk::InteractiveViewer::cameraOrientationRightDownAction
protected

to change the axes view mode

Referenced by cameraOrientationChanged(), getMenu(), and initActions().

◆ cameraOrientationRightUpAction

QAction* camitk::InteractiveViewer::cameraOrientationRightUpAction
protected

◆ colorAction

QAction* camitk::InteractiveViewer::colorAction
protected

◆ connector

vtkSmartPointer<vtkEventQtSlotConnect> camitk::InteractiveViewer::connector
protected

Referenced by InteractiveViewer().

◆ controlModeJoystickAction

QAction* camitk::InteractiveViewer::controlModeJoystickAction
protected

Referenced by getMenu(), and initActions().

◆ controlModeTrackballAction

QAction* camitk::InteractiveViewer::controlModeTrackballAction
protected

to change the camera control mode

Referenced by getMenu(), initActions(), and viewControlModeChanged().

◆ defaultNames

QString camitk::InteractiveViewer::defaultNames = {QString("3DViewer"), QString("axialViewer"), QString("coronalViewer"), QString("sagittalViewer"), QString("arbitraryViewer") }
staticprotected

the QString array containing all InteractiveViewer instance default names

Referenced by get3DViewer(), getArbitraryViewer(), getAxialViewer(), getCoronalViewer(), getSagittalViewer(), and getViewer().

◆ displayedTopLevelComponents

unsigned int camitk::InteractiveViewer::displayedTopLevelComponents
protected

number of top-level component that are currently displayed

Referenced by InteractiveViewer(), and refresh().

◆ frame

InteractiveViewerFrame* camitk::InteractiveViewer::frame
protected

◆ glyphAction

QAction* camitk::InteractiveViewer::glyphAction
protected

◆ highlightModeProperty

Property* camitk::InteractiveViewer::highlightModeProperty
protected

The property that stands for the type of highlight mode of the 3D viewer.

Referenced by createProperties(), eventFilter(), highlightModeChanged(), initSettings(), setHighlightMode(), and updateSelectionDisplay().

◆ highlightOffAction

QAction* camitk::InteractiveViewer::highlightOffAction
protected

◆ highlightSelectionAction

QAction* camitk::InteractiveViewer::highlightSelectionAction
protected

display mode

Referenced by getMenu(), highlightModeChanged(), and initActions().

◆ highlightSelectionOnlyAction

QAction* camitk::InteractiveViewer::highlightSelectionOnlyAction
protected

◆ isChangingSlice

bool camitk::InteractiveViewer::isChangingSlice
protected

Indicates that this viewer is changing the slice by the slice slider.

Referenced by InteractiveViewer(), refresh(), and sliderChanged().

◆ isPicking

bool camitk::InteractiveViewer::isPicking
protected

Indicates that this viewer is picking.

Referenced by InteractiveViewer(), picked(), and refresh().

◆ linesAsTubesProperty

Property* camitk::InteractiveViewer::linesAsTubesProperty
protected

Property that tells whether the viewer uses lines as tubes or not.

Referenced by createProperties(), eventFilter(), initActions(), initSettings(), refresh(), and setLinesAsTubes().

◆ myType

ViewerType camitk::InteractiveViewer::myType
protected

◆ oddWhatsThis

bool camitk::InteractiveViewer::oddWhatsThis
protected

are we currently in a odd table line

Referenced by addWhatsThisItem(), and startWhatsThisSection().

◆ pickCellAction

QAction* camitk::InteractiveViewer::pickCellAction
protected

◆ pickCellRegionAction

QAction* camitk::InteractiveViewer::pickCellRegionAction
protected

◆ pickedComponent

std::vector<Component*> camitk::InteractiveViewer::pickedComponent
protected

list of Component that are currently picked, correctly displayed in the InteractiveViewer, but for speed optimization that are not yet selected in the explorer.

They will all be selected in the explorer when the user release the mouse button.

◆ pickingEffectIsSelecting

bool camitk::InteractiveViewer::pickingEffectIsSelecting
protected

picking effect while mouse button is kept pressed is selecting (depends on the selection state of the first component picked)

Referenced by InteractiveViewer(), and picked().

◆ pickingEffectUpdated

bool camitk::InteractiveViewer::pickingEffectUpdated
protected

was the picking effect updated (it has to be updated with the first picking for a given button down session)

Referenced by initPicking(), and picked().

◆ pickingMode

PickingMode camitk::InteractiveViewer::pickingMode
protected

Current picking mode, NO_PICKING be default.

Referenced by initPicking(), and picked().

◆ pickPointAction

QAction* camitk::InteractiveViewer::pickPointAction
protected

action of the picking menu

Referenced by getMenu(), getToolBar(), initActions(), and pickingModeChanged().

◆ pickPointRegionAction

QAction* camitk::InteractiveViewer::pickPointRegionAction
protected

◆ pointsAction

QAction* camitk::InteractiveViewer::pointsAction
protected

◆ pointSizeProperty

Property* camitk::InteractiveViewer::pointSizeProperty
protected

Property which defines the point size of each point in the 3D viewer.

Referenced by createProperties(), eventFilter(), and initSettings().

◆ propertyObject

PropertyObject* camitk::InteractiveViewer::propertyObject
protected

◆ rendererWidget

RendererWidget* camitk::InteractiveViewer::rendererWidget
protected

◆ renderingMenu

QMenu* camitk::InteractiveViewer::renderingMenu
protected

Rendering.

Referenced by getMenu(), initActions(), and updateActions().

◆ scalarDataColorAction

QWidgetAction* camitk::InteractiveViewer::scalarDataColorAction
protected

◆ scalarDataComboBox

QComboBox* camitk::InteractiveViewer::scalarDataComboBox
protected

the ComboBox for mesh scalar data

Referenced by initActions().

◆ scalarDataModel

MeshDataFilterModel* camitk::InteractiveViewer::scalarDataModel
protected

Referenced by initActions(), and updateActions().

◆ screenshotAction

QAction* camitk::InteractiveViewer::screenshotAction
protected

Screenshot.

Referenced by getMenu(), getToolBar(), getWidget(), and initActions().

◆ screenshotActionMenu

QToolBar* camitk::InteractiveViewer::screenshotActionMenu
protected

the screenshot action is inside this menu (in the slice viewer side bar)

Referenced by getWidget(), InteractiveViewer(), and setScreenshotAction().

◆ screenshotActionProperty

Property* camitk::InteractiveViewer::screenshotActionProperty
protected

Property that tells whether the screenshot action is visible or not.

Referenced by createProperties(), eventFilter(), initActions(), initSettings(), and setScreenshotAction().

◆ sideFrame

QFrame* camitk::InteractiveViewer::sideFrame
protected

the right side frame (this is where the slider and screenshot buttons are shown)

Referenced by getWidget(), and setSideFrameVisible().

◆ sliceSlider

SliderSpinBoxWidget* camitk::InteractiveViewer::sliceSlider
protected

Slider used to control the slice index in a InteractiveViewer.

This slider is visible only when the scene a 2D viewer (see constructor).

Referenced by getWidget(), InteractiveViewer(), keyPressEvent(), and refresh().

◆ surfaceAction

QAction* camitk::InteractiveViewer::surfaceAction
protected

◆ toggleAxesAction

QAction* camitk::InteractiveViewer::toggleAxesAction
protected

button allows one to display the Axes in the InteractiveViewer

Referenced by getMenu(), getToolBar(), initActions(), and keyPressEvent().

◆ toggleBackfaceCullingAction

QAction* camitk::InteractiveViewer::toggleBackfaceCullingAction
protected

back face culling

Referenced by getMenu(), and initActions().

◆ toggleCopyrightAction

QAction* camitk::InteractiveViewer::toggleCopyrightAction
protected

button to remove the copyright

Referenced by getMenu(), and initActions().

◆ toggleLabelAction

QAction* camitk::InteractiveViewer::toggleLabelAction
protected

button allows one to display the labels of the object3D

Referenced by getMenu(), getToolBar(), initActions(), keyPressEvent(), and updateActions().

◆ toggleLinesAsTubesAction

QAction* camitk::InteractiveViewer::toggleLinesAsTubesAction
protected

button allows one to display the lines as tubes (the lines are to be in vtkPolyData)

Referenced by getMenu(), and initActions().

◆ toggleOrientationDecorationsAction

QAction* camitk::InteractiveViewer::toggleOrientationDecorationsAction
protected

button allows one to display orientation decoration in SLICE_VIEWER mode

Referenced by getMenu(), getToolBar(), and initActions().

◆ toggleScreenshotAction

QAction* camitk::InteractiveViewer::toggleScreenshotAction
protected

visibility of the screenshot action in the side toolbar of slice viewer

Referenced by getMenu(), and initActions().

◆ viewerMenu

QMenu* camitk::InteractiveViewer::viewerMenu
protected

◆ viewers

QMap< QString, InteractiveViewer * > camitk::InteractiveViewer::viewers
staticprotected

the map containing all the InteractiveViewer instances

the register containing all the viewers (static instanciation, global variable, but global only for this file)

Referenced by getNewViewer(), getViewer(), and ~InteractiveViewer().

◆ viewerToolBar

QToolBar* camitk::InteractiveViewer::viewerToolBar
protected

◆ whatsThis

QString camitk::InteractiveViewer::whatsThis
protected

◆ wireframeAction

QAction* camitk::InteractiveViewer::wireframeAction
protected

The documentation for this class was generated from the following files: