mitk::LabelHighlightGuard Class Reference

#include <mitkLabelHighlightGuard.h>

Collaboration diagram for mitk::LabelHighlightGuard:

Public Member Functions
void	SetSegmentationNode (DataNode *node)
DataNode::Pointer	GetSegmentationNode () const
void	SetHighlightedLabels (LabelSetImage::LabelValueVectorType labels)
void	SetHighlightInvisibleLabels (bool highlightInvisible)
	~LabelHighlightGuard ()

Static Public Member Functions
constexpr static const char *	PROPERTY_NAME_LABELS_HIGHLIGHTED ()
constexpr static const char *	PROPERTY_NAME_HIGHLIGHT_INVISIBLE ()

Static Protected Member Functions
static void	UpdateNode (DataNode *node, LabelSetImage::LabelValueVectorType labels, bool highlightInvisible)

Protected Attributes
LabelSetImage::LabelValueVectorType	m_Labels
bool	m_HighlightInvisible
WeakPointer< DataNode >	m_Node

Detailed Description

Helper class that allows to manage the node properties for label highlighting. Using the class ensures that the highlighting will always be removed if needed: (a) the destructor of the guard is called, or (b) the node changes (highlight of former node will be removed). The guard also manages the triggering the RenderWindowManager, if need, to refresh the render windows.

Definition at line 29 of file mitkLabelHighlightGuard.h.

Constructor & Destructor Documentation

~LabelHighlightGuard()

mitk::LabelHighlightGuard::~LabelHighlightGuard

(

)

Member Function Documentation

GetSegmentationNode()

DataNode::Pointer mitk::LabelHighlightGuard::GetSegmentationNode

(

)

const

PROPERTY_NAME_HIGHLIGHT_INVISIBLE()

constexpr static const char* mitk::LabelHighlightGuard::PROPERTY_NAME_HIGHLIGHT_INVISIBLE ( )

inlinestaticconstexpr

Definition at line 45 of file mitkLabelHighlightGuard.h.

PROPERTY_NAME_LABELS_HIGHLIGHTED()

constexpr static const char* mitk::LabelHighlightGuard::PROPERTY_NAME_LABELS_HIGHLIGHTED ( )

inlinestaticconstexpr

Definition at line 40 of file mitkLabelHighlightGuard.h.

SetHighlightedLabels()

void mitk::LabelHighlightGuard::SetHighlightedLabels

(

LabelSetImage::LabelValueVectorType

labels

)

SetHighlightInvisibleLabels()

void mitk::LabelHighlightGuard::SetHighlightInvisibleLabels

(

bool

highlightInvisible

)

SetSegmentationNode()

void mitk::LabelHighlightGuard::SetSegmentationNode

(

DataNode *

node

)

UpdateNode()

static void mitk::LabelHighlightGuard::UpdateNode ( DataNode *  node, LabelSetImage::LabelValueVectorType  labels, bool  highlightInvisible  )

staticprotected

Member Data Documentation

m_HighlightInvisible

bool mitk::LabelHighlightGuard::m_HighlightInvisible

protected

Definition at line 53 of file mitkLabelHighlightGuard.h.

m_Labels

LabelSetImage::LabelValueVectorType mitk::LabelHighlightGuard::m_Labels

protected

Definition at line 52 of file mitkLabelHighlightGuard.h.

m_Node

WeakPointer<DataNode> mitk::LabelHighlightGuard::m_Node

protected

Definition at line 54 of file mitkLabelHighlightGuard.h.

---

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

• mitkLabelHighlightGuard.h