Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
Medical Imaging Interaction Toolkit
mitk::VtkAnnotation Class Referenceabstract

The VtkAnnotation class is the base for all Annotation which are using the VTK framework to render the elements. More...

#include <mitkVtkAnnotation.h>

Inheritance diagram for mitk::VtkAnnotation:
Collaboration diagram for mitk::VtkAnnotation:

Public Member Functions

 mitkClassMacro (VtkAnnotation, Annotation)
 
void Update (BaseRenderer *renderer) override
 Applies all properties and should be called before the rendering procedure. More...
 
void AddToBaseRenderer (BaseRenderer *renderer) override
 Adds the Annotation to the specified renderer. Update Annotation should be called soon in order to apply all properties. More...
 
void AddToRenderer (BaseRenderer *renderer, vtkRenderer *vtkrenderer) override
 Adds the Annotation to the specified renderer. Update Annotation should be called soon in order to apply all properties. More...
 
void RemoveFromRenderer (BaseRenderer *renderer, vtkRenderer *vtkrenderer) override
 Removes the Annotation from the specified renderer. It is not visible anymore then. More...
 
void RemoveFromBaseRenderer (BaseRenderer *renderer) override
 Removes the Annotation from the specified renderer. It is not visible anymore then. More...
 
void Paint (BaseRenderer *renderer)
 Paints the Annotation. More...
 
- Public Member Functions inherited from mitk::Annotation
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::BasePropertyGetProperty (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 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
 
PropertyListGetPropertyList () 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
 

Protected Member Functions

virtual vtkProp * GetVtkProp (BaseRenderer *renderer) const =0
 This method is implemented by the specific VTKAnnotation in order to create the element as a vtkProp. More...
 
virtual void UpdateVtkAnnotation (BaseRenderer *renderer)=0
 
 VtkAnnotation ()
 explicit constructor which disallows implicit conversions More...
 
 ~VtkAnnotation () override
 virtual destructor in order to derive from this class More...
 
- Protected Member Functions inherited from mitk::Annotation
 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)
 

Additional Inherited Members

- Public Types inherited from mitk::Annotation
typedef Annotation Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Static Public Member Functions inherited from mitk::Annotation
static const char * GetStaticNameOfClass ()
 
- Static Public Attributes inherited from mitk::Annotation
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 Attributes inherited from mitk::Annotation
PropertyList::Pointer m_PropertyList
 BaseRenderer-independent PropertyList. More...
 
itk::TimeStamp m_DataReferenceChangedTime
 Timestamp of the last change of m_Data. More...
 

Detailed Description

The VtkAnnotation class is the base for all Annotation which are using the VTK framework to render the elements.

Definition at line 28 of file mitkVtkAnnotation.h.

Constructor & Destructor Documentation

◆ VtkAnnotation()

mitk::VtkAnnotation::VtkAnnotation ( )
explicitprotected

explicit constructor which disallows implicit conversions

◆ ~VtkAnnotation()

mitk::VtkAnnotation::~VtkAnnotation ( )
overrideprotected

virtual destructor in order to derive from this class

Member Function Documentation

◆ AddToBaseRenderer()

void mitk::VtkAnnotation::AddToBaseRenderer ( BaseRenderer renderer)
overridevirtual

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

Implements mitk::Annotation.

◆ AddToRenderer()

void mitk::VtkAnnotation::AddToRenderer ( BaseRenderer renderer,
vtkRenderer *  vtkrenderer 
)
overridevirtual

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

Implements mitk::Annotation.

◆ GetVtkProp()

virtual vtkProp* mitk::VtkAnnotation::GetVtkProp ( BaseRenderer renderer) const
protectedpure virtual

This method is implemented by the specific VTKAnnotation in order to create the element as a vtkProp.

Parameters
renderer
Returns
The element that was created by the subclasses as a vtkProp.

Implemented in mitk::ScaleLegendAnnotation, mitk::LabelAnnotation3D, mitk::LogoAnnotation, mitk::ColorBarAnnotation, mitk::TextAnnotation2D, mitk::TextAnnotation3D, and mitk::VtkAnnotation2D.

◆ mitkClassMacro()

mitk::VtkAnnotation::mitkClassMacro ( VtkAnnotation  ,
Annotation   
)

◆ Paint()

void mitk::VtkAnnotation::Paint ( BaseRenderer renderer)

Paints the Annotation.

This method forces a paint of the Annotation as it is configured at the moment.

Warning
Should only be used as alternative to the AnnotationManager mechanism in GL-Mappers.

◆ RemoveFromBaseRenderer()

void mitk::VtkAnnotation::RemoveFromBaseRenderer ( BaseRenderer renderer)
overridevirtual

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

Implements mitk::Annotation.

◆ RemoveFromRenderer()

void mitk::VtkAnnotation::RemoveFromRenderer ( BaseRenderer renderer,
vtkRenderer *  vtkrenderer 
)
overridevirtual

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

Implements mitk::Annotation.

◆ Update()

void mitk::VtkAnnotation::Update ( BaseRenderer renderer)
overridevirtual

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

Implements mitk::Annotation.

◆ UpdateVtkAnnotation()

virtual void mitk::VtkAnnotation::UpdateVtkAnnotation ( BaseRenderer renderer)
protectedpure virtual

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