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 }
 
enum  PickingMode {
  PIXEL_PICKING, POINT_PICKING, CELL_PICKING, AREA_CELL_PICKING,
  AREA_POINT_PICKING, NO_PICKING
}
 

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 (Component *comp)
 the selection has changed to be just one comp More...
 
void selectionChanged (ComponentList &compSet)
 The selection has changed to the given ComponentList. 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.

◆ 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 initPicking(), and PIXEL_PICKING.

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

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)

◆ backgroundColor

void camitk::InteractiveViewer::backgroundColor ( )
protectedslot

◆ cameraOrientationChanged

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

◆ createProperties()

void camitk::InteractiveViewer::createProperties ( )
protected

Create and handle the CamiTK properties of this viewer.

◆ endWhatsThisSection()

void camitk::InteractiveViewer::endWhatsThisSection ( )
protected

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

References rendererWidget.

◆ eventFilter()

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

Event filter of this class instance to watch its properties instances.

Each time a property has dynamically changed, this method is called.

Note
Only used by Geometry viewers

◆ get3DViewer()

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

get the 3D viewer default InteractiveViewer (provided for convenience, equivalent to getViewer("3DViewer")

Referenced by VRMLComponentExtension::save().

◆ getArbitraryViewer()

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

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

◆ getAxialViewer()

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

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

◆ getBounds()

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

Compute the bounding box of all displayed Component.

◆ getBoundsOfSelected()

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

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

◆ 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.

◆ getColorScale()

bool camitk::InteractiveViewer::getColorScale ( ) const

get the current value of the color scale property.

References pointsAction, surfaceAction, and wireframeAction.

◆ getCoronalViewer()

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

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

References frame, camitk::RendererWidget(), rendererWidget, and camitk::TRACKBALL_2D.

◆ getMenu()

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

◆ getName()

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

get the scene name

References removeAllActors().

◆ 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.

◆ getPropertyObject()

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

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

Reimplemented from camitk::Viewer.

◆ getRendererWidget()

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

return interactiveViewer RendererWidget

Referenced by ReorientImage::initInternalViewer(), and ReorientImage::modelChanged().

◆ getSagittalViewer()

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

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

◆ getToolBar()

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

get the viewer toolbar

Reimplemented from camitk::Viewer.

References toggleOrientationDecorationsAction, and viewerToolBar.

Referenced by getMenu().

◆ getViewer()

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

get a viewer by its name (return NULL if no instance has the given name, use getNewViewer to create one viewer)

◆ getWidget()

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

get the InteractiveViewer widget (QTreeWidget).

Parameters
parentthe parent widget for the viewer widget

Implements camitk::Viewer.

Referenced by ReorientImage::initDialog().

◆ 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)

◆ initPicking()

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

Init the picker with a given picking mode.

Referenced by InteractiveViewer(), and setLinesAsTubes().

◆ initSettings()

void camitk::InteractiveViewer::initSettings ( )
protected

initialize the property object and state using the user settings (user preferences system files .config/.ini)

◆ initWhatsThis()

void camitk::InteractiveViewer::initWhatsThis ( )
protected

initialize the what's this html string

References whatsThis.

◆ 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 toggleAxesAction.

◆ numberOfViewedComponent()

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

returns the number of Component that are displayed by this viewer

Implements camitk::Viewer.

◆ picked

void camitk::InteractiveViewer::picked ( )
protectedslot

get the picker and populate the picked component with the picked stuff

References actorMap.

◆ pickingModeChanged

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

◆ refresh()

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

◆ refreshRenderer()

void camitk::InteractiveViewer::refreshRenderer ( )
private

just refresh the renderer

References frame, and viewerMenu.

◆ removeAllActors()

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

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

Referenced by getName(), and 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

Referenced by highlightModeChanged().

◆ rightClick

void camitk::InteractiveViewer::rightClick ( )
protectedslot

◆ screenshot [1/2]

void camitk::InteractiveViewer::screenshot ( )
slot

call this method to take a screenshot in various format and write the resulting image to a file

◆ screenshot() [2/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 rendererWidget.

◆ setActiveCamera()

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

Set the active virtual camera.

References actorMap, and isChangingSlice.

◆ setBackfaceCulling

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

set the backface culling mode (default is true).

◆ setBackgroundColor()

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

set background color

References camitk::Component::isSelected().

◆ setColorScale()

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

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

◆ 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)

◆ setColorScaleTitle()

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

set the color scale title.

Parameters
ttitle of the color scale

References colorAction.

◆ setGlyph

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

◆ setGradientBackground()

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

set gradient background on/off

◆ setHighlightMode()

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

Set the current highlighting mode.

References camitk::Property::getName(), highlightModeProperty, OFF, and propertyObject.

Referenced by ReorientImage::initInternalViewer().

◆ setLabel

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

if true currently selected Components label will have their label on (shown)

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

◆ 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 initPicking(), and POINT_PICKING.

◆ setScreenshotAction

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

visibility of the screenshot in slice viewers

References pickingEffectUpdated, and rendererWidget.

◆ setSideFrameVisible()

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

set the slice viewer side bar+screenshot button visibility

References camitk::Property::getName(), highlightModeProperty, camitk::InterfaceGeometry::Normal, propertyObject, and SELECTION.

◆ 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.

◆ startWhatsThisSection()

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

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

◆ toggleAxes

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

◆ toggleCopyright

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

show/hide the copyright in 3D

Referenced by ReorientImage::initInternalViewer().

◆ 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 camitk::InterfaceGeometry::Shaded.

◆ toggleOrientationDecorations

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

◆ updateActions()

void camitk::InteractiveViewer::updateActions ( )
protected

◆ updateSelectionDisplay()

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

Update the display of the given Component, according to its selection state and the current HighlightMode.

Referenced by refresh().

◆ 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.

◆ yAngleChanged

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

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

◆ zAngleChanged

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

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

References rendererWidget.

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

the map containing all the actors in the InteractiveViewer

Referenced by picked(), refresh(), setActiveCamera(), and sliderChanged().

◆ backfaceCullingProperty

Property* camitk::InteractiveViewer::backfaceCullingProperty
protected

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

◆ backgroundColorAction

QAction* camitk::InteractiveViewer::backgroundColorAction
protected

background color

◆ backgroundColorProperty

Property* camitk::InteractiveViewer::backgroundColorProperty
protected

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

◆ backgroundGradientColorProperty

Property* camitk::InteractiveViewer::backgroundGradientColorProperty
protected

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

◆ cameraMap

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

all the available camera

◆ cameraOrientationLeftUpAction

QAction* camitk::InteractiveViewer::cameraOrientationLeftUpAction
protected

Referenced by highlightModeChanged().

◆ cameraOrientationRightDownAction

QAction* camitk::InteractiveViewer::cameraOrientationRightDownAction
protected

to change the axes view mode

Referenced by highlightModeChanged().

◆ cameraOrientationRightUpAction

QAction* camitk::InteractiveViewer::cameraOrientationRightUpAction
protected

Referenced by highlightModeChanged().

◆ colorAction

QAction* camitk::InteractiveViewer::colorAction
protected

◆ connector

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

◆ controlModeJoystickAction

QAction* camitk::InteractiveViewer::controlModeJoystickAction
protected

Referenced by getMenu().

◆ controlModeTrackballAction

QAction* camitk::InteractiveViewer::controlModeTrackballAction
protected

to change the camera control mode

Referenced by getMenu().

◆ 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

◆ displayedTopLevelComponents

unsigned int camitk::InteractiveViewer::displayedTopLevelComponents
protected

number of top-level component that are currently displayed

◆ frame

InteractiveViewerFrame* camitk::InteractiveViewer::frame
protected

◆ glyphAction

QAction* camitk::InteractiveViewer::glyphAction
protected

Referenced by updateActions().

◆ highlightModeProperty

Property* camitk::InteractiveViewer::highlightModeProperty
protected

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

Referenced by renderingActorsChanged(), setHighlightMode(), and setSideFrameVisible().

◆ highlightOffAction

QAction* camitk::InteractiveViewer::highlightOffAction
protected

Referenced by getMenu().

◆ highlightSelectionAction

QAction* camitk::InteractiveViewer::highlightSelectionAction
protected

display mode

Referenced by getMenu().

◆ highlightSelectionOnlyAction

QAction* camitk::InteractiveViewer::highlightSelectionOnlyAction
protected

Referenced by getMenu().

◆ isChangingSlice

bool camitk::InteractiveViewer::isChangingSlice
protected

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

Referenced by setActiveCamera().

◆ isPicking

bool camitk::InteractiveViewer::isPicking
protected

Indicates that this viewer is picking.

◆ linesAsTubesProperty

Property* camitk::InteractiveViewer::linesAsTubesProperty
protected

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

Referenced by refresh(), and setLabel().

◆ myType

ViewerType camitk::InteractiveViewer::myType
protected

type of InteractiveViewer (display slice or geometry)

◆ oddWhatsThis

bool camitk::InteractiveViewer::oddWhatsThis
protected

are we currently in a odd table line

◆ 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)

◆ 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 setScreenshotAction().

◆ pickingMode

PickingMode camitk::InteractiveViewer::pickingMode
protected

Current picking mode, NO_PICKING be default.

◆ pickPointAction

QAction* camitk::InteractiveViewer::pickPointAction
protected

action of the picking menu

◆ pickPointRegionAction

QAction* camitk::InteractiveViewer::pickPointRegionAction
protected

◆ pointsAction

QAction* camitk::InteractiveViewer::pointsAction
protected

Referenced by getColorScale(), and updateActions().

◆ pointSizeProperty

Property* camitk::InteractiveViewer::pointSizeProperty
protected

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

◆ propertyObject

PropertyObject* camitk::InteractiveViewer::propertyObject
protected

The property object that holds the properties of this viewer.

Referenced by refresh(), renderingActorsChanged(), setGlyph(), setHighlightMode(), setLabel(), and setSideFrameVisible().

◆ rendererWidget

RendererWidget* camitk::InteractiveViewer::rendererWidget
protected

The 3D scene itself, wrapping VTK render window, renderer and interactor in a single Qt widget

Referenced by endWhatsThisSection(), getCoronalViewer(), highlightModeChanged(), screenshot(), setScreenshotAction(), and zAngleChanged().

◆ renderingMenu

QMenu* camitk::InteractiveViewer::renderingMenu
protected

Rendering.

◆ scalarDataColorAction

QWidgetAction* camitk::InteractiveViewer::scalarDataColorAction
protected

Referenced by updateActions().

◆ scalarDataComboBox

QComboBox* camitk::InteractiveViewer::scalarDataComboBox
protected

the ComboBox for mesh scalar data

◆ scalarDataModel

MeshDataFilterModel* camitk::InteractiveViewer::scalarDataModel
protected

Referenced by updateActions().

◆ screenshotAction

QAction* camitk::InteractiveViewer::screenshotAction
protected

Screenshot.

◆ screenshotActionMenu

QToolBar* camitk::InteractiveViewer::screenshotActionMenu
protected

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

Referenced by setGlyph().

◆ screenshotActionProperty

Property* camitk::InteractiveViewer::screenshotActionProperty
protected

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

Referenced by setGlyph().

◆ sideFrame

QFrame* camitk::InteractiveViewer::sideFrame
protected

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

◆ 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 refresh().

◆ surfaceAction

QAction* camitk::InteractiveViewer::surfaceAction
protected

Referenced by getColorScale(), and updateActions().

◆ toggleAxesAction

QAction* camitk::InteractiveViewer::toggleAxesAction
protected

button allows one to display the Axes in the InteractiveViewer

Referenced by keyPressEvent().

◆ toggleBackfaceCullingAction

QAction* camitk::InteractiveViewer::toggleBackfaceCullingAction
protected

back face culling

Referenced by getMenu().

◆ toggleCopyrightAction

QAction* camitk::InteractiveViewer::toggleCopyrightAction
protected

button to remove the copyright

◆ toggleLabelAction

QAction* camitk::InteractiveViewer::toggleLabelAction
protected

button allows one to display the labels of the object3D

Referenced by getMenu(), 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().

◆ toggleOrientationDecorationsAction

QAction* camitk::InteractiveViewer::toggleOrientationDecorationsAction
protected

button allows one to display orientation decoration in SLICE_VIEWER mode

Referenced by getToolBar().

◆ toggleScreenshotAction

QAction* camitk::InteractiveViewer::toggleScreenshotAction
protected

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

◆ viewerMenu

QMenu* camitk::InteractiveViewer::viewerMenu
protected

the QMenu for the InteractiveViewer

Referenced by refreshRenderer().

◆ viewers

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

the map containing all the InteractiveViewer instances

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

◆ viewerToolBar

QToolBar* camitk::InteractiveViewer::viewerToolBar
protected

the QToolBar for the InteractiveViewer

Referenced by getToolBar().

◆ whatsThis

QString camitk::InteractiveViewer::whatsThis
protected

The what's html string

Referenced by initWhatsThis().

◆ wireframeAction

QAction* camitk::InteractiveViewer::wireframeAction
protected

Referenced by getColorScale(), and updateActions().


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