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

Implementation of luciad::IInputEvent that represents a drag gesture. More...

#include <luciad/input/IInputEvent.h>

Inheritance diagram for luciad::DragEvent:
luciad::IInputEvent luciad::MouseDragEvent luciad::TouchDragEvent

Public Member Functions

 DragEvent (Coordinate location, EventStatus status, Coordinate startLocation)
 Creates a drag event. More...
 
Coordinate getLocation () const noexcept
 Returns the position of the event. More...
 
virtual ModifierKeys getModifierKeys () const noexcept
 Returns the modifier keys. More...
 
Coordinate getStartLocation () const noexcept
 Returns the initial location of the entire drag gesture. More...
 
EventStatus getStatus () const noexcept
 Returns the status of the event. More...
 
- Public Member Functions inherited from luciad::IInputEvent
virtual ~IInputEvent ()=default
 

Detailed Description

Implementation of luciad::IInputEvent that represents a drag gesture.

This class contains the current mouse location, the start location and the status of the drag gesture.

Since
2020.1

Constructor & Destructor Documentation

◆ DragEvent()

luciad::DragEvent::DragEvent ( Coordinate  location,
EventStatus  status,
Coordinate  startLocation 
)
inline

Creates a drag event.

Parameters
locationThe current event location, defined in device independent pixels.
statusThe event status.
startLocationThe location of the first event for this gesture.

Member Function Documentation

◆ getLocation()

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

Returns the position of the event.

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

Returns
the position of the event.

◆ getModifierKeys()

virtual ModifierKeys luciad::DragEvent::getModifierKeys ( ) const
inlinevirtualnoexcept

Returns the modifier keys.

Returns
the modifier keys.

Reimplemented in luciad::MouseDragEvent.

◆ getStartLocation()

Coordinate luciad::DragEvent::getStartLocation ( ) const
inlinenoexcept

Returns the initial location of the entire drag gesture.

The location is defined in screen coordinates with top-left corner of the map being the (0,0) position.

Returns
the initial location of the entire drag gesture.

◆ getStatus()

EventStatus luciad::DragEvent::getStatus ( ) const
inlinenoexcept

Returns the status of the event.

Returns
the status of the event.