LuciadCPillar 2024.0.08
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
luciad::ClickEvent Class Reference

Implementation of luciad::IInputEvent that represents a click event. More...

#include <luciad/input/IInputEvent.h>

Inheritance diagram for luciad::ClickEvent:
luciad::IInputEvent luciad::MouseClickEvent luciad::TouchTapEvent

Public Member Functions

 ClickEvent (Coordinate location, size_t clickCount)
 Creates an event representing a click. More...
 
 ClickEvent (Coordinate location, size_t clickCount, ModifierKeys modifierKeys)
 Creates an event representing a click. More...
 
size_t getClickCount () const noexcept
 Returns the amount of clicks. More...
 
Coordinate getLocation () const noexcept
 Returns the position of the event. More...
 
ModifierKeys getModifierKeys () const noexcept
 Returns the modifiers of the event. More...
 
- Public Member Functions inherited from luciad::IInputEvent
virtual ~IInputEvent ()=default
 

Detailed Description

Implementation of luciad::IInputEvent that represents a click event.

This class contains the location and the click count. The click count is reset if the interval between two clicks exceeds luciad::MouseGestureRecognizer::getMultiClickInterval.

Since
2020.1

Constructor & Destructor Documentation

◆ ClickEvent() [1/2]

luciad::ClickEvent::ClickEvent ( Coordinate  location,
size_t  clickCount,
ModifierKeys  modifierKeys 
)
inline

Creates an event representing a click.

Parameters
locationThe location of the event, defined in device independent pixels
clickCountThe number of clicks.
modifierKeysThe modifiers of the event.
Since
2022.0

◆ ClickEvent() [2/2]

luciad::ClickEvent::ClickEvent ( Coordinate  location,
size_t  clickCount 
)
inline

Creates an event representing a click.

Parameters
locationThe location of the event, defined in device independent pixels
clickCountThe number of clicks.

Member Function Documentation

◆ getClickCount()

size_t luciad::ClickEvent::getClickCount ( ) const
inlinenoexcept

Returns the amount of clicks.

Returns
the amount of clicks.
See also
luciad::MouseGestureRecognizer::getMultiClickInterval

◆ getLocation()

Coordinate luciad::ClickEvent::getLocation ( ) const
inlinenoexcept

Returns the position of the event.

It is expressed in device independent pixel coordinates with top-left corner of the map being the (0,0) position.

Returns
the position of the event.

◆ getModifierKeys()

ModifierKeys luciad::ClickEvent::getModifierKeys ( ) const
inlinenoexcept

Returns the modifiers of the event.

Returns
the modifiers of the event.
Since
2022.0