Medical Imaging Interaction Toolkit
2018.4.99-389bf124
Medical Imaging Interaction Toolkit
|
Displays configurable scales on the renderwindow. The scale is determined by the image spacing. More...
#include <mitkColorBarAnnotation.h>
Classes | |
class | LocalStorage |
Public Member Functions | |
mitkClassMacro (ColorBarAnnotation, mitk::VtkAnnotation) | |
Pointer | Clone () const |
void | SetDrawAnnotations (bool annotations) |
bool | GetDrawAnnotations () const |
void | SetOrientationToHorizontal () |
void | SetOrientationToVertical () |
void | SetOrientation (int orientation) |
int | GetOrientation () const |
void | SetMaxNumberOfColors (int numberOfColors) |
int | GetMaxNumberOfColors () const |
void | SetNumberOfLabels (int numberOfLabels) |
int | GetNumberOfLabels () const |
void | SetLookupTable (vtkSmartPointer< vtkLookupTable > table) |
vtkSmartPointer< vtkLookupTable > | GetLookupTable () const |
void | SetDrawTickLabels (bool ticks) |
bool | GetDrawTickLabels () const |
void | SetAnnotationTextScaling (bool scale) |
bool | GetAnnotationTextScaling () const |
![]() | |
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... | |
![]() | |
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 |
Static Public Member Functions | |
static Pointer | New () |
![]() | |
static const char * | GetStaticNameOfClass () |
Protected Member Functions | |
vtkProp * | GetVtkProp (BaseRenderer *renderer) const override |
This method is implemented by the specific VTKAnnotation in order to create the element as a vtkProp. More... | |
void | UpdateVtkAnnotation (BaseRenderer *renderer) override |
ColorBarAnnotation () | |
explicit constructor which disallows implicit conversions More... | |
~ColorBarAnnotation () override | |
virtual destructor in order to derive from this class More... | |
![]() | |
VtkAnnotation () | |
explicit constructor which disallows implicit conversions More... | |
~VtkAnnotation () override | |
virtual destructor in order to derive from this class More... | |
![]() | |
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 | |
mitk::LocalStorageHandler< LocalStorage > | m_LSH |
The LocalStorageHandler holds all LocalStorages for the render windows. More... | |
![]() | |
PropertyList::Pointer | m_PropertyList |
BaseRenderer-independent PropertyList. More... | |
itk::TimeStamp | m_DataReferenceChangedTime |
Timestamp of the last change of m_Data. More... | |
Additional Inherited Members | |
![]() | |
typedef Annotation | Self |
typedef itk::Object | Superclass |
typedef itk::SmartPointer< Self > | Pointer |
typedef itk::SmartPointer< const Self > | ConstPointer |
![]() | |
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 |
Displays configurable scales on the renderwindow. The scale is determined by the image spacing.
Definition at line 27 of file mitkColorBarAnnotation.h.
|
explicitprotected |
explicit constructor which disallows implicit conversions
Definition at line 18 of file mitkColorBarAnnotation.cpp.
References SetAnnotationTextScaling(), SetDrawAnnotations(), SetDrawTickLabels(), SetLookupTable(), SetMaxNumberOfColors(), SetNumberOfLabels(), and SetOrientationToVertical().
|
overrideprotected |
virtual destructor in order to derive from this class
Definition at line 34 of file mitkColorBarAnnotation.cpp.
References mitk::LocalStorageHandler< L >::GetRegisteredBaseRenderer(), m_LSH, and mitk::VtkAnnotation::RemoveFromBaseRenderer().
Pointer mitk::ColorBarAnnotation::Clone | ( | ) | const |
bool mitk::ColorBarAnnotation::GetAnnotationTextScaling | ( | ) | const |
Definition at line 181 of file mitkColorBarAnnotation.cpp.
References mitk::PropertyList::GetBoolProperty(), and mitk::Annotation::GetPropertyList().
Referenced by UpdateVtkAnnotation().
bool mitk::ColorBarAnnotation::GetDrawAnnotations | ( | ) | const |
Definition at line 94 of file mitkColorBarAnnotation.cpp.
References mitk::PropertyList::GetBoolProperty(), and mitk::Annotation::GetPropertyList().
Referenced by UpdateVtkAnnotation().
bool mitk::ColorBarAnnotation::GetDrawTickLabels | ( | ) | const |
Definition at line 135 of file mitkColorBarAnnotation.cpp.
References mitk::PropertyList::GetBoolProperty(), and mitk::Annotation::GetPropertyList().
Referenced by UpdateVtkAnnotation().
vtkSmartPointer< vtkLookupTable > mitk::ColorBarAnnotation::GetLookupTable | ( | ) | const |
Definition at line 110 of file mitkColorBarAnnotation.cpp.
References mitk::PropertyList::GetProperty(), mitk::Annotation::GetPropertyList(), and mitk::LookupTable::New().
Referenced by UpdateVtkAnnotation().
int mitk::ColorBarAnnotation::GetMaxNumberOfColors | ( | ) | const |
Definition at line 157 of file mitkColorBarAnnotation.cpp.
References mitk::PropertyList::GetIntProperty(), and mitk::Annotation::GetPropertyList().
Referenced by UpdateVtkAnnotation().
int mitk::ColorBarAnnotation::GetNumberOfLabels | ( | ) | const |
Definition at line 169 of file mitkColorBarAnnotation.cpp.
References mitk::PropertyList::GetIntProperty(), and mitk::Annotation::GetPropertyList().
Referenced by UpdateVtkAnnotation().
int mitk::ColorBarAnnotation::GetOrientation | ( | ) | const |
Definition at line 123 of file mitkColorBarAnnotation.cpp.
References mitk::PropertyList::GetIntProperty(), and mitk::Annotation::GetPropertyList().
Referenced by UpdateVtkAnnotation().
|
overrideprotectedvirtual |
This method is implemented by the specific VTKAnnotation in order to create the element as a vtkProp.
renderer |
Implements mitk::VtkAnnotation.
Definition at line 83 of file mitkColorBarAnnotation.cpp.
References mitk::LocalStorageHandler< L >::GetLocalStorage(), ls, m_LSH, and mitk::ColorBarAnnotation::LocalStorage::m_ScalarBarActor.
mitk::ColorBarAnnotation::mitkClassMacro | ( | ColorBarAnnotation | , |
mitk::VtkAnnotation | |||
) |
|
static |
void mitk::ColorBarAnnotation::SetAnnotationTextScaling | ( | bool | scale | ) |
Definition at line 176 of file mitkColorBarAnnotation.cpp.
References mitk::Annotation::SetBoolProperty().
Referenced by ColorBarAnnotation().
void mitk::ColorBarAnnotation::SetDrawAnnotations | ( | bool | annotations | ) |
Definition at line 89 of file mitkColorBarAnnotation.cpp.
References mitk::Annotation::SetBoolProperty().
Referenced by ColorBarAnnotation().
void mitk::ColorBarAnnotation::SetDrawTickLabels | ( | bool | ticks | ) |
Definition at line 130 of file mitkColorBarAnnotation.cpp.
References mitk::Annotation::SetBoolProperty().
Referenced by ColorBarAnnotation().
void mitk::ColorBarAnnotation::SetLookupTable | ( | vtkSmartPointer< vtkLookupTable > | table | ) |
Definition at line 101 of file mitkColorBarAnnotation.cpp.
References mitk::LookupTable::New(), mitk::LookupTableProperty::New(), and mitk::Annotation::SetProperty().
Referenced by ColorBarAnnotation().
void mitk::ColorBarAnnotation::SetMaxNumberOfColors | ( | int | numberOfColors | ) |
Definition at line 152 of file mitkColorBarAnnotation.cpp.
References mitk::Annotation::SetIntProperty().
Referenced by ColorBarAnnotation().
void mitk::ColorBarAnnotation::SetNumberOfLabels | ( | int | numberOfLabels | ) |
Definition at line 164 of file mitkColorBarAnnotation.cpp.
References mitk::Annotation::SetIntProperty().
Referenced by ColorBarAnnotation().
void mitk::ColorBarAnnotation::SetOrientation | ( | int | orientation | ) |
Definition at line 118 of file mitkColorBarAnnotation.cpp.
References mitk::Annotation::SetIntProperty().
Referenced by SetOrientationToHorizontal(), and SetOrientationToVertical().
void mitk::ColorBarAnnotation::SetOrientationToHorizontal | ( | ) |
Definition at line 142 of file mitkColorBarAnnotation.cpp.
References SetOrientation().
void mitk::ColorBarAnnotation::SetOrientationToVertical | ( | ) |
Definition at line 147 of file mitkColorBarAnnotation.cpp.
References SetOrientation().
Referenced by ColorBarAnnotation().
|
overrideprotectedvirtual |
Implements mitk::VtkAnnotation.
Definition at line 54 of file mitkColorBarAnnotation.cpp.
References GetAnnotationTextScaling(), GetDrawAnnotations(), GetDrawTickLabels(), mitk::LocalStorageHandler< L >::GetLocalStorage(), GetLookupTable(), GetMaxNumberOfColors(), GetNumberOfLabels(), GetOrientation(), mitk::Annotation::BaseLocalStorage::IsGenerateDataRequired(), ls, m_LSH, and mitk::ColorBarAnnotation::LocalStorage::m_ScalarBarActor.
|
mutableprotected |
The LocalStorageHandler holds all LocalStorages for the render windows.
Definition at line 74 of file mitkColorBarAnnotation.h.
Referenced by GetVtkProp(), UpdateVtkAnnotation(), and ~ColorBarAnnotation().