mitkStepper.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 mitkStepper_h
#define mitkStepper_h
 
#include "mitkNumericTypes.h"
#include <MitkCoreExports.h>
#include <mitkCommon.h>
 
#include <itkObject.h>
#include <itkObjectFactory.h>
 
#include <string>
 
namespace mitk
{
  class MITKCORE_EXPORT Stepper : public itk::Object
  {
  public:
    mitkClassMacroItkParent(Stepper, itk::Object);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
    itkGetConstMacro(Pos, unsigned int);
 
    virtual void SetPos(unsigned int pos)
    {
      // copied from itkMacro.h, itkSetClampMacro(...)
      unsigned int newPos;
      if (m_Steps != 0)
      {
        newPos = (pos > m_Steps - 1 ? m_Steps - 1 : pos);
      }
      else
      {
        newPos = 0;
      }
 
      if (this->m_Pos != newPos)
      {
        this->m_Pos = newPos;
        this->Modified();
      }
    }
 
    itkGetConstMacro(Steps, unsigned int);
    itkSetMacro(Steps, unsigned int);
 
    itkGetConstMacro(AutoRepeat, bool);
    itkSetMacro(AutoRepeat, bool);
    itkBooleanMacro(AutoRepeat);
 
    itkSetMacro(PingPong, bool);
    itkGetConstMacro(PingPong, bool);
    itkBooleanMacro(PingPong);
 
    itkSetMacro(InverseDirection, bool);
    itkGetConstMacro(InverseDirection, bool);
    itkBooleanMacro(InverseDirection);
 
    void SetRange(ScalarType min, ScalarType max);
    void InvalidateRange();
    ScalarType GetRangeMin() const;
    ScalarType GetRangeMax() const;
    bool HasValidRange() const;
    void RemoveRange();
    bool HasRange() const;
 
    void SetUnitName(const char *unitName);
    const char *GetUnitName() const;
    void RemoveUnitName();
    bool HasUnitName() const;
 
    virtual void Next();
 
    virtual void Previous();
 
    virtual void MoveSlice(int sliceDelta);
 
    virtual void First();
 
    virtual void Last();
 
  protected:
    Stepper();
    ~Stepper() override;
 
    void Increase();
 
    void Decrease();
 
    unsigned int m_Pos;
 
    unsigned int m_Steps;
 
    bool m_AutoRepeat;
 
    bool m_PingPong;
    bool m_InverseDirection;
 
    ScalarType m_RangeMin;
    ScalarType m_RangeMax;
    bool m_RangeValid;
    bool m_HasRange;
 
    std::string m_UnitName;
    bool m_HasUnitName;
  };
 
} // namespace mitk
 
#endif