Medical Imaging Interaction Toolkit  2018.4.99-c0f884b2
Medical Imaging Interaction Toolkit

Helper class to step through a list. More...

#include <mitkStepper.h>

Inheritance diagram for mitk::Stepper:
Collaboration diagram for mitk::Stepper:

Public Types

typedef Stepper Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual unsigned int GetPos () const
 
virtual void SetPos (unsigned int pos)
 
virtual unsigned int GetSteps () const
 
virtual void SetSteps (unsigned int _arg)
 
virtual bool GetAutoRepeat () const
 
virtual void SetAutoRepeat (bool _arg)
 
virtual void AutoRepeatOn ()
 
virtual void AutoRepeatOff ()
 
virtual void SetPingPong (bool _arg)
 
virtual bool GetPingPong () const
 
virtual void PingPongOn ()
 
virtual void PingPongOff ()
 
virtual void SetInverseDirection (bool _arg)
 
virtual bool GetInverseDirection () const
 
virtual void InverseDirectionOn ()
 
virtual void InverseDirectionOff ()
 
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 ()
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 

Protected Member Functions

 Stepper ()
 
 ~Stepper () override
 
void Increase ()
 
void Decrease ()
 

Protected Attributes

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
 

Detailed Description

Helper class to step through a list.

A helper class to step through a list. Does not contain the list, just the position in the list (between 0 and GetSteps()). Provides methods like First (go to the first element), Next (go to the next one), etc.

Besides the actual number of steps, the stepper can also hold a stepping range, indicating the scalar values corresponding to the covered steps. For example, steppers are generally used to slice a dataset with a plane; Hereby, Steps indicates the total number of steps (positions) available for the plane, Pos indicates the current step, and Range indicates the physical minimum and maximum values for the plane, in this case a value in mm.

The range can also be supplied with a unit name (a string) which can be used by classes providing information about the stepping (e.g. graphical sliders).

Definition at line 47 of file mitkStepper.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 50 of file mitkStepper.h.

◆ Pointer

Definition at line 50 of file mitkStepper.h.

◆ Self

Definition at line 50 of file mitkStepper.h.

◆ Superclass

typedef itk::Object mitk::Stepper::Superclass

Definition at line 50 of file mitkStepper.h.

Constructor & Destructor Documentation

◆ Stepper()

mitk::Stepper::Stepper ( )
protected

Definition at line 15 of file mitkStepper.cpp.

◆ ~Stepper()

mitk::Stepper::~Stepper ( )
overrideprotected

Definition at line 29 of file mitkStepper.cpp.

Member Function Documentation

◆ AutoRepeatOff()

virtual void mitk::Stepper::AutoRepeatOff ( )
virtual

◆ AutoRepeatOn()

virtual void mitk::Stepper::AutoRepeatOn ( )
virtual

◆ Clone()

Pointer mitk::Stepper::Clone ( ) const

◆ Decrease()

void mitk::Stepper::Decrease ( )
protected

Definition at line 121 of file mitkStepper.cpp.

References GetPos(), GetSteps(), m_AutoRepeat, m_InverseDirection, m_PingPong, and SetPos().

Referenced by Next(), and Previous().

◆ First()

void mitk::Stepper::First ( )
virtual

Definition at line 197 of file mitkStepper.cpp.

References SetPos().

◆ GetAutoRepeat()

virtual bool mitk::Stepper::GetAutoRepeat ( ) const
virtual

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::Stepper::GetClassHierarchy ( ) const
inlinevirtual

Definition at line 50 of file mitkStepper.h.

◆ GetClassName()

virtual const char* mitk::Stepper::GetClassName ( ) const
virtual

◆ GetInverseDirection()

virtual bool mitk::Stepper::GetInverseDirection ( ) const
virtual

◆ GetPingPong()

virtual bool mitk::Stepper::GetPingPong ( ) const
virtual

◆ GetPos()

◆ GetRangeMax()

mitk::ScalarType mitk::Stepper::GetRangeMax ( ) const

Definition at line 54 of file mitkStepper.cpp.

References m_RangeMax.

◆ GetRangeMin()

mitk::ScalarType mitk::Stepper::GetRangeMin ( ) const

Definition at line 49 of file mitkStepper.cpp.

References m_RangeMin.

◆ GetStaticNameOfClass()

static const char* mitk::Stepper::GetStaticNameOfClass ( )
inlinestatic

Definition at line 50 of file mitkStepper.h.

◆ GetSteps()

◆ GetUnitName()

const char * mitk::Stepper::GetUnitName ( ) const

Definition at line 82 of file mitkStepper.cpp.

References m_UnitName.

◆ HasRange()

bool mitk::Stepper::HasRange ( ) const

Definition at line 70 of file mitkStepper.cpp.

References m_HasRange.

◆ HasUnitName()

bool mitk::Stepper::HasUnitName ( ) const

Definition at line 93 of file mitkStepper.cpp.

References m_HasUnitName.

◆ HasValidRange()

bool mitk::Stepper::HasValidRange ( ) const

Definition at line 65 of file mitkStepper.cpp.

References m_HasRange, and m_RangeValid.

◆ Increase()

void mitk::Stepper::Increase ( )
protected

Definition at line 98 of file mitkStepper.cpp.

References GetPos(), GetSteps(), m_AutoRepeat, m_InverseDirection, m_PingPong, and SetPos().

Referenced by Next(), and Previous().

◆ InvalidateRange()

void mitk::Stepper::InvalidateRange ( )

Definition at line 42 of file mitkStepper.cpp.

References m_HasRange, and m_RangeValid.

◆ InverseDirectionOff()

virtual void mitk::Stepper::InverseDirectionOff ( )
virtual

◆ InverseDirectionOn()

virtual void mitk::Stepper::InverseDirectionOn ( )
virtual

◆ Last()

void mitk::Stepper::Last ( )
virtual

Definition at line 202 of file mitkStepper.cpp.

References GetSteps(), and SetPos().

◆ MoveSlice()

void mitk::Stepper::MoveSlice ( int  sliceDelta)
virtual

◆ New()

static Pointer mitk::Stepper::New ( )
static

◆ Next()

void mitk::Stepper::Next ( )
virtual

◆ PingPongOff()

virtual void mitk::Stepper::PingPongOff ( )
virtual

◆ PingPongOn()

virtual void mitk::Stepper::PingPongOn ( )
virtual

◆ Previous()

void mitk::Stepper::Previous ( )
virtual

◆ RemoveRange()

void mitk::Stepper::RemoveRange ( )

Definition at line 59 of file mitkStepper.cpp.

References m_HasRange.

◆ RemoveUnitName()

void mitk::Stepper::RemoveUnitName ( )

Definition at line 87 of file mitkStepper.cpp.

References m_HasUnitName.

◆ SetAutoRepeat()

◆ SetInverseDirection()

virtual void mitk::Stepper::SetInverseDirection ( bool  _arg)
virtual

If set to true, the Next() decreases the stepper and Previous() decreases it

◆ SetPingPong()

virtual void mitk::Stepper::SetPingPong ( bool  _arg)
virtual

Causes the stepper to shift direction when the boundary is reached

◆ SetPos()

◆ SetRange()

void mitk::Stepper::SetRange ( ScalarType  min,
ScalarType  max 
)

Definition at line 33 of file mitkStepper.cpp.

References m_HasRange, m_RangeMax, m_RangeMin, m_RangeValid, max(), and min().

◆ SetSteps()

virtual void mitk::Stepper::SetSteps ( unsigned int  _arg)
virtual

◆ SetUnitName()

void mitk::Stepper::SetUnitName ( const char *  unitName)

Definition at line 75 of file mitkStepper.cpp.

References m_HasUnitName, and m_UnitName.

Member Data Documentation

◆ m_AutoRepeat

bool mitk::Stepper::m_AutoRepeat
protected

Definition at line 128 of file mitkStepper.h.

Referenced by Decrease(), Increase(), and MoveSlice().

◆ m_HasRange

bool mitk::Stepper::m_HasRange
protected

Definition at line 136 of file mitkStepper.h.

Referenced by HasRange(), HasValidRange(), InvalidateRange(), RemoveRange(), and SetRange().

◆ m_HasUnitName

bool mitk::Stepper::m_HasUnitName
protected

Definition at line 139 of file mitkStepper.h.

Referenced by HasUnitName(), RemoveUnitName(), and SetUnitName().

◆ m_InverseDirection

bool mitk::Stepper::m_InverseDirection
protected

Definition at line 131 of file mitkStepper.h.

Referenced by Decrease(), Increase(), Next(), and Previous().

◆ m_PingPong

bool mitk::Stepper::m_PingPong
protected

Definition at line 130 of file mitkStepper.h.

Referenced by Decrease(), and Increase().

◆ m_Pos

unsigned int mitk::Stepper::m_Pos
protected

Definition at line 124 of file mitkStepper.h.

◆ m_RangeMax

ScalarType mitk::Stepper::m_RangeMax
protected

Definition at line 134 of file mitkStepper.h.

Referenced by GetRangeMax(), and SetRange().

◆ m_RangeMin

ScalarType mitk::Stepper::m_RangeMin
protected

Definition at line 133 of file mitkStepper.h.

Referenced by GetRangeMin(), and SetRange().

◆ m_RangeValid

bool mitk::Stepper::m_RangeValid
protected

Definition at line 135 of file mitkStepper.h.

Referenced by HasValidRange(), InvalidateRange(), and SetRange().

◆ m_Steps

unsigned int mitk::Stepper::m_Steps
protected

Definition at line 126 of file mitkStepper.h.

Referenced by mitk::MultiStepper::UpdateStepCount().

◆ m_UnitName

std::string mitk::Stepper::m_UnitName
protected

Definition at line 138 of file mitkStepper.h.

Referenced by GetUnitName(), and SetUnitName().


The documentation for this class was generated from the following files: