diff --git a/Modules/Core/include/mitkAbstractAnnotationRenderer.h b/Modules/Core/include/mitkAbstractAnnotationRenderer.h index d1aec9eee8..5b87e78229 100644 --- a/Modules/Core/include/mitkAbstractAnnotationRenderer.h +++ b/Modules/Core/include/mitkAbstractAnnotationRenderer.h @@ -1,85 +1,87 @@ /*=================================================================== * The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ #ifndef ABSTRACTANNOTATIONRENDERER_H #define ABSTRACTANNOTATIONRENDERER_H #include "mitkOverlay.h" #include "mitkServiceInterface.h" #include "usGetModuleContext.h" #include "usServiceTracker.h" #include #include namespace mitk { class BaseRenderer; /** @brief Baseclass of Overlay layouters */ /** *A AbstractAnnotationRenderer can be implemented to control a set of Overlays by means of position and size. *AbstractAnnotationRenderer::PrepareLayout() should be implemented with a routine to set the position of the internal *m_ManagedOverlays List. *A layouter is always connected to one BaseRenderer, so there is one instance of the layouter for each BaseRenderer. *One type of layouter should always have a unique identifier. *@ingroup Overlays */ class MITKCORE_EXPORT AbstractAnnotationRenderer : public us::ServiceTracker { public: typedef us::ServiceTracker Superclass; AbstractAnnotationRenderer(const std::string &rendererID, const std::string &arID); /** \brief virtual destructor in order to derive from this class */ virtual ~AbstractAnnotationRenderer(); const std::string GetID() const; const std::string GetRendererID() const; void CurrentBaseRendererChanged(); void RemoveAllOverlays(); void Update(); static const std::string US_INTERFACE_NAME; static const std::string US_PROPKEY_ID; static const std::string US_PROPKEY_RENDERER_ID; + protected: + BaseRenderer *GetCurrentBaseRenderer(); + private: /** \brief copy constructor */ AbstractAnnotationRenderer(const AbstractAnnotationRenderer &); /** \brief assignment operator */ AbstractAnnotationRenderer &operator=(const AbstractAnnotationRenderer &); TrackedType AddingService(const ServiceReferenceType &reference) override; void ModifiedService(const ServiceReferenceType & /*reference*/, TrackedType tracked) override; void RemovedService(const ServiceReferenceType & /*reference*/, TrackedType tracked) override; - BaseRenderer *GetCurrentBaseRenderer(); - + virtual void OnAnnotationRenderersChanged() {} const std::string m_RendererID; const std::string m_ID; }; } // namespace mitk MITK_DECLARE_SERVICE_INTERFACE(mitk::AbstractAnnotationRenderer, "org.mitk.services.AbstractAnnotationRenderer") #endif // ABSTRACTANNOTATIONRENDERER_H diff --git a/Modules/Core/include/mitkOverlay.h b/Modules/Core/include/mitkOverlay.h index 9cbc19d901..75cb1d2f15 100644 --- a/Modules/Core/include/mitkOverlay.h +++ b/Modules/Core/include/mitkOverlay.h @@ -1,457 +1,461 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ #ifndef OVERLAY_H #define OVERLAY_H #include "mitkServiceInterface.h" #include "usServiceRegistration.h" #include #include #include namespace mitk { class AbstractOverlayLayouter; /** \brief Base class for all overlays */ /** This class is to be implemented in order to create overlays which are managed by the OverlayManager and can be placed by a AbstractOverlayLayouter. This class contains an internal Propertylist, and another PropertyList for each BaseRenderer. A property that is specified for a specific renderer always overrides the general internal property of the same name. AddOverlay, RemoveOverlay and UpdateOverlay methods have to be implemented.*/ class MITKCORE_EXPORT Overlay : public itk::Object { friend class AbstractOverlayLayouter; public: /** \brief Container for position and size on the display.*/ struct Bounds { itk::Point Position; itk::Point Size; }; /** \brief Base class for mapper specific rendering ressources. */ class MITKCORE_EXPORT BaseLocalStorage { public: bool IsGenerateDataRequired(mitk::BaseRenderer *renderer, mitk::Overlay *overlay); inline void UpdateGenerateDataTime() { m_LastGenerateDataTime.Modified(); } inline itk::TimeStamp &GetLastGenerateDataTime() { return m_LastGenerateDataTime; } protected: /** \brief timestamp of last update of stored data */ itk::TimeStamp m_LastGenerateDataTime; }; /** * @brief Set the property (instance of BaseProperty) with key @a propertyKey in the PropertyList * of the @a renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-value. * * @warning Change in semantics since Aug 25th 2006. Check your usage of this method if you do * more with properties than just call SetProperty( "key", new SomeProperty("value") ). * * @sa GetProperty * @sa m_PropertyList * @sa m_MapOfPropertyLists */ void SetProperty(const std::string &propertyKey, const BaseProperty::Pointer &property); /** * @brief Replace the property (instance of BaseProperty) with key @a propertyKey in the PropertyList * of the @a renderer (if NULL, use BaseRenderer-independent PropertyList). This is set-by-reference. * * If @a renderer is @a NULL the property is set in the BaseRenderer-independent * PropertyList of this Overlay. * @sa GetProperty * @sa m_PropertyList * @sa m_MapOfPropertyLists */ void ReplaceProperty(const std::string &propertyKey, const BaseProperty::Pointer &property); /** * @brief Add the property (instance of BaseProperty) if it does * not exist (or always if \a overwrite is \a true) * with key @a propertyKey in the PropertyList * of the @a renderer (if NULL, use BaseRenderer-independent * PropertyList). This is set-by-value. * * For \a overwrite == \a false the property is \em not changed * if it already exists. For \a overwrite == \a true the method * is identical to SetProperty. * * @sa SetProperty * @sa GetProperty * @sa m_PropertyList * @sa m_MapOfPropertyLists */ void AddProperty(const std::string &propertyKey, const BaseProperty::Pointer &property, bool overwrite = false); /** * @brief Add values from another PropertyList. * * Overwrites values in m_PropertyList only when possible (i.e. when types are compatible). * If you want to allow for object type changes (replacing a "visible":BoolProperty with "visible":IntProperty, * set the @param replace. * * @param replace true: if @param pList contains a property "visible" of type ColorProperty and our m_PropertyList * also has a "visible" property of a different type (e.g. BoolProperty), change the type, i.e. replace the objects * behind the pointer. * * @sa SetProperty * @sa ReplaceProperty * @sa m_PropertyList */ void ConcatenatePropertyList(PropertyList *pList, bool replace = false); /** * @brief Get the property (instance of BaseProperty) with key @a propertyKey from the PropertyList * of the @a renderer, if available there, otherwise use the BaseRenderer-independent PropertyList. * * If @a renderer is @a NULL or the @a propertyKey cannot be found * in the PropertyList specific to @a renderer or is disabled there, the BaseRenderer-independent * PropertyList of this Overlay is queried. * @sa GetPropertyList * @sa m_PropertyList * @sa m_MapOfPropertyLists */ mitk::BaseProperty *GetProperty(const std::string &propertyKey) const; /** * @brief Get the property of type T with key @a propertyKey from the PropertyList * of the @a renderer, if available there, otherwise use the BaseRenderer-independent PropertyList. * * If @a renderer is @a NULL or the @a propertyKey cannot be found * in the PropertyList specific to @a renderer or is disabled there, the BaseRenderer-independent * PropertyList of this Overlay is queried. * @sa GetPropertyList * @sa m_PropertyList * @sa m_MapOfPropertyLists */ template bool GetProperty(itk::SmartPointer &property, const std::string &propertyKey) const { property = dynamic_cast(GetProperty(propertyKey)); return property.IsNotNull(); } /** * @brief Get the property of type T with key @a propertyKey from the PropertyList * of the @a renderer, if available there, otherwise use the BaseRenderer-independent PropertyList. * * If @a renderer is @a NULL or the @a propertyKey cannot be found * in the PropertyList specific to @a renderer or is disabled there, the BaseRenderer-independent * PropertyList of this Overlay is queried. * @sa GetPropertyList * @sa m_PropertyList * @sa m_MapOfPropertyLists */ template bool GetProperty(T *&property, const std::string &propertyKey) const { property = dynamic_cast(GetProperty(propertyKey)); return property != nullptr; } /** * @brief Convenience access method for GenericProperty properties * (T being the type of the second parameter) * @return @a true property was found */ template bool GetPropertyValue(const std::string &propertyKey, T &value) const { GenericProperty *gp = dynamic_cast *>(GetProperty(propertyKey)); if (gp != nullptr) { value = gp->GetValue(); return true; } return false; } /** * @brief Convenience access method for bool properties (instances of * BoolProperty) * @return @a true property was found */ bool GetBoolProperty(const std::string &propertyKey, bool &boolValue) const; /** * @brief Convenience access method for int properties (instances of * IntProperty) * @return @a true property was found */ bool GetIntProperty(const std::string &propertyKey, int &intValue) const; /** * @brief Convenience access method for float properties (instances of * FloatProperty) * @return @a true property was found */ bool GetFloatProperty(const std::string &propertyKey, float &floatValue) const; /** * @brief Convenience access method for string properties (instances of * StringProperty) * @return @a true property was found */ bool GetStringProperty(const std::string &propertyKey, std::string &string) const; /** * @brief Convenience method for setting int properties (instances of * IntProperty) */ void SetIntProperty(const std::string &propertyKey, int intValue); /** * @brief Convenience method for setting int properties (instances of * IntProperty) */ void SetBoolProperty(const std::string &propertyKey, bool boolValue); /** * @brief Convenience method for setting int properties (instances of * IntProperty) */ void SetFloatProperty(const std::string &propertyKey, float floatValue); /** * @brief Convenience method for setting int properties (instances of * IntProperty) */ void SetStringProperty(const std::string &propertyKey, const std::string &string); /** * @brief 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 @a defaultIsOn is returned. * * Thus, the return value has a different meaning than in the * GetBoolProperty method! * @sa GetBoolProperty */ bool IsOn(const std::string &propertyKey, bool defaultIsOn = true) const { GetBoolProperty(propertyKey, defaultIsOn); return defaultIsOn; } /** * @brief Convenience access method for accessing the name of an object (instance of * StringProperty with property-key "name") * @return @a true property was found */ bool GetName(std::string &nodeName, const std::string &propertyKey = "name") const; /** * @brief Extra convenience access method for accessing the name of an object (instance of * StringProperty with property-key "name"). * * This method does not take the renderer specific * propertylists into account, because the name of an object should never be renderer specific. * @returns a std::string with the name of the object (content of "name" Property). * If there is no "name" Property, an empty string will be returned. */ virtual std::string GetName() const; /** * @brief Extra convenience access method to set the name of an object. * * The name will be stored in the non-renderer-specific PropertyList in a StringProperty named "name". */ virtual void SetName(const std::string &name); /** * @brief Convenience access method for color properties (instances of * ColorProperty) * @return @a true property was found */ bool GetColor(float rgb[], const std::string &propertyKey = "color") const; /** * @brief Convenience method for setting color properties (instances of * ColorProperty) */ void SetColor(const mitk::Color &color, const std::string &propertyKey = "color"); /** * @brief Convenience method for setting color properties (instances of * ColorProperty) */ void SetColor(float red, float green, float blue, const std::string &propertyKey = "color"); /** * @brief Convenience method for setting color properties (instances of * ColorProperty) */ void SetColor(const float rgb[], const std::string &propertyKey = "color"); /** * @brief Convenience access method for opacity properties (instances of * FloatProperty) * @return @a true property was found */ bool GetOpacity(float &opacity, const std::string &propertyKey = "opacity") const; /** * @brief Convenience method for setting opacity properties (instances of * FloatProperty) */ void SetOpacity(float opacity, const std::string &propertyKey = "opacity"); void SetText(std::string text); std::string GetText() const; void SetFontSize(int fontSize); int GetFontSize() const; /** * @brief Convenience access method for visibility properties (instances * of BoolProperty with property-key "visible") * @return @a true property was found * @sa IsVisible */ bool GetVisibility(bool &visible, const std::string &propertyKey = "visible") const; /** * @brief 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 (@a * propertyKey) is not found. * * Thus, the return value has a different meaning than in the * GetVisibility method! * @sa GetVisibility * @sa IsOn */ bool IsVisible(const std::string &propertyKey = "visible", bool defaultIsOn = true) const; /** * @brief Convenience method for setting visibility properties (instances * of BoolProperty) * @param visible If set to true, the data will be rendered. If false, the render will skip this data. * @param renderer Specify a renderer if the visibility shall be specific to a renderer * @param propertykey Can be used to specify a user defined name of the visibility propery. */ void SetVisibility(bool visible, const std::string &propertyKey = "visible"); /** \brief Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all * properties*/ virtual void AddToBaseRenderer(BaseRenderer *renderer) = 0; /** \brief Adds the overlay to the specified renderer. Update Overlay should be called soon in order to apply all * properties*/ virtual void AddToRenderer(BaseRenderer *renderer, vtkRenderer *vtkrenderer) = 0; /** \brief Removes the overlay from the specified renderer. It is not visible anymore then.*/ virtual void RemoveFromBaseRenderer(BaseRenderer *renderer) = 0; /** \brief Removes the overlay from the specified renderer. It is not visible anymore then.*/ virtual void RemoveFromRenderer(BaseRenderer *renderer, vtkRenderer *vtkrenderer) = 0; /** \brief Applies all properties and should be called before the rendering procedure.*/ virtual void Update(BaseRenderer *renderer) = 0; /** \brief Returns position and size of the overlay on the display.*/ virtual Bounds GetBoundsOnDisplay(BaseRenderer *renderer) const; /** \brief Sets position and size of the overlay on the display.*/ virtual void SetBoundsOnDisplay(BaseRenderer *renderer, const Bounds &); void SetForceInForeground(bool forceForeground); bool IsForceInForeground() const; PropertyList *GetPropertyList() const; /** *\brief Returns the id that this device is registered with. The id will only be valid, if the * Overlay has been registered using RegisterAsMicroservice(). */ std::string GetMicroserviceID(); /** *\brief These Constants are used in conjunction with Microservices */ static const std::string US_INTERFACE_NAME; static const std::string US_PROPKEY_OVERLAYNAME; 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; /** *\brief Registers this object as a Microservice, making it available to every module and/or plugin. * To unregister, call UnregisterMicroservice(). */ virtual void RegisterAsMicroservice(us::ServiceProperties props); /** *\brief Registers this object as a Microservice, making it available to every module and/or plugin. */ virtual void UnRegisterMicroservice(); void OverlayModified(); mitkClassMacroItkParent(Overlay, itk::Object); + void SetMargin2D(const Point2D &OffsetVector); + + mitk::Point2D GetMargin2D() const; + protected: /** \brief explicit constructor which disallows implicit conversions */ Overlay(); /** \brief virtual destructor in order to derive from this class */ virtual ~Overlay(); /** * @brief BaseRenderer-independent PropertyList * * Properties herein can be overwritten specifically for each BaseRenderer * by the BaseRenderer-specific properties defined in m_MapOfPropertyLists. */ PropertyList::Pointer m_PropertyList; /** * @brief Timestamp of the last change of m_Data */ itk::TimeStamp m_DataReferenceChangedTime; void SetUSProperty(const std::string &propertyKey, us::Any value); private: /** \brief render this overlay on a foreground renderer */ bool m_ForceInForeground; /** \brief copy constructor */ Overlay(const Overlay &); /** \brief assignment operator */ Overlay &operator=(const Overlay &); /** \brief Reference to the layouter in which this overlay is managed. */ AbstractOverlayLayouter *m_LayoutedBy; private: us::ServiceRegistration m_ServiceRegistration; unsigned long m_PropertyListModifiedObserverTag; void PropertyListModified(const itk::Object *, const itk::EventObject &); }; } // namespace mitk MITK_DECLARE_SERVICE_INTERFACE(mitk::Overlay, "org.mitk.services.Overlay") #endif // OVERLAY_H diff --git a/Modules/Core/src/Rendering/mitkOverlay.cpp b/Modules/Core/src/Rendering/mitkOverlay.cpp index 671bcec7c6..4820a5bb09 100644 --- a/Modules/Core/src/Rendering/mitkOverlay.cpp +++ b/Modules/Core/src/Rendering/mitkOverlay.cpp @@ -1,344 +1,358 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ #include "mitkOverlay.h" #include "usGetModuleContext.h" const std::string mitk::Overlay::US_INTERFACE_NAME = "org.mitk.services.Overlay"; const std::string mitk::Overlay::US_PROPKEY_OVERLAYNAME = US_INTERFACE_NAME + ".name"; const std::string mitk::Overlay::US_PROPKEY_ID = US_INTERFACE_NAME + ".id"; const std::string mitk::Overlay::US_PROPKEY_MODIFIED = US_INTERFACE_NAME + ".modified"; const std::string mitk::Overlay::US_PROPKEY_RENDERER_ID = US_INTERFACE_NAME + ".rendererId"; const std::string mitk::Overlay::US_PROPKEY_AR_ID = US_INTERFACE_NAME + ".arId"; mitk::Overlay::Overlay() : m_LayoutedBy(nullptr), m_PropertyListModifiedObserverTag(0) { m_PropertyList = mitk::PropertyList::New(); itk::MemberCommand::Pointer _PropertyListModifiedCommand = itk::MemberCommand::New(); _PropertyListModifiedCommand->SetCallbackFunction(this, &mitk::Overlay::PropertyListModified); m_PropertyListModifiedObserverTag = m_PropertyList->AddObserver(itk::ModifiedEvent(), _PropertyListModifiedCommand); this->SetName(this->GetNameOfClass()); this->SetVisibility(true); this->SetOpacity(1.0); } void mitk::Overlay::PropertyListModified(const itk::Object * /*caller*/, const itk::EventObject &) { OverlayModified(); } mitk::Overlay::~Overlay() { this->UnRegisterMicroservice(); } void mitk::Overlay::SetUSProperty(const std::string &propertyKey, us::Any value) { if (this->m_ServiceRegistration) { us::ServiceProperties props; std::vector propertyKeys; m_ServiceRegistration.GetReference().GetPropertyKeys(propertyKeys); for (std::string key : propertyKeys) { props[key] = m_ServiceRegistration.GetReference().GetProperty(key); } props[propertyKey] = value; m_ServiceRegistration.SetProperties(props); } } void mitk::Overlay::SetProperty(const std::string &propertyKey, const BaseProperty::Pointer &propertyValue) { this->m_PropertyList->SetProperty(propertyKey, propertyValue); } void mitk::Overlay::ReplaceProperty(const std::string &propertyKey, const BaseProperty::Pointer &propertyValue) { this->m_PropertyList->ReplaceProperty(propertyKey, propertyValue); } void mitk::Overlay::AddProperty(const std::string &propertyKey, const BaseProperty::Pointer &propertyValue, bool overwrite) { if ((overwrite) || (GetProperty(propertyKey) == NULL)) { SetProperty(propertyKey, propertyValue); } } void mitk::Overlay::ConcatenatePropertyList(PropertyList *pList, bool replace) { m_PropertyList->ConcatenatePropertyList(pList, replace); } mitk::BaseProperty *mitk::Overlay::GetProperty(const std::string &propertyKey) const { mitk::BaseProperty::Pointer property = m_PropertyList->GetProperty(propertyKey); if (property.IsNotNull()) return property; // only to satisfy compiler! return NULL; } bool mitk::Overlay::GetBoolProperty(const std::string &propertyKey, bool &boolValue) const { mitk::BoolProperty::Pointer boolprop = dynamic_cast(GetProperty(propertyKey)); if (boolprop.IsNull()) return false; boolValue = boolprop->GetValue(); return true; } bool mitk::Overlay::GetIntProperty(const std::string &propertyKey, int &intValue) const { mitk::IntProperty::Pointer intprop = dynamic_cast(GetProperty(propertyKey)); if (intprop.IsNull()) return false; intValue = intprop->GetValue(); return true; } bool mitk::Overlay::GetFloatProperty(const std::string &propertyKey, float &floatValue) const { mitk::FloatProperty::Pointer floatprop = dynamic_cast(GetProperty(propertyKey)); if (floatprop.IsNull()) return false; floatValue = floatprop->GetValue(); return true; } bool mitk::Overlay::GetStringProperty(const std::string &propertyKey, std::string &string) const { mitk::StringProperty::Pointer stringProp = dynamic_cast(GetProperty(propertyKey)); if (stringProp.IsNull()) { return false; } else { // memcpy((void*)string, stringProp->GetValue(), strlen(stringProp->GetValue()) + 1 ); // looks dangerous string = stringProp->GetValue(); return true; } } void mitk::Overlay::SetIntProperty(const std::string &propertyKey, int intValue) { this->m_PropertyList->SetProperty(propertyKey, mitk::IntProperty::New(intValue)); Modified(); } void mitk::Overlay::SetBoolProperty(const std::string &propertyKey, bool boolValue) { this->m_PropertyList->SetProperty(propertyKey, mitk::BoolProperty::New(boolValue)); Modified(); } void mitk::Overlay::SetFloatProperty(const std::string &propertyKey, float floatValue) { this->m_PropertyList->SetProperty(propertyKey, mitk::FloatProperty::New(floatValue)); Modified(); } void mitk::Overlay::SetStringProperty(const std::string &propertyKey, const std::string &stringValue) { this->m_PropertyList->SetProperty(propertyKey, mitk::StringProperty::New(stringValue)); Modified(); } std::string mitk::Overlay::GetName() const { mitk::StringProperty *sp = dynamic_cast(this->GetProperty("name")); if (sp == NULL) return ""; return sp->GetValue(); } void mitk::Overlay::SetName(const std::string &name) { this->SetStringProperty("name", name); } bool mitk::Overlay::GetName(std::string &nodeName, const std::string &propertyKey) const { return GetStringProperty(propertyKey, nodeName); } void mitk::Overlay::SetText(std::string text) { SetStringProperty("Text", text.c_str()); } std::string mitk::Overlay::GetText() const { std::string text; GetStringProperty("Text", text); return text; } void mitk::Overlay::SetFontSize(int fontSize) { SetIntProperty("FontSize", fontSize); } int mitk::Overlay::GetFontSize() const { int fontSize = 1; GetIntProperty("FontSize", fontSize); return fontSize; } +void mitk::Overlay::SetMargin2D(const Point2D &OffsetVector) +{ + mitk::Point2dProperty::Pointer OffsetVectorProperty = mitk::Point2dProperty::New(OffsetVector); + SetProperty("Margin2D", OffsetVectorProperty.GetPointer()); +} + +mitk::Point2D mitk::Overlay::GetMargin2D() const +{ + mitk::Point2D OffsetVector; + OffsetVector.Fill(0); + GetPropertyValue("Margin2D", OffsetVector); + return OffsetVector; +} + bool mitk::Overlay::GetVisibility(bool &visible, const std::string &propertyKey) const { return GetBoolProperty(propertyKey, visible); } bool mitk::Overlay::IsVisible(const std::string &propertyKey, bool defaultIsOn) const { return IsOn(propertyKey, defaultIsOn); } bool mitk::Overlay::GetColor(float rgb[], const std::string &propertyKey) const { mitk::ColorProperty::Pointer colorprop = dynamic_cast(GetProperty(propertyKey)); if (colorprop.IsNull()) return false; memcpy(rgb, colorprop->GetColor().GetDataPointer(), 3 * sizeof(float)); return true; } void mitk::Overlay::SetColor(const mitk::Color &color, const std::string &propertyKey) { mitk::ColorProperty::Pointer prop; prop = mitk::ColorProperty::New(color); this->m_PropertyList->SetProperty(propertyKey, prop); } void mitk::Overlay::SetColor(float red, float green, float blue, const std::string &propertyKey) { float color[3]; color[0] = red; color[1] = green; color[2] = blue; SetColor(color, propertyKey); } void mitk::Overlay::SetColor(const float rgb[], const std::string &propertyKey) { mitk::ColorProperty::Pointer prop; prop = mitk::ColorProperty::New(rgb); this->m_PropertyList->SetProperty(propertyKey, prop); } bool mitk::Overlay::GetOpacity(float &opacity, const std::string &propertyKey) const { mitk::FloatProperty::Pointer opacityprop = dynamic_cast(GetProperty(propertyKey)); if (opacityprop.IsNull()) return false; opacity = opacityprop->GetValue(); return true; } void mitk::Overlay::SetOpacity(float opacity, const std::string &propertyKey) { mitk::FloatProperty::Pointer prop; prop = mitk::FloatProperty::New(opacity); this->m_PropertyList->SetProperty(propertyKey, prop); } void mitk::Overlay::SetVisibility(bool visible, const std::string &propertyKey) { mitk::BoolProperty::Pointer prop; prop = mitk::BoolProperty::New(visible); this->m_PropertyList->SetProperty(propertyKey, prop); Modified(); } bool mitk::Overlay::BaseLocalStorage::IsGenerateDataRequired(mitk::BaseRenderer *renderer, mitk::Overlay *overlay) { if (m_LastGenerateDataTime < overlay->GetMTime()) return true; if (m_LastGenerateDataTime < overlay->GetPropertyList()->GetMTime()) return true; if (renderer && m_LastGenerateDataTime < renderer->GetTimeStepUpdateTime()) return true; return false; } mitk::Overlay::Bounds mitk::Overlay::GetBoundsOnDisplay(mitk::BaseRenderer *) const { mitk::Overlay::Bounds bounds; bounds.Position[0] = bounds.Position[1] = bounds.Size[0] = bounds.Size[1] = 0; return bounds; } void mitk::Overlay::SetBoundsOnDisplay(mitk::BaseRenderer *, const mitk::Overlay::Bounds &) { } void mitk::Overlay::SetForceInForeground(bool forceForeground) { m_ForceInForeground = forceForeground; } bool mitk::Overlay::IsForceInForeground() const { return m_ForceInForeground; } mitk::PropertyList *mitk::Overlay::GetPropertyList() const { return m_PropertyList; } std::string mitk::Overlay::GetMicroserviceID() { return this->m_ServiceRegistration.GetReference().GetProperty(US_PROPKEY_ID).ToString(); } void mitk::Overlay::RegisterAsMicroservice(us::ServiceProperties props) { if (m_ServiceRegistration != NULL) m_ServiceRegistration.Unregister(); us::ModuleContext *context = us::GetModuleContext(); // Define ServiceProps mitk::UIDGenerator uidGen = mitk::UIDGenerator("org.mitk.services.Overlay.id_", 16); props[US_PROPKEY_ID] = uidGen.GetUID(); m_ServiceRegistration = context->RegisterService(this, props); } void mitk::Overlay::UnRegisterMicroservice() { if (m_ServiceRegistration != NULL) m_ServiceRegistration.Unregister(); m_ServiceRegistration = 0; } void mitk::Overlay::OverlayModified() { Modified(); this->SetUSProperty(US_PROPKEY_MODIFIED, this->GetMTime()); } diff --git a/Modules/Overlays/include/mitkOverlayLayouter2D.h b/Modules/Overlays/include/mitkOverlayLayouter2D.h index 8f873baea2..20828703ba 100644 --- a/Modules/Overlays/include/mitkOverlayLayouter2D.h +++ b/Modules/Overlays/include/mitkOverlayLayouter2D.h @@ -1,50 +1,91 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ #ifndef OVERLAYLAYOUTER2D_H #define OVERLAYLAYOUTER2D_H #include "MitkOverlaysExports.h" #include "mitkAbstractAnnotationRenderer.h" namespace mitk { class BaseRenderer; /** \brief The OverlayLayouter2D updates and manages Overlays and the respective Layouters. */ /** An Instance of the OverlayLayouter2D can be registered to several BaseRenderer instances in order to * call the update method of each Overlay during the rendering phase of the renderer. * See \ref OverlaysPage for more info. */ class MITKOVERLAYS_EXPORT OverlayLayouter2D : public AbstractAnnotationRenderer { public: + static const std::string PROP_LAYOUT; + static const std::string PROP_LAYOUT_PRIORITY; + static const std::string PROP_LAYOUT_ALIGNMENT; + enum Alignment + { + TopLeft, + Top, + TopRight, + BottomLeft, + Bottom, + BottomRight, + Left, + Right + }; + typedef std::vector OverlayVector; + typedef std::map OverlayLayouterContainerMap; + /** \brief virtual destructor in order to derive from this class */ virtual ~OverlayLayouter2D(); const std::string GetID() const; static OverlayLayouter2D *GetAnnotationRenderer(const std::string &rendererID); + static void AddOverlay(Overlay *overlay, + const std::string &rendererID, + Alignment alignment = TopLeft, + int priority = -1); + + static void AddOverlay(Overlay *overlay, BaseRenderer *renderer, Alignment alignment = TopLeft, int priority = -1); + + void PrepareLayout(); + private: OverlayLayouter2D(const std::string &rendererId); + static void AddAlignmentProperty(Overlay *overlay, Alignment activeAlignment, int priority); + + void PrepareTopLeftLayout(int *displaySize); + void PrepareTopLayout(int *displaySize); + void PrepareTopRightLayout(int *displaySize); + void PrepareBottomLeftLayout(int *displaySize); + void PrepareBottomLayout(int *displaySize); + void PrepareBottomRightLayout(int *displaySize); + void PrepareLeftLayout(int *displaySize); + void PrepareRightLayout(int *displaySize); + + static double GetHeight(OverlayVector &overlays, BaseRenderer *renderer); + + virtual void OnAnnotationRenderersChanged(); static const std::string ANNOTATIONRENDERER_ID; + OverlayLayouterContainerMap m_OverlayContainerMap; }; } // namespace mitk #endif // OVERLAYLAYOUTER2D_H diff --git a/Modules/Overlays/src/mitkAnnotationPlacer.cpp b/Modules/Overlays/src/mitkAnnotationPlacer.cpp index 037f3f39ea..836be0e75b 100644 --- a/Modules/Overlays/src/mitkAnnotationPlacer.cpp +++ b/Modules/Overlays/src/mitkAnnotationPlacer.cpp @@ -1,60 +1,61 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ #include "mitkAnnotationPlacer.h" #include "mitkBaseRenderer.h" #include "mitkAnnotationService.h" #include "mitkOverlay2DLayouter.h" #include namespace mitk { const std::string AnnotationPlacer::ANNOTATIONRENDERER_ID = "AnnotationPlacer"; AnnotationPlacer::AnnotationPlacer(const std::string &rendererId) : AbstractAnnotationRenderer(rendererId, AnnotationPlacer::ANNOTATIONRENDERER_ID) { } AnnotationPlacer::~AnnotationPlacer() {} AnnotationPlacer *AnnotationPlacer::GetAnnotationRenderer(const std::string &rendererID) { AnnotationPlacer *result = nullptr; AbstractAnnotationRenderer *registeredService = AnnotationService::GetAnnotationRenderer(ANNOTATIONRENDERER_ID, rendererID); if (registeredService) result = dynamic_cast(registeredService); if (!result) { result = new AnnotationPlacer(rendererID); AnnotationService::RegisterAnnotationRenderer(result); } return result; } void AnnotationPlacer::AddOverlay(Overlay *overlay, const std::string &rendererID) { GetAnnotationRenderer(rendererID); us::ServiceProperties props; props[Overlay::US_PROPKEY_AR_ID] = ANNOTATIONRENDERER_ID; props[Overlay::US_PROPKEY_RENDERER_ID] = rendererID; overlay->RegisterAsMicroservice(props); } + void AnnotationPlacer::AddOverlay(Overlay *overlay, BaseRenderer *renderer) { AddOverlay(overlay, renderer->GetName()); } } diff --git a/Modules/Overlays/src/mitkOverlayLayouter2D.cpp b/Modules/Overlays/src/mitkOverlayLayouter2D.cpp index 7ecd1c6931..19bd20be7c 100644 --- a/Modules/Overlays/src/mitkOverlayLayouter2D.cpp +++ b/Modules/Overlays/src/mitkOverlayLayouter2D.cpp @@ -1,49 +1,295 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ #include "mitkOverlayLayouter2D.h" #include "mitkBaseRenderer.h" #include "mitkAnnotationService.h" +#include "mitkEnumerationProperty.h" #include "mitkOverlay2DLayouter.h" #include namespace mitk { const std::string OverlayLayouter2D::ANNOTATIONRENDERER_ID = "OverlayLayouter2D"; + const std::string OverlayLayouter2D::PROP_LAYOUT = "Layout"; + const std::string OverlayLayouter2D::PROP_LAYOUT_PRIORITY = PROP_LAYOUT + ".priority"; + const std::string OverlayLayouter2D::PROP_LAYOUT_ALIGNMENT = PROP_LAYOUT + ".alignment"; + OverlayLayouter2D::OverlayLayouter2D(const std::string &rendererId) : AbstractAnnotationRenderer(rendererId, OverlayLayouter2D::ANNOTATIONRENDERER_ID) { } + void OverlayLayouter2D::AddAlignmentProperty(Overlay *overlay, Alignment activeAlignment, int priority) + { + EnumerationProperty::Pointer alignmentProperty(mitk::EnumerationProperty::New()); + alignmentProperty->AddEnum("TopLeft", TopLeft); + alignmentProperty->AddEnum("Top", Top); + alignmentProperty->AddEnum("TopRight", TopRight); + alignmentProperty->AddEnum("BottomLeft ", BottomLeft); + alignmentProperty->AddEnum("Bottom", Bottom); + alignmentProperty->AddEnum("BottomRight", BottomRight); + alignmentProperty->AddEnum("Left", Left); + alignmentProperty->AddEnum("Right", Right); + alignmentProperty->SetValue(activeAlignment); + overlay->AddProperty(PROP_LAYOUT_ALIGNMENT, alignmentProperty.GetPointer()); + overlay->SetIntProperty(PROP_LAYOUT_PRIORITY, priority); + } + + void OverlayLayouter2D::OnAnnotationRenderersChanged() + { + m_OverlayContainerMap.clear(); + for (Overlay *overlay : this->GetServices()) + { + BaseProperty *prop = overlay->GetProperty(PROP_LAYOUT_ALIGNMENT); + EnumerationProperty *enumProb = dynamic_cast(prop); + Alignment currentAlignment = TopLeft; + int priority = -1; + overlay->GetIntProperty(PROP_LAYOUT_PRIORITY, priority); + if (!enumProb) + { + AddAlignmentProperty(overlay, currentAlignment, priority); + } + else + { + currentAlignment = static_cast(enumProb->GetValueAsId()); + } + OverlayVector &overlayVec = m_OverlayContainerMap[currentAlignment]; + if (!overlayVec.empty() && priority >= 0) + { + for (auto it = overlayVec.begin(); it != overlayVec.end(); ++it) + { + int listPrio = -1; + (*it)->GetIntProperty(PROP_LAYOUT_PRIORITY, listPrio); + if (listPrio >= priority) + { + overlayVec.insert(it + 1, overlay); + } + } + } + overlayVec.push_back(overlay); + } + } + OverlayLayouter2D::~OverlayLayouter2D() {} const std::string OverlayLayouter2D::GetID() const { return ANNOTATIONRENDERER_ID; } OverlayLayouter2D *OverlayLayouter2D::GetAnnotationRenderer(const std::string &rendererID) { OverlayLayouter2D *result = nullptr; AbstractAnnotationRenderer *registeredService = AnnotationService::GetAnnotationRenderer(ANNOTATIONRENDERER_ID, rendererID); if (registeredService) result = dynamic_cast(registeredService); if (!result) { result = new OverlayLayouter2D(rendererID); AnnotationService::RegisterAnnotationRenderer(result); } return result; } + + void OverlayLayouter2D::AddOverlay(Overlay *overlay, const std::string &rendererID, Alignment alignment, int priority) + { + GetAnnotationRenderer(rendererID); + us::ServiceProperties props; + props[Overlay::US_PROPKEY_AR_ID] = ANNOTATIONRENDERER_ID; + props[Overlay::US_PROPKEY_RENDERER_ID] = rendererID; + overlay->RegisterAsMicroservice(props); + AddAlignmentProperty(overlay, alignment, priority); + } + + void OverlayLayouter2D::AddOverlay(Overlay *overlay, BaseRenderer *renderer, Alignment alignment, int priority) + { + AddOverlay(overlay, renderer->GetName(), alignment, priority); + } + + void OverlayLayouter2D::PrepareLayout() + { + // std::vector managedOverlays = this->GetServices(); + // std::list::iterator it; + // mitk::Overlay::Bounds bounds; + // int *size = this->GetCurrentBaseRenderer()->GetVtkRenderer()->GetSize(); + + // The alignment enum defines the type of this layouter + } + + void OverlayLayouter2D::PrepareTopLeftLayout(int *displaySize) + { + double posX, posY; + Point2D margin; + posX = 0; + posY = displaySize[1]; + mitk::Overlay::Bounds bounds; + for (mitk::Overlay *overlay : m_OverlayContainerMap[TopLeft]) + { + margin = overlay->GetMargin2D(); + bounds = overlay->GetBoundsOnDisplay(this->GetCurrentBaseRenderer()); + + posX += margin[0]; + posY -= bounds.Size[1] + margin[1]; + bounds.Position[0] = posX; + bounds.Position[1] = posY; + overlay->SetBoundsOnDisplay(this->GetCurrentBaseRenderer(), bounds); + } + } + void OverlayLayouter2D::PrepareTopLayout(int *displaySize) + { + double posX, posY; + Point2D margin; + posX = 0; + posY = displaySize[1]; + mitk::Overlay::Bounds bounds; + for (mitk::Overlay *overlay : m_OverlayContainerMap[Top]) + { + margin = overlay->GetMargin2D(); + bounds = overlay->GetBoundsOnDisplay(this->GetCurrentBaseRenderer()); + + posX = displaySize[0] / 2 - bounds.Size[0] / 2; + posY -= bounds.Size[1] + margin[1]; + bounds.Position[0] = posX; + bounds.Position[1] = posY; + overlay->SetBoundsOnDisplay(this->GetCurrentBaseRenderer(), bounds); + } + } + void OverlayLayouter2D::PrepareTopRightLayout(int *displaySize) + { + double posX, posY; + Point2D margin; + posX = 0; + posY = displaySize[1]; + mitk::Overlay::Bounds bounds; + for (mitk::Overlay *overlay : m_OverlayContainerMap[TopRight]) + { + margin = overlay->GetMargin2D(); + bounds = overlay->GetBoundsOnDisplay(this->GetCurrentBaseRenderer()); + + posX = displaySize[0] - (bounds.Size[0] + margin[0]); + posY -= bounds.Size[1] + margin[1]; + bounds.Position[0] = posX; + bounds.Position[1] = posY; + overlay->SetBoundsOnDisplay(this->GetCurrentBaseRenderer(), bounds); + } + } + void OverlayLayouter2D::PrepareBottomLeftLayout(int * /*displaySize*/) + { + double posX, posY; + Point2D margin; + posX = 0; + posY = 0; + mitk::Overlay::Bounds bounds; + for (mitk::Overlay *overlay : m_OverlayContainerMap[BottomLeft]) + { + margin = overlay->GetMargin2D(); + bounds = overlay->GetBoundsOnDisplay(this->GetCurrentBaseRenderer()); + + bounds.Position[0] = posX + margin[0]; + bounds.Position[1] = posY + margin[1]; + overlay->SetBoundsOnDisplay(this->GetCurrentBaseRenderer(), bounds); + posY += bounds.Size[1] + margin[1]; + } + } + void OverlayLayouter2D::PrepareBottomLayout(int *displaySize) + { + double posX, posY; + Point2D margin; + posX = 0; + posY = 0; + mitk::Overlay::Bounds bounds; + for (mitk::Overlay *overlay : m_OverlayContainerMap[Bottom]) + { + margin = overlay->GetMargin2D(); + bounds = overlay->GetBoundsOnDisplay(this->GetCurrentBaseRenderer()); + + posX = displaySize[0] / 2 - bounds.Size[0] / 2; + bounds.Position[0] = posX; + bounds.Position[1] = posY + margin[1]; + overlay->SetBoundsOnDisplay(this->GetCurrentBaseRenderer(), bounds); + posY += bounds.Size[1] + margin[1]; + } + } + void OverlayLayouter2D::PrepareBottomRightLayout(int *displaySize) + { + double posX, posY; + Point2D margin; + posX = 0; + posY = 0; + mitk::Overlay::Bounds bounds; + for (mitk::Overlay *overlay : m_OverlayContainerMap[BottomRight]) + { + margin = overlay->GetMargin2D(); + bounds = overlay->GetBoundsOnDisplay(this->GetCurrentBaseRenderer()); + + posX = displaySize[0] - (bounds.Size[0] + margin[0]); + bounds.Position[0] = posX; + bounds.Position[1] = posY + margin[1]; + overlay->SetBoundsOnDisplay(this->GetCurrentBaseRenderer(), bounds); + posY += bounds.Size[1] + margin[1]; + } + } + void OverlayLayouter2D::PrepareLeftLayout(int *displaySize) + { + double posX, posY; + Point2D margin; + posX = displaySize[0]; + posY = displaySize[1] / 2.0; + mitk::Overlay::Bounds bounds; + for (mitk::Overlay *overlay : m_OverlayContainerMap[Left]) + { + margin = overlay->GetMargin2D(); + bounds = overlay->GetBoundsOnDisplay(this->GetCurrentBaseRenderer()); + + posY = (displaySize[1] - bounds.Size[1]) / 2.0; + posX = displaySize[0] - (bounds.Size[0] + margin[0]); + bounds.Position[0] = posX; + bounds.Position[1] = posY + margin[1]; + overlay->SetBoundsOnDisplay(this->GetCurrentBaseRenderer(), bounds); + posY += bounds.Size[1]; + } + } + void OverlayLayouter2D::PrepareRightLayout(int *displaySize) + { + double posX, posY; + Point2D margin; + posX = 0; + posY = displaySize[1] / 2.0; + mitk::Overlay::Bounds bounds; + for (mitk::Overlay *overlay : m_OverlayContainerMap[Right]) + { + margin = overlay->GetMargin2D(); + bounds = overlay->GetBoundsOnDisplay(this->GetCurrentBaseRenderer()); + + posY = (displaySize[1] - bounds.Size[1]) / 2.0; + bounds.Position[0] = posX + margin[0]; + bounds.Position[1] = posY; + overlay->SetBoundsOnDisplay(this->GetCurrentBaseRenderer(), bounds); + posY += bounds.Size[1] + margin[1]; + } + } + + double OverlayLayouter2D::GetHeight(OverlayVector &overlays, BaseRenderer *renderer) + { + double height = 0; + for (auto overlay : overlays) + { + Overlay::Bounds bounds = overlay->GetBoundsOnDisplay(renderer); + height += bounds.Size[0]; + height += overlay->GetMargin2D()[0]; + } + return height; + } }