LuciadCPillar 2023.1.04
luciad::MousePressedEvent Class Reference

Implementation of luciad::IInputEvent that represents a mouse pressed. More...

#include <luciad/input/mouse/MouseEvents.h>

Inheritance diagram for luciad::MousePressedEvent:
luciad::IInputEvent

Public Member Functions

 MousePressedEvent (Coordinate location, ModifierKeys modifierKeys, MouseButton mouseButton)
 Creates an event representing a mouse button being pressed. More...
 
Coordinate getLocation () const noexcept
 
ModifierKeys getModifierKeys () const noexcept
 
MouseButton getMouseButton () const noexcept
 
- Public Member Functions inherited from luciad::IInputEvent
virtual ~IInputEvent ()=default
 

Detailed Description

Implementation of luciad::IInputEvent that represents a mouse pressed.

This class contains the location, the mouse button and the modifiers if any.

Since
2020.1

Constructor & Destructor Documentation

◆ MousePressedEvent()

luciad::MousePressedEvent::MousePressedEvent ( Coordinate  location,
ModifierKeys  modifierKeys,
MouseButton  mouseButton 
)
inline

Creates an event representing a mouse button being pressed.

Parameters
locationThe mouse location, defined in device independent pixels.
modifierKeysThe modifiers of the event.
mouseButtonThe mouse button of the event.

Member Function Documentation

◆ getLocation()

Coordinate luciad::MousePressedEvent::getLocation ( ) const
inlinenoexcept
Returns
the position of the event, expressed in device independent pixel coordinates with top-left corner of the map being the (0,0) position.

◆ getModifierKeys()

ModifierKeys luciad::MousePressedEvent::getModifierKeys ( ) const
inlinenoexcept
Returns
the modifiers of the event.

◆ getMouseButton()

MouseButton luciad::MousePressedEvent::getMouseButton ( ) const
inlinenoexcept
Returns
the mouse button of the event.