mitk::OverlayManager Class Reference

The OverlayManager updates and manages Overlays and the respective Layouters. More...

#include <mitkOverlayManager.h>

Inheritance diagram for mitk::OverlayManager:

Collaboration diagram for mitk::OverlayManager:

Public Types
typedef std::set< BaseRenderer * >	BaseRendererSet
typedef std::set< Overlay::Pointer >	OverlaySet
typedef std::map< const std::string, AbstractOverlayLayouter::Pointer >	LayouterMap
typedef std::map< const BaseRenderer *, LayouterMap >	LayouterRendererMap
typedef std::map< const BaseRenderer *, vtkSmartPointer< vtkRenderer > >	ForegroundRendererMap
typedef OverlayManager	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const
virtual const char *	GetClassName () const
Pointer	Clone () const
void	AddOverlay (const Overlay::Pointer &overlay, bool ForceInForeground=true)
void	AddOverlay (const Overlay::Pointer &overlay, BaseRenderer *renderer, bool ForceInForeground=true)
void	RemoveOverlay (const Overlay::Pointer &overlay)
void	RemoveAllOverlays ()
	Clears the manager of all Overlays. More...
void	SetLayouter (Overlay *overlay, const std::string &identifier, BaseRenderer *renderer)
	Adds the overlay to the layouter specified by identifier and renderer. More...
void	UpdateLayouts (BaseRenderer *renderer)
	Calls all layouters to update the position and size of the registered Overlays. More...
AbstractOverlayLayouter::Pointer	GetLayouter (BaseRenderer *renderer, const std::string &identifier)
	Returns the Layouter specified by renderer and the identifier. More...
void	AddLayouter (const AbstractOverlayLayouter::Pointer &layouter)
	Add a layouter to provide it with the use of the SetLayouter method. More...
void	AddBaseRenderer (BaseRenderer *renderer)
void	UpdateOverlays (BaseRenderer *baseRenderer)
	The layout of each Overlay will be prepared and the properties of each Overlay is updated. More...
void	RemoveBaseRenderer (mitk::BaseRenderer *renderer)
void	RemoveAllBaseRenderers ()
const OverlaySet &	GetAllOverlays ()

Static Public Member Functions
static const char *	GetStaticNameOfClass ()
static Pointer	New ()
static OverlayManager *	GetInstance ()

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

Detailed Description

The OverlayManager updates and manages Overlays and the respective Layouters.

An Instance of the OverlayManager can be registered to several BaseRenderer instances in order to call the update method of each Overlay during the rendering phase of the renderer. See Overlays and Annotations Concepts for more info.

Definition at line 39 of file mitkOverlayManager.h.

Member Typedef Documentation

typedef std::set<BaseRenderer *> mitk::OverlayManager::BaseRendererSet

Definition at line 42 of file mitkOverlayManager.h.

typedef itk::SmartPointer<const Self> mitk::OverlayManager::ConstPointer

Definition at line 48 of file mitkOverlayManager.h.

typedef std::map<const BaseRenderer *, vtkSmartPointer<vtkRenderer> > mitk::OverlayManager::ForegroundRendererMap

Definition at line 46 of file mitkOverlayManager.h.

typedef std::map<const std::string, AbstractOverlayLayouter::Pointer> mitk::OverlayManager::LayouterMap

Definition at line 44 of file mitkOverlayManager.h.

typedef std::map<const BaseRenderer *, LayouterMap> mitk::OverlayManager::LayouterRendererMap

Definition at line 45 of file mitkOverlayManager.h.

typedef std::set<Overlay::Pointer> mitk::OverlayManager::OverlaySet

Definition at line 43 of file mitkOverlayManager.h.

typedef itk::SmartPointer<Self> mitk::OverlayManager::Pointer

Definition at line 48 of file mitkOverlayManager.h.

typedef OverlayManager mitk::OverlayManager::Self

Definition at line 48 of file mitkOverlayManager.h.

typedef itk::Object mitk::OverlayManager::Superclass

Definition at line 48 of file mitkOverlayManager.h.

Constructor & Destructor Documentation

mitk::OverlayManager::OverlayManager ( )

explicitprotected

explicit constructor which disallows implicit conversions

mitk::OverlayManager::~OverlayManager ( )

protected

Definition at line 30 of file mitkOverlayManager.cpp.

References RemoveAllBaseRenderers(), and RemoveAllOverlays().

Member Function Documentation

void mitk::OverlayManager::AddBaseRenderer

(

BaseRenderer *

renderer

)

Definition at line 36 of file mitkOverlayManager.cpp.

References mitk::VtkLayerController::GetInstance(), and mitk::New().

void mitk::OverlayManager::AddLayouter

(

const AbstractOverlayLayouter::Pointer &

layouter

)

Add a layouter to provide it with the use of the SetLayouter method.

Definition at line 212 of file mitkOverlayManager.cpp.

References MITK_WARN.

void mitk::OverlayManager::AddOverlay	(	const Overlay::Pointer &	overlay,
		bool	ForceInForeground = true
	)

Definition at line 106 of file mitkOverlayManager.cpp.

void mitk::OverlayManager::AddOverlay	(	const Overlay::Pointer &	overlay,
		BaseRenderer *	renderer,
		bool	ForceInForeground = true
	)

Definition at line 127 of file mitkOverlayManager.cpp.

Pointer mitk::OverlayManager::Clone

(

)

const

const OverlayManager::OverlaySet & mitk::OverlayManager::GetAllOverlays

(

)

Definition at line 93 of file mitkOverlayManager.cpp.

virtual std::vector<std::string> mitk::OverlayManager::GetClassHierarchy ( ) const

inlinevirtual

Definition at line 48 of file mitkOverlayManager.h.

virtual const char* mitk::OverlayManager::GetClassName ( ) const

virtual

OverlayManager * mitk::OverlayManager::GetInstance ( )

static

Definition at line 94 of file mitkOverlayManager.cpp.

References mitk::RenderingManager::GetAllRegisteredRenderWindows(), mitk::BaseRenderer::GetInstance(), mitk::RenderingManager::GetInstance(), and mitk::BaseRenderer::GetOverlayManager().

AbstractOverlayLayouter::Pointer mitk::OverlayManager::GetLayouter	(	BaseRenderer *	renderer,
		const std::string &	identifier
	)

Returns the Layouter specified by renderer and the identifier.

Definition at line 206 of file mitkOverlayManager.cpp.

Referenced by SetLayouter().

static const char* mitk::OverlayManager::GetStaticNameOfClass ( )

inlinestatic

Definition at line 48 of file mitkOverlayManager.h.

static Pointer mitk::OverlayManager::New ( )

static

Referenced by mitk::BaseRenderer::GetOverlayManager(), QmitkStdMultiWidget::InitializeWidget(), and main().

void mitk::OverlayManager::RemoveAllBaseRenderers

(

)

Definition at line 84 of file mitkOverlayManager.cpp.

References RemoveBaseRenderer().

Referenced by ~OverlayManager().

void mitk::OverlayManager::RemoveAllOverlays

(

)

Clears the manager of all Overlays.

Definition at line 163 of file mitkOverlayManager.cpp.

References RemoveOverlay().

Referenced by ~OverlayManager().

void mitk::OverlayManager::RemoveBaseRenderer

(

mitk::BaseRenderer *

renderer

)

Definition at line 61 of file mitkOverlayManager.cpp.

Referenced by RemoveAllBaseRenderers().

void mitk::OverlayManager::RemoveOverlay

(

const Overlay::Pointer &

overlay

)

Definition at line 144 of file mitkOverlayManager.cpp.

Referenced by RemoveAllOverlays().

void mitk::OverlayManager::SetLayouter	(	Overlay *	overlay,
		const std::string &	identifier,
		BaseRenderer *	renderer
	)

Adds the overlay to the layouter specified by identifier and renderer.

Definition at line 179 of file mitkOverlayManager.cpp.

References GetLayouter(), and MITK_WARN.

void mitk::OverlayManager::UpdateLayouts

(

BaseRenderer *

renderer

)

Calls all layouters to update the position and size of the registered Overlays.

Definition at line 196 of file mitkOverlayManager.cpp.

Referenced by UpdateOverlays().

void mitk::OverlayManager::UpdateOverlays

(

BaseRenderer *

baseRenderer

)

The layout of each Overlay will be prepared and the properties of each Overlay is updated.

Definition at line 169 of file mitkOverlayManager.cpp.

References UpdateLayouts().

---

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

• mitkOverlayManager.h
• mitkOverlayManager.cpp