Louvre  v2.13.0-1
C++ library for Wayland compositors
Public Member Functions | List of all members
LPointerPinchUpdateEvent Class Referencefinal

Pointer pinch update gesture event. More...

+ Inheritance diagram for LPointerPinchUpdateEvent:

Public Member Functions

 LPointerPinchUpdateEvent (UInt32 fingers=0, const LPointF &delta=LPointF(0.f, 0.f), const LPointF &deltaUnaccelerated=LPointF(0.f, 0.f), Float32 scale=1.f, Float32 rotation=0.f, UInt32 serial=LTime::nextSerial(), UInt32 ms=LTime::ms(), UInt64 us=LTime::us(), LInputDevice *device=nullptr) noexcept
 Constructs an LPointerPinchUpdateEvent object. More...
 
void setFingers (UInt32 fingers) noexcept
 Sets the number of fingers involved in the pinch gesture. More...
 
UInt32 fingers () const noexcept
 Gets the number of fingers involved in the pinch gesture. More...
 
void setDelta (const LPointF &delta) noexcept
 Sets the movement delta of the pinch gesture. More...
 
void setDx (Float32 dx) noexcept
 Sets the movement delta along the x-axis of the pinch gesture. More...
 
void setDy (Float32 dy) noexcept
 Sets the movement delta along the y-axis of the pinch gesture. More...
 
const LPointFdelta () const noexcept
 Gets the movement delta of the pinch gesture. More...
 
void setDeltaUnaccelerated (const LPointF &deltaUnaccelerated) noexcept
 Sets the unaccelerated movement delta of the pinch gesture. More...
 
void setDxUnaccelerated (Float32 dx) noexcept
 Sets the unaccelerated movement delta along the x-axis of the pinch gesture. More...
 
void setDyUnaccelerated (Float32 dy) noexcept
 Sets the unaccelerated movement delta along the y-axis of the pinch gesture. More...
 
const LPointFdeltaUnaccelerated () const noexcept
 Gets the unaccelerated movement delta of the pinch gesture. More...
 
void setScale (Float32 scale) noexcept
 Sets the scale factor of the pinch gesture. More...
 
Float32 scale () const noexcept
 Gets the scale factor of the pinch gesture. More...
 
void setRotation (Float32 rotation) noexcept
 Sets the rotation angle of the pinch gesture. More...
 
Float32 rotation () const noexcept
 Gets the rotation angle of the pinch gesture. More...
 
- Public Member Functions inherited from LInputEvent
void setDevice (LInputDevice *device) noexcept
 Sets the input device that originated the event. More...
 
LInputDevicedevice () const noexcept
 Gets the input device that originated this event. More...
 
- Public Member Functions inherited from LEvent
 ~LEvent () noexcept=default
 Destructor. More...
 
Type type () const noexcept
 Retrieves the type of the event. More...
 
Subtype subtype () const noexcept
 Retrieves the subtype of the event. More...
 
void setSerial (UInt32 serial) noexcept
 Sets the serial of the event. More...
 
UInt32 serial () const noexcept
 Retrieves the serial of the event. More...
 
void setMs (UInt32 ms) noexcept
 Sets the time the event was generated in milliseconds. More...
 
UInt32 ms () const noexcept
 Retrieves the time the event was generated in milliseconds. More...
 
void setUs (UInt32 us) noexcept
 Sets the time the event was generated in microseconds. More...
 
UInt64 us () const noexcept
 Retrieves the time the event was generated in microseconds. More...
 
LEventcopy () const noexcept
 Creates a deep copy of the event. More...
 

Additional Inherited Members

- Public Types inherited from LEvent
enum class  Type : UInt8
 Defines the type of event. More...
 
enum class  Subtype : UInt8
 Defines the subtype of event. More...
 

Detailed Description

Pointer pinch update gesture event.

Constructor & Destructor Documentation

◆ LPointerPinchUpdateEvent()

LPointerPinchUpdateEvent ( UInt32  fingers = 0,
const LPointF delta = LPointF(0.f, 0.f),
const LPointF deltaUnaccelerated = LPointF(0.f, 0.f),
Float32  scale = 1.f,
Float32  rotation = 0.f,
UInt32  serial = LTime::nextSerial(),
UInt32  ms = LTime::ms(),
UInt64  us = LTime::us(),
LInputDevice device = nullptr 
)
inlinenoexcept

Constructs an LPointerPinchUpdateEvent object.

Parameters
fingersThe number of fingers involved in the pinch gesture.
deltaThe movement delta of the pinch gesture.
deltaUnacceleratedThe unaccelerated movement delta of the pinch gesture.
scaleThe scale factor of the pinch gesture.
rotationThe rotation angle of the pinch gesture.
serialThe serial number of the event.
msThe millisecond timestamp of the event.
usThe microsecond timestamp of the event.
deviceThe input device that originated the event.

Member Function Documentation

◆ setFingers()

void setFingers ( UInt32  fingers)
inlinenoexcept

Sets the number of fingers involved in the pinch gesture.

◆ fingers()

UInt32 fingers ( ) const
inlinenoexcept

Gets the number of fingers involved in the pinch gesture.

◆ setDelta()

void setDelta ( const LPointF delta)
inlinenoexcept

Sets the movement delta of the pinch gesture.

◆ setDx()

void setDx ( Float32  dx)
inlinenoexcept

Sets the movement delta along the x-axis of the pinch gesture.

◆ setDy()

void setDy ( Float32  dy)
inlinenoexcept

Sets the movement delta along the y-axis of the pinch gesture.

◆ delta()

const LPointF& delta ( ) const
inlinenoexcept

Gets the movement delta of the pinch gesture.

◆ setDeltaUnaccelerated()

void setDeltaUnaccelerated ( const LPointF deltaUnaccelerated)
inlinenoexcept

Sets the unaccelerated movement delta of the pinch gesture.

◆ setDxUnaccelerated()

void setDxUnaccelerated ( Float32  dx)
inlinenoexcept

Sets the unaccelerated movement delta along the x-axis of the pinch gesture.

◆ setDyUnaccelerated()

void setDyUnaccelerated ( Float32  dy)
inlinenoexcept

Sets the unaccelerated movement delta along the y-axis of the pinch gesture.

◆ deltaUnaccelerated()

const LPointF& deltaUnaccelerated ( ) const
inlinenoexcept

Gets the unaccelerated movement delta of the pinch gesture.

◆ setScale()

void setScale ( Float32  scale)
inlinenoexcept

Sets the scale factor of the pinch gesture.

◆ scale()

Float32 scale ( ) const
inlinenoexcept

Gets the scale factor of the pinch gesture.

The scale begins at 1.0, and if e.g. the fingers moved together by 50% then the scale will become 0.5, if they move twice as far apart as initially the scale becomes 2.0, etc.

◆ setRotation()

void setRotation ( Float32  rotation)
inlinenoexcept

Sets the rotation angle of the pinch gesture.

◆ rotation()

Float32 rotation ( ) const
inlinenoexcept

Gets the rotation angle of the pinch gesture.

The angle delta is defined as the change in angle of the line formed by the 2 fingers of a pinch gesture. Clockwise rotation is represented by a positive delta, counter-clockwise by a negative delta. If e.g. the fingers are on the 12 and 6 location of a clock face plate and they move to the 1 resp. 7 location in a single event then the angle delta is 30 degrees.