omni::ui::mixin::Step< VALUE > Struct Template Reference

Mixin Stepping value class template Singla and page step. More...

#include <Step.h>

Inheritance diagram for omni::ui::mixin::Step< VALUE >:

Collaboration diagram for omni::ui::mixin::Step< VALUE >:

Public Types
typedef VALUE	value_type

Public Member Functions
	Step (value_type _singleStep=1.0, value_type _pageStep=10.0, bool _snap=false)
	Construct with a single step, page step value. More...
qreal	snapped (value_type _v) const
	Return snapped value. More...
bool	snap () const
	Snap value (align to single step value) More...
void	setSnap (bool _snap)
	Set boolean if value is to be snapped. More...
value_type	singleStep () const
	Return value for single step. More...
value_type	pageStep () const
	Return value for page step. More...
void	setSingleStep (value_type _singleStep)
	Set new single step value. More...
void	setPageStep (value_type _pageStep)
	Set new value for page step. More...

Protected Member Functions
template<typename MIN , typename MAX , typename F >
void	for_each_step (MIN _min, MAX _max, F f)
	Functor to be applied for each step between min and maximum. More...

Private Attributes
value_type	singleStep_
value_type	pageStep_
bool	snap_

Detailed Description

template<typename VALUE>
struct omni::ui::mixin::Step< VALUE >

Mixin Stepping value class template Singla and page step.

Member Typedef Documentation

template<typename VALUE>

typedef VALUE omni::ui::mixin::Step< VALUE >::value_type

Constructor & Destructor Documentation

template<typename VALUE>

omni::ui::mixin::Step< VALUE >::Step ( value_type  _singleStep = 1.0, value_type  _pageStep = 10.0, bool  _snap = false  )

inline

Construct with a single step, page step value.

                                    :
          singleStep_(_singleStep),
          pageStep_(_pageStep),
          snap_(_snap)
        {}

Member Function Documentation

template<typename VALUE>

template<typename MIN , typename MAX , typename F >

void omni::ui::mixin::Step< VALUE >::for_each_step ( MIN  _min, MAX  _max, F  f  )

inlineprotected

Functor to be applied for each step between min and maximum.

          {
            int _step = 0;

            for (value_type i = _min; i <= _max; i += singleStep())
            {
              int _rI = int(std::round(double(i) / singleStep()));

              bool _isPage = int(pageStep()) == 0 ? false :
                             abs(_rI) %
                             int(std::round(double(pageStep()) /
                                            singleStep())) == 0;
              f(_step, i, _isPage);
              ++_step;
            }
          }

template<typename VALUE>

value_type omni::ui::mixin::Step< VALUE >::pageStep ( ) const

inline

Return value for page step.

        {
          return pageStep_;
        }

template<typename VALUE>

void omni::ui::mixin::Step< VALUE >::setPageStep ( value_type  _pageStep )

inline

Set new value for page step.

        {
          pageStep_ = _pageStep;
        }

template<typename VALUE>

void omni::ui::mixin::Step< VALUE >::setSingleStep ( value_type  _singleStep )

inline

Set new single step value.

        {
          singleStep_ = _singleStep;
        }

template<typename VALUE>

void omni::ui::mixin::Step< VALUE >::setSnap ( bool  _snap )

inline

Set boolean if value is to be snapped.

        {
          snap_ = _snap;
        }

template<typename VALUE>

value_type omni::ui::mixin::Step< VALUE >::singleStep ( ) const

inline

Return value for single step.

        {
          return singleStep_;
        }

template<typename VALUE>

bool omni::ui::mixin::Step< VALUE >::snap ( ) const

inline

Snap value (align to single step value)

        {
          return snap_;
        }

template<typename VALUE>

qreal omni::ui::mixin::Step< VALUE >::snapped ( value_type  _v ) const

inline

Return snapped value.

        {
          return value_type(round(qreal(_v) / singleStep())) *
                 singleStep();
        }

Field Documentation

template<typename VALUE>

value_type omni::ui::mixin::Step< VALUE >::pageStep_

private

template<typename VALUE>

value_type omni::ui::mixin::Step< VALUE >::singleStep_

private

template<typename VALUE>

bool omni::ui::mixin::Step< VALUE >::snap_

private

---

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

• include/omni/ui/mixin/Step.h