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

#include <mitkLayoutAnnotationRenderer.h>

Inheritance diagram for mitk::LayoutAnnotationRenderer:

[legend]

Collaboration diagram for mitk::LayoutAnnotationRenderer:

[legend]

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 TTT::TrackedType	T
	The type of the tracked object. More...

typedef ServiceReference< Annotation >	ServiceReferenceType
	The service reference type. More...

typedef std::map< ServiceReference< Annotation >, T >	TrackingMap
	A map type from ServiceReference to tracked objects. More...

Public Member Functions
	~LayoutAnnotationRenderer () override
	virtual destructor in order to derive from this class More...

const std::string	GetID () const

void	OnRenderWindowModified () override
	Called when the render window is modified. Override to react to changes. More...

void	PrepareLayout ()

Public Member Functions inherited from mitk::AbstractAnnotationRenderer
	AbstractAnnotationRenderer (const std::string &rendererID, const std::string &arID)
	Construct an annotation renderer for a specific renderer and annotation renderer ID. More...

	~AbstractAnnotationRenderer () override
	Virtual destructor. More...

const std::string	GetID () const
	Get the unique ID of this annotation renderer. More...

const std::string	GetRendererID () const
	Get the ID of the associated BaseRenderer. More...

void	CurrentBaseRendererChanged ()
	Notify that the current BaseRenderer has changed. More...

void	RemoveAllAnnotation ()
	Remove all tracked Annotation objects from the associated renderer. More...

void	Update ()
	Update all tracked Annotation objects. More...

Public Member Functions inherited from us::ServiceTracker< Annotation >
	~ServiceTracker () override
	Destructor. More...

	ServiceTracker (ModuleContext context, const ServiceReferenceType &reference, ServiceTrackerCustomizer< Annotation, T > customizer=nullptr)
	Create a `ServiceTracker` on the specified `ServiceReference`. More...

	ServiceTracker (ModuleContext context, const std::string &clazz, ServiceTrackerCustomizer< Annotation, T > customizer=0)
	Create a `ServiceTracker` on the specified class name. More...

	ServiceTracker (ModuleContext context, const LDAPFilter &filter, ServiceTrackerCustomizer< Annotation, T > customizer=nullptr)
	Create a `ServiceTracker` on the specified `LDAPFilter` object. More...

	ServiceTracker (ModuleContext context, ServiceTrackerCustomizer< Annotation, T > customizer=nullptr)
	Create a `ServiceTracker` on the class template argument S. More...

virtual void	Open ()
	Open this `ServiceTracker` and begin tracking services. More...

virtual void	Close ()
	Close this `ServiceTracker`. More...

virtual T	WaitForService (unsigned long timeoutMillis=0)
	Wait for at least one service to be tracked by this `ServiceTracker`. This method will also return when this `ServiceTracker` is closed. More...

virtual std::vector< ServiceReferenceType >	GetServiceReferences () const
	Return a list of `ServiceReference`s for all services being tracked by this `ServiceTracker`. More...

virtual ServiceReferenceType	GetServiceReference () const
	Returns a `ServiceReference` for one of the services being tracked by this `ServiceTracker`. More...

virtual T	GetService (const ServiceReferenceType &reference) const
	Returns the service object for the specified `ServiceReference` if the specified referenced service is being tracked by this `ServiceTracker`. More...

virtual T	GetService () const
	Returns a service object for one of the services being tracked by this `ServiceTracker`. More...

virtual std::vector< T >	GetServices () const
	Return a list of service objects for all services being tracked by this `ServiceTracker`. More...

virtual void	Remove (const ServiceReferenceType &reference)
	Remove a service from this `ServiceTracker`. More...

virtual int	Size () const
	Return the number of services being tracked by this `ServiceTracker`. More...

virtual int	GetTrackingCount () const
	Returns the tracking count for this `ServiceTracker`. More...

virtual void	GetTracked (TrackingMap &tracked) const
	Return a sorted map of the `ServiceReference`s and service objects for all services being tracked by this `ServiceTracker`. The map is sorted in natural order of `ServiceReference`. That is, the last entry is the service with the highest ranking and the lowest service id. More...

virtual bool	IsEmpty () const
	Return if this `ServiceTracker` is empty. More...

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
	Micro service interface name. More...

static const std::string	US_PROPKEY_ID
	Service property key for the annotation renderer ID. More...

static const std::string	US_PROPKEY_RENDERER_ID
	Service property key for the renderer ID. More...

Additional Inherited Members
Protected Types inherited from us::ServiceTrackerCustomizer< S, T >
typedef S	ServiceType
	The service type being tracked. More...

typedef T	TrackedType
	The tracked object type. More...

typedef ServiceReference< ServiceType >	ServiceReferenceType
	The service reference type for the tracked service. More...

Protected Member Functions inherited from mitk::AbstractAnnotationRenderer
BaseRenderer *	GetCurrentBaseRenderer ()
	Get the BaseRenderer associated with this annotation renderer. More...

Protected Member Functions inherited from us::ServiceTracker< Annotation >
T	AddingService (const ServiceReferenceType &reference) override
	Default implementation of the `ServiceTrackerCustomizer::AddingService` method. More...

void	ModifiedService (const ServiceReferenceType &reference, T service) override
	Default implementation of the `ServiceTrackerCustomizer::ModifiedService` method. More...

void	RemovedService (const ServiceReferenceType &reference, T service) override
	Default implementation of the `ServiceTrackerCustomizer::RemovedService` method. More...

Protected Member Functions inherited from us::ServiceTrackerCustomizer< S, T >
virtual	~ServiceTrackerCustomizer ()
	Destructor. More...

virtual void	ModifiedService (const ServiceReferenceType &reference, TrackedType service)=0
	A service tracked by the `ServiceTracker` has been modified. More...

virtual void	RemovedService (const ServiceReferenceType &reference, TrackedType service)=0
	A service tracked by the `ServiceTracker` has been removed. More...

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

Called when the render window is modified. Override to react to changes.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AnnotationLayouterContainerMap

◆ AnnotationRankedMap

Member Enumeration Documentation

◆ Alignment

Constructor & Destructor Documentation

◆ ~LayoutAnnotationRenderer()

Member Function Documentation

◆ AddAnnotation() [1/2]

◆ AddAnnotation() [2/2]

◆ GetAnnotationRenderer()

◆ GetID()

◆ OnRenderWindowModified()

◆ PrepareLayout()

Member Data Documentation

◆ PROP_LAYOUT

◆ PROP_LAYOUT_ALIGNMENT

◆ PROP_LAYOUT_MARGIN

◆ PROP_LAYOUT_PRIORITY