Medical Imaging Interaction Toolkit
2016.11.0
Medical Imaging Interaction Toolkit
|
The VtkOverlay class is the base for all Overlays which are using the VTK framework to render the elements. More...
#include <mitkVtkOverlay.h>
Public Types | |
typedef VtkOverlay | Self |
typedef Overlay | Superclass |
typedef itk::SmartPointer< Self > | Pointer |
typedef itk::SmartPointer< const Self > | ConstPointer |
Public Types inherited from mitk::Overlay | |
typedef std::map< const BaseRenderer *, PropertyList::Pointer > | MapOfPropertyLists |
typedef Overlay | Self |
typedef itk::Object | Superclass |
typedef itk::SmartPointer< Self > | Pointer |
typedef itk::SmartPointer< const Self > | ConstPointer |
Public Member Functions | |
virtual std::vector< std::string > | GetClassHierarchy () const override |
virtual const char * | GetClassName () const |
void | Update (BaseRenderer *renderer) override |
Applies all properties and should be called before the rendering procedure. More... | |
void | AddToBaseRenderer (BaseRenderer *renderer) override |
Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all properties. More... | |
void | AddToRenderer (BaseRenderer *renderer, vtkRenderer *vtkrenderer) override |
Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all properties. More... | |
void | RemoveFromRenderer (BaseRenderer *renderer, vtkRenderer *vtkrenderer) override |
Removes the overlay from the specified renderer. It is not visible anymore then. More... | |
void | RemoveFromBaseRenderer (BaseRenderer *renderer) override |
Removes the overlay from the specified renderer. It is not visible anymore then. More... | |
void | Paint (BaseRenderer *renderer) |
Paints the overlay. More... | |
Public Member Functions inherited from mitk::Overlay | |
void | SetProperty (const std::string &propertyKey, const BaseProperty::Pointer &property, const mitk::BaseRenderer *renderer=nullptr) |
Set the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-value. More... | |
void | ReplaceProperty (const std::string &propertyKey, const BaseProperty::Pointer &property, const mitk::BaseRenderer *renderer=nullptr) |
Replace the property (instance of BaseProperty) with key propertyKey in the PropertyList of the renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-reference. More... | |
void | AddProperty (const std::string &propertyKey, const BaseProperty::Pointer &property, const mitk::BaseRenderer *renderer=nullptr, 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 NULL, use BaseRenderer-independent PropertyList). This is set-by-value. More... | |
mitk::PropertyList * | GetPropertyList (const mitk::BaseRenderer *renderer=nullptr) const |
Get the PropertyList of the renderer. If renderer is NULL, the BaseRenderer-independent PropertyList of this Overlay is returned. More... | |
void | ConcatenatePropertyList (PropertyList *pList, bool replace=false) |
Add values from another PropertyList. More... | |
mitk::BaseProperty * | GetProperty (const std::string &propertyKey, const mitk::BaseRenderer *renderer=nullptr) 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 mitk::BaseRenderer *renderer=nullptr) 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 mitk::BaseRenderer *renderer=nullptr) 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, mitk::BaseRenderer *renderer=nullptr) 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, mitk::BaseRenderer *renderer=nullptr) const |
Convenience access method for bool properties (instances of BoolProperty) More... | |
bool | GetIntProperty (const std::string &propertyKey, int &intValue, mitk::BaseRenderer *renderer=nullptr) const |
Convenience access method for int properties (instances of IntProperty) More... | |
bool | GetFloatProperty (const std::string &propertyKey, float &floatValue, mitk::BaseRenderer *renderer=nullptr) const |
Convenience access method for float properties (instances of FloatProperty) More... | |
bool | GetStringProperty (const std::string &propertyKey, std::string &string, mitk::BaseRenderer *renderer=nullptr) const |
Convenience access method for string properties (instances of StringProperty) More... | |
void | SetIntProperty (const std::string &propertyKey, int intValue, mitk::BaseRenderer *renderer=nullptr) |
Convenience method for setting int properties (instances of IntProperty) More... | |
void | SetBoolProperty (const std::string &propertyKey, bool boolValue, mitk::BaseRenderer *renderer=nullptr) |
Convenience method for setting int properties (instances of IntProperty) More... | |
void | SetFloatProperty (const std::string &propertyKey, float floatValue, mitk::BaseRenderer *renderer=nullptr) |
Convenience method for setting int properties (instances of IntProperty) More... | |
void | SetStringProperty (const std::string &propertyKey, const std::string &string, mitk::BaseRenderer *renderer=nullptr) |
Convenience method for setting int properties (instances of IntProperty) More... | |
bool | IsOn (const std::string &propertyKey, mitk::BaseRenderer *renderer, 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, mitk::BaseRenderer *renderer=nullptr, 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[], mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="color") const |
Convenience access method for color properties (instances of ColorProperty) More... | |
void | SetColor (const mitk::Color &color, mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="color") |
Convenience method for setting color properties (instances of ColorProperty) More... | |
void | SetColor (float red, float green, float blue, mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="color") |
Convenience method for setting color properties (instances of ColorProperty) More... | |
void | SetColor (const float rgb[], mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="color") |
Convenience method for setting color properties (instances of ColorProperty) More... | |
bool | GetOpacity (float &opacity, mitk::BaseRenderer *renderer, const std::string &propertyKey="opacity") const |
Convenience access method for opacity properties (instances of FloatProperty) More... | |
void | SetOpacity (float opacity, mitk::BaseRenderer *renderer=nullptr, const std::string &propertyKey="opacity") |
Convenience method for setting opacity properties (instances of FloatProperty) More... | |
void | SetText (std::string text, mitk::BaseRenderer *renderer=nullptr) |
std::string | GetText (mitk::BaseRenderer *renderer=nullptr) const |
void | SetFontSize (int fontSize, mitk::BaseRenderer *renderer=nullptr) |
int | GetFontSize (mitk::BaseRenderer *renderer=nullptr) const |
bool | GetVisibility (bool &visible, mitk::BaseRenderer *renderer, const std::string &propertyKey="visible") const |
Convenience access method for visibility properties (instances of BoolProperty with property-key "visible") More... | |
bool | IsVisible (mitk::BaseRenderer *renderer, 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, mitk::BaseRenderer *renderer=nullptr, 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 overlay on the display. More... | |
virtual void | SetBoundsOnDisplay (BaseRenderer *renderer, const Bounds &) |
Sets position and size of the overlay on the display. More... | |
void | SetForceInForeground (bool forceForeground) |
bool | IsForceInForeground () const |
Static Public Member Functions | |
static const char * | GetStaticNameOfClass () |
Static Public Member Functions inherited from mitk::Overlay | |
static const char * | GetStaticNameOfClass () |
Protected Member Functions | |
virtual vtkProp * | GetVtkProp (BaseRenderer *renderer) const =0 |
This method is implemented by the specific VTKOverlays in order to create the element as a vtkProp. More... | |
virtual void | UpdateVtkOverlay (BaseRenderer *renderer)=0 |
VtkOverlay () | |
explicit constructor which disallows implicit conversions More... | |
virtual | ~VtkOverlay () |
virtual destructor in order to derive from this class More... | |
Protected Member Functions inherited from mitk::Overlay | |
Overlay () | |
explicit constructor which disallows implicit conversions More... | |
virtual | ~Overlay () |
virtual destructor in order to derive from this class More... | |
Additional Inherited Members | |
Protected Attributes inherited from mitk::Overlay | |
PropertyList::Pointer | m_PropertyList |
BaseRenderer-independent PropertyList. More... | |
MapOfPropertyLists | m_MapOfPropertyLists |
Map associating each BaseRenderer with its own PropertyList. More... | |
itk::TimeStamp | m_DataReferenceChangedTime |
Timestamp of the last change of m_Data. More... | |
The VtkOverlay class is the base for all Overlays which are using the VTK framework to render the elements.
Definition at line 32 of file mitkVtkOverlay.h.
typedef itk::SmartPointer<const Self> mitk::VtkOverlay::ConstPointer |
Definition at line 35 of file mitkVtkOverlay.h.
Definition at line 35 of file mitkVtkOverlay.h.
typedef VtkOverlay mitk::VtkOverlay::Self |
Definition at line 35 of file mitkVtkOverlay.h.
typedef Overlay mitk::VtkOverlay::Superclass |
Definition at line 35 of file mitkVtkOverlay.h.
|
explicitprotected |
explicit constructor which disallows implicit conversions
Definition at line 21 of file mitkVtkOverlay.cpp.
|
protectedvirtual |
virtual destructor in order to derive from this class
Definition at line 25 of file mitkVtkOverlay.cpp.
|
overridevirtual |
Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all properties.
Implements mitk::Overlay.
Definition at line 44 of file mitkVtkOverlay.cpp.
References mitk::BaseRenderer::GetVtkRenderer().
|
overridevirtual |
Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all properties.
Implements mitk::Overlay.
Definition at line 51 of file mitkVtkOverlay.cpp.
References mitk::RenderingManager::GetInstance(), mitk::RenderingManager::RequestUpdate(), and Update().
|
inlineoverridevirtual |
Reimplemented from mitk::Overlay.
Reimplemented in mitk::VtkOverlay3D, and mitk::VtkOverlay2D.
Definition at line 35 of file mitkVtkOverlay.h.
|
virtual |
Reimplemented from mitk::Overlay.
Reimplemented in mitk::VtkOverlay3D, and mitk::VtkOverlay2D.
|
inlinestatic |
Definition at line 35 of file mitkVtkOverlay.h.
|
protectedpure virtual |
This method is implemented by the specific VTKOverlays in order to create the element as a vtkProp.
renderer |
Implemented in mitk::LabelOverlay3D, mitk::LogoOverlay, mitk::ColorBarOverlay, mitk::ScaleLegendOverlay, mitk::TextOverlay2D, mitk::TextOverlay3D, mitk::AxisOverlay, and mitk::VtkOverlay2D.
void mitk::VtkOverlay::Paint | ( | BaseRenderer * | renderer | ) |
Paints the overlay.
This method forces a paint of the overlay as it is configured at the moment. Should only be used as alternative to the OverlayManager mechanism in GL-Mappers.
Definition at line 83 of file mitkVtkOverlay.cpp.
References mitk::BaseRenderer::GetVtkRenderer().
|
overridevirtual |
Removes the overlay from the specified renderer. It is not visible anymore then.
Implements mitk::Overlay.
Definition at line 64 of file mitkVtkOverlay.cpp.
References mitk::BaseRenderer::GetVtkRenderer().
|
overridevirtual |
Removes the overlay from the specified renderer. It is not visible anymore then.
Implements mitk::Overlay.
Definition at line 71 of file mitkVtkOverlay.cpp.
References mitk::RenderingManager::GetInstance(), and mitk::RenderingManager::RequestUpdate().
|
overridevirtual |
Applies all properties and should be called before the rendering procedure.
Implements mitk::Overlay.
Definition at line 29 of file mitkVtkOverlay.cpp.
|
protectedpure virtual |