Base class for all Annotation This class is to be implemented in order to create Annotation which are managed by a AbstractAnnotationRenderer. This class contains an internal Propertylist for configuring the appearance of the implemented Overlay. More...

#include <mitkAnnotation.h>

Inheritance diagram for mitk::Annotation:

[legend]

Collaboration diagram for mitk::Annotation:

[legend]

Classes
class	BaseLocalStorage
	Base class for mapper specific rendering ressources. More...

struct	Bounds
	Container for position and size on the display. More...

Public Types
typedef Annotation	Self

typedef itk::Object	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
void	SetProperty (const std::string &propertyKey, const BaseProperty::Pointer &property)
	Set the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if nullptr, use BaseRenderer-independent PropertyList). This is set-by-value. More...

void	ReplaceProperty (const std::string &propertyKey, const BaseProperty::Pointer &property)
	Replace the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if nullptr, use BaseRenderer-independent PropertyList). This is set-by-reference. More...

void	AddProperty (const std::string &propertyKey, const BaseProperty::Pointer &property, bool overwrite=false)
	Add the property (instance of BaseProperty) if it does not exist (or always if overwrite is true) with key propertyKey in the PropertyList of the renderer (if nullptr, use BaseRenderer-independent PropertyList). This is set-by-value. More...

void	ConcatenatePropertyList (PropertyList *pList, bool replace=false)
	Add values from another PropertyList. More...

mitk::BaseProperty *	GetProperty (const std::string &propertyKey) const
	Get the property (instance of BaseProperty) with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList. More...

template<typename T >
bool	GetProperty (itk::SmartPointer< T > &property, const std::string &propertyKey) const
	Get the property of type T with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList. More...

template<typename T >
bool	GetProperty (T *&property, const std::string &propertyKey) const
	Get the property of type T with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList. More...

template<typename T >
bool	GetPropertyValue (const std::string &propertyKey, T &value) const
	Convenience access method for GenericProperty<T> properties (T being the type of the second parameter) More...

bool	GetBoolProperty (const std::string &propertyKey, bool &boolValue) const
	Convenience access method for bool properties (instances of BoolProperty) More...

bool	GetIntProperty (const std::string &propertyKey, int &intValue) const
	Convenience access method for int properties (instances of IntProperty) More...

bool	GetFloatProperty (const std::string &propertyKey, float &floatValue) const
	Convenience access method for float properties (instances of FloatProperty) More...

bool	GetDoubleProperty (const std::string &propertyKey, double &doubleValue) const
	Convenience access method for double properties (instances of DoubleProperty) More...

bool	GetStringProperty (const std::string &propertyKey, std::string &string) const
	Convenience access method for string properties (instances of StringProperty) More...

void	SetIntProperty (const std::string &propertyKey, int intValue)
	Convenience method for setting int properties (instances of IntProperty) More...

void	SetBoolProperty (const std::string &propertyKey, bool boolValue)
	Convenience method for setting int properties (instances of IntProperty) More...

void	SetFloatProperty (const std::string &propertyKey, float floatValue)
	Convenience method for setting int properties (instances of IntProperty) More...

void	SetDoubleProperty (const std::string &propertyKey, double doubleValue)
	Convenience method for setting int properties (instances of IntProperty) More...

void	SetStringProperty (const std::string &propertyKey, const std::string &string)
	Convenience method for setting int properties (instances of IntProperty) More...

bool	IsOn (const std::string &propertyKey, bool defaultIsOn=true) const
	Convenience access method for boolean properties (instances of BoolProperty). Return value is the value of the property. If the property is not found, the value of defaultIsOn is returned. More...

bool	GetName (std::string &nodeName, const std::string &propertyKey="name") const
	Convenience access method for accessing the name of an object (instance of StringProperty with property-key "name") More...

virtual std::string	GetName () const
	Extra convenience access method for accessing the name of an object (instance of StringProperty with property-key "name"). More...

virtual void	SetName (const std::string &name)
	Extra convenience access method to set the name of an object. More...

bool	GetColor (float rgb[], const std::string &propertyKey="color") const
	Convenience access method for color properties (instances of ColorProperty) More...

void	SetColor (const mitk::Color &color, const std::string &propertyKey="color")
	Convenience method for setting color properties (instances of ColorProperty) More...

void	SetColor (float red, float green, float blue, const std::string &propertyKey="color")
	Convenience method for setting color properties (instances of ColorProperty) More...

void	SetColor (const float rgb[], const std::string &propertyKey="color")
	Convenience method for setting color properties (instances of ColorProperty) More...

bool	GetOpacity (float &opacity, const std::string &propertyKey="opacity") const
	Convenience access method for opacity properties (instances of FloatProperty) More...

void	SetOpacity (float opacity, const std::string &propertyKey="opacity")
	Convenience method for setting opacity properties (instances of FloatProperty) More...

void	SetText (std::string text)

std::string	GetText () const

void	SetFontSize (int fontSize)

int	GetFontSize () const

bool	GetVisibility (bool &visible, const std::string &propertyKey="visible") const
	Convenience access method for visibility properties (instances of BoolProperty with property-key "visible") More...

bool	IsVisible (const std::string &propertyKey="visible", bool defaultIsOn=true) const
	Convenience access method for visibility properties (instances of BoolProperty). Return value is the visibility. Default is visible==true, i.e., true is returned even if the property (propertyKey) is not found. More...

void	SetVisibility (bool visible, const std::string &propertyKey="visible")
	Convenience method for setting visibility properties (instances of BoolProperty) More...

virtual void	AddToBaseRenderer (BaseRenderer *renderer)=0
	Adds the Annotation to the specified renderer. Update Annotation should be called soon in order to apply all properties. More...

virtual void	AddToRenderer (BaseRenderer renderer, vtkRenderer vtkrenderer)=0
	Adds the Annotation to the specified renderer. Update Annotation should be called soon in order to apply all properties. More...

virtual void	RemoveFromBaseRenderer (BaseRenderer *renderer)=0
	Removes the Annotation from the specified renderer. It is not visible anymore then. More...

virtual void	RemoveFromRenderer (BaseRenderer renderer, vtkRenderer vtkrenderer)=0
	Removes the Annotation from the specified renderer. It is not visible anymore then. More...

virtual void	Update (BaseRenderer *renderer)=0
	Applies all properties and should be called before the rendering procedure. More...

virtual Bounds	GetBoundsOnDisplay (BaseRenderer *renderer) const
	Returns position and size of the Annotation on the display. More...

virtual void	SetBoundsOnDisplay (BaseRenderer *renderer, const Bounds &)
	Sets position and size of the Annotation on the display. More...

void	SetForceInForeground (bool forceForeground)

bool	IsForceInForeground () const

PropertyList *	GetPropertyList () const

std::string	GetMicroserviceID ()
	Returns the id that this device is registered with. The id will only be valid, if the Annotation has been registered using RegisterAsMicroservice(). More...

virtual void	RegisterAsMicroservice (us::ServiceProperties props)
	Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More...

virtual void	UnRegisterMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin. More...

void	AnnotationModified ()

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

virtual const char *	GetClassName () const

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

Static Public Attributes
static const std::string	US_INTERFACE_NAME
	These Constants are used in conjunction with Microservices. More...

static const std::string	US_PROPKEY_AnnotationNAME

static const std::string	US_PROPKEY_ID

static const std::string	US_PROPKEY_MODIFIED

static const std::string	US_PROPKEY_RENDERER_ID

static const std::string	US_PROPKEY_AR_ID

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

	~Annotation () override
	virtual destructor in order to derive from this class More...

void	SetUSProperty (const std::string &propertyKey, us::Any value)

Protected Attributes
PropertyList::Pointer	m_PropertyList
	BaseRenderer-independent PropertyList. More...

itk::TimeStamp	m_DataReferenceChangedTime
	Timestamp of the last change of m_Data. More...

Detailed Description

Base class for all Annotation This class is to be implemented in order to create Annotation which are managed by a AbstractAnnotationRenderer. This class contains an internal Propertylist for configuring the appearance of the implemented Overlay.

Definition at line 27 of file mitkAnnotation.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 413 of file mitkAnnotation.h.

◆ Pointer

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

Definition at line 413 of file mitkAnnotation.h.

◆ Self

typedef Annotation mitk::Annotation::Self

Definition at line 413 of file mitkAnnotation.h.

◆ Superclass

typedef itk::Object mitk::Annotation::Superclass

Definition at line 413 of file mitkAnnotation.h.

Constructor & Destructor Documentation

◆ Annotation()

mitk::Annotation::Annotation ( )

protected

explicit constructor which disallows implicit conversions

Definition at line 23 of file mitkAnnotation.cpp.

References AnnotationModified(), m_PropertyList, mitk::PropertyList::New(), SetName(), SetOpacity(), and SetVisibility().

◆ ~Annotation()

mitk::Annotation::~Annotation ( )

overrideprotected

virtual destructor in order to derive from this class

Definition at line 40 of file mitkAnnotation.cpp.

References UnRegisterMicroservice().

Member Function Documentation

◆ AddProperty()

void mitk::Annotation::AddProperty	(	const std::string &	propertyKey,
		const BaseProperty::Pointer &	property,
		bool	overwrite = `false`
	)

Add the property (instance of BaseProperty) if it does not exist (or always if overwrite is true) with key propertyKey in the PropertyList of the renderer (if nullptr, use BaseRenderer-independent PropertyList). This is set-by-value.

For overwrite == false the property is not changed if it already exists. For overwrite == true the method is identical to SetProperty.

See also: SetProperty; GetProperty; m_PropertyList; m_MapOfPropertyLists

Definition at line 71 of file mitkAnnotation.cpp.

References GetProperty(), and SetProperty().

◆ AddToBaseRenderer()

virtual void mitk::Annotation::AddToBaseRenderer ( BaseRenderer * renderer )

pure virtual

Adds the Annotation to the specified renderer. Update Annotation should be called soon in order to apply all properties.

Implemented in mitk::VtkAnnotation.

Referenced by mitk::AbstractAnnotationRenderer::GetID().

◆ AddToRenderer()

virtual void mitk::Annotation::AddToRenderer	(	BaseRenderer *	renderer,
		vtkRenderer *	vtkrenderer
	)

pure virtual

Adds the Annotation to the specified renderer. Update Annotation should be called soon in order to apply all properties.

Implemented in mitk::VtkAnnotation.

◆ AnnotationModified()

void mitk::Annotation::AnnotationModified ( )

Definition at line 344 of file mitkAnnotation.cpp.

References SetUSProperty(), and US_PROPKEY_MODIFIED.

Referenced by Annotation().

◆ ConcatenatePropertyList()

void mitk::Annotation::ConcatenatePropertyList	(	PropertyList *	pList,
		bool	replace = `false`
	)

Add values from another PropertyList.

Overwrites values in m_PropertyList only when possible (i.e. when types are compatible). If you want to allow for object type changes (replacing a "visible":BoolProperty with "visible":IntProperty, set the

Parameters

replace.
replace	true: if
pList	contains a property "visible" of type ColorProperty and our m_PropertyList also has a "visible" property of a different type (e.g. BoolProperty), change the type, i.e. replace the objects behind the pointer.

See also: SetProperty; ReplaceProperty; m_PropertyList

Definition at line 81 of file mitkAnnotation.cpp.

References m_PropertyList.

◆ GetBoolProperty()

bool mitk::Annotation::GetBoolProperty	(	const std::string &	propertyKey,
		bool &	boolValue
	)		const

Convenience access method for bool properties (instances of BoolProperty)

Returns: true property was found

Definition at line 96 of file mitkAnnotation.cpp.

References GetProperty().

Referenced by GetVisibility(), and mitk::TextAnnotation2D::UpdateVtkAnnotation2D().

◆ GetBoundsOnDisplay()

mitk::Annotation::Bounds mitk::Annotation::GetBoundsOnDisplay ( mitk::BaseRenderer * renderer ) const

virtual

Returns position and size of the Annotation on the display.

Reimplemented in mitk::TextAnnotation2D, and mitk::VtkAnnotation2D.

Definition at line 295 of file mitkAnnotation.cpp.

References mitk::Annotation::Bounds::Position, and mitk::Annotation::Bounds::Size.

Referenced by mitk::LayoutAnnotationRenderer::PrepareLayout().

◆ GetClassHierarchy()

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

inlinevirtual

Definition at line 413 of file mitkAnnotation.h.

◆ GetClassName()

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

virtual

◆ GetColor()

bool mitk::Annotation::GetColor	(	float	rgb[],
		const std::string &	propertyKey = `"color"`
	)		const

Convenience access method for color properties (instances of ColorProperty)

Returns: true property was found

Definition at line 222 of file mitkAnnotation.cpp.

References GetProperty().

Referenced by mitk::VtkAnnotation2D::UpdateVtkAnnotation(), mitk::TextAnnotation3D::UpdateVtkAnnotation(), mitk::LabelAnnotation3D::UpdateVtkAnnotation(), and mitk::TextAnnotation2D::UpdateVtkAnnotation2D().

◆ GetDoubleProperty()

bool mitk::Annotation::GetDoubleProperty	(	const std::string &	propertyKey,
		double &	doubleValue
	)		const

Convenience access method for double properties (instances of DoubleProperty)

Returns: true property was found

◆ GetFloatProperty()

bool mitk::Annotation::GetFloatProperty	(	const std::string &	propertyKey,
		float &	floatValue
	)		const

Convenience access method for float properties (instances of FloatProperty)

Returns: true property was found

Definition at line 116 of file mitkAnnotation.cpp.

References GetProperty().

Referenced by mitk::LogoAnnotation::GetRelativeSize().

◆ GetFontSize()

int mitk::Annotation::GetFontSize ( ) const

Definition at line 205 of file mitkAnnotation.cpp.

References GetIntProperty().

Referenced by mitk::TextAnnotation3D::UpdateVtkAnnotation(), and mitk::TextAnnotation2D::UpdateVtkAnnotation2D().

◆ GetIntProperty()

bool mitk::Annotation::GetIntProperty	(	const std::string &	propertyKey,
		int &	intValue
	)		const

Convenience access method for int properties (instances of IntProperty)

Returns: true property was found

Definition at line 106 of file mitkAnnotation.cpp.

References GetProperty().

Referenced by mitk::LogoAnnotation::GetCornerPosition(), and GetFontSize().

◆ GetMicroserviceID()

std::string mitk::Annotation::GetMicroserviceID ( )

Returns the id that this device is registered with. The id will only be valid, if the Annotation has been registered using RegisterAsMicroservice().

Definition at line 321 of file mitkAnnotation.cpp.

References us::ServiceRegistration< I1, I2, I3 >::GetReference(), and US_PROPKEY_ID.

◆ GetName() [1/2]

bool mitk::Annotation::GetName	(	std::string &	nodeName,
		const std::string &	propertyKey = `"name"`
	)		const

Convenience access method for accessing the name of an object (instance of StringProperty with property-key "name")

Returns: true property was found

Definition at line 183 of file mitkAnnotation.cpp.

References GetStringProperty().

◆ GetName() [2/2]

std::string mitk::Annotation::GetName ( ) const

virtual

Extra convenience access method for accessing the name of an object (instance of StringProperty with property-key "name").

This method does not take the renderer specific propertylists into account, because the name of an object should never be renderer specific.

Returns: a std::string with the name of the object (content of "name" Property). If there is no "name" Property, an empty string will be returned.

Definition at line 170 of file mitkAnnotation.cpp.

References GetProperty(), and mitk::StringProperty::GetValue().

◆ GetOpacity()

bool mitk::Annotation::GetOpacity	(	float &	opacity,
		const std::string &	propertyKey = `"opacity"`
	)		const

Convenience access method for opacity properties (instances of FloatProperty)

Returns: true property was found

Definition at line 255 of file mitkAnnotation.cpp.

References GetProperty().

Referenced by mitk::VtkAnnotation2D::UpdateVtkAnnotation(), mitk::TextAnnotation3D::UpdateVtkAnnotation(), mitk::LogoAnnotation::UpdateVtkAnnotation(), mitk::LabelAnnotation3D::UpdateVtkAnnotation(), and mitk::TextAnnotation2D::UpdateVtkAnnotation2D().

◆ GetProperty() [1/3]

mitk::BaseProperty * mitk::Annotation::GetProperty ( const std::string & propertyKey ) const

Get the property (instance of BaseProperty) with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList.

If renderer is nullptr or the propertyKey cannot be found in the PropertyList specific to renderer or is disabled there, the BaseRenderer-independent PropertyList of this Annotation is queried.

See also: GetPropertyList; m_PropertyList; m_MapOfPropertyLists

Definition at line 86 of file mitkAnnotation.cpp.

References m_PropertyList.

Referenced by AddProperty(), GetBoolProperty(), GetColor(), GetFloatProperty(), GetIntProperty(), GetName(), GetOpacity(), and GetStringProperty().

◆ GetProperty() [2/3]

template<typename T >

bool mitk::Annotation::GetProperty	(	itk::SmartPointer< T > &	property,
		const std::string &	propertyKey
	)		const

inline

Get the property of type T with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList.

If renderer is nullptr or the propertyKey cannot be found in the PropertyList specific to renderer or is disabled there, the BaseRenderer-independent PropertyList of this Annotation is queried.

See also: GetPropertyList; m_PropertyList; m_MapOfPropertyLists

Definition at line 136 of file mitkAnnotation.h.

◆ GetProperty() [3/3]

template<typename T >

bool mitk::Annotation::GetProperty	(	T *&	property,
		const std::string &	propertyKey
	)		const

inline

Get the property of type T with key propertyKey from the PropertyList of the renderer, if available there, otherwise use the BaseRenderer-independent PropertyList.

If renderer is nullptr or the propertyKey cannot be found in the PropertyList specific to renderer or is disabled there, the BaseRenderer-independent PropertyList of this Annotation is queried.

See also: GetPropertyList; m_PropertyList; m_MapOfPropertyLists

Definition at line 154 of file mitkAnnotation.h.

◆ GetPropertyList()

mitk::PropertyList * mitk::Annotation::GetPropertyList ( ) const

Definition at line 316 of file mitkAnnotation.cpp.

References m_PropertyList.

◆ GetPropertyValue()

template<typename T >

bool mitk::Annotation::GetPropertyValue	(	const std::string &	propertyKey,
		T &	value
	)		const

inline

Convenience access method for GenericProperty<T> properties (T being the type of the second parameter)

Returns: true property was found

Definition at line 166 of file mitkAnnotation.h.

References mitk::GenericProperty< T >::GetValue(), and Json::intValue.

◆ GetStaticNameOfClass()

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

inlinestatic

Definition at line 413 of file mitkAnnotation.h.

◆ GetStringProperty()

bool mitk::Annotation::GetStringProperty	(	const std::string &	propertyKey,
		std::string &	string
	)		const

Convenience access method for string properties (instances of StringProperty)

Returns: true property was found

Definition at line 126 of file mitkAnnotation.cpp.

References GetProperty().

Referenced by GetName(), GetText(), and mitk::TextAnnotation2D::UpdateVtkAnnotation2D().

◆ GetText()

std::string mitk::Annotation::GetText ( ) const

Definition at line 193 of file mitkAnnotation.cpp.

References GetStringProperty().

Referenced by mitk::TextAnnotation3D::UpdateVtkAnnotation(), and mitk::TextAnnotation2D::UpdateVtkAnnotation2D().

◆ GetVisibility()

bool mitk::Annotation::GetVisibility	(	bool &	visible,
		const std::string &	propertyKey = `"visible"`
	)		const

Convenience access method for visibility properties (instances of BoolProperty with property-key "visible")

Returns: true property was found

See also: IsVisible

Definition at line 212 of file mitkAnnotation.cpp.

References GetBoolProperty().

◆ IsForceInForeground()

bool mitk::Annotation::IsForceInForeground ( ) const

Definition at line 311 of file mitkAnnotation.cpp.

◆ IsOn()

bool mitk::Annotation::IsOn	(	const std::string &	propertyKey,
		bool	defaultIsOn = `true`
	)		const

inline

Convenience access method for boolean properties (instances of BoolProperty). Return value is the value of the property. If the property is not found, the value of defaultIsOn is returned.

Thus, the return value has a different meaning than in the GetBoolProperty method!

See also: GetBoolProperty

Definition at line 251 of file mitkAnnotation.h.

References GetName(), and Update().

Referenced by IsVisible().

◆ IsVisible()

bool mitk::Annotation::IsVisible	(	const std::string &	propertyKey = `"visible"`,
		bool	defaultIsOn = `true`
	)		const

Convenience access method for visibility properties (instances of BoolProperty). Return value is the visibility. Default is visible==true, i.e., true is returned even if the property (propertyKey) is not found.

Thus, the return value has a different meaning than in the GetVisibility method!

See also: GetVisibility; IsOn

Definition at line 217 of file mitkAnnotation.cpp.

References IsOn().

Referenced by mitk::VtkAnnotation::Update().

◆ RegisterAsMicroservice()

void mitk::Annotation::RegisterAsMicroservice ( us::ServiceProperties props )

virtual

Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice().

Definition at line 326 of file mitkAnnotation.cpp.

References us::GetModuleContext(), mitk::UIDGenerator::GetUID(), us::ServiceRegistrationBase::Unregister(), and US_PROPKEY_ID.

Referenced by mitk::ManualPlacementAnnotationRenderer::AddAnnotation(), and mitk::LayoutAnnotationRenderer::AddAnnotation().

◆ RemoveFromBaseRenderer()

virtual void mitk::Annotation::RemoveFromBaseRenderer ( BaseRenderer * renderer )

pure virtual

Removes the Annotation from the specified renderer. It is not visible anymore then.

Implemented in mitk::VtkAnnotation.

◆ RemoveFromRenderer()

virtual void mitk::Annotation::RemoveFromRenderer	(	BaseRenderer *	renderer,
		vtkRenderer *	vtkrenderer
	)

pure virtual

Removes the Annotation from the specified renderer. It is not visible anymore then.

Implemented in mitk::VtkAnnotation.

◆ ReplaceProperty()

void mitk::Annotation::ReplaceProperty	(	const std::string &	propertyKey,
		const BaseProperty::Pointer &	property
	)

Replace the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if nullptr, use BaseRenderer-independent PropertyList). This is set-by-reference.

If renderer is nullptr the property is set in the BaseRenderer-independent PropertyList of this Annotation.

See also: GetProperty; m_PropertyList; m_MapOfPropertyLists

Definition at line 66 of file mitkAnnotation.cpp.

References m_PropertyList.

◆ SetBoolProperty()

void mitk::Annotation::SetBoolProperty	(	const std::string &	propertyKey,
		bool	boolValue
	)

Convenience method for setting int properties (instances of IntProperty)

Definition at line 146 of file mitkAnnotation.cpp.

References m_PropertyList, and mitk::BoolProperty::New().

Referenced by mitk::ColorBarAnnotation::SetAnnotationTextScaling(), mitk::ScaleLegendAnnotation::SetBottomAxisVisibility(), mitk::ColorBarAnnotation::SetDrawAnnotations(), mitk::ColorBarAnnotation::SetDrawTickLabels(), mitk::ScaleLegendAnnotation::SetLeftAxisVisibility(), mitk::ScaleLegendAnnotation::SetLegendVisibility(), mitk::ScaleLegendAnnotation::SetRightAxisVisibility(), mitk::ScaleLegendAnnotation::SetTopAxisVisibility(), and mitk::TextAnnotation2D::TextAnnotation2D().

◆ SetBoundsOnDisplay()

void mitk::Annotation::SetBoundsOnDisplay	(	mitk::BaseRenderer *	renderer,
		const Bounds &
	)

virtual

Sets position and size of the Annotation on the display.

Reimplemented in mitk::TextAnnotation2D, and mitk::VtkAnnotation2D.

Definition at line 302 of file mitkAnnotation.cpp.

Referenced by mitk::LayoutAnnotationRenderer::PrepareLayout().

◆ SetColor() [1/3]

void mitk::Annotation::SetColor	(	const mitk::Color &	color,
		const std::string &	propertyKey = `"color"`
	)

Convenience method for setting color properties (instances of ColorProperty)

Definition at line 232 of file mitkAnnotation.cpp.

References m_PropertyList, and mitk::ColorProperty::New().

Referenced by SetColor(), mitk::TextAnnotation2D::TextAnnotation2D(), and mitk::TextAnnotation3D::TextAnnotation3D().

◆ SetColor() [2/3]

void mitk::Annotation::SetColor	(	float	red,
		float	green,
		float	blue,
		const std::string &	propertyKey = `"color"`
	)

Convenience method for setting color properties (instances of ColorProperty)

Definition at line 239 of file mitkAnnotation.cpp.

References SetColor().

◆ SetColor() [3/3]

void mitk::Annotation::SetColor	(	const float	rgb[],
		const std::string &	propertyKey = `"color"`
	)

Convenience method for setting color properties (instances of ColorProperty)

Definition at line 248 of file mitkAnnotation.cpp.

References m_PropertyList, and mitk::ColorProperty::New().

◆ SetDoubleProperty()

void mitk::Annotation::SetDoubleProperty	(	const std::string &	propertyKey,
		double	doubleValue
	)

Convenience method for setting int properties (instances of IntProperty)

Definition at line 158 of file mitkAnnotation.cpp.

References m_PropertyList, and mitk::DoubleProperty::New().

Referenced by mitk::ScaleLegendAnnotation::SetCornerOffsetFactor(), and mitk::ScaleLegendAnnotation::SetFontFactor().

◆ SetFloatProperty()

void mitk::Annotation::SetFloatProperty	(	const std::string &	propertyKey,
		float	floatValue
	)

Convenience method for setting int properties (instances of IntProperty)

Definition at line 152 of file mitkAnnotation.cpp.

References m_PropertyList, and mitk::FloatProperty::New().

Referenced by mitk::LogoAnnotation::SetRelativeSize().

◆ SetFontSize()

void mitk::Annotation::SetFontSize ( int fontSize )

Definition at line 200 of file mitkAnnotation.cpp.

References SetIntProperty().

Referenced by mitk::TextAnnotation2D::TextAnnotation2D(), and mitk::TextAnnotation3D::TextAnnotation3D().

◆ SetForceInForeground()

void mitk::Annotation::SetForceInForeground ( bool forceForeground )

Definition at line 306 of file mitkAnnotation.cpp.

◆ SetIntProperty()

void mitk::Annotation::SetIntProperty	(	const std::string &	propertyKey,
		int	intValue
	)

Convenience method for setting int properties (instances of IntProperty)

Definition at line 141 of file mitkAnnotation.cpp.

References m_PropertyList, and mitk::IntProperty::New().

Referenced by mitk::ScaleLegendAnnotation::SetBottomBorderOffset(), mitk::LogoAnnotation::SetCornerPosition(), SetFontSize(), mitk::ScaleLegendAnnotation::SetLeftBorderOffset(), mitk::ColorBarAnnotation::SetMaxNumberOfColors(), mitk::ColorBarAnnotation::SetNumberOfLabels(), mitk::ColorBarAnnotation::SetOrientation(), mitk::ScaleLegendAnnotation::SetRightBorderOffset(), and mitk::ScaleLegendAnnotation::SetTopBorderOffset().

◆ SetName()

void mitk::Annotation::SetName ( const std::string & name )

virtual

Extra convenience access method to set the name of an object.

The name will be stored in the non-renderer-specific PropertyList in a StringProperty named "name".

Definition at line 178 of file mitkAnnotation.cpp.

References SetStringProperty().

Referenced by Annotation().

◆ SetOpacity()

void mitk::Annotation::SetOpacity	(	float	opacity,
		const std::string &	propertyKey = `"opacity"`
	)

Convenience method for setting opacity properties (instances of FloatProperty)

Definition at line 265 of file mitkAnnotation.cpp.

References m_PropertyList, and mitk::FloatProperty::New().

Referenced by Annotation().

◆ SetProperty()

void mitk::Annotation::SetProperty	(	const std::string &	propertyKey,
		const BaseProperty::Pointer &	property
	)

Set the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if nullptr, use BaseRenderer-independent PropertyList). This is set-by-value.

Warning: Change in semantics since Aug 25th 2006. Check your usage of this method if you do more with properties than just call SetProperty( "key", new SomeProperty("value") ).

See also: GetProperty; m_PropertyList; m_MapOfPropertyLists

Definition at line 61 of file mitkAnnotation.cpp.

References m_PropertyList.

Referenced by AddProperty(), mitk::ColorBarAnnotation::SetLookupTable(), mitk::VtkAnnotation3D::SetOffsetVector(), mitk::VtkAnnotation2D::SetOffsetVector(), mitk::LogoAnnotation::SetOffsetVector(), mitk::VtkAnnotation2D::SetPosition2D(), and mitk::VtkAnnotation3D::SetPosition3D().

◆ SetStringProperty()

void mitk::Annotation::SetStringProperty	(	const std::string &	propertyKey,
		const std::string &	string
	)

Convenience method for setting int properties (instances of IntProperty)

Definition at line 164 of file mitkAnnotation.cpp.

References m_PropertyList, and mitk::StringProperty::New().

Referenced by mitk::LogoAnnotation::SetLogoImagePath(), SetName(), SetText(), and mitk::TextAnnotation2D::TextAnnotation2D().

◆ SetText()

void mitk::Annotation::SetText ( std::string text )

Definition at line 188 of file mitkAnnotation.cpp.

References SetStringProperty().

Referenced by main(), mitk::TextAnnotation2D::TextAnnotation2D(), and mitk::TextAnnotation3D::TextAnnotation3D().

◆ SetUSProperty()

void mitk::Annotation::SetUSProperty	(	const std::string &	propertyKey,
		us::Any	value
	)

protected

Definition at line 45 of file mitkAnnotation.cpp.

References us::ServiceRegistration< I1, I2, I3 >::GetReference(), and us::ServiceRegistrationBase::SetProperties().

Referenced by AnnotationModified().

◆ SetVisibility()

void mitk::Annotation::SetVisibility	(	bool	visible,
		const std::string &	propertyKey = `"visible"`
	)

Convenience method for setting visibility properties (instances of BoolProperty)

Parameters

visible	If set to true, the data will be rendered. If false, the render will skip this data.
renderer	Specify a renderer if the visibility shall be specific to a renderer
propertykey	Can be used to specify a user defined name of the visibility propery.

Definition at line 272 of file mitkAnnotation.cpp.

References m_PropertyList, and mitk::BoolProperty::New().

Referenced by Annotation().

◆ UnRegisterMicroservice()

void mitk::Annotation::UnRegisterMicroservice ( )

virtual

Registers this object as a Microservice, making it available to every module and/or plugin.

Definition at line 337 of file mitkAnnotation.cpp.

References us::ServiceRegistrationBase::Unregister().

Referenced by ~Annotation().

◆ Update()

virtual void mitk::Annotation::Update ( BaseRenderer * renderer )

pure virtual

Applies all properties and should be called before the rendering procedure.

Implemented in mitk::VtkAnnotation.

Member Data Documentation

◆ m_DataReferenceChangedTime

itk::TimeStamp mitk::Annotation::m_DataReferenceChangedTime

protected

Timestamp of the last change of m_Data.

Definition at line 433 of file mitkAnnotation.h.

◆ m_PropertyList

PropertyList::Pointer mitk::Annotation::m_PropertyList

protected

BaseRenderer-independent PropertyList.

Properties herein can be overwritten specifically for each BaseRenderer by the BaseRenderer-specific properties defined in m_MapOfPropertyLists.

Definition at line 428 of file mitkAnnotation.h.

Referenced by Annotation(), ConcatenatePropertyList(), GetProperty(), GetPropertyList(), ReplaceProperty(), SetBoolProperty(), SetColor(), SetDoubleProperty(), SetFloatProperty(), SetIntProperty(), SetOpacity(), SetProperty(), SetStringProperty(), and SetVisibility().

◆ US_INTERFACE_NAME

const std::string mitk::Annotation::US_INTERFACE_NAME

static

These Constants are used in conjunction with Microservices.

Definition at line 393 of file mitkAnnotation.h.

◆ US_PROPKEY_AnnotationNAME

const std::string mitk::Annotation::US_PROPKEY_AnnotationNAME

static

Definition at line 394 of file mitkAnnotation.h.

◆ US_PROPKEY_AR_ID

const std::string mitk::Annotation::US_PROPKEY_AR_ID

static

Definition at line 398 of file mitkAnnotation.h.

Referenced by mitk::ManualPlacementAnnotationRenderer::AddAnnotation(), and mitk::LayoutAnnotationRenderer::AddAnnotation().

◆ US_PROPKEY_ID

const std::string mitk::Annotation::US_PROPKEY_ID

static

Definition at line 395 of file mitkAnnotation.h.

Referenced by mitk::AnnotationUtils::GetAnnotation(), GetMicroserviceID(), and RegisterAsMicroservice().

◆ US_PROPKEY_MODIFIED

const std::string mitk::Annotation::US_PROPKEY_MODIFIED

static

Definition at line 396 of file mitkAnnotation.h.

Referenced by AnnotationModified().

◆ US_PROPKEY_RENDERER_ID

const std::string mitk::Annotation::US_PROPKEY_RENDERER_ID

static

Definition at line 397 of file mitkAnnotation.h.

Referenced by mitk::ManualPlacementAnnotationRenderer::AddAnnotation(), and mitk::LayoutAnnotationRenderer::AddAnnotation().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ Annotation()

◆ ~Annotation()

Member Function Documentation

◆ AddProperty()

◆ AddToBaseRenderer()

◆ AddToRenderer()

◆ AnnotationModified()

◆ ConcatenatePropertyList()

◆ GetBoolProperty()

◆ GetBoundsOnDisplay()

◆ GetClassHierarchy()

◆ GetClassName()

◆ GetColor()

◆ GetDoubleProperty()

◆ GetFloatProperty()

◆ GetFontSize()

◆ GetIntProperty()

◆ GetMicroserviceID()

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ GetOpacity()

◆ GetProperty() [1/3]

◆ GetProperty() [2/3]

◆ GetProperty() [3/3]

◆ GetPropertyList()

◆ GetPropertyValue()

◆ GetStaticNameOfClass()

◆ GetStringProperty()

◆ GetText()

◆ GetVisibility()

◆ IsForceInForeground()

◆ IsOn()

◆ IsVisible()

◆ RegisterAsMicroservice()

◆ RemoveFromBaseRenderer()

◆ RemoveFromRenderer()

◆ ReplaceProperty()

◆ SetBoolProperty()

◆ SetBoundsOnDisplay()

◆ SetColor() [1/3]

◆ SetColor() [2/3]

◆ SetColor() [3/3]

◆ SetDoubleProperty()

◆ SetFloatProperty()

◆ SetFontSize()

◆ SetForceInForeground()

◆ SetIntProperty()

◆ SetName()

◆ SetOpacity()

◆ SetProperty()

◆ SetStringProperty()

◆ SetText()

◆ SetUSProperty()

◆ SetVisibility()

◆ UnRegisterMicroservice()

◆ Update()

Member Data Documentation

◆ m_DataReferenceChangedTime

◆ m_PropertyList

◆ US_INTERFACE_NAME

◆ US_PROPKEY_AnnotationNAME

◆ US_PROPKEY_AR_ID

◆ US_PROPKEY_ID

◆ US_PROPKEY_MODIFIED

◆ US_PROPKEY_RENDERER_ID