omni::ui::Dial Class Reference

Circular dial widget with range value and editor. More...

#include <Dial.h>

Inheritance diagram for omni::ui::Dial:

Collaboration diagram for omni::ui::Dial:

Public Types
typedef mixin::Editor< Dial, QDoubleSpinBox >	mixin_editor_type
	Editor mixin type. More...
typedef mixin::RangedValue < Dial, double >	mixin_range_type
	Ranged value mixin type. More...
typedef mixin_range_type::value_type	value_type
Public Types inherited from omni::ui::mixin::RangedValue< Dial, double >
typedef Range< double >	range_type
typedef Step< double >	step_type
typedef double	value_type
Public Types inherited from omni::ui::mixin::Range< double >
typedef double	value_type
Public Types inherited from omni::ui::mixin::Step< double >
typedef double	value_type

Public Slots
void	setShowTicks (bool)
	Set show ticks. More...
void	setSuffix (QString const &)
	Set suffix string. More...
void	setLetter (QChar)
	Set letter. More...
void	setSingleStep (double)
	Set single step value. More...
void	setPageStep (double)
	Set page step value. More...
void	setMinimum (double)
	Set minimum value. More...
void	setMaximum (double)
	Set maximum value. More...
void	setRange (double, double)
	Set range. More...
void	setValue (int)
	Set value from integer. More...
void	setValue (double)
	Set value. More...
void	setEditorVisible (bool)
	Set visibility of editor. More...

Signals
void	valueChanged ()
void	rangeChanged ()

Public Member Functions
	Dial (QWidget *=nullptr)
	Construct with optional parent widget. More...
	Dial (value_type _value, value_type _minimum, value_type _maximum, QWidget *=nullptr)
	Construct with value and minimum and maximum values. More...
	~Dial ()
	Destructor. More...
QString const &	suffix () const
	Return suffix string. More...
QChar	letter () const
	Return letter shown in background. More...
ColorSet const &	colorSet () const
	Return color set. More...
bool	isMoving () const
	Is moving when mouse button is pressed. More...
bool	showTicks () const
	Show ticks. More...
Public Member Functions inherited from omni::ui::mixin::RangedValue< Dial, double >
	RangedValue ()
	Default constructor. More...
	RangedValue (value_type _value, value_type _minimum, value_type _maximum, value_type _singleStep=1.0, value_type _pageStep=10.0)
	Constructor from user defined value and range. More...
qreal	ratio () const
	Returns ratio of current value. More...
value_type	value () const
	Return value. More...
value_type	defaultValue () const
	Return default value. More...
value_type	pivot () const
	Return pivot value. More...
void	increase ()
	Increate value by single step value. More...
void	decrease ()
	Decrease value by single step value. More...
void	setValue (value_type _value)
	Set new value and emit value changed event. More...
void	reset ()
	Reset value to default value. More...
void	setDefaultValue (value_type _value)
	Set new default value. More...
void	setPivot (value_type _pivot)
	Set pivot value (0.0 by default) More...
Public Member Functions inherited from omni::ui::mixin::Range< double >
	Range (value_type _minimum=0.0, value_type _maximum=100.0)
qreal	ratio (value_type _v) const
	Return ratio of value v. More...
value_type	range () const
	Return range (difference between maximum and minimum) More...
value_type	minimum () const
	Return minimum value. More...
value_type	maximum () const
	Return maximum value. More...
void	setMinimum (value_type _minimum)
	Set new minimum value and value and emit rangeChanged event. More...
void	disableMinimum ()
	Disable minimum by setting the value to infinite. More...
void	setMaximum (value_type _maximum)
	Set new maximum value and value and emit rangeChanged event. More...
void	disableMaximum ()
	Disable maximum by setting maximum to infinite value. More...
void	setRange (value_type _minimum, value_type _maximum)
	Set range and validate. More...
void	disableRange ()
	Disable range by setting minimum and maximum to infinite value. More...
bool	minimumUsed () const
bool	maximumUsed () const
Public Member Functions inherited from omni::ui::mixin::Step< double >
	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
void	resizeEvent (QResizeEvent *)
	Re-paint on resize. More...
void	paintEvent (QPaintEvent *)
void	mousePressEvent (QMouseEvent *)
void	mouseReleaseEvent (QMouseEvent *)
void	mouseMoveEvent (QMouseEvent *)
void	mouseDoubleClickEvent (QMouseEvent *)
	Double click in center shows editor, double click on border reset to default value. More...
void	keyPressEvent (QKeyEvent *)
	Show editor when enter key is pressed. More...
void	valueChangedEvent ()
	Value changed event which is emitted on changed value. More...
void	rangeChangedEvent ()
	Handler to emit rangeChanged signal in derived widgets. More...
Protected Member Functions inherited from omni::ui::mixin::RangedValue< Dial, double >
void	apply (WIDGET *_widget) const
	Apply ranged value to widget. More...
void	for_each_step (F f)
	Functor to apply for each step. More...
void	validate ()
	Validate minimum, maximum and value. More...
Protected Member Functions inherited from omni::ui::mixin::Range< double >
void	apply (WIDGET *_widget) const
	Apply range to widget. More...
void	apply (WIDGET *_widget, V _value) const
	Applay range to widget and set value. More...
Protected Member Functions inherited from omni::ui::mixin::Step< double >
void	for_each_step (MIN _min, MAX _max, F f)
	Functor to be applied for each step between min and maximum. More...
Protected Member Functions inherited from omni::ui::mixin::Editor< Dial, QDoubleSpinBox >
	Editor (widget_type *_widget)
T *	createEditor ()
	Create editor with type. More...
editor_type const *	editor () const
	Return pointer editor (const version) More...
editor_type *	editor ()
	Return pointer editor. More...
T *	editorAs ()
	Return editor as type T. More...
T const *	editorAs () const
	Return editor as type T (const version) More...
virtual void	setEditorVisible (bool _visible)
	Set editor visibility and set focus. More...
void	showEditor ()
	Show editor and set focus. More...
void	hideEditor ()
	Hide editor. More...

Private Member Functions
void	init ()
void	editorSetup ()
double	radius () const
double	getValue (QPoint const &)
	Get value from point on widget. More...
void	paintTick (QPainter &, double _value, double _length)
	Draw a tick with value and length. More...

Private Attributes
bool	isMoving_ = false
bool	showTicks_ = true
QChar	letter_ = 'X'
QString	suffix_
QLabel *	valueLabel_
ColorSet	colorSet_
QPointF	pos_

Additional Inherited Members
Protected Types inherited from omni::ui::mixin::Editor< Dial, QDoubleSpinBox >
typedef Dial	widget_type
	Widget type. More...
typedef QDoubleSpinBox	editor_type
	Editor widget type, e.g. QDoubleSpinBox. More...

Detailed Description

Circular dial widget with range value and editor.

Member Typedef Documentation

typedef mixin::Editor<Dial, QDoubleSpinBox> omni::ui::Dial::mixin_editor_type

Editor mixin type.

typedef mixin::RangedValue<Dial, double> omni::ui::Dial::mixin_range_type

Ranged value mixin type.

typedef mixin_range_type::value_type omni::ui::Dial::value_type

Constructor & Destructor Documentation

omni::ui::Dial::Dial

(

QWidget *

_parent = nullptr

)

Construct with optional parent widget.

                                   :
            QWidget(_parent),
            mixin_range_type(0, 0, 100),
            mixin_editor_type(this),
            colorSet_(this)
        {
            init();
        }

omni::ui::Dial::Dial	(	value_type	_value,
		value_type	_minimum,
		value_type	_maximum,
		QWidget *	_parent = nullptr
	)

Construct with value and minimum and maximum values.

                                       :
            QWidget(_parent),
            mixin_range_type(_value, _minimum, _maximum),
            mixin_editor_type(this),
            colorSet_(this)
        {
            init();
        }

omni::ui::Dial::~Dial

(

)

Destructor.

        {}

Member Function Documentation

ColorSet const & omni::ui::Dial::colorSet

(

)

const

Return color set.

        {
            return colorSet_;
        }

void omni::ui::Dial::editorSetup ( )

privatevirtual

Implements omni::ui::mixin::Editor< Dial, QDoubleSpinBox >.

                               {
            auto _editor = this->editorAs<editor_type>();

            connect(_editor, SIGNAL(valueChanged(double)), this,
                    SLOT(setValue(double)));
            _editor->setFrame(false);
            _editor->setAlignment(Qt::AlignRight);
            _editor->setButtonSymbols(QAbstractSpinBox::PlusMinus);
            mixin_range_type::apply(_editor);
            valueChangedEvent();
        }

double omni::ui::Dial::getValue ( QPoint const &  _point )

private

Get value from point on widget.

        {
            auto  _v     = QVector2D(_point - rect().center()).normalized();
            float _angle = atan2(_v.x(), -_v.y()) / M_PI * 0.5;

            _angle = (_angle + 0.5) * (maximum() - minimum()) + minimum();
            return _angle;
        }

void omni::ui::Dial::init ( )

private

        {
            setMinimumSize(32 / devicePixelRatio(), 96 / devicePixelRatio());
            setMaximumSize(16000, 320 / devicePixelRatio());

            valueLabel_ = new QLabel(this);
            valueLabel_->setAlignment(Qt::AlignCenter);
            valueLabel_->setStyleSheet("background : transparent; color: #808080;");

            mixin_editor_type::createEditor<>();

            valueChangedEvent();
        }

bool omni::ui::Dial::isMoving

(

)

const

Is moving when mouse button is pressed.

        {
            return isMoving_;
        }

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

protected

Show editor when enter key is pressed.

                                                  {
            if (((_event->key() == Qt::Key_Enter) ||
                 (_event->key() == Qt::Key_Return)))
            {
                setEditorVisible(!editor()->hasFocus());
            }

            float _step = singleStep();

            if (_event->modifiers() & Qt::ShiftModifier) {
                _step = 1.0;
            }
            if (_event->modifiers() & Qt::ControlModifier) {
                _step = pageStep();
            }

            if (_event->key() == Qt::Key_Left) {
                setValue(value() - _step);
            }
            if (_event->key() == Qt::Key_Right) {
                setValue(value() + _step);
            }
        }

QChar omni::ui::Dial::letter

(

)

const

Return letter shown in background.

void omni::ui::Dial::mouseDoubleClickEvent ( QMouseEvent *  event )

protected

Double click in center shows editor, double click on border reset to default value.

        {
            float _d = QVector2D(rect().center() - event->pos()).length();

            if ((_d < radius()) && (_d > radius()*0.6)) {
                setValue(minimum());
            }
            // Show editor when click in the middle
            if (_d < radius()*0.4) {
                setEditorVisible(!editor()->isVisible());
            } else {
                setEditorVisible(false);
            }
        }

void omni::ui::Dial::mouseMoveEvent ( QMouseEvent *  e )

protected

        {
            if (isMoving_)
            {
                if (!minimumUsed() || !maximumUsed())
                {
                    auto _center = rect().center();

                    if ((pos_.x() > _center.x()) &&
                        (e->pos().x() <= _center.x()) &&
                        (e->pos().y() > _center.y()))
                    {
                        mixin_range_type::setValue(
                            value() + mixin_range_type::range());
                    }

                    if ((pos_.x() <= _center.x()) &&
                        (e->pos().x() > _center.x()) &&
                        (e->pos().y() > _center.y()))
                    {
                        mixin_range_type::setValue(
                            value() - mixin_range_type::range());
                    }
                }

                pos_ = e->pos();
                setValue(getValue(e->pos()));
            }
        }

void omni::ui::Dial::mousePressEvent ( QMouseEvent *  e )

protected

        {
            setFocus();

            float _d = QVector2D(rect().center() - e->pos()).length();
            isMoving_ = (_d < radius()) && (_d > radius()*0.6);

            if (isMoving_)
            {
                pos_ = e->pos();
                setValue(getValue(e->pos()));
            }
        }

void omni::ui::Dial::mouseReleaseEvent ( QMouseEvent *  e )

protected

        {
            if (isMoving_)
            {
                pos_ = e->pos();
                setValue(getValue(e->pos()));
            }
            isMoving_ = false;
        }

void omni::ui::Dial::paintEvent ( QPaintEvent *  e )

protected

        {
            auto && _rect = rect();
            QPointF _center = _rect.center();

            double   _r = radius() - radius() / 50.0;
            QPainter _p(this);
            _p.setRenderHint(QPainter::Antialiasing);
            _p.setBrush(colorSet().button());
            _p.setPen(hasFocus() ? QPen(colorSet().dark(),
                                        radius() / 50.0) : Qt::NoPen);

            _p.drawEllipse(_center, _r, _r);

            QPainterPath _ellipsePath, _piePath;
            _ellipsePath.addEllipse(_center, _r,        _r);
            _ellipsePath.addEllipse(_center, _r * 0.75, _r * 0.75);
            auto && _pieRect = _ellipsePath.boundingRect().adjusted(-2, -2, 2, 2);

            _p.setBrush(
                hasFocus() ?
                colorSet().highlight() :
                colorSet().dark());

            QPainterPath _arc(_center);
            _arc.arcTo(_pieRect, -90, -ratio() * 360);
            _arc.lineTo(_center);
            _arc.closeSubpath();

            _piePath = _arc & _ellipsePath;
            _p.drawPath(_piePath);

            if (showTicks())
            {
                mixin_range_type::for_each_step([&](int _step, double i,
                                                    bool _isPage)
                {
                    _p.setPen(QPen(i >= mixin_range_type::value() ?
                                   colorSet().shadow() :
                                   colorSet().windowText(), 1));
                    paintTick(_p, i, _isPage ? 0.25 : 0.125);
                });
            }

            _p.setPen(QPen(colorSet().shadow(), _r / 50.0));
            paintTick(_p, mixin_range_type::value(), 0.333);
            paintTick(_p, 0.0,                       0.25);


            // Draw big letter in the middle
            _p.setPen(QPen(QColor("#3d3d3d"), 2));
            QFont _font = font();
            _font.setPixelSize(_r);
            _p.setFont(_font);
            _p.drawText(_rect, Qt::AlignCenter, letter_);
        }

void omni::ui::Dial::paintTick ( QPainter &  _p, double  _value, double  _length  )

private

Draw a tick with value and length.

        {
            auto && _rect = rect();
            auto _center = QVector2D(_rect.center());

            auto _theta = mixin::Range<value_type>::ratio(_value) * M_PI * 2.0;

            QVector2D _a(-sin(_theta), cos(_theta));
            _a *= radius() - radius() / 50.0;
            QVector2D _b = _a * (1.0 - _length);
            _a += _center;
            _b += _center;

            _p.drawLine(_a.toPointF(), _b.toPointF());
        }

double omni::ui::Dial::radius ( ) const

private

        {
            double _r = width() > height() ? height() : width();

            return _r * 0.5;
        }

void omni::ui::Dial::rangeChanged ( )

signal

void omni::ui::Dial::rangeChangedEvent ( )

protectedvirtual

Handler to emit rangeChanged signal in derived widgets.

Reimplemented from omni::ui::mixin::Range< double >.

        {
            emit rangeChanged();

            update();
        }

void omni::ui::Dial::resizeEvent ( QResizeEvent *  e )

protected

Re-paint on resize.

        {
            valueLabel_->setGeometry(rect());
            if (editor()) {
                editor()->move(rect().center() -
                    QPoint(editor()->width()*0.5,editor()->height()*0.5));
            }
        }

void omni::ui::Dial::setEditorVisible ( bool  _visible )

slot

Set visibility of editor.

        {
            mixin_editor_type::setEditorVisible(_visible);

            valueLabel_->setVisible(!_visible);

            if (!_visible)
            {
                setFocus();
                return;
            }
        }

void omni::ui::Dial::setLetter ( QChar  c )

slot

Set letter.

        {
            letter_ = c;
            update();
        }

void omni::ui::Dial::setMaximum ( double  _max )

slot

Set maximum value.

        {
            mixin_range_type::setMaximum(_max);
        }

void omni::ui::Dial::setMinimum ( double  _min )

slot

Set minimum value.

        {
            mixin_range_type::setMinimum(_min);
        }

void omni::ui::Dial::setPageStep ( double  _pageStep )

slot

Set page step value.

        {
            mixin_range_type::setPageStep(_pageStep);

            update();
        }

void omni::ui::Dial::setRange ( double  _min, double  _max  )

slot

Set range.

        {
            mixin_range_type::setRange(_min, _max);
        }

void omni::ui::Dial::setShowTicks ( bool  _showTicks )

slot

Set show ticks.

        {
            showTicks_ = _showTicks;
            update();
        }

void omni::ui::Dial::setSingleStep ( double  _singleStep )

slot

Set single step value.

        {
            mixin_range_type::setSingleStep(_singleStep);

            update();
        }

void omni::ui::Dial::setSuffix ( QString const &  _s )

slot

Set suffix string.

        {
            suffix_ = _s;
            valueLabel_->setText(QString("%1%2").arg(int(value())).arg(suffix()));
            update();
        }

void omni::ui::Dial::setValue ( int  _value )

slot

Set value from integer.

        {
            mixin_range_type::setValue(_value);
        }

void omni::ui::Dial::setValue ( double  _value )

slot

Set value.

        {
            mixin_range_type::setValue(_value);
        }

bool omni::ui::Dial::showTicks

(

)

const

Show ticks.

        {
            return showTicks_;
        }

QString const & omni::ui::Dial::suffix

(

)

const

Return suffix string.

        {
            return suffix_;
        }

void omni::ui::Dial::valueChanged ( )

signal

void omni::ui::Dial::valueChangedEvent ( )

protectedvirtual

Value changed event which is emitted on changed value.

Reimplemented from omni::ui::mixin::RangedValue< Dial, double >.

        {
            valueLabel_->setText(QString("%1%2").arg(int(value())).arg(suffix()));
            emit valueChanged();
            update();
        }

Field Documentation

ColorSet omni::ui::Dial::colorSet_

private

bool omni::ui::Dial::isMoving_ = false

private

QChar omni::ui::Dial::letter_ = 'X'

private

QPointF omni::ui::Dial::pos_

private

bool omni::ui::Dial::showTicks_ = true

private

QString omni::ui::Dial::suffix_

private

QLabel* omni::ui::Dial::valueLabel_

private

---

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

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