Baseclass of Overlay layouters. More...

#include <mitkAbstractOverlayLayouter.h>

Inheritance diagram for mitk::AbstractOverlayLayouter:

Collaboration diagram for mitk::AbstractOverlayLayouter:

Public Member Functions
	mitkClassMacroItkParent (AbstractOverlayLayouter, itk::LightObject)

void	SetBaseRenderer (BaseRenderer *renderer)

BaseRenderer *	GetBaseRenderer ()

void	AddOverlay (Overlay *Overlay)
	Adds an Overlay to the internal list of managed Overlays. More...

void	RemoveOverlay (Overlay *Overlay)
	Removes the passed Overlay from the m_ManagedOverlays List. More...

std::string	GetIdentifier () const
	Returns a unique identifier for one specific kind of layouter. More...

virtual void	PrepareLayout ()=0
	Sets the positions of each managed overlay according to the layouter role. More...

Protected Member Functions
	AbstractOverlayLayouter ()
	explicit constructor which disallows implicit conversions More...

virtual	~AbstractOverlayLayouter ()
	virtual destructor in order to derive from this class More...

std::list< mitk::Overlay * >	GetManagedOverlays () const
	returns a list of the overlays that is managed by this Layouter. More...

Protected Attributes
std::string	m_Identifier
	A unique identifier for one specific kind of layouter. More...

Detailed Description

Baseclass of Overlay layouters.

A AbstractOverlayLayouter can be implemented to control a set of Overlays by means of position and size. AbstractOverlayLayouter::PrepareLayout() should be implemented with a routine to set the position of the internal m_ManagedOverlays List. A layouter is always connected to one BaseRenderer, so there is one instance of the layouter for each BaseRenderer. One type of layouter should always have a unique identifier.

Definition at line 38 of file mitkAbstractOverlayLayouter.h.

Constructor & Destructor Documentation

mitk::AbstractOverlayLayouter::AbstractOverlayLayouter ( )

explicitprotected

explicit constructor which disallows implicit conversions

Definition at line 20 of file mitkAbstractOverlayLayouter.cpp.

mitk::AbstractOverlayLayouter::~AbstractOverlayLayouter ( )

protectedvirtual

virtual destructor in order to derive from this class

Definition at line 24 of file mitkAbstractOverlayLayouter.cpp.

Member Function Documentation

void mitk::AbstractOverlayLayouter::AddOverlay ( mitk::Overlay * Overlay )

Adds an Overlay to the internal list of managed Overlays.

By calling this, the previous Layouter of the passed Overlays is called to remove this overlay from its internal list.

Definition at line 43 of file mitkAbstractOverlayLayouter.cpp.

References RemoveOverlay().

mitk::BaseRenderer * mitk::AbstractOverlayLayouter::GetBaseRenderer ( )

Definition at line 38 of file mitkAbstractOverlayLayouter.cpp.

std::string mitk::AbstractOverlayLayouter::GetIdentifier ( ) const

Returns a unique identifier for one specific kind of layouter.

Definition at line 57 of file mitkAbstractOverlayLayouter.cpp.

std::list< mitk::Overlay * > mitk::AbstractOverlayLayouter::GetManagedOverlays ( ) const

protected

returns a list of the overlays that is managed by this Layouter.

Definition at line 28 of file mitkAbstractOverlayLayouter.cpp.

mitk::AbstractOverlayLayouter::mitkClassMacroItkParent	(	AbstractOverlayLayouter	,
		itk::LightObject
	)

virtual void mitk::AbstractOverlayLayouter::PrepareLayout ( )

pure virtual

Sets the positions of each managed overlay according to the layouter role.

This has to be implemented in order to provide a layouting procedure for the list of managed Overlays. The method has to provide a layouting for each identifier.

Implemented in mitk::Overlay2DLayouter.

void mitk::AbstractOverlayLayouter::RemoveOverlay ( mitk::Overlay * Overlay )

Removes the passed Overlay from the m_ManagedOverlays List.

Definition at line 52 of file mitkAbstractOverlayLayouter.cpp.

Referenced by AddOverlay().

void mitk::AbstractOverlayLayouter::SetBaseRenderer ( BaseRenderer * renderer )

Definition at line 33 of file mitkAbstractOverlayLayouter.cpp.