mitkScaleLegendOverlay.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 SCALELEGENDOVERLAY_H
#define SCALELEGENDOVERLAY_H

#include "MitkOverlaysExports.h"
#include <mitkLocalStorageHandler.h>
#include <mitkVtkOverlay.h>
#include <vtkSmartPointer.h>

class vtkLegendScaleActor;

namespace mitk
{
  class MITKOVERLAYS_EXPORT ScaleLegendOverlay : public mitk::VtkOverlay
  {
  public:
    class LocalStorage : public mitk::Overlay::BaseLocalStorage
    {
    public:
      vtkSmartPointer<vtkLegendScaleActor> m_legendScaleActor;

      itk::TimeStamp m_LastUpdateTime;

      LocalStorage();
      ~LocalStorage();
    };

    mitkClassMacro(ScaleLegendOverlay, mitk::VtkOverlay);
    itkFactorylessNewMacro(Self) itkCloneMacro(Self)

      void SetRightAxisVisibility(bool visibility);
    bool GetRightAxisVisibility() const;

    void SetLeftAxisVisibility(bool visibility);
    bool GetLeftAxisVisibility() const;

    void SetTopAxisVisibility(bool visibility);
    bool GetTopAxisVisibility() const;

    void SetBottomAxisVisibility(bool visibility);
    bool GetBottomAxisVisibility() const;

    void SetLegendVisibility(bool visibility);
    bool GetLegendVisibility() const;

    void SetRightBorderOffset(int offset);
    int GetRightBorderOffset() const;

    void SetCornerOffsetFactor(float offsetFactor);
    float GetCornerOffsetFactor() const;

  protected:
    mutable mitk::LocalStorageHandler<LocalStorage> m_LSH;

    virtual vtkProp *GetVtkProp(BaseRenderer *renderer) const override;
    virtual void UpdateVtkOverlay(BaseRenderer *renderer) override;

    explicit ScaleLegendOverlay();

    virtual ~ScaleLegendOverlay();

  private:
    ScaleLegendOverlay(const ScaleLegendOverlay &);

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

} // namespace mitk
#endif // SCALELEGENDOVERLAY_H