QmitkRenderWindowUtilityWidget Class Reference

Utility widget that extends a QmitkRenderWindowWidget with window-specific controls. More...

#include <QmitkRenderWindowUtilityWidget.h>

Inheritance diagram for QmitkRenderWindowUtilityWidget:

Collaboration diagram for QmitkRenderWindowUtilityWidget:

Public Types
using	GroupSyncIndexType = int

Public Slots
void	UpdateViewPlaneSelection ()
void	OnSyncGroupAdded (const GroupSyncIndexType index)

Signals
void	SynchronizationToggled (QmitkSynchronizedNodeSelectionWidget *synchronizedWidget)
void	SyncGroupChanged (QmitkSynchronizedNodeSelectionWidget *synchronizedWidget, GroupSyncIndexType index)
void	CreateNewSyncGroupRequested (QmitkSynchronizedNodeSelectionWidget *synchronizedWidget)
	Emitted when the user requests a new synchronization group via the '+' button. The owning multi widget allocates a free index and assigns this cell to it. More...
void	SetDataSelection (const QList< mitk::DataNode::Pointer > &newSelection)

Public Member Functions
	QmitkRenderWindowUtilityWidget (QWidget *parent=nullptr, QmitkRenderWindow *renderWindow=nullptr, mitk::DataStorage *dataStorage=nullptr)
	~QmitkRenderWindowUtilityWidget () override
void	SetSyncGroup (const GroupSyncIndexType index)
	Select the combobox row for the given synchronization group index. More...
GroupSyncIndexType	GetSyncGroup () const
	Returns the currently selected group index, or '-1' when the combobox holds no selection. More...
void	SetGeometry (const itk::EventObject &event)
QmitkSynchronizedNodeSelectionWidget *	GetNodeSelectionWidget () const

Detailed Description

Utility widget that extends a QmitkRenderWindowWidget with window-specific controls.

It offers to select the viewing direction of the window, as well as a QmitkSliceNavigationWidget to scroll through the current view direction. In addition, it contains a QmitkSynchronizedNodeSelectionWidget that controls renderer-specific properties and shown nodes, as well as a synchronization-group selector to share this state with other render windows.

Definition at line 48 of file QmitkRenderWindowUtilityWidget.h.

Member Typedef Documentation

GroupSyncIndexType

using QmitkRenderWindowUtilityWidget::GroupSyncIndexType = int

Definition at line 62 of file QmitkRenderWindowUtilityWidget.h.

Constructor & Destructor Documentation

QmitkRenderWindowUtilityWidget()

QmitkRenderWindowUtilityWidget::QmitkRenderWindowUtilityWidget	(	QWidget *	parent = nullptr,
		QmitkRenderWindow *	renderWindow = nullptr,
		mitk::DataStorage *	dataStorage = nullptr
	)

~QmitkRenderWindowUtilityWidget()

QmitkRenderWindowUtilityWidget::~QmitkRenderWindowUtilityWidget ( )

override

Member Function Documentation

CreateNewSyncGroupRequested

void QmitkRenderWindowUtilityWidget::CreateNewSyncGroupRequested ( QmitkSynchronizedNodeSelectionWidget *  synchronizedWidget )

signal

Emitted when the user requests a new synchronization group via the '+' button. The owning multi widget allocates a free index and assigns this cell to it.

GetNodeSelectionWidget()

QmitkSynchronizedNodeSelectionWidget* QmitkRenderWindowUtilityWidget::GetNodeSelectionWidget

(

)

const

GetSyncGroup()

GroupSyncIndexType QmitkRenderWindowUtilityWidget::GetSyncGroup

(

)

const

Returns the currently selected group index, or '-1' when the combobox holds no selection.

'-1' is returned only when no group has yet been registered with this widget (the combobox is empty – happens during initial construction before the first 'OnSyncGroupAdded' or 'SetSyncGroup'). After at least one group has been registered, the return value is always a valid group index >= 1.

OnSyncGroupAdded

void QmitkRenderWindowUtilityWidget::OnSyncGroupAdded ( const GroupSyncIndexType  index )

slot

SetDataSelection

void QmitkRenderWindowUtilityWidget::SetDataSelection ( const QList< mitk::DataNode::Pointer > &  newSelection )

signal

SetGeometry()

void QmitkRenderWindowUtilityWidget::SetGeometry

(

const itk::EventObject &

event

)

SetSyncGroup()

void QmitkRenderWindowUtilityWidget::SetSyncGroup

(

const GroupSyncIndexType

index

)

Select the combobox row for the given synchronization group index.

Parameters

index

The 1-based group index. Must be >= 1 and must already be registered with this widget (i.e. 'OnSyncGroupAdded' has run for this index, or it was added by a prior 'SetSyncGroup').

Precondition

index >= 1 (otherwise mitk::Exception)

the group is present in this widget's combobox (otherwise mitk::Exception)

Exceptions

mitk::Exception

on precondition violation.

SyncGroupChanged

void QmitkRenderWindowUtilityWidget::SyncGroupChanged ( QmitkSynchronizedNodeSelectionWidget *  synchronizedWidget, GroupSyncIndexType  index  )

signal

SynchronizationToggled

void QmitkRenderWindowUtilityWidget::SynchronizationToggled ( QmitkSynchronizedNodeSelectionWidget *  synchronizedWidget )

signal

UpdateViewPlaneSelection

void QmitkRenderWindowUtilityWidget::UpdateViewPlaneSelection ( )

slot

---

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

• QmitkRenderWindowUtilityWidget.h