mitk::VtkAnnotation3D Class Referenceabstract
The VtkAnnotation3D class is the basis for all VTK based Annotation which create any 3D element as a vtkProp that will be drawn on the renderer. More...
#include <mitkVtkAnnotation3D.h>
Inheritance diagram for mitk::VtkAnnotation3D:
Collaboration diagram for mitk::VtkAnnotation3D:
Public Member Functions | |
| void | SetPosition3D (const Point3D &position3D) |
| Point3D | GetPosition3D () const |
| void | SetOffsetVector (const Point3D &OffsetVector) |
| Point3D | GetOffsetVector () const |
| mitkClassMacro (VtkAnnotation3D, VtkAnnotation) | |
 Public Member Functions inherited from mitk::VtkAnnotation | |
| 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::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 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 |
Protected Member Functions | |
| void | UpdateVtkAnnotation (BaseRenderer *renderer) override=0 |
| VtkAnnotation3D () | |
| explicit constructor which disallows implicit conversions More... | |
| ~VtkAnnotation3D () override | |
| virtual destructor in order to derive from this class More... | |
| Protected Member Functions inherited from mitk::VtkAnnotation | |
| 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... | |
| 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< Self > | Pointer |
| typedef itk::SmartPointer< const Self > | ConstPointer |
| 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 VtkAnnotation3D class is the basis for all VTK based Annotation which create any 3D element as a vtkProp that will be drawn on the renderer.
Definition at line 26 of file mitkVtkAnnotation3D.h.
Constructor & Destructor Documentation
◆ VtkAnnotation3D()
|
explicitprotected |
explicit constructor which disallows implicit conversions
Definition at line 15 of file mitkVtkAnnotation3D.cpp.
References SetOffsetVector().
◆ ~VtkAnnotation3D()
|
overrideprotected |
virtual destructor in order to derive from this class
Definition at line 22 of file mitkVtkAnnotation3D.cpp.
Member Function Documentation
◆ GetOffsetVector()
| mitk::Point3D mitk::VtkAnnotation3D::GetOffsetVector | ( | ) | const |
Definition at line 46 of file mitkVtkAnnotation3D.cpp.
Referenced by mitk::TextAnnotation3D::UpdateVtkAnnotation(), and mitk::LabelAnnotation3D::UpdateVtkAnnotation().
◆ GetPosition3D()
| mitk::Point3D mitk::VtkAnnotation3D::GetPosition3D | ( | ) | const |
Definition at line 32 of file mitkVtkAnnotation3D.cpp.
Referenced by mitk::TextAnnotation3D::UpdateVtkAnnotation().
◆ mitkClassMacro()
| mitk::VtkAnnotation3D::mitkClassMacro | ( | VtkAnnotation3D | , |
| VtkAnnotation | |||
| ) |
◆ SetOffsetVector()
| void mitk::VtkAnnotation3D::SetOffsetVector | ( | const Point3D & | OffsetVector | ) |
Definition at line 40 of file mitkVtkAnnotation3D.cpp.
References mitk::Point3dProperty::New(), and mitk::Annotation::SetProperty().
Referenced by mitk::TextAnnotation3D::TextAnnotation3D(), and VtkAnnotation3D().
◆ SetPosition3D()
| void mitk::VtkAnnotation3D::SetPosition3D | ( | const Point3D & | position3D | ) |
Definition at line 26 of file mitkVtkAnnotation3D.cpp.
References mitk::Point3dProperty::New(), and mitk::Annotation::SetProperty().
Referenced by mitk::TextAnnotation3D::TextAnnotation3D().
◆ UpdateVtkAnnotation()
|
overrideprotectedpure virtual |
Implements mitk::VtkAnnotation.
Implemented in mitk::LabelAnnotation3D, and mitk::TextAnnotation3D.
The documentation for this class was generated from the following files:
