KisGammaExposureAction Class Reference

#include <kis_gamma_exposure_action.h>

Inheritance diagram for KisGammaExposureAction:

Classes
class	Private

Public Types
enum	Shortcuts {   ExposureShortcut , GammaShortcut , AddExposure05Shortcut , RemoveExposure05Shortcut ,   AddGamma05Shortcut , RemoveGamma05Shortcut , AddExposure02Shortcut , RemoveExposure02Shortcut ,   AddGamma02Shortcut , RemoveGamma02Shortcut , ResetExposureAndGammaShortcut }

Public Member Functions
void	activate (int shortcut) override
void	begin (int shortcut, QEvent *event=nullptr) override
void	cursorMovedAbsolute (const QPointF &lastPos, const QPointF &pos) override
void	deactivate (int shortcut) override
bool	isShortcutRequired (int shortcut) const override
	KisGammaExposureAction ()
int	priority () const override
	~KisGammaExposureAction () override
Public Member Functions inherited from KisAbstractInputAction
virtual bool	canIgnoreModifiers () const
virtual QString	description () const
virtual void	end (QEvent *event)
virtual QString	id () const
virtual KisInputActionGroup	inputActionGroup (int shortcut) const
virtual void	inputEvent (QEvent *event)
virtual bool	isAvailable () const
	KisAbstractInputAction (const QString &id)
virtual QString	name () const
virtual QHash< QString, int >	shortcutIndexes () const
virtual bool	supportsHiResInputEvents (int shortcut) const
virtual	~KisAbstractInputAction ()

Private Attributes
Private *const	d {nullptr}

Additional Inherited Members
Public Attributes inherited from KisAbstractInputAction
QString	description
QString	id
QHash< QString, int >	indexes
QPointF	lastCursorPosition
QString	name
QPointF	startCursorPosition
Static Public Attributes inherited from KisAbstractInputAction
static KisInputManager *	inputManager
Protected Member Functions inherited from KisAbstractInputAction
virtual void	cursorMoved (const QPointF &lastPos, const QPointF &pos)
QPoint	eventPos (const QEvent *event)
QPointF	eventPosF (const QEvent *event)
KisInputManager *	inputManager () const
void	setDescription (const QString &description)
void	setName (const QString &name)
void	setShortcutIndexes (const QHash< QString, int > &indexes)

Detailed Description

Definition at line 13 of file kis_gamma_exposure_action.h.

Member Enumeration Documentation

Shortcuts

enum KisGammaExposureAction::Shortcuts

The different behaviours for this action.

Enumerator
ExposureShortcut
GammaShortcut
AddExposure05Shortcut
RemoveExposure05Shortcut
AddGamma05Shortcut
RemoveGamma05Shortcut
AddExposure02Shortcut
RemoveExposure02Shortcut
AddGamma02Shortcut
RemoveGamma02Shortcut
ResetExposureAndGammaShortcut

Definition at line 19 of file kis_gamma_exposure_action.h.

                   {
        ExposureShortcut,
        GammaShortcut,
        AddExposure05Shortcut,
        RemoveExposure05Shortcut,
        AddGamma05Shortcut,
        RemoveGamma05Shortcut,
        AddExposure02Shortcut,
        RemoveExposure02Shortcut,
        AddGamma02Shortcut,
        RemoveGamma02Shortcut,
        ResetExposureAndGammaShortcut
    };

Constructor & Destructor Documentation

KisGammaExposureAction()

KisGammaExposureAction::KisGammaExposureAction ( )

explicit

Definition at line 58 of file kis_gamma_exposure_action.cpp.

    : KisAbstractInputAction("Exposure or Gamma")
    , d(new Private(this))
{
    setName(i18n("Exposure and Gamma"));
    setDescription(i18n("The <i>Exposure and Gamma</i> action changes the display mode of the canvas."));
 
    QHash< QString, int > shortcuts;
    shortcuts.insert(i18n("Exposure Mode"), ExposureShortcut);
    shortcuts.insert(i18n("Gamma Mode"), GammaShortcut);
 
    shortcuts.insert(i18n("Exposure +0.5"), AddExposure05Shortcut);
    shortcuts.insert(i18n("Exposure -0.5"), RemoveExposure05Shortcut);
    shortcuts.insert(i18n("Gamma +0.5"), AddGamma05Shortcut);
    shortcuts.insert(i18n("Gamma -0.5"), RemoveGamma05Shortcut);
 
    shortcuts.insert(i18n("Exposure +0.2"), AddExposure02Shortcut);
    shortcuts.insert(i18n("Exposure -0.2"), RemoveExposure02Shortcut);
    shortcuts.insert(i18n("Gamma +0.2"), AddGamma02Shortcut);
    shortcuts.insert(i18n("Gamma -0.2"), RemoveGamma02Shortcut);
 
    shortcuts.insert(i18n("Reset Exposure and Gamma"), ResetExposureAndGammaShortcut);
    setShortcutIndexes(shortcuts);
}

References AddExposure02Shortcut, AddExposure05Shortcut, AddGamma02Shortcut, AddGamma05Shortcut, ExposureShortcut, GammaShortcut, RemoveExposure02Shortcut, RemoveExposure05Shortcut, RemoveGamma02Shortcut, RemoveGamma05Shortcut, ResetExposureAndGammaShortcut, KisAbstractInputAction::setDescription(), KisAbstractInputAction::setName(), and KisAbstractInputAction::setShortcutIndexes().

~KisGammaExposureAction()

KisGammaExposureAction::~KisGammaExposureAction ( )

override

Definition at line 83 of file kis_gamma_exposure_action.cpp.

{
    delete d;
}

References d.

Member Function Documentation

activate()

void KisGammaExposureAction::activate ( int shortcut )

overridevirtual

The method is called when the action is yet to be started, that is, e.g. the user has pressed all the modifiers for the action but hasn't started painting yet. This method is a right place to show the user what is going to happen, e.g. change the cursor.

Reimplemented from KisAbstractInputAction.

Definition at line 93 of file kis_gamma_exposure_action.cpp.

{
    if (shortcut == ExposureShortcut) {
        QApplication::setOverrideCursor(KisCursor::changeExposureCursor());
    } else /* if (shortcut == GammaShortcut) */ {
        QApplication::setOverrideCursor(KisCursor::changeGammaCursor());
    }
}

References KisCursor::changeExposureCursor(), KisCursor::changeGammaCursor(), and ExposureShortcut.

begin()

void KisGammaExposureAction::begin ( int shortcut, QEvent * event = nullptr )

overridevirtual

Begin the action.

Parameters

shortcut	The index of the behaviour to trigger.
event	The mouse event that has triggered this action. Is null for keyboard-activated actions.

Reimplemented from KisAbstractInputAction.

Definition at line 108 of file kis_gamma_exposure_action.cpp.

{
    KisAbstractInputAction::begin(shortcut, event);
 
    KisExposureGammaCorrectionInterface *interface =
        inputManager()->canvas()->exposureGammaCorrectionInterface();
 
    switch(shortcut) {
    case ExposureShortcut:
        d->baseExposure = interface->currentExposure();
        d->mode = (Shortcuts)shortcut;
        break;
    case GammaShortcut:
        d->baseGamma = interface->currentGamma();
        d->mode = (Shortcuts)shortcut;
        break;
 
    case AddExposure05Shortcut:
        d->addExposure(0.5);
        break;
    case RemoveExposure05Shortcut:
        d->addExposure(-0.5);
        break;
    case AddGamma05Shortcut:
        d->addGamma(0.5);
        break;
    case RemoveGamma05Shortcut:
        d->addGamma(-0.5);
        break;
 
    case AddExposure02Shortcut:
        d->addExposure(0.2);
        break;
    case RemoveExposure02Shortcut:
        d->addExposure(-0.2);
        break;
    case AddGamma02Shortcut:
        d->addGamma(0.2);
        break;
    case RemoveGamma02Shortcut:
        d->addGamma(-0.2);
        break;
 
    case ResetExposureAndGammaShortcut: {
        KisExposureGammaCorrectionInterface *interface =
            inputManager()->canvas()->exposureGammaCorrectionInterface();
        if (!interface->canChangeExposureAndGamma()) break;
 
        interface->setCurrentGamma(1.0);
        interface->setCurrentExposure(0.0);
        break;
    }
    }
}

References KisGammaExposureAction::Private::addExposure(), AddExposure02Shortcut, AddExposure05Shortcut, KisGammaExposureAction::Private::addGamma(), AddGamma02Shortcut, AddGamma05Shortcut, KisGammaExposureAction::Private::baseExposure, KisGammaExposureAction::Private::baseGamma, KisAbstractInputAction::begin(), Private::canvas, d, ExposureShortcut, GammaShortcut, KisAbstractInputAction::inputManager, KisGammaExposureAction::Private::mode, RemoveExposure02Shortcut, RemoveExposure05Shortcut, RemoveGamma02Shortcut, RemoveGamma05Shortcut, and ResetExposureAndGammaShortcut.

cursorMovedAbsolute()

void KisGammaExposureAction::cursorMovedAbsolute ( const QPointF & lastPos, const QPointF & pos )

overridevirtual

Reimplemented from KisAbstractInputAction.

Definition at line 163 of file kis_gamma_exposure_action.cpp.

{
    QPointF diff = -(pos - startPos);
 
    const int step = 200;
 
    KisExposureGammaCorrectionInterface *interface =
        inputManager()->canvas()->exposureGammaCorrectionInterface();
 
    if (!interface->canChangeExposureAndGamma()) return;
 
 
    if (d->mode == ExposureShortcut) {
        const qreal currentExposure = d->baseExposure + qreal(diff.y()) / step;
        interface->setCurrentExposure(currentExposure);
    } else if (d->mode == GammaShortcut) {
        const qreal currentGamma = d->baseExposure + qreal(diff.y()) / step;
        interface->setCurrentGamma(currentGamma);
    }
}

References KisGammaExposureAction::Private::baseExposure, Private::canvas, d, ExposureShortcut, GammaShortcut, KisAbstractInputAction::inputManager, and KisGammaExposureAction::Private::mode.

deactivate()

void KisGammaExposureAction::deactivate ( int shortcut )

overridevirtual

The method is called when the action is not a candidate for the starting anymore. The action should revert everything that was done in activate() method.

See also

activate()

Reimplemented from KisAbstractInputAction.

Definition at line 102 of file kis_gamma_exposure_action.cpp.

{
    Q_UNUSED(shortcut);
    QApplication::restoreOverrideCursor();
}

isShortcutRequired()

bool KisGammaExposureAction::isShortcutRequired ( int shortcut ) const

overridevirtual

Return true when the specified shortcut is required for basic user interaction. This is used by the configuration system to prevent basic actions like painting from being removed.

Parameters

shortcut

The shortcut index to check.

Returns

True if the shortcut is required, false if not.

Reimplemented from KisAbstractInputAction.

Definition at line 184 of file kis_gamma_exposure_action.cpp.

{
    Q_UNUSED(shortcut);
    return false;
}

priority()

int KisGammaExposureAction::priority ( ) const

overridevirtual

The priority for this action.

Priority determines how "important" the action is and is used to resolve conflicts when multiple actions can be activated.

Reimplemented from KisAbstractInputAction.

Definition at line 88 of file kis_gamma_exposure_action.cpp.

{
    return 5;
}

Member Data Documentation

d

Private* const KisGammaExposureAction::d {nullptr}

private

Definition at line 47 of file kis_gamma_exposure_action.h.

{nullptr};

---

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

• libs/ui/input/kis_gamma_exposure_action.h
• libs/ui/input/kis_gamma_exposure_action.cpp