Implementation of luciad::IInputEvent that represents a scroll gesture (for example using the mouse wheel). More...

#include <luciad/input/IInputEvent.h>

Inheritance diagram for luciad::ScrollEvent:

Public Member Functions
	ScrollEvent (Coordinate location, ModifierKeys modifierKeys, double deltaY)
	Creates a scroll event. More...

double	getDeltaY () const noexcept
	Returns the vertical scroll amount and direction. More...

Coordinate	getLocation () const noexcept

ModifierKeys	getModifierKeys () const noexcept

Public Member Functions inherited from luciad::IInputEvent
virtual	~IInputEvent ()=default

Detailed Description

Implementation of luciad::IInputEvent that represents a scroll gesture (for example using the mouse wheel).

This class contains the location, the scroll amount and direction and modifiers if any.

Constructor & Destructor Documentation

luciad::ScrollEvent::ScrollEvent	(	Coordinate	location,
		ModifierKeys	modifierKeys,
		double	deltaY
	)

inline

Creates a scroll event.

Parameters

location	The location of the event, defined in device independent pixels.
modifierKeys	The modifiers of the event.
deltaY	the vertical scroll amount and direction.

double luciad::ScrollEvent::getDeltaY ( ) const

inlinenoexcept

Returns the vertical scroll amount and direction.

A positive value indicates scrolling up, a negative value indicates scrolling down.

A delta of 1.0 (or -1.0) should be interpreted as follows:

for mouse wheels, this would correspond to 1 tick, typically 15 degrees of rotation
for other devices, this would correspond to 10 pixels (device independent pixels)

Coordinate luciad::ScrollEvent::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.

ModifierKeys luciad::ScrollEvent::getModifierKeys ( ) const

inlinenoexcept