omni::ui::ParameterWidget Class Reference

A widget which holds sub-widgets for manipulating parameters. More...

#include <ParameterWidget.h>

Inheritance diagram for omni::ui::ParameterWidget:

Collaboration diagram for omni::ui::ParameterWidget:

Public Slots
void	clear ()
	Removes all parameter widgets. More...
virtual void	updateParameters ()
double	getParamAsFloat (QString const &) const
	Utility method for retrieving the value from a slider with id. More...
void	setParamAsFloat (QString const &_str, double _value)
	Set slider value from given value. More...
int	getParamAsInt (QString const &) const
	Utility method for retrieving the value from a slider with id. More...
void	setParamAsInt (QString const &_str, int _value)
	Set slider value from given value. More...
bool	getParamAsBool (QString const &) const
	Utility method for retrieving the value from checkbox with id. More...
QWidget *	getWidget (QString const &)
	Get parameter widget from parameter map with Id. More...
void	setParametersVisible (bool)
	Show / hide parameter widgets. More...
bool	focusNext (bool _circular=false)
	Put focus on next element. More...
bool	focusPrev (bool _circular=false)
	Put focus on prev element. More...
void	focus (int _index)
	Focus item in layout with index. More...
void	focusFirst ()
	Set focus on first widget in parameter list. More...
void	focusLast ()
	Set focus on last widget in parameter list. More...
virtual void	setScale (float)
	Set slider ranges. More...
virtual void	setUnit (QString const &)
	Set slider ranges. More...

Signals
void	parametersUpdated ()

Public Member Functions
	ParameterWidget (QWidget *_parent=nullptr)
	Default constructor. More...
virtual	~ParameterWidget ()
	Default Constructor. More...
RangedFloat *	addWidget (QString const &, float, float, float)
	Adds a widget with a name, a value and min-max range. More...
RangedInt *	addIntegerWidget (QString const &, int, int, int)
	Adds a integer widget with a name, a value and min-max range. More...
RangedFloat *	addAngleWidget (QString const &, float, float, float)
	Adds an angle widget with a name, a value and min-max range. More...
RangedFloat *	addOffsetWidget (QString const &, float, float, float)
	Adds an offset widget with a name, a value and min-max range. More...
Rotation *	addRotationWidget (QString const &)
	Adds an Rotation widget with three dials for X,Y and Z axis. More...
omni::ui::AffineTransform *	addAffineTransformWidget (QString const &, omni::AffineTransform *)
	Add a new affine transform widget with an id. More...
QCheckBox *	addCheckBox (QString const &, bool _checked=false)
	Adds a checkbox. More...
int	focusId () const
	Return id of focused parameter, -1 if no parameter is focused. More...
Public Member Functions inherited from omni::ui::mixin::Scale< omni::ui::RangedFloat >
	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...

Protected Member Functions
virtual int	firstFocusId () const
	Id of first focussed widget. More...
void	keyPressEvent (QKeyEvent *_event)

Protected Attributes
std::vector< QUniquePtr < QWidget > >	parameters_
	Slider parameter widgets. More...
std::map< QString, QWidget * >	parameterMap_
	Slider widgets, sorted by their label. More...

Additional Inherited Members
Public Types inherited from omni::ui::mixin::Scale< omni::ui::RangedFloat >
typedef omni::ui::RangedFloat	slider_type
typedef float	scalar_type
Static Public Member Functions inherited from omni::ui::mixin::Scale< omni::ui::RangedFloat >
static int	getPrecision (float _scale)
	Return precesion by scale. More...

Detailed Description

A widget which holds sub-widgets for manipulating parameters.

Constructor & Destructor Documentation

omni::ui::ParameterWidget::ParameterWidget

(

QWidget *

_parent = nullptr

)

Default constructor.

                                                     :
      QWidget(_parent)
    {
    }

omni::ui::ParameterWidget::~ParameterWidget ( )

virtual

Default Constructor.

    {
    }

Member Function Documentation

omni::ui::AffineTransform * omni::ui::ParameterWidget::addAffineTransformWidget	(	QString const &	_id,
		omni::AffineTransform *	_transform
	)

Add a new affine transform widget with an id.

Install event filter to pipe through focus event to parent widget

Signal-slot connection for updating the data model

                                                             {
        if (getWidget(_id)) {
            return static_cast<omni::ui::AffineTransform*>(getWidget(_id));
          }

        auto* _widget = ui::makeWidget<omni::ui::AffineTransform>(_transform);

        if (layout())
            layout()->addWidget(_widget);

        /// Install event filter to pipe through focus event to parent widget
        _widget->installEventFilter(this);

        /// Signal-slot connection for updating the data model
        connect(_widget,SIGNAL(dataModelChanged()),this,SLOT(updateParameters()));

        parameterMap_[_id] = _widget;
        parameters_.emplace_back(_widget);
        return _widget;
    }

RangedFloat * omni::ui::ParameterWidget::addAngleWidget	(	QString const &	_str,
		float	_value,
		float	_min,
		float	_max
	)

Adds an angle widget with a name, a value and min-max range.

    {
      if (getWidget(_str)) {
        return static_cast<RangedFloat*>(getWidget(_str));
      }
      auto* _angle = addWidget(_str,_value,_min,_max);
      _angle->setSuffix("°");
      _angle->setSingleStep(5.0);
      _angle->setPageStep(45.0);
      return _angle;
    }

QCheckBox * omni::ui::ParameterWidget::addCheckBox	(	QString const &	_text,
		bool	_checked = false
	)

Adds a checkbox.

Signal-slot connection for updating the data model

    {
      if (getWidget(_text)) {
        auto* _checkbox = static_cast<QCheckBox*>(getWidget(_text));
        return _checkbox;
      }

      auto* _checkbox = new QCheckBox(_text, this);
      if (layout())
        layout()->addWidget(_checkbox);

      _checkbox->setChecked(_checked);

      /// Signal-slot connection for updating the data model
      connect(_checkbox,SIGNAL(clicked()),this,SLOT(updateParameters()));
      parameterMap_[_text] = _checkbox;
      parameters_.emplace_back(_checkbox);
      return _checkbox;

    }

RangedInt * omni::ui::ParameterWidget::addIntegerWidget	(	QString const &	_str,
		int	_value,
		int	_min,
		int	_max
	)

Adds a integer widget with a name, a value and min-max range.

Install event filter to pipe through focus event to parent widget

Signal-slot connection for updating the data model

    {
      if (getWidget(_str)) {
        return static_cast<RangedInt*>(getWidget(_str));
      }
      auto* _widget = new RangedInt(_str,_value,_min,_max,this);
      if (layout())
        layout()->addWidget(_widget);

      _widget->setRange(_min,_max);
      _widget->setSingleStep(1);
      _widget->setPageStep(2);
      _widget->setDefaultValue(_value);
      _widget->setUseDefaultValue(true);

      /// Install event filter to pipe through focus event to parent widget
      _widget->installEventFilter(this);

      /// Signal-slot connection for updating the data model
      connect(_widget,SIGNAL(valueChanged()),this,SLOT(updateParameters()));
      parameterMap_[_str] = _widget;
      parameters_.emplace_back(_widget);
      return _widget;
    }

RangedFloat * omni::ui::ParameterWidget::addOffsetWidget	(	QString const &	_str,
		float	_value,
		float	_min,
		float	_max
	)

Adds an offset widget with a name, a value and min-max range.

    {
      if (getWidget(_str)) {
        return static_cast<RangedFloat*>(getWidget(_str));
      }
      auto* _offset = addWidget(_str,_value,_min,_max);
      _offset->setSuffix("m");
      _offset->setSingleStep(0.001);
      _offset->setPageStep(0.01);
      _offset->setPivot(0.0);
      this->registerScaledSlider(_offset);
      return _offset;
    }

Rotation * omni::ui::ParameterWidget::addRotationWidget

(

QString const &

_str

)

Adds an Rotation widget with three dials for X,Y and Z axis.

Install event filter to pipe through focus event to parent widget

Signal-slot connection for updating the data model

    {
      if (getWidget(_str)) {
        return static_cast<Rotation*>(getWidget(_str));
      }
      auto* _widget = new Rotation(0.0,0.0,0.0,this);

      if (layout())
        layout()->addWidget(_widget);

      /// Install event filter to pipe through focus event to parent widget
      _widget->installEventFilter(this);

      /// Signal-slot connection for updating the data model
      connect(_widget,SIGNAL(xChanged()),this,SLOT(updateParameters()));
      connect(_widget,SIGNAL(yChanged()),this,SLOT(updateParameters()));
      connect(_widget,SIGNAL(zChanged()),this,SLOT(updateParameters()));

      parameterMap_[_str] = _widget;
      parameters_.emplace_back(_widget);
      return _widget;
    }

RangedFloat * omni::ui::ParameterWidget::addWidget	(	QString const &	_str,
		float	_value,
		float	_min,
		float	_max
	)

Adds a widget with a name, a value and min-max range.

Install event filter to pipe through focus event to parent widget

Signal-slot connection for updating the data model

    {
      auto* _widget = new RangedFloat(_str,_value,_min,_max,this);
      if (layout())
        layout()->addWidget(_widget);

      this->installEventFilter(_widget);

      _widget->setUseDefaultValue(true);

      /// Install event filter to pipe through focus event to parent widget
      _widget->installEventFilter(this);

      /// Signal-slot connection for updating the data model
      connect(_widget,SIGNAL(valueChanged()),this,SLOT(updateParameters()));
      parameterMap_[_str] = _widget;
      parameters_.emplace_back(_widget);
      return _widget;
    }

void omni::ui::ParameterWidget::clear ( )

slot

Removes all parameter widgets.

    {
        parameters_.clear();
        parameterMap_.clear();

        if (layout())
        {
          QLayoutItem *item = nullptr;
          while ((item = layout()->takeAt(0)))
          {
            delete item->widget();
            delete item;
          }
        }
    }

virtual int omni::ui::ParameterWidget::firstFocusId ( ) const

inlineprotectedvirtual

Id of first focussed widget.

Reimplemented in omni::ui::proj::Tuning.

                                                {
          return 0;
        }

void omni::ui::ParameterWidget::focus ( int  _index )

slot

Focus item in layout with index.

                                          {
        if (!layout()->itemAt(_index)) return;

        layout()->itemAt(_index)->widget()->setFocus();
    }

void omni::ui::ParameterWidget::focusFirst ( )

slot

Set focus on first widget in parameter list.

                                     {
        focus(firstFocusId());
    }

int omni::ui::ParameterWidget::focusId

(

)

const

Return id of focused parameter, -1 if no parameter is focused.

                                       {
        int _id = 0;
        for (int i = 0; i < layout()->count(); ++i) {
            auto _param = layout()->itemAt(i)->widget();
            if (_param->hasFocus()) {
                return _id;
            }
            ++_id;
        }
        return -1;
    }

void omni::ui::ParameterWidget::focusLast ( )

slot

Set focus on last widget in parameter list.

                                    {
        focus(layout()->count()-1);
    }

bool omni::ui::ParameterWidget::focusNext ( bool  _circular = false )

slot

Put focus on next element.

Parameters

_circular

Selects first parameter when last parameter has been reached

Returns

True if last parameter has been reached, always returns true when in circular mode

                                                  {
        int _focusId = focusId();

        if (_focusId != -1) {
            int _nextFocusId = _focusId + 1;
            if (_nextFocusId >= layout()->count()) {
                _nextFocusId = _circular ? firstFocusId() : layout()->count() - 1;
            }
            auto _param = layout()->itemAt(_nextFocusId)->widget();
            _param->setFocus();
            return _focusId != _nextFocusId;
        }
        return false;
    }

bool omni::ui::ParameterWidget::focusPrev ( bool  _circular = false )

slot

Put focus on prev element.

Parameters

_circular

Selects last parameter when first parameter has been reached

Returns

True if first parameter has been reached, always returns true when in circular mode

                                                  {
        int _focusId = focusId();

        if (_focusId != -1) {
            int _prevFocus = _focusId - 1;
            if (_prevFocus < firstFocusId()) {
                _prevFocus = _circular ? layout()->count() - 1 : firstFocusId();
            }
            auto _param = layout()->itemAt(_prevFocus)->widget();
            _param->setFocus();
            return _focusId != _prevFocus;
        }
        return false;
    }

bool omni::ui::ParameterWidget::getParamAsBool ( QString const &  _str ) const

slot

Utility method for retrieving the value from checkbox with id.

    {
      auto* _widget = static_cast<QCheckBox*>(this->parameterMap_.at(_str));
      if (!_widget) return false;
      return _widget->isChecked();
    }

double omni::ui::ParameterWidget::getParamAsFloat ( QString const &  _str ) const

slot

Utility method for retrieving the value from a slider with id.

    {
      auto* _widget = static_cast<RangedFloat*>(this->parameterMap_.at(_str));
      if (!_widget) return 0.0;


      return _widget->value();
    }

int omni::ui::ParameterWidget::getParamAsInt ( QString const &  _str ) const

slot

Utility method for retrieving the value from a slider with id.

    {
      auto* _widget = static_cast<RangedInt*>(this->parameterMap_.at(_str));
      if (!_widget) return 0;
      return _widget->value();
    }

QWidget * omni::ui::ParameterWidget::getWidget ( QString const &  _id )

slot

Get parameter widget from parameter map with Id.

    {
      if (!parameterMap_.count(_id)) return nullptr;
      return parameterMap_[_id];
    }

void omni::ui::ParameterWidget::keyPressEvent ( QKeyEvent *  _event )

protected

                                                         {
          if (_event->key() == Qt::Key_Up) {
              focusPrev(false);
          }
          if (_event->key() == Qt::Key_Down) {
              focusNext(false);
          }
      }

void omni::ui::ParameterWidget::parametersUpdated ( )

signal

void omni::ui::ParameterWidget::setParamAsFloat ( QString const &  _str, double  _value  )

slot

Set slider value from given value.

    {
      auto* _widget = static_cast<RangedFloat*>(this->parameterMap_.at(_str));
      if (!_widget) return;

      _widget->setValue(_value);
    }

void omni::ui::ParameterWidget::setParamAsInt ( QString const &  _str, int  _value  )

slot

Set slider value from given value.

    {
      auto* _widget = static_cast<RangedInt*>(this->parameterMap_.at(_str));
      if (!_widget) return;

      _widget->setValue(_value);
    }

void omni::ui::ParameterWidget::setParametersVisible ( bool  _visible )

slot

Show / hide parameter widgets.

    {
      for (auto& _parameter : parameters_)
        _parameter->setVisible(_visible);
    }

void omni::ui::ParameterWidget::setScale ( float  _scale )

virtualslot

Set slider ranges.

                                               {
        mixin::Scale<omni::ui::RangedFloat>::setScale(_scale);
    }

void omni::ui::ParameterWidget::setUnit ( QString const &  _unitAbbr )

virtualslot

Set slider ranges.

                                                          {
        mixin::Scale<omni::ui::RangedFloat>::setSuffix(_unitAbbr);
    }

void omni::ui::ParameterWidget::updateParameters ( )

virtualslot

    {
      emit parametersUpdated();
    }

Field Documentation

std::map<QString, QWidget *> omni::ui::ParameterWidget::parameterMap_

protected

Slider widgets, sorted by their label.

std::vector<QUniquePtr<QWidget> > omni::ui::ParameterWidget::parameters_

protected

Slider parameter widgets.

---

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

• include/omni/ui/ParameterWidget.h
• src/lib/ui/ParameterWidget.cpp