Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
QmitkRenderWindowWidget Class Reference

The 'QmitkRenderWindowWidget' is a QFrame that holds a render window and some associates properties, e.g. decorations. Decorations are corner annotation (text and color), frame color or background color and can be set using this class. The 'QmitkRenderWindowWidget' is used inside a 'QmitkAbstractMultiWidget', where a map contains several render window widgets to create the multi widget display. This class uses a CrosshairManager, which allows to use plane geometries as crosshair. More...

#include <QmitkRenderWindowWidget.h>

Inheritance diagram for QmitkRenderWindowWidget:
Collaboration diagram for QmitkRenderWindowWidget:

Public Slots

void OnResetGeometry ()
 

Public Member Functions

 QmitkRenderWindowWidget (QWidget *parent, const QString &widgetName, mitk::DataStorage *dataStorage)
 Construct a render-window widget. More...
 
 ~QmitkRenderWindowWidget () override
 
void SetDataStorage (mitk::DataStorage *dataStorage)
 
const QString & GetWidgetName () const
 
QmitkRenderWindow * GetRenderWindow () const
 
const QString & GetDisplayName () const
 Optional human-readable display label. More...
 
void SetDisplayName (const QString &displayName)
 
mitk::SliceNavigationController * GetSliceNavigationController () const
 
void RequestUpdate ()
 
void ForceImmediateUpdate ()
 
void AddUtilityWidget (QWidget *utilityWidget)
 
QmitkRenderWindowUtilityWidget * GetUtilityWidget ()
 
const QmitkRenderWindowUtilityWidget * GetUtilityWidget () const
 
void SetGradientBackgroundColors (const mitk::Color &upper, const mitk::Color &lower)
 
void ShowGradientBackground (bool enable)
 
std::pair< mitk::Color, mitk::Color > GetGradientBackgroundColors () const
 
bool IsGradientBackgroundOn () const
 
void SetDecorationColor (const mitk::Color &color)
 
mitk::Color GetDecorationColor () const
 
void ShowColoredRectangle (bool show)
 
bool IsColoredRectangleVisible () const
 
void ShowCornerAnnotation (bool show)
 
bool IsCornerAnnotationVisible () const
 
void SetCornerAnnotationText (const std::string &cornerAnnotation)
 
std::string GetCornerAnnotationText () const
 
bool IsRenderWindowMenuActivated () const
 
void SetCrosshairVisibility (bool visible)
 
bool GetCrosshairVisibility ()
 
void SetCrosshairGap (unsigned int gapSize)
 
void EnableCrosshair ()
 
void DisableCrosshair ()
 
void SetCrosshairPosition (const mitk::Point3D &newPosition)
 
mitk::Point3D GetCrosshairPosition () const
 
void SetGeometry (const itk::EventObject &event)
 
void SetGeometrySlice (const itk::EventObject &event)
 

Detailed Description

The 'QmitkRenderWindowWidget' is a QFrame that holds a render window and some associates properties, e.g. decorations. Decorations are corner annotation (text and color), frame color or background color and can be set using this class. The 'QmitkRenderWindowWidget' is used inside a 'QmitkAbstractMultiWidget', where a map contains several render window widgets to create the multi widget display. This class uses a CrosshairManager, which allows to use plane geometries as crosshair.

Definition at line 43 of file QmitkRenderWindowWidget.h.

Constructor & Destructor Documentation

◆ QmitkRenderWindowWidget()

QmitkRenderWindowWidget::QmitkRenderWindowWidget ( QWidget *  parent,
const QString &  widgetName,
mitk::DataStorage *  dataStorage 
)

Construct a render-window widget.

Parameters
parentOwning Qt parent. Must not be null.
widgetNameCanonical name registered with the rendering manager (e.g. 'stdmulti.axial' for StdMulti, or 'mxn__widget0' for MxN; the editor that owns this widget chooses the convention). Must not be empty.
dataStorageData storage backing the render window. Must not be null; the widget unconditionally talks to it during 'InitializeGUI'.

Defaults intentionally not provided: the widget is unusable without a non-null data storage and a non-empty name. Earlier versions defaulted all three parameters; that hid construction errors at the call site.

◆ ~QmitkRenderWindowWidget()

QmitkRenderWindowWidget::~QmitkRenderWindowWidget ( )
override

Member Function Documentation

◆ AddUtilityWidget()

void QmitkRenderWindowWidget::AddUtilityWidget ( QWidget *  utilityWidget)

◆ DisableCrosshair()

void QmitkRenderWindowWidget::DisableCrosshair ( )

◆ EnableCrosshair()

void QmitkRenderWindowWidget::EnableCrosshair ( )

◆ ForceImmediateUpdate()

void QmitkRenderWindowWidget::ForceImmediateUpdate ( )

◆ GetCornerAnnotationText()

std::string QmitkRenderWindowWidget::GetCornerAnnotationText ( ) const

◆ GetCrosshairPosition()

mitk::Point3D QmitkRenderWindowWidget::GetCrosshairPosition ( ) const

◆ GetCrosshairVisibility()

bool QmitkRenderWindowWidget::GetCrosshairVisibility ( )

◆ GetDecorationColor()

mitk::Color QmitkRenderWindowWidget::GetDecorationColor ( ) const
inline

Definition at line 103 of file QmitkRenderWindowWidget.h.

◆ GetDisplayName()

const QString& QmitkRenderWindowWidget::GetDisplayName ( ) const
inline

Optional human-readable display label.

Persisted as the optional name field of the corresponding window leaf in the v2 layout document; empty when the layout omits that field. Pure metadata: not used for routing, addressing, persisted-state keying, or REST URL construction (those all use the bare widget id, derivable from GetWidgetName via the editor-prefix strip).

Definition at line 85 of file QmitkRenderWindowWidget.h.

◆ GetGradientBackgroundColors()

std::pair<mitk::Color, mitk::Color> QmitkRenderWindowWidget::GetGradientBackgroundColors ( ) const
inline

Definition at line 99 of file QmitkRenderWindowWidget.h.

◆ GetRenderWindow()

QmitkRenderWindow* QmitkRenderWindowWidget::GetRenderWindow ( ) const
inline

Definition at line 74 of file QmitkRenderWindowWidget.h.

◆ GetSliceNavigationController()

mitk::SliceNavigationController* QmitkRenderWindowWidget::GetSliceNavigationController ( ) const

◆ GetUtilityWidget() [1/2]

QmitkRenderWindowUtilityWidget* QmitkRenderWindowWidget::GetUtilityWidget ( )

◆ GetUtilityWidget() [2/2]

const QmitkRenderWindowUtilityWidget* QmitkRenderWindowWidget::GetUtilityWidget ( ) const

◆ GetWidgetName()

const QString& QmitkRenderWindowWidget::GetWidgetName ( ) const
inline

Definition at line 73 of file QmitkRenderWindowWidget.h.

◆ IsColoredRectangleVisible()

bool QmitkRenderWindowWidget::IsColoredRectangleVisible ( ) const

◆ IsCornerAnnotationVisible()

bool QmitkRenderWindowWidget::IsCornerAnnotationVisible ( ) const

◆ IsGradientBackgroundOn()

bool QmitkRenderWindowWidget::IsGradientBackgroundOn ( ) const

◆ IsRenderWindowMenuActivated()

bool QmitkRenderWindowWidget::IsRenderWindowMenuActivated ( ) const

◆ OnResetGeometry

void QmitkRenderWindowWidget::OnResetGeometry ( )
slot

◆ RequestUpdate()

void QmitkRenderWindowWidget::RequestUpdate ( )

◆ SetCornerAnnotationText()

void QmitkRenderWindowWidget::SetCornerAnnotationText ( const std::string &  cornerAnnotation)

◆ SetCrosshairGap()

void QmitkRenderWindowWidget::SetCrosshairGap ( unsigned int  gapSize)

◆ SetCrosshairPosition()

void QmitkRenderWindowWidget::SetCrosshairPosition ( const mitk::Point3D &  newPosition)

◆ SetCrosshairVisibility()

void QmitkRenderWindowWidget::SetCrosshairVisibility ( bool  visible)

◆ SetDataStorage()

void QmitkRenderWindowWidget::SetDataStorage ( mitk::DataStorage *  dataStorage)

◆ SetDecorationColor()

void QmitkRenderWindowWidget::SetDecorationColor ( const mitk::Color &  color)

◆ SetDisplayName()

void QmitkRenderWindowWidget::SetDisplayName ( const QString &  displayName)
inline

Definition at line 86 of file QmitkRenderWindowWidget.h.

◆ SetGeometry()

void QmitkRenderWindowWidget::SetGeometry ( const itk::EventObject &  event)

◆ SetGeometrySlice()

void QmitkRenderWindowWidget::SetGeometrySlice ( const itk::EventObject &  event)

◆ SetGradientBackgroundColors()

void QmitkRenderWindowWidget::SetGradientBackgroundColors ( const mitk::Color &  upper,
const mitk::Color &  lower 
)

◆ ShowColoredRectangle()

void QmitkRenderWindowWidget::ShowColoredRectangle ( bool  show)

◆ ShowCornerAnnotation()

void QmitkRenderWindowWidget::ShowCornerAnnotation ( bool  show)

◆ ShowGradientBackground()

void QmitkRenderWindowWidget::ShowGradientBackground ( bool  enable)

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