stmi::TouchEvent Class Reference

Event generated when the state of a touch is changed. More...

Inheritance diagram for stmi::TouchEvent:

Public Types
enum	TOUCH_INPUT_TYPE { TOUCH_BEGIN = 1, TOUCH_UPDATE = 2, TOUCH_END = 3, TOUCH_CANCEL = 4 }
	The touch event type. More...
Public Types inherited from stmi::XYEvent
enum	XY_GRAB_INPUT_TYPE {   XY_HOVER = 0, XY_GRAB = 1, XY_MOVE = 2, XY_UNGRAB = 3,   XY_UNGRAB_CANCEL = 4 }
	The type of grab the event represents. More...
Public Types inherited from stmi::Event
enum	AS_KEY_INPUT_TYPE { AS_KEY_PRESS = 1, AS_KEY_RELEASE = 2, AS_KEY_RELEASE_CANCEL = 3 }
	Key simulation type. More...

Public Member Functions
	TouchEvent (int64_t nTimeUsec, const shared_ptr< Accessor > &refAccessor, const shared_ptr< TouchCapability > &refTouchCapability, TOUCH_INPUT_TYPE eType, double fX, double fY, int64_t nFingerId) noexcept
	Constructor. More...
TOUCH_INPUT_TYPE	getType () const noexcept
	The touch event type. More...
int64_t	getFingerId () const noexcept
	The finger id performing the touch. More...
shared_ptr< TouchCapability >	getTouchCapability () const noexcept
	The touch capability that generated the event. More...
shared_ptr< Capability >	getCapability () const noexcept override
	Returns the capability that generated this event. More...
Public Member Functions inherited from stmi::XYEvent
double	getX () const noexcept
	The main X coordinate. More...
double	getY () const noexcept
	The main Y coordinate. More...
bool	getIsModified () const noexcept
	Whether the event coordinates were modified. More...
XY_GRAB_INPUT_TYPE	getXYGrabType () const noexcept
	Get the grab type of the event. More...
int64_t	getXYGrabId () const noexcept
	Identifies what is grabbed. More...
virtual void	translateXY (double fDX, double fDY) noexcept
	Translates the xy coordinates. More...
virtual void	scaleXY (double fSX, double fSY) noexcept
	Scales the xy coordinates. More...
Public Member Functions inherited from stmi::Event
virtual	~Event () noexcept=default
int64_t	getTimeUsec () const noexcept
	Returns the time this event originated. More...
int32_t	getCapabilityId () const noexcept
	Returns the id of the capability that generated this event. More...
const shared_ptr< Accessor > &	getAccessor () const noexcept
	Returns the accessor that helped generate this event. More...
virtual bool	getAsKey (HARDWARE_KEY &eKey, AS_KEY_INPUT_TYPE &eType, bool &bMoreThanOne) const noexcept
	Tells whether the event can simulate hardware keys. More...
virtual std::vector< std::pair< HARDWARE_KEY, AS_KEY_INPUT_TYPE > >	getAsKeys () const noexcept
	All the keys this event simulates. More...
const Class &	getEventClass () const noexcept
	Get the registered class of the event instance. More...

Static Public Member Functions
static const Event::Class &	getClass () noexcept
Static Public Member Functions inherited from stmi::Event
static bool	isEventClassIdRegistered (const std::string &sEventClassId) noexcept
	Tells whether the given event class id is registered. More...
static Class	getEventClassIdClass (const std::string &sEventClassId) noexcept
	Gets the event class with given class id. More...

Static Public Attributes
static const char *const	s_sClassId

Protected Member Functions
void	setTypeAndFinger (TOUCH_INPUT_TYPE eType, int64_t nFingerId) noexcept
	Sets touch and grab fields. More...
void	setTouchCapability (const shared_ptr< TouchCapability > &refTouchCapability) noexcept
	Sets the capability. More...
Protected Member Functions inherited from stmi::XYEvent
	XYEvent (const Class &oClass, int64_t nTimeUsec, int32_t nCapabilityId, const shared_ptr< Accessor > &refAccessor, double fX, double fY) noexcept
	Constructor without grab info. More...
	XYEvent (const Class &oClass, int64_t nTimeUsec, int32_t nCapabilityId, const shared_ptr< Accessor > &refAccessor, double fX, double fY, XY_GRAB_INPUT_TYPE eXYGrabType, int64_t nGrabId) noexcept
	Constructor. More...
void	setX (double fX) noexcept
	Sets X. More...
void	setY (double fY) noexcept
	Sets Y. More...
void	setIsModified (bool bIsModified) noexcept
	Sets the modified flag. More...
void	setXYGrab (XY_GRAB_INPUT_TYPE eXYGrabType, int64_t nGrabId) noexcept
	Sets the grab type and id. More...
Protected Member Functions inherited from stmi::Event
	Event (const Class &oClass, int64_t nTimeUsec, int32_t nCapabilityId, const shared_ptr< Accessor > &refAccessor) noexcept
	Constructor to be called from subclasses. More...
	Event (const Class &oClass, int64_t nTimeUsec, int32_t nCapabilityId) noexcept
	Constructor to be called from subclasses (with empty accessor). More...
void	setTimeUsec (int64_t nTimeUsec) noexcept
	Set the event time. More...
void	setCapabilityId (int32_t nCapabilityId) noexcept
	Set the capability id. More...
void	setAccessor (const shared_ptr< Accessor > &refAccessor) noexcept
	Set the accessor. More...

Additional Inherited Members
Static Protected Member Functions inherited from stmi::Event
static bool	isEventTypeRegistered (const std::type_info &oEventType) noexcept
	Tells whether an event type was registered. More...
static const std::type_info &	getEventClassIdType (const std::string &sEventClassId, bool &bRegistered) noexcept
	Gets the type of the registered event subclass associated with class id. More...
static std::string	getEventTypeClassId (const std::type_info &oType) noexcept
	Gets the class id of the given type. More...

Detailed Description

Event generated when the state of a touch is changed.

Note that the reference to the capability that generated this event is weak.

Member Enumeration Documentation

TOUCH_INPUT_TYPE

enum stmi::TouchEvent::TOUCH_INPUT_TYPE

The touch event type.

Enumerator
TOUCH_BEGIN
TOUCH_UPDATE
TOUCH_END
TOUCH_CANCEL

Constructor & Destructor Documentation

TouchEvent()

stmi::TouchEvent::TouchEvent ( int64_t  nTimeUsec, const shared_ptr< Accessor > &  refAccessor, const shared_ptr< TouchCapability > &  refTouchCapability, TOUCH_INPUT_TYPE  eType, double  fX, double  fY, int64_t  nFingerId  )

noexcept

Constructor.

Parameters

nTimeUsec	Time from epoch in microseconds.
refAccessor	The accessor used to generate the event. Can be null.
refTouchCapability	The capability that generated this event. Cannot be null.
eType	The touch event type.
fX	The X position of the touch.
fY	The Y position of the touch.
nFingerId	The id of the finger performing the touch.

Member Function Documentation

getCapability()

shared_ptr<Capability> stmi::TouchEvent::getCapability ( ) const

inlineoverridevirtualnoexcept

Returns the capability that generated this event.

The Event subclass implementation keeps only a weak_ptr on the capability to avoid reference cycles.

Returns

The capability or null if the capability was deleted.

Implements stmi::Event.

getClass()

static const Event::Class& stmi::TouchEvent::getClass ( )

inlinestaticnoexcept

getFingerId()

int64_t stmi::TouchEvent::getFingerId ( ) const

inlinenoexcept

The finger id performing the touch.

getTouchCapability()

shared_ptr<TouchCapability> stmi::TouchEvent::getTouchCapability ( ) const

inlinenoexcept

The touch capability that generated the event.

Returns

The capability or null if the capability was deleted.

getType()

TOUCH_INPUT_TYPE stmi::TouchEvent::getType ( ) const

inlinenoexcept

The touch event type.

setTouchCapability()

void stmi::TouchEvent::setTouchCapability ( const shared_ptr< TouchCapability > &  refTouchCapability )

inlineprotectednoexcept

Sets the capability.

Parameters

refTouchCapability

The capability that generated this event. Cannot be null.

setTypeAndFinger()

void stmi::TouchEvent::setTypeAndFinger ( TOUCH_INPUT_TYPE  eType, int64_t  nFingerId  )

inlineprotectednoexcept

Sets touch and grab fields.

This method also calls XYEvent::setXYGrab().

Parameters

eType	The touch event type.
nFingerId	The finger id performing the touch.

Member Data Documentation

s_sClassId

const char* const stmi::TouchEvent::s_sClassId

static