LuciadCPillar C# 2024.1.04
Luciad.Input.ScrollEvent Class Reference

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

Inheritance diagram for Luciad.Input.ScrollEvent:
Luciad.Input.IInputEvent

Public Member Functions

 ScrollEvent (Luciad.Cartesian.Coordinate location, Luciad.Input.ModifierKeys modifierKeys, double deltaY)
 Creates a scroll event. More...
 
void Dispose ()
 

Properties

double DeltaY [get]
 The vertical scroll amount and direction. More...
 
Luciad.Cartesian.Coordinate Location [get]
 The position of the event. More...
 
Luciad.Input.ModifierKeys ModifierKeys [get]
 The modifiers of the event. More...
 

Detailed Description

Implementation of 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.

Since
2020.1

Constructor & Destructor Documentation

◆ ScrollEvent()

Luciad.Input.ScrollEvent.ScrollEvent ( Luciad.Cartesian.Coordinate  location,
Luciad.Input.ModifierKeys  modifierKeys,
double  deltaY 
)
inline

Creates a scroll event.

Parameters
locationThe location of the event, defined in device independent pixels.
modifierKeysThe modifiers of the event.
deltaYthe vertical scroll amount and direction.

Member Function Documentation

◆ Dispose()

void Luciad.Input.ScrollEvent.Dispose ( )
inline

Property Documentation

◆ DeltaY

double Luciad.Input.ScrollEvent.DeltaY
get

The vertical scroll amount and direction.

[get]

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)

◆ Location

Luciad.Cartesian.Coordinate Luciad.Input.ScrollEvent.Location
get

The position of the event.

[get]

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.

◆ ModifierKeys

Luciad.Input.ModifierKeys Luciad.Input.ScrollEvent.ModifierKeys
get

The modifiers of the event.

[get]

Returns the modifiers of the event.