mitk::LayoutAnnotationRenderer Class Reference

The LayoutAnnotationRenderer is used for the layouted placement of mitk::Annotation Objects. More...

#include <mitkLayoutAnnotationRenderer.h>

Inheritance diagram for mitk::LayoutAnnotationRenderer:

Collaboration diagram for mitk::LayoutAnnotationRenderer:

Public Types
enum	Alignment {   TopLeft, Top, TopRight, BottomLeft,   Bottom, BottomRight, Left, Right }
typedef std::multimap< int, mitk::Annotation * >	AnnotationRankedMap
typedef std::map< Alignment, AnnotationRankedMap >	AnnotationLayouterContainerMap
Public Types inherited from mitk::AbstractAnnotationRenderer
typedef us::ServiceTracker< Annotation >	Superclass
Public Types inherited from us::ServiceTracker< Annotation >
typedef Annotation	ServiceType
	The type of the service being tracked. More...
typedef TrackedTypeTraits< Annotation,Annotation * > ::TrackedType	T
	The type of the tracked object. More...
typedef ServiceReference< Annotation >	ServiceReferenceType
typedef std::map< ServiceReference< Annotation >, T >	TrackingMap

Public Member Functions
	~LayoutAnnotationRenderer () override
	virtual destructor in order to derive from this class More...
const std::string	GetID () const
void	OnRenderWindowModified () override
void	PrepareLayout ()
Public Member Functions inherited from mitk::AbstractAnnotationRenderer
	AbstractAnnotationRenderer (const std::string &rendererID, const std::string &arID)
	~AbstractAnnotationRenderer () override
	virtual destructor in order to derive from this class More...
const std::string	GetID () const
const std::string	GetRendererID () const
void	CurrentBaseRendererChanged ()
void	RemoveAllAnnotation ()
void	Update ()
Public Member Functions inherited from us::ServiceTracker< Annotation >
	~ServiceTracker () override
	ServiceTracker (ModuleContext *context, const ServiceReferenceType &reference, ServiceTrackerCustomizer< Annotation, T > *customizer=nullptr)
	ServiceTracker (ModuleContext *context, const std::string &clazz, ServiceTrackerCustomizer< Annotation, T > *customizer=0)
	ServiceTracker (ModuleContext *context, const LDAPFilter &filter, ServiceTrackerCustomizer< Annotation, T > *customizer=nullptr)
	ServiceTracker (ModuleContext *context, ServiceTrackerCustomizer< Annotation, T > *customizer=nullptr)
virtual void	Open ()
virtual void	Close ()
virtual T	WaitForService (unsigned long timeoutMillis=0)
virtual std::vector< ServiceReferenceType >	GetServiceReferences () const
virtual ServiceReferenceType	GetServiceReference () const
virtual T	GetService (const ServiceReferenceType &reference) const
virtual T	GetService () const
virtual std::vector< T >	GetServices () const
virtual void	Remove (const ServiceReferenceType &reference)
virtual int	Size () const
virtual int	GetTrackingCount () const
virtual void	GetTracked (TrackingMap &tracked) const
virtual bool	IsEmpty () const

Static Public Member Functions
static LayoutAnnotationRenderer *	GetAnnotationRenderer (const std::string &rendererID)
static void	AddAnnotation (Annotation *annotation, const std::string &rendererID, Alignment alignment=TopLeft, double marginX=5, double marginY=5, int priority=-1)
static void	AddAnnotation (Annotation *annotation, BaseRenderer *renderer, Alignment alignment=TopLeft, double marginX=5, double marginY=5, int priority=-1)

Static Public Attributes
static const std::string	PROP_LAYOUT
static const std::string	PROP_LAYOUT_PRIORITY
static const std::string	PROP_LAYOUT_ALIGNMENT
static const std::string	PROP_LAYOUT_MARGIN
Static Public Attributes inherited from mitk::AbstractAnnotationRenderer
static const std::string	US_INTERFACE_NAME
static const std::string	US_PROPKEY_ID
static const std::string	US_PROPKEY_RENDERER_ID

Additional Inherited Members
Protected Types inherited from us::ServiceTrackerCustomizer< S, T >
typedef S	ServiceType
typedef T	TrackedType
typedef ServiceReference< ServiceType >	ServiceReferenceType
Protected Member Functions inherited from mitk::AbstractAnnotationRenderer
BaseRenderer *	GetCurrentBaseRenderer ()
Protected Member Functions inherited from us::ServiceTracker< Annotation >
T	AddingService (const ServiceReferenceType &reference) override
void	ModifiedService (const ServiceReferenceType &reference, T service) override
void	RemovedService (const ServiceReferenceType &reference, T service) override
Protected Member Functions inherited from us::ServiceTrackerCustomizer< S, T >
virtual	~ServiceTrackerCustomizer ()
virtual void	ModifiedService (const ServiceReferenceType &reference, TrackedType service)=0
virtual void	RemovedService (const ServiceReferenceType &reference, TrackedType service)=0

Detailed Description

The LayoutAnnotationRenderer is used for the layouted placement of mitk::Annotation Objects.

An instance of this service is registered for a specific Baserenderer and is used to manage all annotations which are added to it. The static function AddAnnotation is used to register an annotation to a specific service and to create this service if it does not exist yet. The position of the layouted annotation can be passed as a parameter.

See Annotation Concept for more info.

Definition at line 32 of file mitkLayoutAnnotationRenderer.h.

Member Typedef Documentation

AnnotationLayouterContainerMap

typedef std::map<Alignment, AnnotationRankedMap> mitk::LayoutAnnotationRenderer::AnnotationLayouterContainerMap

Definition at line 51 of file mitkLayoutAnnotationRenderer.h.

AnnotationRankedMap

typedef std::multimap<int, mitk::Annotation *> mitk::LayoutAnnotationRenderer::AnnotationRankedMap

Definition at line 50 of file mitkLayoutAnnotationRenderer.h.

Member Enumeration Documentation

Alignment

enum mitk::LayoutAnnotationRenderer::Alignment

Enumerator
TopLeft
Top
TopRight
BottomLeft
Bottom
BottomRight
Left
Right

Definition at line 39 of file mitkLayoutAnnotationRenderer.h.

Constructor & Destructor Documentation

~LayoutAnnotationRenderer()

mitk::LayoutAnnotationRenderer::~LayoutAnnotationRenderer ( )

override

virtual destructor in order to derive from this class

Member Function Documentation

AddAnnotation() [1/2]

static void mitk::LayoutAnnotationRenderer::AddAnnotation ( Annotation *  annotation, BaseRenderer *  renderer, Alignment  alignment = TopLeft, double  marginX = 5, double  marginY = 5, int  priority = -1  )

static

AddAnnotation() [2/2]

static void mitk::LayoutAnnotationRenderer::AddAnnotation ( Annotation *  annotation, const std::string &  rendererID, Alignment  alignment = TopLeft, double  marginX = 5, double  marginY = 5, int  priority = -1  )

static

GetAnnotationRenderer()

static LayoutAnnotationRenderer* mitk::LayoutAnnotationRenderer::GetAnnotationRenderer ( const std::string &  rendererID )

static

GetID()

const std::string mitk::LayoutAnnotationRenderer::GetID

(

)

const

OnRenderWindowModified()

void mitk::LayoutAnnotationRenderer::OnRenderWindowModified ( )

overridevirtual

Reimplemented from mitk::AbstractAnnotationRenderer.

PrepareLayout()

void mitk::LayoutAnnotationRenderer::PrepareLayout

(

)

Member Data Documentation

PROP_LAYOUT

const std::string mitk::LayoutAnnotationRenderer::PROP_LAYOUT

static

Definition at line 35 of file mitkLayoutAnnotationRenderer.h.

PROP_LAYOUT_ALIGNMENT

const std::string mitk::LayoutAnnotationRenderer::PROP_LAYOUT_ALIGNMENT

static

Definition at line 37 of file mitkLayoutAnnotationRenderer.h.

PROP_LAYOUT_MARGIN

const std::string mitk::LayoutAnnotationRenderer::PROP_LAYOUT_MARGIN

static

Definition at line 38 of file mitkLayoutAnnotationRenderer.h.

PROP_LAYOUT_PRIORITY

const std::string mitk::LayoutAnnotationRenderer::PROP_LAYOUT_PRIORITY

static

Definition at line 36 of file mitkLayoutAnnotationRenderer.h.

---

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

• mitkLayoutAnnotationRenderer.h