KoPointerEvent Class Reference

#include <KoPointerEvent.h>

Inheritance diagram for KoPointerEvent:

Public Member Functions
void	accept ()
Qt::MouseButton	button () const
	return button pressed (see QMouseEvent::button());
Qt::MouseButtons	buttons () const
	return buttons pressed (see QMouseEvent::buttons());
KoPointerEventWrapper	deepCopyEvent () const
QPoint	globalPos () const
	Return the position screen coordinates.
void	ignore ()
bool	isAccepted () const
	return if the event has been accepted.
bool	isTabletEvent () const
bool	isTouchEvent () const
	KoPointerEvent (const KoPointerEvent &rhs)
	KoPointerEvent (KoPointerEvent *event, const QPointF &point)
	KoPointerEvent (QMouseEvent *event, const QPointF &point)
	KoPointerEvent (QTabletEvent *event, const QPointF &point)
	KoPointerEvent (QTouchEvent *ev, const QPointF &pnt)
Qt::KeyboardModifiers	modifiers () const
KoPointerEvent &	operator= (const KoPointerEvent &rhs)
QPoint	pos () const
	return the position in widget coordinates
qreal	pressure () const
template<typename Event >
	Private (Event *event)
qreal	rotation () const
	return the rotation (or a default value)
bool	spontaneous () const
	return if this event was spontaneous (see QMouseEvent::spontaneous())
qreal	tangentialPressure () const
ulong	time () const
int	x () const
qreal	xTilt () const
int	y () const
qreal	yTilt () const
int	z () const
	~KoPointerEvent ()

Static Public Member Functions
static std::optional< QPointF >	fetchGlobalPositionFromPointerEvent (QEvent *event)
static bool	tabletInputReceived ()

Public Attributes
boost::variant2::variant< QMouseEvent *, QTabletEvent *, QTouchEvent * >	eventPtr
QPointF	point
	The point in document coordinates.

Static Public Attributes
static bool	s_tabletInputReceived

Private Attributes
const QScopedPointer< Private >	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Friends
class	KisScratchPadEventFilter
class	KisToolProxy
class	KoToolProxy

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

KoPointerEvent is a synthetic event that can be built from a mouse, touch or tablet event. In addition to always providing tools with tablet pressure characteristics, KoPointerEvent has both the original (canvas based) position as well as the normalized position, that is, the position of the event in the document coordinates.

Definition at line 92 of file KoPointerEvent.cpp.

Constructor & Destructor Documentation

KoPointerEvent() [1/5]

KoPointerEvent::KoPointerEvent	(	QMouseEvent *	event,
		const QPointF &	point )

Constructor.

Parameters

event	the mouse event that is the base of this event.
point	the zoomed point in the normal coordinate system.

Definition at line 107 of file KoPointerEvent.cpp.

    : point(pnt),
      d(new Private(ev))
{
}

KoPointerEvent() [2/5]

KoPointerEvent::KoPointerEvent	(	QTabletEvent *	event,
		const QPointF &	point )

Constructor.

Parameters

event	the tablet event that is the base of this event.
point	the zoomed point in the normal coordinate system.

Definition at line 113 of file KoPointerEvent.cpp.

    : point(pnt),
      d(new Private(ev))
{
    if (!Private::s_tabletInputReceived) {
        Private::s_tabletInputReceived = true;
        KisConfigNotifier::instance()->notifyTouchPaintingChanged();
    }
}

References KisConfigNotifier::instance(), and KisConfigNotifier::notifyTouchPaintingChanged().

KoPointerEvent() [3/5]

KoPointerEvent::KoPointerEvent	(	QTouchEvent *	ev,
		const QPointF &	pnt )

Definition at line 123 of file KoPointerEvent.cpp.

    : point(pnt),
      d(new Private(ev))
{
}

KoPointerEvent() [4/5]

KoPointerEvent::KoPointerEvent	(	KoPointerEvent *	event,
		const QPointF &	point )

Definition at line 129 of file KoPointerEvent.cpp.

    : point(point)
    , d(new Private(*(event->d)))
{
}

~KoPointerEvent()

KoPointerEvent::~KoPointerEvent

(

)

Definition at line 151 of file KoPointerEvent.cpp.

{
}

KoPointerEvent() [5/5]

KoPointerEvent::KoPointerEvent

(

const KoPointerEvent &

rhs

)

Copies the event object

The newly created object will still point to the original QMouseEvent, QTabletEvent or QTouchEvent, so it is not safe to store such object. If you want to store a KoPointerEvent object, use deepCopyEvent() instead.

Definition at line 135 of file KoPointerEvent.cpp.

    : point(rhs.point)
    , d(new Private(*(rhs.d)))
{
}

Member Function Documentation

accept()

void KoPointerEvent::accept

(

)

For classes that are handed this event, you can choose to accept (default) this event. Acceptance signifies that you have handled this event and found it useful, the effect of that will be that the event will not be handled to other event handlers.

Definition at line 443 of file KoPointerEvent.cpp.

{
    struct Visitor {
        void operator() (QInputEvent *event) {
            event->accept();
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

button()

Qt::MouseButton KoPointerEvent::button

(

)

const

return button pressed (see QMouseEvent::button());

Definition at line 202 of file KoPointerEvent.cpp.

{
    struct Visitor {
        Qt::MouseButton operator() (const QMouseEvent *event) {
            return event->button();
        }
        Qt::MouseButton operator() (const QTabletEvent *event) {
            return event->button();
        }
        Qt::MouseButton operator() (const QTouchEvent *) {
            return Qt::LeftButton;
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

buttons()

Qt::MouseButtons KoPointerEvent::buttons

(

)

const

return buttons pressed (see QMouseEvent::buttons());

Definition at line 219 of file KoPointerEvent.cpp.

{
    struct Visitor {
        Qt::MouseButtons operator() (const QMouseEvent *event) {
            return event->buttons();
        }
        Qt::MouseButtons operator() (const QTabletEvent *event) {
            return event->buttons();
        }
        Qt::MouseButtons operator() (const QTouchEvent *) {
            return Qt::LeftButton;
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

deepCopyEvent()

KoPointerEventWrapper KoPointerEvent::deepCopyEvent

(

)

const

Copies KoPointerEvent and its underlying Qt event.

Normal copy-constructor keeps the pointers to the original Qt event intact, therefore you cannot store this event for any time longer than the lifetime of the handler for this event.

Definition at line 177 of file KoPointerEvent.cpp.

{
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    return visit(DeepCopyVisitor{point}, d->eventPtr);
#else
    struct Visitor {
 
        QPointF point;
 
        KoPointerEventWrapper operator() (const QMouseEvent *event) {
            return KoPointerEventWrapper(event->clone(), point);
        }
        KoPointerEventWrapper operator() (const QTabletEvent *event) {
            return KoPointerEventWrapper(event->clone(), point);
        }
        KoPointerEventWrapper operator() (const QTouchEvent *event) {
            return KoPointerEventWrapper(event->clone(), point);
        }
    };
    return visit(Visitor{point}, d->eventPtr);
 
 
#endif
}

References d, and point.

fetchGlobalPositionFromPointerEvent()

std::optional< QPointF > KoPointerEvent::fetchGlobalPositionFromPointerEvent ( QEvent * event )

static

Definition at line 504 of file KoPointerEvent.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(event, std::nullopt);
 
    if (event->type() == QEvent::TouchBegin || event->type() == QEvent::TouchUpdate || event->type() == QEvent::TouchEnd) {
        const QTouchEvent *touchEvent = static_cast<const QTouchEvent *>(event);
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
        const QList<QEventPoint> &touchPoints = touchEvent->points();
#else
        const QList<QTouchEvent::TouchPoint> &touchPoints = touchEvent->touchPoints();
#endif
        if (touchPoints.isEmpty()) {
            // Getting zero touch points can happen on Android when pressing
            // on the screen with an entire palm. Punt to using the cursor
            // position after all.
            return std::nullopt;
        } else {
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
            return touchPoints.constFirst().globalPosition();
#else
            return touchPoints.constFirst().screenPos();
#endif
        }
    } else if (event->type() == QEvent::TabletPress || event->type() == QEvent::TabletRelease) {
        const QTabletEvent *tabletEvent = static_cast<const QTabletEvent *>(event);
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
        return tabletEvent->globalPosition();
#else
        return tabletEvent->globalPos();
#endif
    } else if (event->type() == QEvent::MouseButtonPress ||
               event->type() == QEvent::MouseButtonRelease ||
               event->type() == QEvent::MouseMove) {
        const QMouseEvent *mouseEvent = static_cast<const QMouseEvent *>(event);
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
        return mouseEvent->globalPosition();
#else
        return mouseEvent->globalPos();
#endif
    }
 
    return std::nullopt;
}

References KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE.

globalPos()

QPoint KoPointerEvent::globalPos

(

)

const

Return the position screen coordinates.

Definition at line 236 of file KoPointerEvent.cpp.

{
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    struct Visitor {
        QPoint operator() (const QMouseEvent *event) {
            return event->globalPos();
        }
        QPoint operator() (const QTabletEvent *event) {
            return event->globalPos();
        }
        QPoint operator() (const QTouchEvent *event) {
            return event->touchPoints().constFirst().screenPos().toPoint();
        }
#else
    struct Visitor {
        QPoint operator() (const QMouseEvent *event) {
            return event->globalPosition().toPoint();
        }
        QPoint operator() (const QTabletEvent *event) {
            return event->globalPosition().toPoint();
        }
        QPoint operator() (const QTouchEvent *event) {
            return event->points().constFirst().globalPosition().toPoint();
        }
#endif
 
    };
 
    return visit(Visitor(), d->eventPtr);
}

ignore()

void KoPointerEvent::ignore

(

)

For classes that are handed this event, you can choose to ignore this event. Ignoring this event means you have not handled it and want to allow other event handlers to try to handle it.

Definition at line 454 of file KoPointerEvent.cpp.

{
    struct Visitor {
        void operator() (QInputEvent *event) {
            event->ignore();
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

isAccepted()

bool KoPointerEvent::isAccepted

(

)

const

return if the event has been accepted.

Definition at line 465 of file KoPointerEvent.cpp.

{
    struct Visitor {
        bool operator() (const QInputEvent *event) {
            return event->isAccepted();
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

isTabletEvent()

bool KoPointerEvent::isTabletEvent

(

)

const

Returns if the event comes from a tablet

Definition at line 417 of file KoPointerEvent.cpp.

{
    return d->eventPtr.index() == 1;
}

References d.

isTouchEvent()

bool KoPointerEvent::isTouchEvent

(

)

const

Returns if the event comes from a touch

Definition at line 422 of file KoPointerEvent.cpp.

{
    return d->eventPtr.index() == 2;
}

References d.

modifiers()

Qt::KeyboardModifiers KoPointerEvent::modifiers

(

)

const

Returns the keyboard modifier flags that existed immediately before the event occurred. See also QApplication::keyboardModifiers().

Definition at line 432 of file KoPointerEvent.cpp.

{
    struct Visitor {
        Qt::KeyboardModifiers operator() (const QInputEvent *event) {
            return event->modifiers();
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

operator=()

KoPointerEvent & KoPointerEvent::operator=

(

const KoPointerEvent &

rhs

)

Copies the event object

See a comment in copy constructor for the difference between deep/shallow copies.

Definition at line 141 of file KoPointerEvent.cpp.

{
    if (&rhs != this) {
        *d = *rhs.d;
        point = rhs.point;
    }
 
    return *this;
}

References d, and point.

pos()

QPoint KoPointerEvent::pos

(

)

const

return the position in widget coordinates

Definition at line 267 of file KoPointerEvent.cpp.

{
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    struct Visitor {
        QPoint operator() (const QMouseEvent *event) {
            return event->pos();
        }
        QPoint operator() (const QTabletEvent *event) {
            return event->pos();
        }
        QPoint operator() (const QTouchEvent *event) {
            return event->touchPoints().at(0).pos().toPoint();
        }
    };
#else
    struct Visitor {
        QPoint operator() (const QMouseEvent *event) {
            return event->position().toPoint();
        }
        QPoint operator() (const QTabletEvent *event) {
            return event->position().toPoint();
        }
        QPoint operator() (const QTouchEvent *event) {
            return event->points().at(0).position().toPoint();
        }
    };
#endif
    return visit(Visitor(), d->eventPtr);
}

References d.

pressure()

qreal KoPointerEvent::pressure

(

)

const

return the pressure (or a default value). The range is 0.0 - 1.0 and the default pressure (this is the pressure that will be given when you use something like the mouse) is 1.0

Definition at line 307 of file KoPointerEvent.cpp.

{
    struct Visitor {
        qreal operator() (const QTabletEvent *event) {
            return event->pressure();
        }
        qreal operator() (const QTouchEvent *event) {
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
            return s_optionContainer->useTouchPressure ? event->touchPoints().at(0).pressure() : 1.0;
#else
            return s_optionContainer->useTouchPressure ? event->points().at(0).pressure() : 1.0;
#endif
        }
        qreal operator() (...) {
            return 1.0;
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

Private()

template<typename Event >

KoPointerEvent::Private ( Event * event )

inline

Definition at line 96 of file KoPointerEvent.cpp.

        : eventPtr(event)
    {
    }

rotation()

qreal KoPointerEvent::rotation

(

)

const

return the rotation (or a default value)

Definition at line 328 of file KoPointerEvent.cpp.

{
    struct Visitor {
        qreal operator() (const QTabletEvent *event) {
            return event->rotation();
        }
        qreal operator() (const QTouchEvent *event) {
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
            return event->touchPoints().at(0).rotation();
#else
            return event->points().at(0).rotation();
#endif
        }
        qreal operator() (...) {
            return 0.0;
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

spontaneous()

bool KoPointerEvent::spontaneous

(

)

const

return if this event was spontaneous (see QMouseEvent::spontaneous())

Definition at line 476 of file KoPointerEvent.cpp.

{
    struct Visitor {
        bool operator() (const QInputEvent *event) {
            return event->spontaneous();
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

tabletInputReceived()

bool KoPointerEvent::tabletInputReceived ( )

static

Whether we ever had any tablet inputs this session

Definition at line 427 of file KoPointerEvent.cpp.

{
    return Private::s_tabletInputReceived;
}

tangentialPressure()

qreal KoPointerEvent::tangentialPressure

(

)

const

return the tangential pressure (or a default value) This is typically given by a finger wheel on an airbrush tool. The range is from -1.0 to 1.0. 0.0 indicates a neutral position. Current airbrushes can only move in the positive direction from the neutral position. If the device does not support tangential pressure, this value is always 0.0.

Definition at line 349 of file KoPointerEvent.cpp.

{
    struct Visitor {
        qreal operator() (const QTabletEvent *event) {
            return std::fmod((event->tangentialPressure() - (-1.0)) / (1.0 - (-1.0)), 2.0);
        }
        qreal operator() (...) {
            return 0.0;
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

time()

ulong KoPointerEvent::time

(

)

const

Returns the time the event was registered.

Definition at line 406 of file KoPointerEvent.cpp.

{
    struct Visitor {
        ulong operator() (const QInputEvent *event) {
            return event->timestamp();
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

x()

int KoPointerEvent::x

(

)

const

Return the x position in widget coordinates.

See also

point

Definition at line 297 of file KoPointerEvent.cpp.

{
    return pos().x();
}

References pos().

xTilt()

qreal KoPointerEvent::xTilt

(

)

const

Returns the angle between the device (a pen, for example) and the perpendicular in the direction of the x axis. Positive values are towards the tablet's physical right. The angle is in the range -60 to +60 degrees. The default value is 0.

Definition at line 363 of file KoPointerEvent.cpp.

{
    struct Visitor {
        int operator() (const QTabletEvent *event) {
            return event->xTilt();
        }
        int operator() (...) {
            return 0;
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

y()

int KoPointerEvent::y

(

)

const

Return the y position in widget coordinates.

See also

point

Definition at line 302 of file KoPointerEvent.cpp.

{
    return pos().y();
}

References pos().

yTilt()

qreal KoPointerEvent::yTilt

(

)

const

Returns the angle between the device (a pen, for example) and the perpendicular in the direction of the x axis. Positive values are towards the tablet's physical right. The angle is in the range -60 to +60 degrees. The default value is 0.

Definition at line 378 of file KoPointerEvent.cpp.

{
    struct Visitor {
        int operator() (const QTabletEvent *event) {
            return event->yTilt();
        }
        int operator() (...) {
            return 0;
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

z()

int KoPointerEvent::z

(

)

const

Returns the z position of the device. Typically this is represented by a wheel on a 4D Mouse. If the device does not support a Z-axis, this value is always zero. This is not the same as pressure.

Definition at line 392 of file KoPointerEvent.cpp.

{
    struct Visitor {
        int operator() (const QTabletEvent *event) {
            return event->z();
        }
        int operator() (...) {
            return 0;
        }
    };
 
    return visit(Visitor(), d->eventPtr);
}

References d.

Friends And Related Symbol Documentation

KisScratchPadEventFilter

friend class KisScratchPadEventFilter

friend

Definition at line 215 of file KoPointerEvent.h.

KisToolProxy

friend class KisToolProxy

friend

Definition at line 214 of file KoPointerEvent.h.

KoToolProxy

friend class KoToolProxy

friend

Definition at line 213 of file KoPointerEvent.h.

Member Data Documentation

d

const QScopedPointer<Private> KoPointerEvent::d

private

Definition at line 219 of file KoPointerEvent.h.

eventPtr

boost::variant2::variant<QMouseEvent*, QTabletEvent*, QTouchEvent*> KoPointerEvent::eventPtr

Definition at line 101 of file KoPointerEvent.cpp.

point

QPointF KoPointerEvent::point

The point in document coordinates.

Definition at line 186 of file KoPointerEvent.h.

s_tabletInputReceived

bool KoPointerEvent::s_tabletInputReceived

static

Definition at line 102 of file KoPointerEvent.cpp.

---

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

• libs/flake/KoPointerEvent.cpp
• libs/flake/KoPointerEvent.h