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

#include <InteractiveViewer.h>

Inheritance diagram for camitk::InteractiveViewer:

Collaboration diagram for camitk::InteractiveViewer:

Public Types
enum	HighlightMode { OFF, SELECTION, SELECTION_ONLY }

enum	PickingMode { PIXEL_PICKING, POINT_PICKING, CELL_PICKING, AREA_CELL_PICKING, AREA_POINT_PICKING, NO_PICKING }

enum	ViewerType { SLICE_VIEWER, GEOMETRY_VIEWER }

Public Types inherited from camitk::Viewer
enum	ViewerType { EMBEDDED, DOCKED }

Public Slots
public slots
void	sliderChanged (int)
	Slot called when the InteractiveViewer slider has been changed. 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...

void	toggleLogo (bool)
	show/hide the logo at the bottom right corner More...

Public Member Functions
virtual void	setBackgroundColor (QColor)
	set background color More...

virtual void	setGradientBackground (bool)
	set gradient background on/off More...


Q_INVOKABLE	InteractiveViewer (QString &name, camitk::InteractiveViewer::ViewerType type)
	Construtor. More...

virtual	~InteractiveViewer () override
	Destructor. More...

QString	getName () const
	get the scene name More...

Inherited from Viewer
void	refresh (Viewer *whoIsAsking=nullptr) override

QWidget *	getWidget () 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...

Misc
set the color scale in the viewport, use setColorScaleMinMax / setColorScaleTitle to change the displayed values.
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
QStringList	getComponents ()
	get the list of Component class manages by this viewer (default is set to "Component", i.e. More...

QString	getDescription () const
	get the name of the viewer More...

QDockWidget *	getDockWidget ()
	Get the QDockWidget* where this viewer is currently docked (or nullptr if it is not docked anywhere or if the viewer is of type EMBEDDED) More...

QLayout *	getEmbedder ()
	Get the QLayout* where this viewer is currently embedded (or nullptr if it is not embedded anywhere or if the viewer is of type DOCKED) More...

virtual QPixmap	getIcon ()
	get the viewer icon More...

QString	getName () const
	get the name of the viewer More...

bool	getToolBarVisibility ()
	get the current value of the toolbar visibility More...

ViewerType	getType ()
	get the viewer layout More...

	Q_ENUM (ViewerType) Viewer(QString name
	default constructor More...

bool	setDockWidget (QDockWidget *)
	If the viewer type is DOCKED, dock the widget inside the given dock widget (do nothing if the type is EMBEDDED or if the viewer has already been docked before) Note that once set, the dock widget cannot be modified. More...

bool	setEmbedder (QLayout *)
	If the viewer type is EMBEDDED, embed the viewer widget in the given layout (do nothing if the type is DOCKED) Note that you can call this method any time you want to move the viewer's widget to another layout (but there is only one embedder at a time) More...

void	setToolBarVisibility (bool)
	set the visibility of the toolbar in the main window (true by default). More...

void	setType (ViewerType)
	set the viewer layout (the type can be changed dynamically to fit the developer's purpose) More...

void	setVisible (bool)
	set the visibility of the viewer (show or hide its widget) More...

virtual	~Viewer () override
	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 Member Functions
void	init ()
	used by both constructors 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...

void	setComponents (QStringList)
	set the list of component class names managed by this viewer More...

void	setDescription (QString)
	set the viewer's description More...

void	setIcon (QPixmap icon)
	set the default icon for the viewer extension More...

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 Member Functions
	Q_ENUMS (HighlightMode RendererWidget::ControlMode RendererWidget::CameraOrientation)

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	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 ()
	Set the current highlighting mode from the current value of the property. More...

RendererWidget *	getRendererWidget ()
	return interactiveViewer RendererWidget More...

void	setBackfaceCulling (bool)

void	setScreenshotAction (bool)
	visibility of the screenshot in slice viewers More...

void	setLinesAsTubes (bool tubes)
	Update the visualization of lines (for all the InterfaceGeometry of the scene). 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, vtkSmartPointerCamera >	cameraMap
	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	resetLUT ()
	for InterfaceBitMap, reset the lut that was changed by the image interactor (window and level) 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
The 3D scene itself, wrapping VTK render window, renderer and interactor in a single Qt widget
RendererWidget *	rendererWidget

SliderSpinBoxWidget *	sliceSlider
	Slider used to control the slice index in a InteractiveViewer. More...

InteractiveViewerFrame *	frame
	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...

MeshDataFilterModel *	scalarDataModel

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 *	toggleLogoAction
	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
PropertyObject *	propertyObject
	The property object that holds the properties of this viewer. More...

Property *	highlightModeProperty
	The property that stands for the type of highlight mode of the 3D viewer. More...

Property *	backgroundColorProperty
	The property that stands for the background color of the viewer. More...

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

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

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

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

Property *	pointSizeProperty
	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...

Public Attributes inherited from camitk::Viewer
ViewerType	type = EMBEDDED)
	this viewer's layout 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.

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!).

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.
That's it for now!

Member Enumeration Documentation

◆ HighlightMode

enum camitk::InteractiveViewer::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

enum camitk::InteractiveViewer::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

◆ ViewerType

enum camitk::InteractiveViewer::ViewerType

there is two possibilities: this InteractiveViewer is used to display slices or geometry

Enumerator
SLICE_VIEWER	display slices (the view is blocked in 2D and the slider is available)
GEOMETRY_VIEWER	display 3D stuff (geometry, etc...)

Constructor & Destructor Documentation

◆ InteractiveViewer()

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

Construtor.

Parameters

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

◆ ~InteractiveViewer()

camitk::InteractiveViewer::~InteractiveViewer ( )

overridevirtual

Destructor.

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

◆ 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

◆ 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

◆ getBounds()

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

Compute the bounding box of all displayed Component.

Referenced by MeshClipping::getWidget(), and RigidTransform::reset().

Here is the caller graph for this function:

◆ getBoundsOfSelected()

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

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

Referenced by ShowFrame::getFrameSize().

Here is the caller graph for this function:

◆ getCamera()

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

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.

◆ getMenu()

QMenu * camitk::InteractiveViewer::getMenu ( )

overridevirtual

get the explorer menu

Reimplemented from camitk::Viewer.

◆ getName()

QString camitk::InteractiveViewer::getName ( ) const

get the scene name

Referenced by BitmapViewer::updateVisibility().

Here is the caller graph for this function:

◆ getPropertyObject()

QObject * camitk::InteractiveViewer::getPropertyObject ( )

overridevirtual

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 BitmapViewer::BitmapViewer(), MeshClipping::getWidget(), ReorientImage::initInternalViewer(), InteractiveSliceViewer::InteractiveSliceViewer(), ReorientImage::modelChanged(), VRMLComponentExtension::save(), and MeshProjection::updateVisibility().

Here is the caller graph for this function:

◆ getToolBar()

QToolBar * camitk::InteractiveViewer::getToolBar ( )

overridevirtual

get the viewer toolbar

Reimplemented from camitk::Viewer.

Reimplemented in BitmapViewer.

◆ getWidget()

QWidget * camitk::InteractiveViewer::getWidget ( )

overridevirtual

get the InteractiveViewer widget (QTreeWidget).

Parameters

parent the parent widget for the viewer widget

Implements camitk::Viewer.

Reimplemented in BitmapViewer.

◆ highlightModeChanged

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

protectedslot

References camitk::LEFT_UP, camitk::refresh(), camitk::resetCamera(), camitk::RIGHT_DOWN, and camitk::RIGHT_UP.

Here is the call graph for this function:

◆ init()

void camitk::InteractiveViewer::init ( )

protected

used by both constructors

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

◆ initSettings()

void camitk::InteractiveViewer::initSettings ( )

protected

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

References camitk::controlMode.

◆ initWhatsThis()

void camitk::InteractiveViewer::initWhatsThis ( )

protected

initialize the what's this html string

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

◆ picked

void camitk::InteractiveViewer::picked ( )

protectedslot

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

References camitk::Component::isSelected().

Here is the call graph for this function:

◆ pickingModeChanged

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

protectedslot

◆ Q_ENUMS()

camitk::InteractiveViewer::Q_ENUMS ( HighlightMode RendererWidget::ControlMode RendererWidget::CameraOrientation )

private

◆ refresh()

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

overridevirtual

Refresh the display.

Implements camitk::Viewer.

Reimplemented in BitmapViewer.

Referenced by ShowFrame::getWidget(), ReorientImage::initDialog(), ReorientImage::modelChanged(), ReorientImage::setAxesOrientation(), and RigidTransform::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refreshRenderer()

void camitk::InteractiveViewer::refreshRenderer ( )

just refresh the renderer

◆ removeAllActors()

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

protected

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

◆ renderingActorsChanged

void camitk::InteractiveViewer::renderingActorsChanged ( )

protectedslot

References camitk::refresh().

Here is the call graph for this function:

◆ resetCamera()

void camitk::InteractiveViewer::resetCamera ( )

Reset scene camera.

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

◆ resetLUT()

void camitk::InteractiveViewer::resetLUT ( )

protected

for InterfaceBitMap, reset the lut that was changed by the image interactor (window and level)

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

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

◆ setActiveCamera()

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

Set the active virtual camera.

◆ 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

◆ setColorScale()

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

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

Here is the caller graph for this function:

◆ setColorScaleMinMax()

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

set the min and max values.

Automatically turns setColorScale to true.

Parameters

m	minimum value (blue)
M	maximum value (red)

◆ setColorScaleTitle()

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

set the color scale title.

Parameters

t	title of the color scale

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

Here is the caller graph for this function:

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

virtual

Set the current highlighting mode from the current value of the property.

Referenced by ReorientImage::initInternalViewer().

Here is the caller graph for this function:

◆ setLabel

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

protectedslot

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

◆ setLinesAsTubes

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

slot

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

tubes if true, then the lines have to be displayed as tube

◆ setScreenshotAction

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

slot

visibility of the screenshot in slice viewers

◆ setSideFrameVisible()

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

set the slice viewer side bar+screenshot button visibility

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

◆ 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

References camitk::Component::getProp(), camitk::Component::getRepresentation(), and camitk::Component::getVisibility().

Here is the call graph for this function:

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

◆ toggleLogo

void camitk::InteractiveViewer::toggleLogo ( bool c )

slot

show/hide the logo at the bottom right corner

◆ toggleOrientationDecorations

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

protectedslot

Referenced by InteractiveSliceViewer::InteractiveSliceViewer().

Here is the caller graph for this function:

◆ updateActions()

void camitk::InteractiveViewer::updateActions ( )

protected

update the viewer menu depending on the selection,...

◆ updateSelectionDisplay()

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

protected

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

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

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

◆ 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

◆ cameraOrientationRightDownAction

QAction* camitk::InteractiveViewer::cameraOrientationRightDownAction

protected

to change the axes view mode

◆ cameraOrientationRightUpAction

QAction* camitk::InteractiveViewer::cameraOrientationRightUpAction

protected

◆ colorAction

QAction* camitk::InteractiveViewer::colorAction

protected

◆ connector

vtkSmartPointer<vtkEventQtSlotConnect> camitk::InteractiveViewer::connector

protected

◆ controlModeJoystickAction

QAction* camitk::InteractiveViewer::controlModeJoystickAction

protected

◆ controlModeTrackballAction

QAction* camitk::InteractiveViewer::controlModeTrackballAction

protected

to change the camera control mode

◆ displayedTopLevelComponents

unsigned int camitk::InteractiveViewer::displayedTopLevelComponents

protected

number of top-level component that are currently displayed

◆ frame

InteractiveViewerFrame* camitk::InteractiveViewer::frame

protected

the InteractiveViewer frame

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

◆ highlightOffAction

QAction* camitk::InteractiveViewer::highlightOffAction

protected

◆ highlightSelectionAction

QAction* camitk::InteractiveViewer::highlightSelectionAction

protected

display mode

◆ highlightSelectionOnlyAction

QAction* camitk::InteractiveViewer::highlightSelectionOnlyAction

protected

◆ isChangingSlice

bool camitk::InteractiveViewer::isChangingSlice

protected

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

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

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

◆ 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

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

◆ rendererWidget

RendererWidget* camitk::InteractiveViewer::rendererWidget

protected

◆ renderingMenu

QMenu* camitk::InteractiveViewer::renderingMenu

protected

Rendering.

◆ scalarDataColorAction

QWidgetAction* camitk::InteractiveViewer::scalarDataColorAction

protected

◆ scalarDataComboBox

QComboBox* camitk::InteractiveViewer::scalarDataComboBox

protected

the ComboBox for mesh scalar data

◆ scalarDataModel

MeshDataFilterModel* camitk::InteractiveViewer::scalarDataModel

protected

◆ screenshotAction

QAction* camitk::InteractiveViewer::screenshotAction

protected

Screenshot.

Referenced by BitmapViewer::getToolBar().

◆ screenshotActionMenu

QToolBar* camitk::InteractiveViewer::screenshotActionMenu

protected

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

◆ screenshotActionProperty

Property* camitk::InteractiveViewer::screenshotActionProperty

protected

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

◆ sideFrame

QFrame* camitk::InteractiveViewer::sideFrame

protected

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

Referenced by BitmapViewer::getWidget().

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

◆ surfaceAction

QAction* camitk::InteractiveViewer::surfaceAction

protected

◆ toggleAxesAction

QAction* camitk::InteractiveViewer::toggleAxesAction

protected

button allows one to display the Axes in the InteractiveViewer

◆ toggleBackfaceCullingAction

QAction* camitk::InteractiveViewer::toggleBackfaceCullingAction

protected

back face culling

◆ toggleLabelAction

QAction* camitk::InteractiveViewer::toggleLabelAction

protected

button allows one to display the labels of the object3D

◆ toggleLinesAsTubesAction

QAction* camitk::InteractiveViewer::toggleLinesAsTubesAction

protected

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

◆ toggleLogoAction

QAction* camitk::InteractiveViewer::toggleLogoAction

protected

button to remove the copyright

◆ toggleOrientationDecorationsAction

QAction* camitk::InteractiveViewer::toggleOrientationDecorationsAction

protected

button allows one to display orientation decoration in SLICE_VIEWER mode

◆ 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

◆ viewerToolbar

QToolBar* camitk::InteractiveViewer::viewerToolbar

protected

the QToolBar for the InteractiveViewer

◆ whatsThis

QString camitk::InteractiveViewer::whatsThis

protected

The what's html string

◆ wireframeAction

QAction* camitk::InteractiveViewer::wireframeAction

protected

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

Public Types

Public Slots

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Private Member Functions

Refresh/screenshot

Viewing/Interaction Property

Display properties

Widget/Action management

Help Whats This Utility

CamiTK Properties of this viewer

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ HighlightMode

◆ PickingMode

◆ ViewerType

Constructor & Destructor Documentation

◆ InteractiveViewer()

◆ ~InteractiveViewer()

Member Function Documentation

◆ addActor()

◆ addWhatsThisItem()

◆ backgroundColor

◆ cameraOrientationChanged

◆ createProperties()

◆ endWhatsThisSection()

◆ eventFilter()

◆ getBounds()

◆ getBoundsOfSelected()

◆ getCamera()

◆ getColorScale()

◆ getMenu()

◆ getName()

◆ getPropertyObject()

◆ getRendererWidget()

◆ getToolBar()

◆ getWidget()

◆ highlightModeChanged

◆ init()

◆ initActions()

◆ initPicking()

◆ initSettings()

◆ initWhatsThis()

◆ keyPressEvent()

◆ picked

◆ pickingModeChanged

◆ Q_ENUMS()

◆ refresh()

◆ refreshRenderer()

◆ removeAllActors()

◆ renderingActorsChanged

◆ resetCamera()

◆ resetLUT()

◆ rightClick

◆ screenshot [1/2]

◆ screenshot() [2/2]

◆ setActiveCamera()

◆ setBackfaceCulling

◆ setBackgroundColor()

◆ setColorScale()

◆ setColorScaleMinMax()

◆ setColorScaleTitle()

◆ setGlyph

◆ setGradientBackground()

◆ setHighlightMode()

◆ setLabel

◆ setLinesAsTubes

◆ setScreenshotAction

◆ setSideFrameVisible()

◆ sliderChanged

◆ startWhatsThisSection()

◆ toggleAxes

◆ toggleInterpolation()

◆ toggleLogo

◆ toggleOrientationDecorations

◆ updateActions()

◆ updateSelectionDisplay()