mitkStepper.h

Go to the documentation of this file.

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

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision$

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.

This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notices for more information.

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


#ifndef STEPPER_H_HEADER_INCLUDED_C1E77191
#define STEPPER_H_HEADER_INCLUDED_C1E77191

#include "mitkCommon.h"
#include "mitkVector.h"

#include <itkObject.h>
#include <itkObjectFactory.h>

#include <string>

namespace mitk {

class MITK_CORE_EXPORT Stepper : public itk::Object
{
public:
  mitkClassMacro(Stepper, itk::Object);
  itkNewMacro(Self);

  itkGetMacro(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();
    }
  }

  itkGetMacro(Steps, unsigned int);
  itkSetMacro(Steps, unsigned int);

  itkGetMacro(AutoRepeat, bool);
  itkSetMacro(AutoRepeat, bool);
  itkBooleanMacro(AutoRepeat);

  itkSetMacro(PingPong, bool);
  itkGetMacro(PingPong, bool);
  itkBooleanMacro(PingPong);

  itkSetMacro(InverseDirection, bool);
  itkGetMacro(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 First();

  virtual void Last();

protected:
  Stepper();
  virtual ~Stepper();

  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 /* STEPPER_H_HEADER_INCLUDED_C1E77191 */