KisAngleGauge Class Reference

A circular widget that allows to choose an angle. More...

#include <KisAngleGauge.h>

Inheritance diagram for KisAngleGauge:

Classes
struct	Private

Public Types
enum	IncreasingDirection { IncreasingDirection_CounterClockwise , IncreasingDirection_Clockwise }

Public Slots
void	reset ()
	Sets the current angle to the reset angle.
void	setAngle (qreal newAngle)
	Sets the current angle.

Signals
void	angleChanged (qreal angle)
	Signal emitted when the angle has changed.

Public Member Functions
qreal	angle () const
	Gets the current angle.
IncreasingDirection	increasingDirection () const
	Gets the direction in which the angle increases.
	KisAngleGauge (QWidget *parent=0)
	Construct a new KisAngleGauge widget.
qreal	resetAngle () const
	Gets the angle that is used to reset the current angle.
void	setIncreasingDirection (IncreasingDirection newIncreasingDirection)
	Sets the increasing direction.
void	setResetAngle (qreal newResetAngle)
	Sets the angle that is used to reset the current angle.
void	setSnapAngle (qreal newSnapAngle)
	Sets the angle to which multiples the selected angle will snap.
qreal	snapAngle () const
	Gets the angle to which multiples the selected angle will snap.
	~KisAngleGauge ()

Protected Member Functions
void	enterEvent (QEnterEvent *e) override
void	keyPressEvent (QKeyEvent *e) override
void	leaveEvent (QEvent *e) override
void	mouseDoubleClickEvent (QMouseEvent *e) override
void	mouseMoveEvent (QMouseEvent *e) override
void	mousePressEvent (QMouseEvent *e) override
void	mouseReleaseEvent (QMouseEvent *e) override
void	paintEvent (QPaintEvent *e) override
void	wheelEvent (QWheelEvent *e) override

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

A circular widget that allows to choose an angle.

Definition at line 20 of file KisAngleGauge.h.

Member Enumeration Documentation

IncreasingDirection

enum KisAngleGauge::IncreasingDirection

Enumerator
IncreasingDirection_CounterClockwise
IncreasingDirection_Clockwise

Definition at line 25 of file KisAngleGauge.h.

    {
        IncreasingDirection_CounterClockwise,
        IncreasingDirection_Clockwise
    };

Constructor & Destructor Documentation

KisAngleGauge()

KisAngleGauge::KisAngleGauge ( QWidget * parent = 0 )

explicit

Construct a new KisAngleGauge widget.

Parameters

parent

the parent widget

Definition at line 26 of file KisAngleGauge.cpp.

    : QWidget(parent)
    , m_d(new Private)
{
    m_d->angle = 0.0;
    m_d->snapAngle = 15.0;
    m_d->resetAngle = 0.0;
    m_d->increasingDirection = IncreasingDirection_CounterClockwise;
    m_d->isPressed = false;
    m_d->isMouseHover = false;
    
    setFocusPolicy(Qt::WheelFocus);
}

References IncreasingDirection_CounterClockwise, and m_d.

~KisAngleGauge()

KisAngleGauge::~KisAngleGauge

(

)

Definition at line 40 of file KisAngleGauge.cpp.

{}

Member Function Documentation

angle()

qreal KisAngleGauge::angle

(

)

const

Gets the current angle.

Returns

The current angle

See also

setAngle(qreal)

Definition at line 43 of file KisAngleGauge.cpp.

{
    return m_d->angle;
}

References m_d.

angleChanged

void KisAngleGauge::angleChanged ( qreal angle )

signal

Signal emitted when the angle has changed.

Parameters

angle

The new angle

enterEvent()

void KisAngleGauge::enterEvent ( QEnterEvent * e )

overrideprotected

Definition at line 311 of file KisAngleGauge.cpp.

{
    m_d->isMouseHover = true;
    update();
    QWidget::enterEvent(e);
}

increasingDirection()

KisAngleGauge::IncreasingDirection KisAngleGauge::increasingDirection

(

)

const

Gets the direction in which the angle increases.

Returns

The direction in which the angle increases

See also

IncreasingDirection

setIncreasingDirection(IncreasingDirection)

Definition at line 58 of file KisAngleGauge.cpp.

{
    return m_d->increasingDirection;
}

References m_d.

keyPressEvent()

void KisAngleGauge::keyPressEvent ( QKeyEvent * e )

overrideprotected

Definition at line 287 of file KisAngleGauge.cpp.

{
    if (e->key() == Qt::Key_Up || e->key() == Qt::Key_Right) {
        if (e->modifiers() & Qt::ControlModifier) {
            setAngle(std::floor((m_d->angle + m_d->snapAngle) / m_d->snapAngle) * m_d->snapAngle);
        } else {
            setAngle(m_d->angle + 1.0);
        }
        e->accept();
    } else if (e->key() == Qt::Key_Down || e->key() == Qt::Key_Left) {
        if (e->modifiers() & Qt::ControlModifier) {
            setAngle(std::ceil((m_d->angle - m_d->snapAngle) / m_d->snapAngle) * m_d->snapAngle);
        } else {
            setAngle(m_d->angle - 1.0);
        }
        e->accept();
    } else {
        e->ignore();
    }
}

References m_d, and setAngle().

leaveEvent()

void KisAngleGauge::leaveEvent ( QEvent * e )

overrideprotected

Definition at line 319 of file KisAngleGauge.cpp.

{
    m_d->isMouseHover = false;
    update();
    QWidget::leaveEvent(e);
}

References m_d.

mouseDoubleClickEvent()

void KisAngleGauge::mouseDoubleClickEvent ( QMouseEvent * e )

overrideprotected

Definition at line 259 of file KisAngleGauge.cpp.

{
    if (e->button() == Qt::LeftButton) {
        reset();
        e->accept();
    } else {
        e->ignore();
    }
}

References reset().

mouseMoveEvent()

void KisAngleGauge::mouseMoveEvent ( QMouseEvent * e )

overrideprotected

Definition at line 226 of file KisAngleGauge.cpp.

{
    if (!(e->buttons() & Qt::LeftButton) || !m_d->isPressed) {
        e->ignore();
        return;
    }
 
    const QPointF center(width() / 2.0, height() / 2.0);
    const qreal radius = std::min(center.x(), center.y());
    const qreal radiusSquared = radius * radius;
    const QPointF delta(e->x() - center.x(), e->y() - center.y());
    const qreal distanceSquared = delta.x() * delta.x() + delta.y() * delta.y();
    qreal angle =
        std::atan2(
            m_d->increasingDirection == IncreasingDirection_CounterClockwise ? -delta.y() : delta.y(),
            delta.x()
        ) * 180.0 / M_PI;
 
    const qreal snapDistance = qMax(m_d->minimumSnapDistance * m_d->minimumSnapDistance, radiusSquared * 4.0);
    const bool controlPressed = e->modifiers() & Qt::ControlModifier;
    const bool shiftPressed = e->modifiers() & Qt::ShiftModifier;
 
    if (controlPressed && shiftPressed) {
        angle = std::round(angle);
    } else if (!shiftPressed && (controlPressed || distanceSquared < snapDistance)) {
        angle = std::round(angle / m_d->snapAngle) * m_d->snapAngle;
    }
 
    setAngle(angle);
    
    e->accept();
}

References angle(), IncreasingDirection_CounterClockwise, m_d, M_PI, and setAngle().

mousePressEvent()

void KisAngleGauge::mousePressEvent ( QMouseEvent * e )

overrideprotected

Definition at line 180 of file KisAngleGauge.cpp.

{
    if (e->button() != Qt::LeftButton) {
        e->ignore();
        return;
    }
 
    const QPointF center(width() / 2.0, height() / 2.0);
    const qreal radius = std::min(center.x(), center.y());
    const qreal radiusSquared = radius * radius;
    const QPointF delta(e->x() - center.x(), e->y() - center.y());
    const qreal distanceSquared = delta.x() * delta.x() + delta.y() * delta.y();
 
    if (distanceSquared > radiusSquared) {
        e->ignore();
        return;
    }
 
    qreal angle =
        std::atan2(
            m_d->increasingDirection == IncreasingDirection_CounterClockwise ? -delta.y() : delta.y(),
            delta.x()
        );
    
    if (e->modifiers() & Qt::ControlModifier)  {
        const qreal sa = m_d->snapAngle * M_PI / 180.0;
        angle = std::round(angle / sa) * sa;
    }
 
    setAngle(angle * 180.0 / M_PI);
 
    m_d->isPressed = true;
    
    e->accept();
}

References angle(), IncreasingDirection_CounterClockwise, m_d, M_PI, and setAngle().

mouseReleaseEvent()

void KisAngleGauge::mouseReleaseEvent ( QMouseEvent * e )

overrideprotected

Definition at line 216 of file KisAngleGauge.cpp.

{
    if (e->button() == Qt::LeftButton && m_d->isPressed) {
        m_d->isPressed = false;
        e->accept();
        return;
    }
    e->ignore();
}

References m_d.

paintEvent()

void KisAngleGauge::paintEvent ( QPaintEvent * e )

overrideprotected

Definition at line 95 of file KisAngleGauge.cpp.

{
    QPainter painter(this);
    const QPointF center(width() / 2.0, height() / 2.0);
    const qreal minSide = std::min(center.x(), center.y());
    const qreal radius = minSide * 0.9;
    const qreal lineMarkerRadius = minSide * 0.1;
    const qreal angleInRadians = m_d->angle * M_PI / 180.0;
    const QPointF d(
        center.x() + std::cos(angleInRadians) * radius,
        m_d->increasingDirection == IncreasingDirection_CounterClockwise
        ? center.y() - std::sin(angleInRadians) * radius
        : center.y() + std::sin(angleInRadians) * radius
    );
 
    painter.setRenderHint(QPainter::Antialiasing, true);
 
    QColor backgroundColor, circleColor, axesColor, angleLineColor, angleLineMarkerColor;
    if (palette().color(QPalette::Window).lightness() < 128) {
        circleColor = palette().color(QPalette::Light);
        axesColor = palette().color(QPalette::Light);
        axesColor.setAlpha(200);
        if (isEnabled()) {
            backgroundColor = palette().color(QPalette::Dark);
            angleLineColor = QColor(255, 255, 255, 128);
            angleLineMarkerColor = QColor(255, 255, 255, 200);
        } else {
            backgroundColor = palette().color(QPalette::Window);
            angleLineColor = palette().color(QPalette::Light);
            angleLineMarkerColor = palette().color(QPalette::Light);
        }
    } else {
        circleColor = palette().color(QPalette::Dark);
        axesColor = palette().color(QPalette::Dark);
        axesColor.setAlpha(200);
        if (isEnabled()) {
            backgroundColor = palette().color(QPalette::Light);
            angleLineColor = QColor(0, 0, 0, 128);
            angleLineMarkerColor = QColor(0, 0, 0, 200);
        } else {
            backgroundColor = palette().color(QPalette::Window);
            angleLineColor = palette().color(QPalette::Dark);
            angleLineMarkerColor = palette().color(QPalette::Dark);
        }
    }
 
    // Background
    painter.setPen(Qt::transparent);
    painter.setBrush(backgroundColor);
    painter.drawEllipse(center, radius, radius);
 
    // Axes lines
    painter.setPen(QPen(axesColor, 1.0, Qt::DotLine));
    painter.drawLine(center.x(), center.y() - radius + 1.0, center.x(), center.y() + radius - 1.0);
    painter.drawLine(center.x() - radius + 1.0, center.y(), center.x() + radius - 1.0, center.y());
 
    // Outer circle
    if (this->hasFocus()) {
        painter.setPen(QPen(palette().color(QPalette::Highlight), 2.0));
    } else {
        if (m_d->isMouseHover && isEnabled()) {
            painter.setPen(QPen(palette().color(QPalette::Highlight), 1.0));
        } else {
            painter.setPen(QPen(circleColor, 1.0));
        }
    }
    painter.setBrush(Qt::transparent);
    painter.drawEllipse(center, radius, radius);
 
    // Angle line
    painter.setPen(QPen(angleLineColor, 1.0));
    painter.drawLine(center, d);
 
    // Inner line marker
    painter.setPen(Qt::transparent);
    painter.setBrush(angleLineMarkerColor);
    painter.drawEllipse(center, lineMarkerRadius, lineMarkerRadius);
 
    // Outer line marker
    painter.setBrush(angleLineMarkerColor);
    painter.drawEllipse(d, lineMarkerRadius, lineMarkerRadius);
 
    e->accept();
}

References IncreasingDirection_CounterClockwise, m_d, M_PI, and palette.

reset

void KisAngleGauge::reset ( )

slot

Sets the current angle to the reset angle.

See also

resetAngle() const

setResetAngle(qreal) const

Definition at line 90 of file KisAngleGauge.cpp.

{
    setAngle(resetAngle());
}

References resetAngle(), and setAngle().

resetAngle()

qreal KisAngleGauge::resetAngle

(

)

const

Gets the angle that is used to reset the current angle.

This angle is used when the user double clicks on the widget

Returns

The angle that is used to reset the current angle

See also

setResetAngle(qreal)

Definition at line 53 of file KisAngleGauge.cpp.

{
    return m_d->resetAngle;
}

References m_d.

setAngle

void KisAngleGauge::setAngle ( qreal newAngle )

slot

Sets the current angle.

Parameters

newAngle

the new angle

See also

angle() const

Definition at line 63 of file KisAngleGauge.cpp.

{
    if (qFuzzyCompare(newAngle, m_d->angle)) {
        return;
    }
 
    m_d->angle = newAngle;
    update();
    Q_EMIT angleChanged(newAngle);
}

References angleChanged(), m_d, and qFuzzyCompare().

setIncreasingDirection()

void KisAngleGauge::setIncreasingDirection

(

IncreasingDirection

newIncreasingDirection

)

Sets the increasing direction.

Parameters

newIncreasingDirection

The new increasing direction

See also

IncreasingDirection

increasingDirection() const

Definition at line 84 of file KisAngleGauge.cpp.

{
    m_d->increasingDirection = newIncreasingDirection;
    update();
}

References m_d.

setResetAngle()

void KisAngleGauge::setResetAngle

(

qreal

newResetAngle

)

Sets the angle that is used to reset the current angle.

Parameters

newResetAngle

the new angle that is used to reset the current angle

See also

resetAngle() const

Definition at line 79 of file KisAngleGauge.cpp.

{
    m_d->resetAngle = newResetAngle;
}

References m_d.

setSnapAngle()

void KisAngleGauge::setSnapAngle

(

qreal

newSnapAngle

)

Sets the angle to which multiples the selected angle will snap.

Parameters

newSnapAngle

the new angle to which multiples the selected angle will snap

See also

snapAngle() const

Definition at line 74 of file KisAngleGauge.cpp.

{
    m_d->snapAngle = newSnapAngle;
}

References m_d.

snapAngle()

qreal KisAngleGauge::snapAngle

(

)

const

Gets the angle to which multiples the selected angle will snap.

The default snap angle is 15 degrees so the selected angle will snap to its multiples (0, 15, 30, 45, etc.)

Returns

The angle to which multiples the selected angle will snap

See also

setSnapAngle(qreal)

Definition at line 48 of file KisAngleGauge.cpp.

{
    return m_d->snapAngle;
}

References m_d.

wheelEvent()

void KisAngleGauge::wheelEvent ( QWheelEvent * e )

overrideprotected

Definition at line 269 of file KisAngleGauge.cpp.

{
    if (e->angleDelta().y() > 0) {
        if (e->modifiers() & Qt::ControlModifier) {
            setAngle(std::floor((m_d->angle + m_d->snapAngle) / m_d->snapAngle) * m_d->snapAngle);
        } else {
            setAngle(m_d->angle + 1.0);
        }
    } else if (e->angleDelta().y() < 0) {
        if (e->modifiers() & Qt::ControlModifier) {
            setAngle(std::ceil((m_d->angle - m_d->snapAngle) / m_d->snapAngle) * m_d->snapAngle);
        } else {
            setAngle(m_d->angle - 1.0);
        }
    }
    e->accept();
}

References m_d, and setAngle().

Member Data Documentation

m_d

const QScopedPointer<Private> KisAngleGauge::m_d

private

Definition at line 126 of file KisAngleGauge.h.

---

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

• libs/widgets/KisAngleGauge.h
• libs/widgets/KisAngleGauge.cpp