QmitkOverlay Class Reference

Abstract base class for all overlay-objects in MITK. More...

#include <QmitkOverlay.h>

Inheritance diagram for QmitkOverlay:

List of all members.

Public Types
enum	DisplayPosition {   top_Left = 0, top_Center = 1, top_Right = 2, middle_Left = 3,   middle_Right = 4, bottom_Left = 5, bottom_Center = 6, bottom_Right = 7 }
	enumeration of all possible display positions More...
Public Member Functions
	QmitkOverlay (const char *id)
	Constructor with string ID.
virtual	~QmitkOverlay ()
	Default Destructor.
virtual void	SetPosition (DisplayPosition)
	setter for the display-position
virtual DisplayPosition	GetPosition ()
	getter for the display-position
virtual void	SetLayer (unsigned int)
	setter for the layer
virtual unsigned int	GetLayer ()
	getter for the layer
virtual void	GenerateData (mitk::PropertyList::Pointer)
	abstract method to internally setup the overlay
virtual QWidget *	GetWidget ()
	returns the internally handled QWidget
Protected Attributes
const char *	m_Id
	ID of the overlay.
DisplayPosition	m_Position
	position of the overlay
unsigned int	m_Layer
	layer of the overlay
QWidget *	m_Widget
	internal QWidget representing the overlay

---

Detailed Description

Abstract base class for all overlay-objects in MITK.

This class is the basis for all classes representing objects that can be visualized as overlays in MITK. It encapsulates an ID, as well as a display-position and a layer.

The ID is used to access mitkProperties in a PropertyList that holds information that is needed for the visualization, e.g. text for TextOverlays or scaleFactor for ScalarBarOverlays ...

The display-position encodes where on the screen the overlay will be positioned at:

See also:

DisplayPosition 0 - 1 - 2 | | | 3 - - 4 | | | 5 - 6 - 7

The layer is needed if several overlays shall be put in the same position. In this case the layer defines the order in which the objects are layouted.

Definition at line 55 of file QmitkOverlay.h.

---

Member Enumeration Documentation

enum QmitkOverlay::DisplayPosition

enumeration of all possible display positions

Enumerator:

top_Left
top_Center
top_Right
middle_Left
middle_Right
bottom_Left
bottom_Center
bottom_Right

Definition at line 62 of file QmitkOverlay.h.

  {
    top_Left = 0,
    top_Center = 1,
    top_Right = 2,
    middle_Left = 3,
    middle_Right = 4,
    bottom_Left = 5,
    bottom_Center = 6,
    bottom_Right = 7
  };

---

Constructor & Destructor Documentation

QmitkOverlay::QmitkOverlay

(

const char *

id )

Constructor with string ID.

Definition at line 23 of file QmitkOverlay.cpp.

References m_Widget.

                                          : 
QObject(), m_Id(id), m_Position(top_Left), m_Layer(-1)
{
  m_Widget = new QWidget();
}

QmitkOverlay::~QmitkOverlay

(

)

[virtual]

Default Destructor.

Definition at line 29 of file QmitkOverlay.cpp.

{

}

---

Member Function Documentation

virtual void QmitkOverlay::GenerateData

(

mitk::PropertyList::Pointer

)

[inline, virtual]

abstract method to internally setup the overlay

Reimplemented in QmitkScalarBarOverlay, and QmitkTextOverlay.

Definition at line 99 of file QmitkOverlay.h.

Referenced by QmitkOverlayController::UpdateOverlayData().

{};

unsigned int QmitkOverlay::GetLayer

(

)

[virtual]

getter for the layer

Definition at line 44 of file QmitkOverlay.cpp.

References m_Layer.

{
  return m_Layer;
}

QmitkOverlay::DisplayPosition QmitkOverlay::GetPosition

(

)

[virtual]

getter for the display-position

Definition at line 34 of file QmitkOverlay.cpp.

References m_Position.

Referenced by QmitkOverlayController::AddOverlay(), and QmitkOverlayController::RemoveOverlay().

{
  return m_Position;
}

QWidget * QmitkOverlay::GetWidget

(

)

[virtual]

returns the internally handled QWidget

Reimplemented in QmitkScalarBarOverlay, and QmitkTextOverlay.

Definition at line 54 of file QmitkOverlay.cpp.

References m_Widget.

Referenced by QmitkOverlayController::AddOverlay(), QmitkOverlayController::RemoveOverlay(), and QmitkOverlayController::SetOverlayVisibility().

{
  return m_Widget;
}

void QmitkOverlay::SetLayer

(

unsigned int

layer )

[virtual]

setter for the layer

Definition at line 49 of file QmitkOverlay.cpp.

References m_Layer.

{
  m_Layer = layer;
}

void QmitkOverlay::SetPosition

(

DisplayPosition

pos )

[virtual]

setter for the display-position

Definition at line 39 of file QmitkOverlay.cpp.

References m_Position.

{
  m_Position = pos;
}

---

Member Data Documentation

const char* QmitkOverlay::m_Id [protected]

ID of the overlay.

Definition at line 110 of file QmitkOverlay.h.

Referenced by QmitkTextOverlay::GenerateData(), QmitkScalarBarOverlay::GenerateData(), QmitkScalarBarOverlay::SetScaleFactor(), and QmitkTextOverlay::SetText().

unsigned int QmitkOverlay::m_Layer [protected]

layer of the overlay

Definition at line 116 of file QmitkOverlay.h.

Referenced by GetLayer(), and SetLayer().

DisplayPosition QmitkOverlay::m_Position [protected]

position of the overlay

Definition at line 113 of file QmitkOverlay.h.

Referenced by GetPosition(), and SetPosition().

QWidget* QmitkOverlay::m_Widget [protected]

internal QWidget representing the overlay

Reimplemented in QmitkScalarBarOverlay, and QmitkTextOverlay.

Definition at line 119 of file QmitkOverlay.h.

Referenced by GetWidget(), and QmitkOverlay().

---

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

• QmitkOverlay.h
• QmitkOverlay.cpp