LuciadCPillar C# 2024.1.04
Luciad.Input.KeyEvent Class Reference

Implementation of IInputEvent that represents keyboard input. More...

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

Public Member Functions

 KeyEvent (Luciad.Input.ButtonState state, Luciad.Input.KeyCode key, Luciad.Input.ModifierKeys modifierKeys)
 Creates a key event. More...
 
 KeyEvent (Luciad.Input.ButtonState state, Luciad.Input.KeyCode key, Luciad.Input.ModifierKeys modifierKeys, Luciad.Cartesian.Coordinate lastKnownLocation)
 Creates a key event. More...
 
void Dispose ()
 

Properties

Luciad.Input.KeyCode Key [get]
 The key of the event. More...
 
Luciad.Cartesian.? Coordinate LastKnownLocation [get]
 The last know location of the input device (for example the mouse cursor) when this event occurred. More...
 
Luciad.Input.ModifierKeys ModifierKeys [get]
 The modifiers of the event. More...
 
Luciad.Input.ButtonState State [get]
 The state of the key. More...
 

Detailed Description

Implementation of IInputEvent that represents keyboard input.

This class contains the button state, the key and the modifiers if any.

Since
2020.1

Constructor & Destructor Documentation

◆ KeyEvent() [1/2]

Luciad.Input.KeyEvent.KeyEvent ( Luciad.Input.ButtonState  state,
Luciad.Input.KeyCode  key,
Luciad.Input.ModifierKeys  modifierKeys 
)
inline

Creates a key event.

Parameters
stateThe state of the key.
keyThe key of the event.
modifierKeysThe modifiers of the event.

◆ KeyEvent() [2/2]

Luciad.Input.KeyEvent.KeyEvent ( Luciad.Input.ButtonState  state,
Luciad.Input.KeyCode  key,
Luciad.Input.ModifierKeys  modifierKeys,
Luciad.Cartesian.Coordinate  lastKnownLocation 
)
inline

Creates a key event.

Parameters
stateThe state of the key.
keyThe key of the event.
modifierKeysThe modifiers of the event.
lastKnownLocationThe last known location of the mouse

Member Function Documentation

◆ Dispose()

void Luciad.Input.KeyEvent.Dispose ( )
inline

Property Documentation

◆ Key

Luciad.Input.KeyCode Luciad.Input.KeyEvent.Key
get

The key of the event.

[get]

Returns the key of the event.

◆ LastKnownLocation

Luciad.Cartesian.? Coordinate Luciad.Input.KeyEvent.LastKnownLocation
get

The last know location of the input device (for example the mouse cursor) when this event occurred.

[get]

Returns the last know location of the input device (for example the mouse cursor) when this event occurred. It is expressed in screen coordinates (px) with top-left corner of the map being the (0,0) position.

◆ ModifierKeys

Luciad.Input.ModifierKeys Luciad.Input.KeyEvent.ModifierKeys
get

The modifiers of the event.

[get]

Returns the modifiers of the event.

◆ State

Luciad.Input.ButtonState Luciad.Input.KeyEvent.State
get

The state of the key.

[get]

Returns the state of the key.