LuciadCPillar 2023.1.04
luciad::MouseClickEvent Class Referencefinal

Specialization of the luciad::ClickEvent for the mouse. More...

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

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

Public Member Functions

 MouseClickEvent (Coordinate location, size_t clickCount, ModifierKeys modifierKeys, MouseButton mouseButton)
 Creates a click event for a mouse. More...
 
MouseButton getMouseButton () const noexcept
 
- Public Member Functions inherited from luciad::ClickEvent
 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
 
Coordinate getLocation () const noexcept
 
ModifierKeys getModifierKeys () const noexcept
 
- Public Member Functions inherited from luciad::IInputEvent
virtual ~IInputEvent ()=default
 

Detailed Description

Specialization of the luciad::ClickEvent for the mouse.

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

Since
2020.1

Constructor & Destructor Documentation

◆ MouseClickEvent()

luciad::MouseClickEvent::MouseClickEvent ( Coordinate  location,
size_t  clickCount,
ModifierKeys  modifierKeys,
MouseButton  mouseButton 
)
inline

Creates a click event for a mouse.

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

Member Function Documentation

◆ getMouseButton()

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