Medical Imaging Interaction Toolkit
2016.11.0
Medical Imaging Interaction Toolkit
|
Can display a high amount of 3D labels to a PointSet. More...
#include <mitkLabelOverlay3D.h>
Classes | |
class | LocalStorage |
Internal class holding the vtkActor, etc. for each of the render windows. More... | |
Public Member Functions | |
mitkClassMacro (LabelOverlay3D, mitk::VtkOverlay3D) | |
Pointer | Clone () const |
void | SetLabelVector (const std::vector< std::string > &LabelVector) |
Set the vector of labels that are shown to each corresponding point3D. The size has to be equal to the provided LabelCoordinates. More... | |
void | SetPriorityVector (const std::vector< int > &PriorityVector) |
Optional: Provide a vector of priorities. The labels with higher priorities will be visible in lower LOD. More... | |
void | SetLabelCoordinates (itk::SmartPointer< PointSet > LabelCoordinates) |
Coordinates of the labels. More... | |
void | PointSetModified (const itk::Object *, const itk::EventObject &) |
Public Member Functions inherited from mitk::VtkOverlay3D | |
void | SetPosition3D (const Point3D &position3D, mitk::BaseRenderer *renderer=NULL) |
Point3D | GetPosition3D (mitk::BaseRenderer *renderer=NULL) const |
void | SetOffsetVector (const Point3D &OffsetVector, mitk::BaseRenderer *renderer=NULL) |
Point3D | GetOffsetVector (mitk::BaseRenderer *renderer=NULL) const |
virtual std::vector< std::string > | GetClassHierarchy () const override |
virtual const char * | GetClassName () const |
Public Member Functions inherited from mitk::VtkOverlay | |
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 Pointer | New () |
Static Public Member Functions inherited from mitk::VtkOverlay3D | |
static const char * | GetStaticNameOfClass () |
Static Public Member Functions inherited from mitk::VtkOverlay | |
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 override |
This method is implemented by the specific VTKOverlays in order to create the element as a vtkProp. More... | |
void | UpdateVtkOverlay (mitk::BaseRenderer *renderer) override |
LabelOverlay3D () | |
explicit constructor which disallows implicit conversions More... | |
virtual | ~LabelOverlay3D () |
virtual destructor in order to derive from this class More... | |
Protected Member Functions inherited from mitk::VtkOverlay3D | |
VtkOverlay3D () | |
explicit constructor which disallows implicit conversions More... | |
virtual | ~VtkOverlay3D () |
virtual destructor in order to derive from this class More... | |
Protected Member Functions inherited from mitk::VtkOverlay | |
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... | |
Protected Attributes | |
mitk::LocalStorageHandler< LocalStorage > | m_LSH |
The LocalStorageHandler holds all LocalStorages for the render windows. More... | |
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... | |
Additional Inherited Members | |
Public Types inherited from mitk::VtkOverlay3D | |
typedef VtkOverlay3D | Self |
typedef VtkOverlay | Superclass |
typedef itk::SmartPointer< Self > | Pointer |
typedef itk::SmartPointer< const Self > | ConstPointer |
Public Types inherited from mitk::VtkOverlay | |
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 |
Can display a high amount of 3D labels to a PointSet.
Definition at line 39 of file mitkLabelOverlay3D.h.
|
explicitprotected |
explicit constructor which disallows implicit conversions
Definition at line 30 of file mitkLabelOverlay3D.cpp.
|
protectedvirtual |
virtual destructor in order to derive from this class
Definition at line 34 of file mitkLabelOverlay3D.cpp.
Pointer mitk::LabelOverlay3D::Clone | ( | ) | const |
|
overrideprotectedvirtual |
This method is implemented by the specific VTKOverlays in order to create the element as a vtkProp.
renderer |
Implements mitk::VtkOverlay.
Definition at line 122 of file mitkLabelOverlay3D.cpp.
References mitk::LabelOverlay3D::LocalStorage::m_LabelsActor.
mitk::LabelOverlay3D::mitkClassMacro | ( | LabelOverlay3D | , |
mitk::VtkOverlay3D | |||
) |
|
static |
void mitk::LabelOverlay3D::PointSetModified | ( | const itk::Object * | , |
const itk::EventObject & | |||
) |
Definition at line 160 of file mitkLabelOverlay3D.cpp.
Referenced by SetLabelCoordinates().
void mitk::LabelOverlay3D::SetLabelCoordinates | ( | itk::SmartPointer< PointSet > | LabelCoordinates | ) |
Coordinates of the labels.
Definition at line 140 of file mitkLabelOverlay3D.cpp.
References mitk::New(), and PointSetModified().
void mitk::LabelOverlay3D::SetLabelVector | ( | const std::vector< std::string > & | LabelVector | ) |
Set the vector of labels that are shown to each corresponding point3D. The size has to be equal to the provided LabelCoordinates.
Definition at line 128 of file mitkLabelOverlay3D.cpp.
void mitk::LabelOverlay3D::SetPriorityVector | ( | const std::vector< int > & | PriorityVector | ) |
Optional: Provide a vector of priorities. The labels with higher priorities will be visible in lower LOD.
Definition at line 134 of file mitkLabelOverlay3D.cpp.
|
overrideprotectedvirtual |
Implements mitk::VtkOverlay3D.
Definition at line 74 of file mitkLabelOverlay3D.cpp.
References mitk::Overlay::BaseLocalStorage::IsGenerateDataRequired(), mitk::LabelOverlay3D::LocalStorage::m_LabelMapper, mitk::LabelOverlay3D::LocalStorage::m_Labels, mitk::LabelOverlay3D::LocalStorage::m_LabelsActor, mitk::LabelOverlay3D::LocalStorage::m_Points, mitk::LabelOverlay3D::LocalStorage::m_PointSetToLabelHierarchyFilter, mitk::LabelOverlay3D::LocalStorage::m_Sizes, MITK_WARN, mitk::New(), and mitk::Overlay::BaseLocalStorage::UpdateGenerateDataTime().
|
mutableprotected |
The LocalStorageHandler holds all LocalStorages for the render windows.
Definition at line 80 of file mitkLabelOverlay3D.h.