camitk::Viewer Class Reference

Viewer is an abstract viewer. More...

#include <Viewer.h>

Inherits QObject.

Inherited by ActionStateViewer, camitk::ActionViewer, camitk::Explorer, camitk::FrameExplorer, camitk::InteractiveViewer, camitk::MedicalImageViewer, and camitk::PropertyExplorer.

Signals
void	selectionChanged ()
	this signal is emitted when the current selection was changed by the viewer More...

Public Member Functions
virtual QMenu *	getMenu ()
	get the viewer menu (returns NULL by default, i.e. there are no default edit menu) More...
virtual QObject *	getPropertyObject ()
	get the viewer property object (returns NULL by default, i.e. there are no property to edit) More...
virtual QToolBar *	getToolBar ()
	get the viewer toolbar (returns NULL by default, i.e. there are no default toolbar) More...
virtual QWidget *	getWidget (QWidget *parent=nullptr)=0
	get the viewer widget. More...
virtual unsigned int	numberOfViewedComponent ()=0
	returns the number of Component that are displayed by this viewer More...
virtual void	refresh (Viewer *whoIsAsking=nullptr)=0
	refresh the view (can be interesting to know which other viewer is calling this) More...
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 Member Functions
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

Viewer is an abstract viewer.

A viewer can contains other viewers, example of viewer are: Explorer, PropertyExplorer, MedicalImageViewer. A viewer can be added to MainWindow, MainWindow will include its menu in the "View" menu and its toolbar in the application toolbar.

Use QObject method getObjectName to get the viewer's name.

Constructor & Destructor Documentation

Viewer()

camitk::Viewer::Viewer

(

QString

name

)

default constructor

~Viewer()

camitk::Viewer::~Viewer ( )

overridedefault

default destructor

Member Function Documentation

clearSelection()

void camitk::Viewer::clearSelection ( )

protected

clear the selection

References camitk::Application::clearSelectedComponents(), and selectionChanged().

Referenced by camitk::InteractiveViewer::keyPressEvent().

getMenu()

virtual QMenu* camitk::Viewer::getMenu ( )

inlinevirtual

get the viewer menu (returns NULL by default, i.e. there are no default edit menu)

Reimplemented in camitk::InteractiveViewer, camitk::MedicalImageViewer, and camitk::Explorer.

Referenced by ImpMainWindow::updateViewMenu().

getPropertyObject()

virtual QObject* camitk::Viewer::getPropertyObject ( )

inlinevirtual

get the viewer property object (returns NULL by default, i.e. there are no property to edit)

Reimplemented in camitk::InteractiveViewer, camitk::PropertyExplorer, and camitk::MedicalImageViewer.

Referenced by ImpMainWindow::editSettings().

getToolBar()

virtual QToolBar* camitk::Viewer::getToolBar ( )

inlinevirtual

get the viewer toolbar (returns NULL by default, i.e. there are no default toolbar)

Reimplemented in camitk::InteractiveViewer, and camitk::MedicalImageViewer.

Referenced by camitk::MainWindow::addViewer().

getWidget()

virtual QWidget* camitk::Viewer::getWidget ( QWidget *  parent = nullptr )

pure virtual

get the viewer widget.

Parameters

parent

the parent widget for the viewer widget

Implemented in camitk::InteractiveViewer, camitk::PropertyExplorer, camitk::MedicalImageViewer, camitk::ActionViewer, camitk::Explorer, camitk::FrameExplorer, and ActionStateViewer.

Referenced by camitk::MainWindow::addDockViewer(), and camitk::MainWindow::setCentralViewer().

numberOfViewedComponent()

virtual unsigned int camitk::Viewer::numberOfViewedComponent ( )

pure virtual

returns the number of Component that are displayed by this viewer

Implemented in camitk::InteractiveViewer, camitk::PropertyExplorer, camitk::MedicalImageViewer, camitk::Explorer, camitk::ActionViewer, camitk::FrameExplorer, and ActionStateViewer.

refresh()

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

pure virtual

refresh the view (can be interesting to know which other viewer is calling this)

Implemented in camitk::InteractiveViewer, camitk::PropertyExplorer, camitk::MedicalImageViewer, camitk::ActionViewer, camitk::Explorer, and camitk::FrameExplorer.

Referenced by camitk::MedicalImageViewer::refresh(), camitk::MainWindow::refresh(), camitk::MainWindow::refreshViewers(), and camitk::MedicalImageViewer::synchronizeSelection().

refreshInterfaceNode()

virtual void camitk::Viewer::refreshInterfaceNode ( Component *  comp )

inlinevirtual

Update the whole tree of the representation of the Component.

Is actually useful (and defined) in Explorer.

Reimplemented in camitk::Explorer.

selectionChanged [1/3]

void camitk::Viewer::selectionChanged ( )

signal

this signal is emitted when the current selection was changed by the viewer

Referenced by clearSelection(), camitk::MedicalImageViewer::getWidget(), camitk::InteractiveViewer::picked(), selectionChanged(), camitk::Explorer::selectionChanged(), camitk::InteractiveViewer::sliderChanged(), and camitk::MedicalImageViewer::synchronizeSelection().

selectionChanged() [2/3]

void camitk::Viewer::selectionChanged ( camitk::ComponentList &  compSet )

protected

The selection has changed to the given ComponentList.

This method updates the Component::selection and emit the modified signal. This method should be called by the inheriting class which can select Components (e.g.: Explorer).

References selectionChanged(), and camitk::Component::setSelected().

selectionChanged() [3/3]

void camitk::Viewer::selectionChanged ( Component *  comp )

protected

the selection has changed to be just one comp

References selectionChanged(), and camitk::Component::setSelected().

---

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

• Viewer.h
• Viewer.cpp