The KisTouchShortcut class only handles touch gestures it does not handle tool invocation i.e painting (which is being handled in KisShortcutMatcher). More...

#include <kis_touch_shortcut.h>

Inheritance diagram for KisTouchShortcut:

Classes
class	Private

Public Member Functions
bool	isAvailable (KisInputActionGroupsMask mask) const override

bool	isHoldType () const

	KisTouchShortcut (KisAbstractInputAction *action, int index, TouchGestureAction type)

bool	matchDragType (const QTouchEvent *event, Qt::TouchPointStates allowedStates)

bool	matchHoldType (const QTouchEvent *event, Qt::TouchPointStates allowedStates)

bool	matchTapType (const QTouchEvent *event, Qt::TouchPointStates allowedStates)

bool	matchTouchPoint (const QTouchEvent *event, Qt::TouchPointStates allowedStates)

qreal	minDragThreshold () const

int	priority () const override

void	setIsTouchPainting (bool value)

void	setMaximumTouchPoints (int max)

void	setMinDragThreshold (qreal value)

void	setMinimumTouchPoints (int min)

	~KisTouchShortcut () override

Public Member Functions inherited from KisAbstractShortcut
KisAbstractInputAction *	action () const

	KisAbstractShortcut (KisAbstractInputAction *action, int index)

void	setAction (KisAbstractInputAction *action)

int	shortcutIndex () const

virtual	~KisAbstractShortcut ()

Static Public Member Functions
static Qt::TouchPointStates	allTouchStates ()

static int	countTouchPoints (const QTouchEvent *event, Qt::TouchPointStates allowedStates)

static Qt::TouchPointStates	pressedOnlyTouchStates ()

static qreal	touchDragDistance (const QTouchEvent *event, Qt::TouchPointStates allowedStates)

Private Types
using	TouchGestureAction = KisShortcutConfiguration::TouchGestureAction

Private Attributes
Private *const	d

Additional Inherited Members
Public Attributes inherited from KisAbstractShortcut
KisAbstractInputAction *	action

int	shortcutIndex

Protected Member Functions inherited from KisAbstractShortcut
bool	compareKeys (const QSet< Qt::Key > &keys1, const QSet< Qt::Key > &keys2)

Detailed Description

The KisTouchShortcut class only handles touch gestures it does not handle tool invocation i.e painting (which is being handled in KisShortcutMatcher).

Definition at line 21 of file kis_touch_shortcut.h.

Member Typedef Documentation

◆ TouchGestureAction

using KisTouchShortcut::TouchGestureAction = KisShortcutConfiguration::TouchGestureAction

private

Definition at line 23 of file kis_touch_shortcut.h.

Constructor & Destructor Documentation

◆ KisTouchShortcut()

KisTouchShortcut::KisTouchShortcut	(	KisAbstractInputAction *	action,
		int	index,
		TouchGestureAction	type )

Definition at line 35 of file kis_touch_shortcut.cpp.

    : KisAbstractShortcut(action, index)
    , d(new Private(type))
{
 
}

◆ ~KisTouchShortcut()

KisTouchShortcut::~KisTouchShortcut ( )

override

Definition at line 42 of file kis_touch_shortcut.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ allTouchStates()

static Qt::TouchPointStates KisTouchShortcut::allTouchStates ( )

inlinestatic

Definition at line 46 of file kis_touch_shortcut.h.

                                                          {
            return Qt::TouchPointStationary | Qt::TouchPointPressed | Qt::TouchPointMoved | Qt::TouchPointReleased;
        }

◆ countTouchPoints()

int KisTouchShortcut::countTouchPoints	(	const QTouchEvent *	event,
		Qt::TouchPointStates	allowedStates )

static

Definition at line 109 of file kis_touch_shortcut.cpp.

{
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
    auto points = event->touchPoints();
    using TouchPoint = QTouchEvent::TouchPoint;
#else
    auto points = event->points();
    using TouchPoint = QEventPoint;
#endif
 
    const int count =
        std::count_if(points.begin(), points.end(), [=] (const TouchPoint &point) {
            auto state = static_cast<Qt::TouchPointState>(point.state());
            return allowedStates.testFlag(state);
        });
 
    return count;
}

◆ isAvailable()

bool KisTouchShortcut::isAvailable ( KisInputActionGroupsMask mask ) const

overridevirtual

Returns true if the shortcut is enabled at the moment

Reimplemented from KisAbstractShortcut.

Definition at line 82 of file kis_touch_shortcut.cpp.

{
    if (d->isTouchPainting && KisConfig(true).disableTouchOnCanvas()) {
        return false;
    }
 
    return KisAbstractShortcut::isAvailable(mask);
}

References d, KisAbstractShortcut::isAvailable(), and KisTouchShortcut::Private::isTouchPainting.

◆ isHoldType()

bool KisTouchShortcut::isHoldType ( ) const

Definition at line 62 of file kis_touch_shortcut.cpp.

{
    return d->type == KisShortcutConfiguration::OneFingerHold;
}

References d, KisShortcutConfiguration::OneFingerHold, and KisTouchShortcut::Private::type.

◆ matchDragType()

bool KisTouchShortcut::matchDragType	(	const QTouchEvent *	event,
		Qt::TouchPointStates	allowedStates )

Definition at line 97 of file kis_touch_shortcut.cpp.

{
    return touchDragDistance(event, allowedStates) > d->minDragThreshold &&
        matchTouchPoint(event, allowedStates)
        && (d->type >= KisShortcutConfiguration::OneFingerDrag && d->type <= KisShortcutConfiguration::FiveFingerDrag);
}

References d, KisShortcutConfiguration::FiveFingerDrag, matchTouchPoint(), KisTouchShortcut::Private::minDragThreshold, KisShortcutConfiguration::OneFingerDrag, touchDragDistance(), and KisTouchShortcut::Private::type.

◆ matchHoldType()

bool KisTouchShortcut::matchHoldType	(	const QTouchEvent *	event,
		Qt::TouchPointStates	allowedStates )

Definition at line 104 of file kis_touch_shortcut.cpp.

{
    return isHoldType() && matchTouchPoint(event, allowedStates);
}

References isHoldType(), and matchTouchPoint().

◆ matchTapType()

bool KisTouchShortcut::matchTapType	(	const QTouchEvent *	event,
		Qt::TouchPointStates	allowedStates )

Definition at line 91 of file kis_touch_shortcut.cpp.

{
    return matchTouchPoint(event, allowedStates)
        && (d->type >= KisShortcutConfiguration::OneFingerTap && d->type <= KisShortcutConfiguration::FiveFingerTap);
}

References d, KisShortcutConfiguration::FiveFingerTap, matchTouchPoint(), KisShortcutConfiguration::OneFingerTap, and KisTouchShortcut::Private::type.

◆ matchTouchPoint()

bool KisTouchShortcut::matchTouchPoint	(	const QTouchEvent *	event,
		Qt::TouchPointStates	allowedStates )

Definition at line 149 of file kis_touch_shortcut.cpp.

{
    const int numStillActivePoints = countTouchPoints(event, allowedStates);
 
    return numStillActivePoints >= d->minTouchPoints && numStillActivePoints <= d->maxTouchPoints;
}

References countTouchPoints(), d, KisTouchShortcut::Private::maxTouchPoints, and KisTouchShortcut::Private::minTouchPoints.

◆ minDragThreshold()

qreal KisTouchShortcut::minDragThreshold ( ) const

Definition at line 47 of file kis_touch_shortcut.cpp.

{
    return d->minDragThreshold;
}

References d, and KisTouchShortcut::Private::minDragThreshold.

◆ pressedOnlyTouchStates()

static Qt::TouchPointStates KisTouchShortcut::pressedOnlyTouchStates ( )

inlinestatic

Definition at line 50 of file kis_touch_shortcut.h.

                                                                  {
            return Qt::TouchPointStationary | Qt::TouchPointPressed | Qt::TouchPointMoved;
        }

◆ priority()

int KisTouchShortcut::priority ( ) const

overridevirtual

The priority of the shortcut. The shortcut with the greatest value will be chosen for execution

Implements KisAbstractShortcut.

Definition at line 57 of file kis_touch_shortcut.cpp.

{
    return d->isTouchPainting ? std::numeric_limits<int>::max() : action()->priority();
}

References KisAbstractShortcut::action, d, KisTouchShortcut::Private::isTouchPainting, and KisAbstractInputAction::priority().

◆ setIsTouchPainting()

void KisTouchShortcut::setIsTouchPainting ( bool value )

Definition at line 77 of file kis_touch_shortcut.cpp.

{
    d->isTouchPainting = value;
}

References d, KisTouchShortcut::Private::isTouchPainting, and value().

◆ setMaximumTouchPoints()

void KisTouchShortcut::setMaximumTouchPoints ( int max )

Definition at line 72 of file kis_touch_shortcut.cpp.

{
    d->maxTouchPoints = max;
}

References d, and KisTouchShortcut::Private::maxTouchPoints.

◆ setMinDragThreshold()

void KisTouchShortcut::setMinDragThreshold ( qreal value )

Definition at line 52 of file kis_touch_shortcut.cpp.

{
    d->minDragThreshold = value;
}

References d, KisTouchShortcut::Private::minDragThreshold, and value().

◆ setMinimumTouchPoints()

void KisTouchShortcut::setMinimumTouchPoints ( int min )

Definition at line 67 of file kis_touch_shortcut.cpp.

{
    d->minTouchPoints = min;
}

References d, and KisTouchShortcut::Private::minTouchPoints.

◆ touchDragDistance()

qreal KisTouchShortcut::touchDragDistance	(	const QTouchEvent *	event,
		Qt::TouchPointStates	allowedStates )

static

Definition at line 128 of file kis_touch_shortcut.cpp.

{
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
    auto points = event->touchPoints();
    using TouchPoint = QTouchEvent::TouchPoint;
#else
    auto points = event->points();
    using TouchPoint = QEventPoint;
#endif
 
    return std::sqrt(std::accumulate(points.begin(), points.end(), qreal(0),
        [&] (qreal maxOffsetSq, const TouchPoint &point) {
            auto state = static_cast<Qt::TouchPointState>(point.state());
            if (!allowedStates.testFlag(state)) {
                return maxOffsetSq;
            }
 
            return std::max(maxOffsetSq, KisAlgebra2D::normSquared(point.pos() - point.startPos()));
        }));
}

References KisAlgebra2D::normSquared().

Member Data Documentation

◆ d

Private* const KisTouchShortcut::d