mitkScaleLegendAnnotation.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef SCALELEGENDAnnotation_H
#define SCALELEGENDAnnotation_H

#include "MitkAnnotationExports.h"
#include <mitkLocalStorageHandler.h>
#include <mitkVtkAnnotation.h>
#include <vtkSmartPointer.h>

class vtkLegendScaleActor;

namespace mitk
{
  class MITKANNOTATION_EXPORT ScaleLegendAnnotation : public mitk::VtkAnnotation
  {
  public:
    class LocalStorage : public mitk::Annotation::BaseLocalStorage
    {
    public:
      vtkSmartPointer<vtkLegendScaleActor> m_legendScaleActor;

      itk::TimeStamp m_LastUpdateTime;

      LocalStorage();
      ~LocalStorage();
    };

    mitkClassMacro(ScaleLegendAnnotation, mitk::VtkAnnotation);
    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 SetLeftBorderOffset(int offset);
    int GetLeftBorderOffset() const;

    void SetTopBorderOffset(int offset);
    int GetTopBorderOffset() const;

    void SetBottomBorderOffset(int offset);
    int GetBottomBorderOffset() const;

    void SetFontFactor(double fontFactor);
    double GetFontFactor() const;

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

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

    vtkProp *GetVtkProp(BaseRenderer *renderer) const override;
    void UpdateVtkAnnotation(BaseRenderer *renderer) override;

    explicit ScaleLegendAnnotation();

    ~ScaleLegendAnnotation() override;

  private:
    ScaleLegendAnnotation(const ScaleLegendAnnotation &);

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

} // namespace mitk
#endif // SCALELEGENDAnnotation_H