Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
Medical Imaging Interaction Toolkit
mitk::AnnotationUtils Class Reference

The AnnotationUtils class provides static functions for accsessing registered AnnotationRenderers and Annotations. More...

#include <mitkAnnotationUtils.h>

Public Types

typedef std::vector< std::unique_ptr< AbstractAnnotationRenderer > > AnnotationRendererServices
 

Public Member Functions

 AnnotationUtils ()
 
 ~AnnotationUtils ()
 

Static Public Member Functions

static AbstractAnnotationRendererGetAnnotationRenderer (const std::string &arTypeID, const std::string &rendererID)
 GetAnnotationRenderer returns a registered AnnotationRenderer of a specific type and for a BaseRenderer. More...
 
static void RegisterAnnotationRenderer (AbstractAnnotationRenderer *annotationRenderer)
 RegisterAnnotationRenderer registers an AnnotationRenderer as a microservice and saves a reference to it in a local static list. More...
 
static std::vector< AbstractAnnotationRenderer * > GetAnnotationRenderer (const std::string &rendererID)
 GetAnnotationRenderer returns a list of registered AnnotationRenderers for a specified BaseRenderer. More...
 
static void UpdateAnnotationRenderer (const std::string &rendererID)
 UpdateAnnotationRenderer is a convenience function which calls AbstractAnnotationRenderer::Update for each registered AnnotationRenderer of a specific BaseRenderer. More...
 
static void BaseRendererChanged (BaseRenderer *renderer)
 BaseRendererChanged has to be called in the case that the actual BaseRenderer object for a BaseRenderer ID has changed. E.g. if a RenderWindow was closed and reopened. More...
 
static mitk::AnnotationGetAnnotation (const std::string &AnnotationID)
 GetAnnotation returns a registered Annotation for a specified ID. More...
 

Detailed Description

The AnnotationUtils class provides static functions for accsessing registered AnnotationRenderers and Annotations.

Definition at line 33 of file mitkAnnotationUtils.h.

Member Typedef Documentation

◆ AnnotationRendererServices

Definition at line 36 of file mitkAnnotationUtils.h.

Constructor & Destructor Documentation

◆ AnnotationUtils()

mitk::AnnotationUtils::AnnotationUtils ( )

◆ ~AnnotationUtils()

mitk::AnnotationUtils::~AnnotationUtils ( )

Member Function Documentation

◆ BaseRendererChanged()

static void mitk::AnnotationUtils::BaseRendererChanged ( BaseRenderer renderer)
static

BaseRendererChanged has to be called in the case that the actual BaseRenderer object for a BaseRenderer ID has changed. E.g. if a RenderWindow was closed and reopened.

Parameters
rendererThe new BaseRenderer

◆ GetAnnotation()

static mitk::Annotation* mitk::AnnotationUtils::GetAnnotation ( const std::string &  AnnotationID)
static

GetAnnotation returns a registered Annotation for a specified ID.

Parameters
AnnotationID
Returns

◆ GetAnnotationRenderer() [1/2]

static AbstractAnnotationRenderer* mitk::AnnotationUtils::GetAnnotationRenderer ( const std::string &  arTypeID,
const std::string &  rendererID 
)
static

GetAnnotationRenderer returns a registered AnnotationRenderer of a specific type and for a BaseRenderer.

Parameters
arTypeIDname specifier of the AnnotationRenderer
rendererIDname specifier of the BaseRenderer
Returns

◆ GetAnnotationRenderer() [2/2]

static std::vector<AbstractAnnotationRenderer *> mitk::AnnotationUtils::GetAnnotationRenderer ( const std::string &  rendererID)
static

GetAnnotationRenderer returns a list of registered AnnotationRenderers for a specified BaseRenderer.

Parameters
rendererIDname specifier of the BaseRenderer
Returns

◆ RegisterAnnotationRenderer()

static void mitk::AnnotationUtils::RegisterAnnotationRenderer ( AbstractAnnotationRenderer annotationRenderer)
static

RegisterAnnotationRenderer registers an AnnotationRenderer as a microservice and saves a reference to it in a local static list.

Parameters
annotationRenderer

◆ UpdateAnnotationRenderer()

static void mitk::AnnotationUtils::UpdateAnnotationRenderer ( const std::string &  rendererID)
static

UpdateAnnotationRenderer is a convenience function which calls AbstractAnnotationRenderer::Update for each registered AnnotationRenderer of a specific BaseRenderer.

Parameters
rendererID

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