KisTemporaryStraightRulerAction Class Reference

#include <kis_temporary_straight_ruler_action.h>

Inheritance diagram for KisTemporaryStraightRulerAction:

Classes
class	Private

Public Types
enum	Shortcut { NormalShortcut , SnapToAngleShortcut }

Public Member Functions
void	activate (int shortcut) override
void	begin (int shortcut, QEvent *event) override
void	deactivate (int shortcut) override
void	end (QEvent *event) override
KisInputActionGroup	inputActionGroup (int shortcut) const override
void	inputEvent (QEvent *event) override
bool	isAvailable () const override
	KisTemporaryStraightRulerAction ()
int	priority () const override
bool	supportsHiResInputEvents (int shortcut) const override
bool	trySwitchShortcut (int oldShortcut, int newShortcut) override
	~KisTemporaryStraightRulerAction () override
Public Member Functions inherited from KisAbstractInputAction
virtual bool	canIgnoreModifiers () const
virtual QString	description () const
virtual QString	id () const
virtual bool	isShortcutRequired (int shortcut) const
	KisAbstractInputAction (const QString &id)
virtual QString	name () const
virtual QHash< QString, int >	shortcutIndexes () const
virtual	~KisAbstractInputAction ()

Private Attributes
Private *const	d

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)
virtual void	cursorMovedAbsolute (const QPointF &startPos, 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 11 of file kis_temporary_straight_ruler_action.h.

Member Enumeration Documentation

Shortcut

enum KisTemporaryStraightRulerAction::Shortcut

Enumerator
NormalShortcut
SnapToAngleShortcut

Definition at line 14 of file kis_temporary_straight_ruler_action.h.

                  {
        NormalShortcut,
        SnapToAngleShortcut
    };

Constructor & Destructor Documentation

KisTemporaryStraightRulerAction()

KisTemporaryStraightRulerAction::KisTemporaryStraightRulerAction

(

)

Definition at line 54 of file kis_temporary_straight_ruler_action.cpp.

    : KisAbstractInputAction("Temporary Straight Ruler")
    , d(new Private)
{
    setName(i18n("Temporary Straight Ruler"));
    setDescription(i18n("The <i>Temporary Straight Ruler</i> action creates a transient ruler for constrained painting."));
 
    QHash<QString, int> shortcuts;
    shortcuts.insert(i18n("Normal"), NormalShortcut);
    shortcuts.insert(i18n("Snapped Angle"), SnapToAngleShortcut);
    setShortcutIndexes(shortcuts);
}

References NormalShortcut, KisAbstractInputAction::setDescription(), KisAbstractInputAction::setName(), KisAbstractInputAction::setShortcutIndexes(), and SnapToAngleShortcut.

~KisTemporaryStraightRulerAction()

KisTemporaryStraightRulerAction::~KisTemporaryStraightRulerAction ( )

override

Definition at line 67 of file kis_temporary_straight_ruler_action.cpp.

{
    delete d;
}

References d.

Member Function Documentation

activate()

void KisTemporaryStraightRulerAction::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 77 of file kis_temporary_straight_ruler_action.cpp.

{
    KisPaintingAssistantsDecorationSP decoration = d->decoration(inputManager());
    if (decoration) {
        KisTemporaryPaintConstraint constraint =
            decoration->temporaryConstraint().value_or(KisTemporaryPaintConstraint());
        constraint.setInteractionMode(Private::interactionMode(shortcut));
        decoration->setTemporaryConstraint(constraint);
    }
}

References d, KisTemporaryStraightRulerAction::Private::decoration(), KisAbstractInputAction::inputManager, KisTemporaryStraightRulerAction::Private::interactionMode(), KisTemporaryPaintConstraint::setInteractionMode(), KisPaintingAssistantsDecoration::setTemporaryConstraint(), and KisPaintingAssistantsDecoration::temporaryConstraint().

begin()

void KisTemporaryStraightRulerAction::begin ( int shortcut, QEvent * event )

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 117 of file kis_temporary_straight_ruler_action.cpp.

{
    Q_UNUSED(shortcut);
 
    if (KisToolInvocationAction *action = d->defaultInputAction(inputManager())) {
        action->begin(KisToolInvocationAction::ActivateShortcut, event);
    }
}

References KisToolInvocationAction::ActivateShortcut, d, KisTemporaryStraightRulerAction::Private::defaultInputAction(), and KisAbstractInputAction::inputManager.

deactivate()

void KisTemporaryStraightRulerAction::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 88 of file kis_temporary_straight_ruler_action.cpp.

{
    Q_UNUSED(shortcut);
 
    KisPaintingAssistantsDecorationSP decoration = d->decoration(inputManager());
    if (decoration) {
        decoration->setTemporaryConstraint(std::nullopt);
    }
}

References d, KisTemporaryStraightRulerAction::Private::decoration(), KisAbstractInputAction::inputManager, and KisPaintingAssistantsDecoration::setTemporaryConstraint().

end()

void KisTemporaryStraightRulerAction::end ( QEvent * event )

overridevirtual

End the action.

Parameters

event

The mouse event that has finished this action. Is null for keyboard-activated actions.

Reimplemented from KisAbstractInputAction.

Definition at line 133 of file kis_temporary_straight_ruler_action.cpp.

{
    if (KisToolInvocationAction *action = d->defaultInputAction(inputManager())) {
        action->end(event);
    }
}

References d, KisTemporaryStraightRulerAction::Private::defaultInputAction(), and KisAbstractInputAction::inputManager.

inputActionGroup()

KisInputActionGroup KisTemporaryStraightRulerAction::inputActionGroup ( int shortcut ) const

overridevirtual

Returns

the group of the action the specified shortcut belongs to

Reimplemented from KisAbstractInputAction.

Definition at line 153 of file kis_temporary_straight_ruler_action.cpp.

{
    Q_UNUSED(shortcut);
    return ToolInvoactionActionGroup;
}

References ToolInvoactionActionGroup.

inputEvent()

void KisTemporaryStraightRulerAction::inputEvent ( QEvent * event )

overridevirtual

Process an input event.

By default handles MouseMove events and passes the data to a convenience cursorMoved() method

Parameters

event

An event to process.

Reimplemented from KisAbstractInputAction.

Definition at line 126 of file kis_temporary_straight_ruler_action.cpp.

{
    if (KisToolInvocationAction *action = d->defaultInputAction(inputManager())) {
        action->inputEvent(event);
    }
}

References d, KisTemporaryStraightRulerAction::Private::defaultInputAction(), and KisAbstractInputAction::inputManager.

isAvailable()

bool KisTemporaryStraightRulerAction::isAvailable ( ) const

overridevirtual

Some of the actions are available in particular situations only. E.g. switch frame action is available iff an animated layer is selected. If isAvailable() returns true then the action will not be triggered by the shortcut matcher.

Reimplemented from KisAbstractInputAction.

Definition at line 148 of file kis_temporary_straight_ruler_action.cpp.

{
    return true;
}

priority()

int KisTemporaryStraightRulerAction::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 72 of file kis_temporary_straight_ruler_action.cpp.

{
    return 100;
}

supportsHiResInputEvents()

bool KisTemporaryStraightRulerAction::supportsHiResInputEvents ( int shortcut ) const

overridevirtual

Returns true if the action can handle HiRes flow of move events which is generated by the tablet. If the function returns false, some of the events will be dropped or postponed. For most of the actions in Krita (except of real painting) it is perfectly acceptable, so 'false' is the default value.

Reimplemented from KisAbstractInputAction.

Definition at line 140 of file kis_temporary_straight_ruler_action.cpp.

{
    Q_UNUSED(shortcut);
 
    KisToolInvocationAction *action = d->defaultInputAction(inputManager());
    return action ? action->supportsHiResInputEvents(KisToolInvocationAction::ActivateShortcut) : true;
}

References KisToolInvocationAction::ActivateShortcut, d, KisTemporaryStraightRulerAction::Private::defaultInputAction(), KisAbstractInputAction::inputManager, and KisToolInvocationAction::supportsHiResInputEvents().

trySwitchShortcut()

bool KisTemporaryStraightRulerAction::trySwitchShortcut ( int oldShortcut, int newShortcut )

overridevirtual

Switch the active shortcut mode without deactivating the action.

Called when modifier keys change while the action is active. Override this to update action state in-place without resetting ongoing interaction.

Returns

true if the switch was handled and the action remains active; false to fall back to standard deactivate() / activate().

Reimplemented from KisAbstractInputAction.

Definition at line 98 of file kis_temporary_straight_ruler_action.cpp.

{
    Q_UNUSED(oldShortcut);
 
    KisPaintingAssistantsDecorationSP decoration = d->decoration(inputManager());
    if (!decoration) {
        return false;
    }
 
    std::optional<KisTemporaryPaintConstraint> constraint = decoration->temporaryConstraint();
    if (!constraint) {
        return false;
    }
 
    constraint->setInteractionMode(Private::interactionMode(newShortcut));
    decoration->setTemporaryConstraint(constraint);
    return true;
}

References d, KisTemporaryStraightRulerAction::Private::decoration(), KisAbstractInputAction::inputManager, KisTemporaryStraightRulerAction::Private::interactionMode(), KisPaintingAssistantsDecoration::setTemporaryConstraint(), and KisPaintingAssistantsDecoration::temporaryConstraint().

Member Data Documentation

d

Private* const KisTemporaryStraightRulerAction::d

private

Definition at line 37 of file kis_temporary_straight_ruler_action.h.

---

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

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