mitkOverlayManager.h

Go to the documentation of this file.

/*===================================================================

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 OVERLAYMANAGER_H
#define OVERLAYMANAGER_H

#include "MitkCoreExports.h"
#include "itkEventObject.h"
#include "mitkAbstractOverlayLayouter.h"
#include "mitkLocalStorageHandler.h"
#include "mitkOverlay.h"
#include <itkLightObject.h>
#include <vtkSmartPointer.h>

namespace mitk
{
  itkEventMacroDeclaration(OverlayAddEvent, itk::AnyEvent)

    class BaseRenderer;

  class MITKCORE_EXPORT OverlayManager : public itk::Object
  {
  public:
    typedef std::set<BaseRenderer *> BaseRendererSet;
    typedef std::set<Overlay::Pointer> OverlaySet;
    typedef std::map<const std::string, AbstractOverlayLayouter::Pointer> LayouterMap;
    typedef std::map<const BaseRenderer *, LayouterMap> LayouterRendererMap;
    typedef std::map<const BaseRenderer *, vtkSmartPointer<vtkRenderer>> ForegroundRendererMap;

    mitkClassMacroItkParent(OverlayManager, itk::Object) itkFactorylessNewMacro(Self) itkCloneMacro(Self)

      void AddOverlay(const Overlay::Pointer &overlay, bool ForceInForeground = true);
    void AddOverlay(const Overlay::Pointer &overlay, BaseRenderer *renderer, bool ForceInForeground = true);
    void RemoveOverlay(const Overlay::Pointer &overlay);

    void RemoveAllOverlays();

    void SetLayouter(Overlay *overlay, const std::string &identifier, BaseRenderer *renderer);

    void UpdateLayouts(BaseRenderer *renderer);

    AbstractOverlayLayouter::Pointer GetLayouter(BaseRenderer *renderer, const std::string &identifier);

    void AddLayouter(const AbstractOverlayLayouter::Pointer &layouter);

    void AddBaseRenderer(BaseRenderer *renderer);

    void UpdateOverlays(BaseRenderer *baseRenderer);

    void RemoveBaseRenderer(mitk::BaseRenderer *renderer);

    void RemoveAllBaseRenderers();

    const OverlaySet &GetAllOverlays();

    static OverlayManager *GetInstance();

  protected:
    explicit OverlayManager();

    ~OverlayManager();

  private:
    OverlaySet m_OverlaySet;

    BaseRendererSet m_BaseRendererSet;

    LayouterRendererMap m_LayouterMap;

    ForegroundRendererMap m_ForegroundRenderer;

    OverlayManager(const OverlayManager &);

    OverlayManager &operator=(const OverlayManager &);
  };

} // namespace mitk

#endif // OVERLAYMANAGER_H