mitk::Stepper Class Reference

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< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer

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

typedef itk::SmartPointer<const Self> mitk::Stepper::ConstPointer

Definition at line 50 of file mitkStepper.h.

Pointer

typedef itk::SmartPointer<Self> mitk::Stepper::Pointer

Definition at line 50 of file mitkStepper.h.

Self

typedef Stepper mitk::Stepper::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

~Stepper()

mitk::Stepper::~Stepper ( )

overrideprotected

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

First()

virtual void mitk::Stepper::First ( )

virtual

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()

virtual unsigned int mitk::Stepper::GetPos ( ) const

virtual

GetRangeMax()

ScalarType mitk::Stepper::GetRangeMax

(

)

const

GetRangeMin()

ScalarType mitk::Stepper::GetRangeMin

(

)

const

GetStaticNameOfClass()

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

inlinestatic

Definition at line 50 of file mitkStepper.h.

GetSteps()

virtual unsigned int mitk::Stepper::GetSteps ( ) const

virtual

GetUnitName()

const char* mitk::Stepper::GetUnitName

(

)

const

HasRange()

bool mitk::Stepper::HasRange

(

)

const

HasUnitName()

bool mitk::Stepper::HasUnitName

(

)

const

HasValidRange()

bool mitk::Stepper::HasValidRange

(

)

const

Increase()

void mitk::Stepper::Increase ( )

protected

InvalidateRange()

void mitk::Stepper::InvalidateRange

(

)

InverseDirectionOff()

virtual void mitk::Stepper::InverseDirectionOff ( )

virtual

InverseDirectionOn()

virtual void mitk::Stepper::InverseDirectionOn ( )

virtual

Last()

virtual void mitk::Stepper::Last ( )

virtual

MoveSlice()

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

virtual

New()

static Pointer mitk::Stepper::New ( )

static

Next()

virtual void mitk::Stepper::Next ( )

virtual

PingPongOff()

virtual void mitk::Stepper::PingPongOff ( )

virtual

PingPongOn()

virtual void mitk::Stepper::PingPongOn ( )

virtual

Previous()

virtual void mitk::Stepper::Previous ( )

virtual

RemoveRange()

void mitk::Stepper::RemoveRange

(

)

RemoveUnitName()

void mitk::Stepper::RemoveUnitName

(

)

SetAutoRepeat()

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

virtual

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()

virtual void mitk::Stepper::SetPos ( unsigned int  pos )

inlinevirtual

Reimplemented in mitk::MultiStepper.

Definition at line 55 of file mitkStepper.h.

SetRange()

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

SetSteps()

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

virtual

Reimplemented in mitk::MultiStepper.

SetUnitName()

void mitk::Stepper::SetUnitName

(

const char *

unitName

)

Member Data Documentation

m_AutoRepeat

bool mitk::Stepper::m_AutoRepeat

protected

Definition at line 128 of file mitkStepper.h.

m_HasRange

bool mitk::Stepper::m_HasRange

protected

Definition at line 136 of file mitkStepper.h.

m_HasUnitName

bool mitk::Stepper::m_HasUnitName

protected

Definition at line 139 of file mitkStepper.h.

m_InverseDirection

bool mitk::Stepper::m_InverseDirection

protected

Definition at line 131 of file mitkStepper.h.

m_PingPong

bool mitk::Stepper::m_PingPong

protected

Definition at line 130 of file mitkStepper.h.

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.

m_RangeMin

ScalarType mitk::Stepper::m_RangeMin

protected

Definition at line 133 of file mitkStepper.h.

m_RangeValid

bool mitk::Stepper::m_RangeValid

protected

Definition at line 135 of file mitkStepper.h.

m_Steps

unsigned int mitk::Stepper::m_Steps

protected

Definition at line 126 of file mitkStepper.h.

m_UnitName

std::string mitk::Stepper::m_UnitName

protected

Definition at line 138 of file mitkStepper.h.

---

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

• mitkStepper.h