A wrapper around KisAngleSelector, a widget with several options to select an angle. The widget itself is accessed with the widget() function. More...

#include <AngleSelector.h>

Inheritance diagram for AngleSelector:

Public Slots
qreal	angle () const
	Gets the current angle.

qreal	closestCoterminalAngleInRange (qreal angle, bool *ok=nullptr) const
	Gets the closest coterminal angle to the provided angle that is in the range established.

static qreal	closestCoterminalAngleInRange (qreal angle, qreal minimum, qreal maximum, bool *ok=nullptr)
	Gets the closest coterminal angle to the provided angle that is in the range provided.

int	decimals () const
	Gets the number of decimals (precision) used by the angle.

void	flip (Qt::Orientations orientations)
	Flips the angle horizontally, vertically, or both.

static qreal	flipAngle (qreal angle, qreal minimum, qreal maximum, Qt::Orientations orientations, bool *ok=nullptr)
	Flips an angle horizontally, vertically, or both.

static qreal	flipAngle (qreal angle, Qt::Orientations orientations)
	Flips an angle horizontally, vertically, or both.

QString	flipOptionsMode () const
	Gets the mode in which the flip options should be shown.

QString	increasingDirection () const
	Gets the direction in which the angle increases in the angle gauge.

bool	isUsingFlatSpinBox () const
	Gets if the spin box is flat (no border or background)

qreal	maximum () const
	Gets the maximum value for the angle.

qreal	minimum () const
	Gets the minimum value for the angle.

QString	prefix () const
	Gets the prefix shown in the spin box.

void	reset ()
	Sets the current angle to the reset angle.

qreal	resetAngle () const
	Gets the angle that is used to reset the current angle.

void	setAngle (qreal newAngle)
	Sets the current angle.

void	setDecimals (int newNumberOfDecimals)
	Sets the number of decimals (precision) used by the angle.

void	setFlipOptionsMode (QString newMode)
	Sets the mode in which the flip options should be shown.

void	setIncreasingDirection (QString newIncreasingDirection)
	Sets the increasing direction in the angle gauge.

void	setMaximum (qreal newMaximum)
	Sets the maximum value for the angle.

void	setMinimum (qreal newMinimum)
	Sets the minimum value for the angle.

void	setPrefix (const QString &newPrefix)
	Sets the prefix shown in the spin box.

void	setRange (qreal newMinimum, qreal newMaximum)
	Sets the minimum and maximum values for the angle.

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.

void	setWidgetsHeight (int newHeight)
	Sets the common height of the widgets inside this angle selector. Use 0 to reset widgets to default height.

void	setWrapping (bool newWrapping)
	Sets if the angle should wrap pass the minimum or maximum angles.

qreal	snapAngle () const
	Gets the angle to which multiples the selected angle will snap.

void	useFlatSpinBox (bool newUseFlatSpinBox)
	Sets if the spin box should be flat.

QWidget *	widget () const
	Get the internal KisAngleSelector as a QWidget, so it may be added to a UI.

int	widgetsHeight () const
	Gets the common height of the widgets inside this angle selector.

bool	wrapping () const
	Gets if the angle should wrap pass the minimum or maximum angles.

Signals
void	angleChanged (qreal angle)

Public Member Functions
	AngleSelector ()

	~AngleSelector () override

Private Attributes
Private *const	d

Detailed Description

A wrapper around KisAngleSelector, a widget with several options to select an angle. The widget itself is accessed with the widget() function.

This widget is a combination of a KisAngleGauge and a spin box, along with some flipping options

Definition at line 21 of file AngleSelector.h.

Constructor & Destructor Documentation

◆ AngleSelector()

AngleSelector::AngleSelector ( )

explicit

Definition at line 29 of file AngleSelector.cpp.

    : QObject()
    , d(new Private)
{
    d->widget = new KisAngleSelector();
 
    // Forward KisAngleSelector::angleChanged to AngleSelector::angleChanged
    connect(d->widget, SIGNAL(angleChanged(qreal)), this, SIGNAL(angleChanged(qreal)));
}

References angleChanged(), connect(), d, and krita::AngleSelector::Private::widget.

◆ ~AngleSelector()

AngleSelector::~AngleSelector ( )

override

Definition at line 39 of file AngleSelector.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ angle

qreal AngleSelector::angle ( ) const

slot

Gets the current angle.

Returns: The current angle

See also: setAngle(qreal)

Definition at line 49 of file AngleSelector.cpp.

{
    return d->widget->angle();
}

References KisAngleSelector::angle(), d, and krita::AngleSelector::Private::widget.

◆ angleChanged

void AngleSelector::angleChanged ( qreal angle )

signal

◆ closestCoterminalAngleInRange [1/2]

qreal AngleSelector::closestCoterminalAngleInRange	(	qreal	angle,
		bool *	ok = nullptr ) const

slot

Gets the closest coterminal angle to the provided angle that is in the range established.

A coterminal angle to the provided angle is one that differs in size by an integer multiple of a turn (360 degrees)

Parameters

	angle	The reference angle for which the function will try to find a coterminal angle
[out]	ok	This parameter will be set to true if a coterminal angle exists in the specified range, or to false otherwise

Returns: The closest coterminal angle in the specified range if one exists, or the closest value in the range (the minimum or maximum) otherwise. If the reference angle is already in the range then it is returned

Definition at line 204 of file AngleSelector.cpp.

{
    return d->widget->closestCoterminalAngleInRange(angle, ok);
}

References angle(), KisAngleSelector::closestCoterminalAngleInRange(), d, and krita::AngleSelector::Private::widget.

◆ closestCoterminalAngleInRange [2/2]

qreal AngleSelector::closestCoterminalAngleInRange	(	qreal	angle,
		qreal	minimum,
		qreal	maximum,
		bool *	ok = nullptr )

staticslot

Gets the closest coterminal angle to the provided angle that is in the range provided.

A coterminal angle to the provided angle is one that differs in size by an integer multiple of a turn (360 degrees)

Parameters

	angle	The reference angle for which the function will try to find a coterminal angle
	minimum	The range's lower bound
	maximum	The range's upper bound
[out]	ok	This parameter will be set to true if a coterminal angle exists in the provided range, or to false otherwise

Returns: The closest coterminal angle in the provided range if one exists, or the closest value in the range (the minimum or maximum) otherwise. If the reference angle is already in the range then it is returned

Definition at line 199 of file AngleSelector.cpp.

{
    return KisAngleSelector::closestCoterminalAngleInRange(angle, minimum, maximum, ok);
}

References angle(), KisAngleSelector::closestCoterminalAngleInRange(), maximum(), and minimum().

◆ decimals

int AngleSelector::decimals ( ) const

slot

Gets the number of decimals (precision) used by the angle.

If you want to simulate integer angles, set it to 0. The default is 2.

Returns: The number of decimals being used

See also: setDecimals(int)

Definition at line 64 of file AngleSelector.cpp.

{
    return d->widget->decimals();
}

References d, KisAngleSelector::decimals(), and krita::AngleSelector::Private::widget.

◆ flip

void AngleSelector::flip ( Qt::Orientations orientations )

slot

Flips the angle horizontally, vertically, or both.

This function will always try to set the closest angle to the stablished one that satisfies the flipping requirements

Parameters

orientations Flags indicating in which directions the angle should be flipped

Definition at line 219 of file AngleSelector.cpp.

{
    bool ok = false;
    qreal flippedAngle = flipAngle(angle(), minimum(), maximum(), orientations, &ok);
    if (ok) {
        setAngle(flippedAngle);
    }
}

References angle(), flipAngle(), maximum(), minimum(), and setAngle().

◆ flipAngle [1/2]

qreal AngleSelector::flipAngle	(	qreal	angle,
		qreal	minimum,
		qreal	maximum,
		Qt::Orientations	orientations,
		bool *	ok = nullptr )

staticslot

Flips an angle horizontally, vertically, or both.

This function will always try to get the closest angle to the provided one that satisfies the flipping requirements

Parameters

	angle	The angle to be flipped
	minimum	The lower bound of the valid range
	maximum	The upper bound of the valid range
	orientations	Flags indicating in which directions the angle should be flipped
[out]	ok	This parameter will be set to true if the flipped angle is in the provided range, or to false otherwise

Returns: The flipped angle if it lies in the provided range or the closest value in the range (the minimum or maximum) otherwise

Definition at line 214 of file AngleSelector.cpp.

{
    return KisAngleSelector::flipAngle(angle, minimum, maximum, orientations, ok);
}

References angle(), KisAngleSelector::flipAngle(), maximum(), and minimum().

◆ flipAngle [2/2]

qreal AngleSelector::flipAngle	(	qreal	angle,
		Qt::Orientations	orientations )

staticslot

Flips an angle horizontally, vertically, or both.

This function will always try to get the closest angle to the provided one that satisfies the flipping requirements

Parameters

angle	The angle to be flipped
orientations	Flags indicating in which directions the angle should be flipped

Returns: The flipped angle

Definition at line 209 of file AngleSelector.cpp.

{
    return KisAngleSelector::flipAngle(angle, orientations);
}

References angle(), and KisAngleSelector::flipAngle().

◆ flipOptionsMode

QString AngleSelector::flipOptionsMode ( ) const

slot

Gets the mode in which the flip options should be shown.

The default is Buttons

Returns: The mode in which the flip options should be shown.

See also: setFlipOptionsMode(QString)

Definition at line 89 of file AngleSelector.cpp.

{
    KisAngleSelector::FlipOptionsMode mode = d->widget->flipOptionsMode();
    if (!(0 <= mode && mode <= FlipOptionsMode.size())) {
        warnScript << "AngleSelector::flipOptionsMode() doesn't handle mode '" << mode << "'!";
        return "";
    }
    return FlipOptionsMode[mode];
}

References d, FlipOptionsMode, KisAngleSelector::flipOptionsMode(), warnScript, and krita::AngleSelector::Private::widget.

◆ increasingDirection

QString AngleSelector::increasingDirection ( ) const

slot

Gets the direction in which the angle increases in the angle gauge.

Returns: The direction in which the angle increases

See also: setIncreasingDirection(QString)

Definition at line 104 of file AngleSelector.cpp.

{
    KisAngleGauge::IncreasingDirection increasingDirection = d->widget->increasingDirection();
    if (!(0 <= increasingDirection && increasingDirection <= IncreasingDirection.size())) {
        warnScript << "AngleSelector::increasingDirection() doesn't handle mode '" << increasingDirection << "'!";
        return "";
    }
    return IncreasingDirection[increasingDirection];
}

References d, IncreasingDirection, increasingDirection(), KisAngleSelector::increasingDirection(), warnScript, and krita::AngleSelector::Private::widget.

◆ isUsingFlatSpinBox

bool AngleSelector::isUsingFlatSpinBox ( ) const

slot

Gets if the spin box is flat (no border or background)

Returns: True if the spin box is flat, false otherwise

See also: useFlatSpinBox(bool)

Definition at line 114 of file AngleSelector.cpp.

{
    return d->widget->isUsingFlatSpinBox();
}

References d, KisAngleSelector::isUsingFlatSpinBox(), and krita::AngleSelector::Private::widget.

◆ maximum

qreal AngleSelector::maximum ( ) const

slot

Gets the maximum value for the angle.

The default is 360

Returns: The maximum value for the angle

See also: setMaximum(qreal); setRange(qreal, qreal)

Definition at line 69 of file AngleSelector.cpp.

{
    return d->widget->maximum();
}

References d, KisAngleSelector::maximum(), and krita::AngleSelector::Private::widget.

◆ minimum

qreal AngleSelector::minimum ( ) const

slot

Gets the minimum value for the angle.

The default is 0

Returns: The minimum value for the angle

See also: setMinimum(qreal); setRange(qreal, qreal)

Definition at line 74 of file AngleSelector.cpp.

{
    return d->widget->minimum();
}

References d, KisAngleSelector::minimum(), and krita::AngleSelector::Private::widget.

◆ prefix

QString AngleSelector::prefix ( ) const

slot

Gets the prefix shown in the spin box.

Returns: The prefix shown in the spin box

See also: setPrefix(const QString&)

Definition at line 79 of file AngleSelector.cpp.

{
    return d->widget->prefix();
}

References d, KisAngleSelector::prefix(), and krita::AngleSelector::Private::widget.

◆ reset

void AngleSelector::reset ( )

slot

Sets the current angle to the reset angle.

See also: resetAngle() const; setResetAngle(qreal) const

Definition at line 194 of file AngleSelector.cpp.

{
    d->widget->reset();
}

References d, KisAngleSelector::reset(), and krita::AngleSelector::Private::widget.

◆ resetAngle

qreal AngleSelector::resetAngle ( ) const

slot

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 59 of file AngleSelector.cpp.

{
    return d->widget->resetAngle();
}

References d, KisAngleSelector::resetAngle(), and krita::AngleSelector::Private::widget.

◆ setAngle

void AngleSelector::setAngle ( qreal newAngle )

slot

Sets the current angle.

Parameters

newAngle the new angle

See also: angle() const

Definition at line 119 of file AngleSelector.cpp.

{
    d->widget->setAngle(newAngle);
}

References d, KisAngleSelector::setAngle(), and krita::AngleSelector::Private::widget.

◆ setDecimals

void AngleSelector::setDecimals ( int newNumberOfDecimals )

slot

Sets the number of decimals (precision) used by the angle.

Parameters

newNumberOfDecimals the new number of decimals used by the angle

See also: decimals() const

Definition at line 134 of file AngleSelector.cpp.

{
    d->widget->setDecimals(newNumberOfDecimals);
}

References d, KisAngleSelector::setDecimals(), and krita::AngleSelector::Private::widget.

◆ setFlipOptionsMode

void AngleSelector::setFlipOptionsMode ( QString newMode )

slot

Sets the mode in which the flip options should be shown.

Parameters

newMode

the new mode in which the flip options should be shown Valid arguments:

NoFlipOptions - There are no flip options available
MenuButton - The flip options are shown as a menu accessible via a options button
Buttons - The flip options are shown as individual buttons
ContextMenu - The flip options are shown only as a context menu when right-clicking the gauge widget
flipOptionsMode() const

Definition at line 164 of file AngleSelector.cpp.

{
    int index = FlipOptionsMode.indexOf(newMode);
    if (index == -1) {
        dbgScript << "Script using AngleSelector.setFlipOptionsMode() passed invalid mode '" << newMode << "', ignoring.";
        return;
    }
    d->widget->setFlipOptionsMode((KisAngleSelector::FlipOptionsMode) index);
}

References d, dbgScript, FlipOptionsMode, KisAngleSelector::setFlipOptionsMode(), and krita::AngleSelector::Private::widget.

◆ setIncreasingDirection

void AngleSelector::setIncreasingDirection ( QString newIncreasingDirection )

slot

Sets the increasing direction in the angle gauge.

Parameters

newIncreasingDirection The new increasing direction Valid arguments: CounterClockwise or Clockwise.

See also: increasingDirection() const

Definition at line 179 of file AngleSelector.cpp.

{
    int index = IncreasingDirection.indexOf(newIncreasingDirection);
    if (index == -1) {
        dbgScript << "Script using AngleSelector.setIncreasingDirection() passed invalid mode '" << newIncreasingDirection << "', ignoring.";
        return;
    }
    d->widget->setIncreasingDirection((KisAngleGauge::IncreasingDirection) index);
}

References d, dbgScript, IncreasingDirection, KisAngleSelector::setIncreasingDirection(), and krita::AngleSelector::Private::widget.

◆ setMaximum

void AngleSelector::setMaximum ( qreal newMaximum )

slot

Sets the maximum value for the angle.

Parameters

newMaximum the new maximum value for the angle

See also: maximum() const; setRange(qreal, qreal)

Definition at line 139 of file AngleSelector.cpp.

{
    d->widget->setMaximum(newMaximum);
}

References d, KisAngleSelector::setMaximum(), and krita::AngleSelector::Private::widget.

◆ setMinimum

void AngleSelector::setMinimum ( qreal newMinimum )

slot

Sets the minimum value for the angle.

Parameters

newMinimum the new minimum value for the angle

See also: minimum() const; setRange(qreal, qreal)

Definition at line 144 of file AngleSelector.cpp.

{
    d->widget->setMinimum(newMinimum);
}

References d, KisAngleSelector::setMinimum(), and krita::AngleSelector::Private::widget.

◆ setPrefix

void AngleSelector::setPrefix ( const QString & newPrefix )

slot

Sets the prefix shown in the spin box.

Parameters

newPrefix the new prefix for the spin box

See also: prefix() const

Definition at line 154 of file AngleSelector.cpp.

{
    d->widget->setPrefix(newPrefix);
}

References d, KisAngleSelector::setPrefix(), and krita::AngleSelector::Private::widget.

◆ setRange

void AngleSelector::setRange	(	qreal	newMinimum,
		qreal	newMaximum )

slot

Sets the minimum and maximum values for the angle.

Parameters

newMinimum	the new minimum value for the angle
newMaximum	the new maximum value for the angle

See also: minimum() const; maximum() const; setMinimum(qreal); setMaximum(qreal)

Definition at line 149 of file AngleSelector.cpp.

{
    d->widget->setRange(newMinimum, newMaximum);
}

References d, KisAngleSelector::setRange(), and krita::AngleSelector::Private::widget.

◆ setResetAngle

void AngleSelector::setResetAngle ( qreal newResetAngle )

slot

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 129 of file AngleSelector.cpp.

{
    d->widget->setResetAngle(newResetAngle);
}

References d, KisAngleSelector::setResetAngle(), and krita::AngleSelector::Private::widget.

◆ setSnapAngle

void AngleSelector::setSnapAngle ( qreal newSnapAngle )

slot

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 124 of file AngleSelector.cpp.

{
    d->widget->setSnapAngle(newSnapAngle);
}

References d, KisAngleSelector::setSnapAngle(), and krita::AngleSelector::Private::widget.

◆ setWidgetsHeight

void AngleSelector::setWidgetsHeight ( int newHeight )

slot

Sets the common height of the widgets inside this angle selector. Use 0 to reset widgets to default height.

Parameters

newHeight the new height of the internal widgets (angle gauge, spin box, etc.)

See also: widgetsHeight() const

Definition at line 174 of file AngleSelector.cpp.

{
    d->widget->setWidgetsHeight(newHeight);
}

References d, KisAngleSelector::setWidgetsHeight(), and krita::AngleSelector::Private::widget.

◆ setWrapping

void AngleSelector::setWrapping ( bool newWrapping )

slot

Sets if the angle should wrap pass the minimum or maximum angles.

Parameters

newWrapping true if the angle should wrap pass the minimum or maximum angles, false otherwise

See also: wrapping() const

Definition at line 159 of file AngleSelector.cpp.

{
    d->widget->setWrapping(newWrapping);
}

References d, KisAngleSelector::setWrapping(), and krita::AngleSelector::Private::widget.

◆ snapAngle

qreal AngleSelector::snapAngle ( ) const

slot

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 54 of file AngleSelector.cpp.

{
    return d->widget->snapAngle();
}

References d, KisAngleSelector::snapAngle(), and krita::AngleSelector::Private::widget.

◆ useFlatSpinBox

void AngleSelector::useFlatSpinBox ( bool newUseFlatSpinBox )

slot

Sets if the spin box should be flat.

Parameters

newUseFlatSpinBox True if the spin box should be flat, false otherwise

See also: isUsingFlatSpinBox() const

Definition at line 189 of file AngleSelector.cpp.

{
    d->widget->useFlatSpinBox(newUseFlatSpinBox);
}

References d, KisAngleSelector::useFlatSpinBox(), and krita::AngleSelector::Private::widget.

◆ widget

QWidget * AngleSelector::widget ( ) const

slot

Get the internal KisAngleSelector as a QWidget, so it may be added to a UI.

Returns: the internal KisAngleSelector as a QWidget

Definition at line 44 of file AngleSelector.cpp.

{
    return d->widget;
}

References d, and krita::AngleSelector::Private::widget.

◆ widgetsHeight

int AngleSelector::widgetsHeight ( ) const

slot

Gets the common height of the widgets inside this angle selector.

Returns: The height of the internal widgets (angle gauge, spin box, etc.). Returns 0 if each widget has its default height.

See also: setWidgetsHeight(int)

Definition at line 99 of file AngleSelector.cpp.

{
    return d->widget->widgetsHeight();
}

References d, krita::AngleSelector::Private::widget, and KisAngleSelector::widgetsHeight().

◆ wrapping

bool AngleSelector::wrapping ( ) const

slot

Gets if the angle should wrap pass the minimum or maximum angles.

Returns: True if the angle should wrap pass the minimum or maximum angles, false otherwise

See also: setWrapping(bool)

Definition at line 84 of file AngleSelector.cpp.

{
    return d->widget->wrapping();
}

References d, krita::AngleSelector::Private::widget, and KisAngleSelector::wrapping().

Member Data Documentation

◆ d

Private* const AngleSelector::d

private

Definition at line 308 of file AngleSelector.h.

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

libs/libkis/AngleSelector.h
libs/libkis/AngleSelector.cpp

Public Slots

Signals

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AngleSelector()

◆ ~AngleSelector()

Member Function Documentation

◆ angle

◆ angleChanged

◆ closestCoterminalAngleInRange [1/2]

◆ closestCoterminalAngleInRange [2/2]

◆ decimals

◆ flip

◆ flipAngle [1/2]

◆ flipAngle [2/2]

◆ flipOptionsMode

◆ increasingDirection

◆ isUsingFlatSpinBox

◆ maximum

◆ minimum

◆ prefix

◆ reset

◆ resetAngle

◆ setAngle

◆ setDecimals

◆ setFlipOptionsMode

◆ setIncreasingDirection

◆ setMaximum

◆ setMinimum

◆ setPrefix

◆ setRange

◆ setResetAngle

◆ setSnapAngle

◆ setWidgetsHeight

◆ setWrapping

◆ snapAngle

◆ useFlatSpinBox

◆ widget

◆ widgetsHeight

◆ wrapping

Member Data Documentation

◆ d