mitkAbstractOverlayLayouter.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 ABSTRACTOVERLAYLAYOUTER_H
#define ABSTRACTOVERLAYLAYOUTER_H

#include "mitkOverlay.h"
#include <MitkCoreExports.h>
#include <itkObject.h>
#include <mitkCommon.h>

namespace mitk
{
  class BaseRenderer;

  class MITKCORE_EXPORT AbstractOverlayLayouter : public itk::LightObject
  {
  public:
    mitkClassMacroItkParent(AbstractOverlayLayouter, itk::LightObject);

    void SetBaseRenderer(BaseRenderer *renderer);
    BaseRenderer *GetBaseRenderer();

    void AddOverlay(Overlay *Overlay);

    void RemoveOverlay(Overlay *Overlay);

    std::string GetIdentifier() const;

    virtual void PrepareLayout() = 0;

  protected:
    explicit AbstractOverlayLayouter();

    virtual ~AbstractOverlayLayouter();

    std::list<mitk::Overlay *> GetManagedOverlays() const;

    std::string m_Identifier;

  private:
    mitk::BaseRenderer *m_BaseRenderer;

    std::list<mitk::Overlay *> m_ManagedOverlays;

    AbstractOverlayLayouter(const AbstractOverlayLayouter &);

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

} // namespace mitk
#endif // ABSTRACTOVERLAYLAYOUTER_H