omni::ui::mixin::Scale< SLIDER, SCALAR > Class Template Reference

Scales a set of sliders and sets a common unit suffix. More...

#include <Scale.h>

Collaboration diagram for omni::ui::mixin::Scale< SLIDER, SCALAR >:

Data Structures
struct	SliderInfo
	Slider Info struct saves min, max and step values. More...

Public Types
typedef SLIDER	slider_type
typedef SCALAR	scalar_type

Public Member Functions
	Scale ()
virtual void	setScale (float _scale)
	Set scale and apply to sliders. More...
bool	rescaleValues () const
void	setRescaleValues (bool _rescaleValues)
float	scale () const
	Return scale value. More...
QString	suffix () const
	Common unit of sliders. More...
void	setSuffix (QString const &_suffix)
	Set suffix (unit) of slider. More...
void	registerScaledSlider (slider_type *_slider)
	Register slider to be scaled. More...
void	unregisterScaledSlider (slider_type *_slider)
	Remove slider from list, keep scale. More...

Static Public Member Functions
static int	getPrecision (float _scale)
	Return precesion by scale. More...

Private Attributes
QString	suffix_
	Common suffix is meter. More...
int	precision_ = 2
float	scale_ = 1.0
bool	rescaleValues_ = true
std::map< slider_type *, SliderInfo >	sliders_

Detailed Description

template<typename SLIDER, typename SCALAR = float>
class omni::ui::mixin::Scale< SLIDER, SCALAR >

Scales a set of sliders and sets a common unit suffix.

Member Typedef Documentation

template<typename SLIDER, typename SCALAR = float>

typedef SCALAR omni::ui::mixin::Scale< SLIDER, SCALAR >::scalar_type

template<typename SLIDER, typename SCALAR = float>

typedef SLIDER omni::ui::mixin::Scale< SLIDER, SCALAR >::slider_type

Constructor & Destructor Documentation

template<typename SLIDER, typename SCALAR = float>

omni::ui::mixin::Scale< SLIDER, SCALAR >::Scale ( )

inline

: suffix_("m") {}

Member Function Documentation

template<typename SLIDER, typename SCALAR = float>

static int omni::ui::mixin::Scale< SLIDER, SCALAR >::getPrecision ( float  _scale )

inlinestatic

Return precesion by scale.

                                                {
            if (_scale <= 0.1) {
              return 4;
            }

            if (_scale <= 1) {
              return 3;
            }

            if (_scale <= 10) {
              return 2;
            }

            if (_scale <= 100) {
              return 1;
            }
            return 2;
          }

template<typename SLIDER, typename SCALAR = float>

void omni::ui::mixin::Scale< SLIDER, SCALAR >::registerScaledSlider ( slider_type *  _slider )

inline

Register slider to be scaled.

                                                          {
            if (sliders_.count(_slider)) return;

            sliders_[_slider] = SliderInfo(_slider->minimum(), _slider->maximum(),
                                           _slider->pageStep(),
                                           _slider->singleStep(),
                                           _slider->defaultValue(),
                                           _slider->pivot());
          }

template<typename SLIDER, typename SCALAR = float>

bool omni::ui::mixin::Scale< SLIDER, SCALAR >::rescaleValues ( ) const

inline

                                     {
            return rescaleValues_;
          }

template<typename SLIDER, typename SCALAR = float>

float omni::ui::mixin::Scale< SLIDER, SCALAR >::scale ( ) const

inline

Return scale value.

                              {
            return scale_;
          }

template<typename SLIDER, typename SCALAR = float>

void omni::ui::mixin::Scale< SLIDER, SCALAR >::setRescaleValues ( bool  _rescaleValues )

inline

                                                     {
            rescaleValues_ = _rescaleValues;
          }

template<typename SLIDER, typename SCALAR = float>

virtual void omni::ui::mixin::Scale< SLIDER, SCALAR >::setScale ( float  _scale )

inlinevirtual

Set scale and apply to sliders.

                                              {
            float _oldScale = scale_;

            scale_ = _scale;

            for (auto& _slider_info : sliders_) {
              auto& _slider = _slider_info.first;
              auto& _info   = _slider_info.second;
              _slider->setRange(_info.min_ * scale_, _info.max_ * scale_);

              if (rescaleValues_) {
                auto  _value  = _slider->value() / _oldScale * scale_;
                _slider->setValue(_value);
              }

              _slider->setSingleStep(_info.singleStep_ * scale_);
              _slider->setDefaultValue(_info.defaultValue_ * scale_);
              _slider->setPageStep(_info.pageStep_ * scale_);
              _slider->setPrecision(getPrecision(scale_));
              _slider->setPivot(_info.pivot_);
            }
          }

template<typename SLIDER, typename SCALAR = float>

void omni::ui::mixin::Scale< SLIDER, SCALAR >::setSuffix ( QString const &  _suffix )

inline

Set suffix (unit) of slider.

                                                 {
            suffix_ = _suffix;

            for (auto& _slider_info : sliders_) {
              _slider_info.first->setSuffix(suffix_);
            }
          }

template<typename SLIDER, typename SCALAR = float>

QString omni::ui::mixin::Scale< SLIDER, SCALAR >::suffix ( ) const

inline

Common unit of sliders.

                                 {
            return suffix_;
          }

template<typename SLIDER, typename SCALAR = float>

void omni::ui::mixin::Scale< SLIDER, SCALAR >::unregisterScaledSlider ( slider_type *  _slider )

inline

Remove slider from list, keep scale.

                                                            {
            if (!sliders_.count(_slider)) return;

            sliders_.erase(_slider);
          }

Field Documentation

template<typename SLIDER, typename SCALAR = float>

int omni::ui::mixin::Scale< SLIDER, SCALAR >::precision_ = 2

private

template<typename SLIDER, typename SCALAR = float>

bool omni::ui::mixin::Scale< SLIDER, SCALAR >::rescaleValues_ = true

private

template<typename SLIDER, typename SCALAR = float>

float omni::ui::mixin::Scale< SLIDER, SCALAR >::scale_ = 1.0

private

template<typename SLIDER, typename SCALAR = float>

std::map<slider_type *, SliderInfo> omni::ui::mixin::Scale< SLIDER, SCALAR >::sliders_

private

template<typename SLIDER, typename SCALAR = float>

QString omni::ui::mixin::Scale< SLIDER, SCALAR >::suffix_

private

Common suffix is meter.

---

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

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