Luciad.Input Namespace Reference

Namespaces
namespace	Mouse
namespace	Touch

Classes
class	ClickEvent
	Implementation of IInputEvent that represents a click event. More...
class	DragEvent
	Implementation of IInputEvent that represents a drag gesture. More...
interface	IInputEvent
	Base interface for all input events. More...
interface	IInputEventCallback
	A callback class that is called when a IInputEvent is fired. More...
class	InputEventCallbackAdapter
struct	KeyCode
	Represents a key in the controller API. More...
class	KeyEvent
	Implementation of IInputEvent that represents keyboard input. More...
class	ScreenDistance
	This class is used to represent distances between screen locations. More...
class	ScrollEvent
	Implementation of IInputEvent that represents a scroll gesture (for example using the mouse wheel). More...
class	TaskSchedulerAdapter

Enumerations
enum	ButtonState { Pressed , Released }
	Possible state of a button or a key. More...
enum	EventStatus { Start , InProgress , End }
	Indicates the status of an event. More...
enum	ModifierKeys { None = 0 , Alt = 1 , Ctrl = 2 , Shift = 4 }
	Utility class that contains the combination of the modifier keys pressed. More...
enum	ScreenDistanceUnit { Pixels , Millimeters }
	Expresses units for length across a display. More...

Enumeration Type Documentation

ButtonState

enum Luciad.Input.ButtonState

Possible state of a button or a key.

Since

2020.1

Enumerator
Pressed	When the button or the key is pressed.
Released	When the button or the key is released.

EventStatus

enum Luciad.Input.EventStatus

Indicates the status of an event.

Since

2020.1

Enumerator
Start	Used to indicate the start of an event.
InProgress	Used to indicate that the event is in progress.
End	Used to indicate the end of an event.

ModifierKeys

enum Luciad.Input.ModifierKeys

Utility class that contains the combination of the modifier keys pressed.

The modifiers keys are mapped to the following values:

• None => 0
• Alt => 1
• Ctrl => 2
• Shift => 4

  Note

  If you want to check that there are no modifiers set, do

              var shift = ModifierKeys.Shift;
              bool checkNone = shift == ModifierKeys.None;
              Assert.False(checkNone);
              var none = ModifierKeys.None;
              checkNone = none == ModifierKeys.None;
              Assert.True(checkNone);

An example usage is:

            var ctrl = ModifierKeys.Ctrl;
            var alt = ModifierKeys.Alt;
            var ctrlAlt = ctrl | alt;
 
            bool isNone = ctrlAlt == ModifierKeys.None;
            bool isAlt = ctrlAlt.HasFlag(ModifierKeys.Alt);
            bool isCtrlAlt = ctrlAlt == (ModifierKeys.Alt | ModifierKeys.Ctrl);

Since

2020.1

See also

KeyCode for the available key codes to use in conjunction with this class.

Enumerator
None	No modifiers are pressed.
Alt	The ALT key.
Ctrl	The CTRL key.
Shift	The SHIFT key.

ScreenDistanceUnit

enum Luciad.Input.ScreenDistanceUnit

Expresses units for length across a display.

Since

2022.0

Enumerator
Pixels	Device independent pixels.
Millimeters	Physical millimeters on the screen.