LuciadCPillar C# 2025.0.09
Luciad.Input.KeyCode Struct Reference

Represents a key in the controller API. More...

Inheritance diagram for Luciad.Input.KeyCode:

Public Member Functions

 KeyCode (uint index)
 Creates a new KeyCode with the given index. More...
 
bool Equals (KeyCode other)
 
override bool Equals (object other)
 
override int GetHashCode ()
 

Static Public Member Functions

static bool operator!= (KeyCode lhs, KeyCode rhs)
 
static bool operator== (KeyCode lhs, KeyCode rhs)
 

Properties

static KeyCode A = new KeyCode(65) [get]
 A key code representing the 'A' key. More...
 
static KeyCode Asterisk = new KeyCode(42) [get]
 A key code representing the '*' key. More...
 
static KeyCode B = new KeyCode(66) [get]
 A key code representing the 'B' key. More...
 
static KeyCode Backspace = new KeyCode(8) [get]
 A key code representing the backspace key. More...
 
static KeyCode C = new KeyCode(67) [get]
 A key code representing the 'C' key. More...
 
static KeyCode D = new KeyCode(68) [get]
 A key code representing the 'D' key. More...
 
static KeyCode Del = new KeyCode(127) [get]
 A key code representing the delete key. More...
 
static KeyCode Down = new KeyCode(205) [get]
 A key code representing the down key. More...
 
static KeyCode E = new KeyCode(69) [get]
 A key code representing the 'E' key. More...
 
static KeyCode Eight = new KeyCode(56) [get]
 A key code representing the '8' key. More...
 
static KeyCode End = new KeyCode(201) [get]
 A key code representing the end key. More...
 
static KeyCode Enter = new KeyCode(10) [get]
 A key code representing the enter key. More...
 
static KeyCode Escape = new KeyCode(27) [get]
 A key code representing the escape key. More...
 
static KeyCode F = new KeyCode(70) [get]
 A key code representing the 'F' key. More...
 
static KeyCode F1 = new KeyCode(112) [get]
 A key code representing the F1 key. More...
 
static KeyCode F10 = new KeyCode(121) [get]
 A key code representing the F10 key. More...
 
static KeyCode F11 = new KeyCode(122) [get]
 A key code representing the F11 key. More...
 
static KeyCode F12 = new KeyCode(123) [get]
 A key code representing the F12 key. More...
 
static KeyCode F2 = new KeyCode(113) [get]
 A key code representing the F2 key. More...
 
static KeyCode F3 = new KeyCode(114) [get]
 A key code representing the F3 key. More...
 
static KeyCode F4 = new KeyCode(115) [get]
 A key code representing the F4 key. More...
 
static KeyCode F5 = new KeyCode(116) [get]
 A key code representing the F5 key. More...
 
static KeyCode F6 = new KeyCode(117) [get]
 A key code representing the F6 key. More...
 
static KeyCode F7 = new KeyCode(118) [get]
 A key code representing the F7 key. More...
 
static KeyCode F8 = new KeyCode(119) [get]
 A key code representing the F8 key. More...
 
static KeyCode F9 = new KeyCode(120) [get]
 A key code representing the F9 key. More...
 
static KeyCode Five = new KeyCode(53) [get]
 A key code representing the '5' key. More...
 
static KeyCode Four = new KeyCode(52) [get]
 A key code representing the '4' key. More...
 
static KeyCode G = new KeyCode(71) [get]
 A key code representing the 'G' key. More...
 
static KeyCode H = new KeyCode(72) [get]
 A key code representing the 'H' key. More...
 
static KeyCode Home = new KeyCode(200) [get]
 A key code representing the home key. More...
 
static KeyCode I = new KeyCode(73) [get]
 A key code representing the 'I' key. More...
 
uint Index [get]
 The index of the key code. More...
 
static KeyCode Insert = new KeyCode(155) [get]
 A key code representing the insert key. More...
 
static KeyCode J = new KeyCode(74) [get]
 A key code representing the 'J' key. More...
 
static KeyCode K = new KeyCode(75) [get]
 A key code representing the 'K' key. More...
 
static KeyCode L = new KeyCode(76) [get]
 A key code representing the 'L' key. More...
 
static KeyCode Left = new KeyCode(202) [get]
 A key code representing the left key. More...
 
static KeyCode M = new KeyCode(77) [get]
 A key code representing the 'M' key. More...
 
static KeyCode Minus = new KeyCode(45) [get]
 A key code representing the '-' key. More...
 
static KeyCode N = new KeyCode(78) [get]
 A key code representing the 'N' key. More...
 
static KeyCode Nine = new KeyCode(57) [get]
 A key code representing the '9' key. More...
 
static KeyCode O = new KeyCode(79) [get]
 A key code representing the 'O' key. More...
 
static KeyCode One = new KeyCode(49) [get]
 A key code representing the '1' key. More...
 
static KeyCode P = new KeyCode(80) [get]
 A key code representing the 'P' key. More...
 
static KeyCode PageDown = new KeyCode(207) [get]
 A key code representing the page down key. More...
 
static KeyCode PageUp = new KeyCode(206) [get]
 A key code representing the pacge up key. More...
 
static KeyCode Plus = new KeyCode(43) [get]
 A key code representing the '+' key. More...
 
static KeyCode Q = new KeyCode(81) [get]
 A key code representing the 'Q' key. More...
 
static KeyCode R = new KeyCode(82) [get]
 A key code representing the 'R' key. More...
 
static KeyCode Right = new KeyCode(204) [get]
 A key code representing the right key. More...
 
static KeyCode S = new KeyCode(83) [get]
 A key code representing the 'S' key. More...
 
static KeyCode Seven = new KeyCode(55) [get]
 A key code representing the '7' key. More...
 
static KeyCode Six = new KeyCode(54) [get]
 A key code representing the '6' key. More...
 
static KeyCode Slash = new KeyCode(47) [get]
 A key code representing the '/' key. More...
 
static KeyCode Space = new KeyCode(32) [get]
 A key code representing the space key. More...
 
static KeyCode T = new KeyCode(84) [get]
 A key code representing the 'T' key. More...
 
static KeyCode Tab = new KeyCode(9) [get]
 A key code representing the tab key. More...
 
static KeyCode Three = new KeyCode(51) [get]
 A key code representing the '3' key. More...
 
static KeyCode Two = new KeyCode(50) [get]
 A key code representing the '2' key. More...
 
static KeyCode U = new KeyCode(85) [get]
 A key code representing the 'U' key. More...
 
static KeyCode Unknown = new KeyCode(0) [get]
 A key code representing an unknown key. More...
 
static KeyCode Up = new KeyCode(203) [get]
 A key code representing the up key. More...
 
static KeyCode V = new KeyCode(86) [get]
 A key code representing the 'V' key. More...
 
static KeyCode W = new KeyCode(87) [get]
 A key code representing the 'W' key. More...
 
static KeyCode X = new KeyCode(88) [get]
 A key code representing the 'X' key. More...
 
static KeyCode Y = new KeyCode(89) [get]
 A key code representing the 'Y' key. More...
 
static KeyCode Z = new KeyCode(90) [get]
 A key code representing the 'Z' key. More...
 
static KeyCode Zero = new KeyCode(48) [get]
 A key code representing the '0' key. More...
 

Detailed Description

Represents a key in the controller API.

Since
2020.1
See also
KeyCode.KeyCode for the key mapping.
ModifierKeys for the available modifiers to use in conjunction with this class.

Constructor & Destructor Documentation

◆ KeyCode()

Luciad.Input.KeyCode.KeyCode ( uint  index)
inline

Creates a new KeyCode with the given index.

The key button index maps on to keys as follows:

  • 0 => Unknown
  • 8 => Backspace
  • 27 => Escape
  • 32 => Space
  • 42 => Asterisk
  • 43 => Plus
  • 45 => Minus
  • 47 => Slash
  • 48 => 0
  • 49 => 1
  • ...
  • 57 => 9
  • 65 => A
  • 66 => B
  • ...
  • 90 => Z
  • 200 => Home
  • 201 => End
  • 202 => Left
  • 203 => Up
  • 204 => Right
  • 205 => Down
  • 206 => Page-Up
  • 207 => Page-Down

If needed other indexes can be used if out of those values. For example if you want to handle unicode characters. Please use index values greater than 1024 for custom key codes.

Parameters
indexthe mouse button index.

Member Function Documentation

◆ Equals() [1/2]

bool Luciad.Input.KeyCode.Equals ( KeyCode  other)
inline

◆ Equals() [2/2]

override bool Luciad.Input.KeyCode.Equals ( object  other)
inline

◆ GetHashCode()

override int Luciad.Input.KeyCode.GetHashCode ( )
inline

◆ operator!=()

static bool Luciad.Input.KeyCode.operator!= ( KeyCode  lhs,
KeyCode  rhs 
)
inlinestatic

◆ operator==()

static bool Luciad.Input.KeyCode.operator== ( KeyCode  lhs,
KeyCode  rhs 
)
inlinestatic

Property Documentation

◆ A

KeyCode Luciad.Input.KeyCode.A = new KeyCode(65)
staticget

A key code representing the 'A' key.

◆ Asterisk

KeyCode Luciad.Input.KeyCode.Asterisk = new KeyCode(42)
staticget

A key code representing the '*' key.

◆ B

KeyCode Luciad.Input.KeyCode.B = new KeyCode(66)
staticget

A key code representing the 'B' key.

◆ Backspace

KeyCode Luciad.Input.KeyCode.Backspace = new KeyCode(8)
staticget

A key code representing the backspace key.

◆ C

KeyCode Luciad.Input.KeyCode.C = new KeyCode(67)
staticget

A key code representing the 'C' key.

◆ D

KeyCode Luciad.Input.KeyCode.D = new KeyCode(68)
staticget

A key code representing the 'D' key.

◆ Del

KeyCode Luciad.Input.KeyCode.Del = new KeyCode(127)
staticget

A key code representing the delete key.

Since
2025.0

◆ Down

KeyCode Luciad.Input.KeyCode.Down = new KeyCode(205)
staticget

A key code representing the down key.

◆ E

KeyCode Luciad.Input.KeyCode.E = new KeyCode(69)
staticget

A key code representing the 'E' key.

◆ Eight

KeyCode Luciad.Input.KeyCode.Eight = new KeyCode(56)
staticget

A key code representing the '8' key.

◆ End

KeyCode Luciad.Input.KeyCode.End = new KeyCode(201)
staticget

A key code representing the end key.

◆ Enter

KeyCode Luciad.Input.KeyCode.Enter = new KeyCode(10)
staticget

A key code representing the enter key.

Since
2025.0

◆ Escape

KeyCode Luciad.Input.KeyCode.Escape = new KeyCode(27)
staticget

A key code representing the escape key.

◆ F

KeyCode Luciad.Input.KeyCode.F = new KeyCode(70)
staticget

A key code representing the 'F' key.

◆ F1

KeyCode Luciad.Input.KeyCode.F1 = new KeyCode(112)
staticget

A key code representing the F1 key.

Since
2025.0

◆ F10

KeyCode Luciad.Input.KeyCode.F10 = new KeyCode(121)
staticget

A key code representing the F10 key.

Since
2025.0

◆ F11

KeyCode Luciad.Input.KeyCode.F11 = new KeyCode(122)
staticget

A key code representing the F11 key.

Since
2025.0

◆ F12

KeyCode Luciad.Input.KeyCode.F12 = new KeyCode(123)
staticget

A key code representing the F12 key.

Since
2025.0

◆ F2

KeyCode Luciad.Input.KeyCode.F2 = new KeyCode(113)
staticget

A key code representing the F2 key.

Since
2025.0

◆ F3

KeyCode Luciad.Input.KeyCode.F3 = new KeyCode(114)
staticget

A key code representing the F3 key.

Since
2025.0

◆ F4

KeyCode Luciad.Input.KeyCode.F4 = new KeyCode(115)
staticget

A key code representing the F4 key.

Since
2025.0

◆ F5

KeyCode Luciad.Input.KeyCode.F5 = new KeyCode(116)
staticget

A key code representing the F5 key.

Since
2025.0

◆ F6

KeyCode Luciad.Input.KeyCode.F6 = new KeyCode(117)
staticget

A key code representing the F6 key.

Since
2025.0

◆ F7

KeyCode Luciad.Input.KeyCode.F7 = new KeyCode(118)
staticget

A key code representing the F7 key.

Since
2025.0

◆ F8

KeyCode Luciad.Input.KeyCode.F8 = new KeyCode(119)
staticget

A key code representing the F8 key.

Since
2025.0

◆ F9

KeyCode Luciad.Input.KeyCode.F9 = new KeyCode(120)
staticget

A key code representing the F9 key.

Since
2025.0

◆ Five

KeyCode Luciad.Input.KeyCode.Five = new KeyCode(53)
staticget

A key code representing the '5' key.

◆ Four

KeyCode Luciad.Input.KeyCode.Four = new KeyCode(52)
staticget

A key code representing the '4' key.

◆ G

KeyCode Luciad.Input.KeyCode.G = new KeyCode(71)
staticget

A key code representing the 'G' key.

◆ H

KeyCode Luciad.Input.KeyCode.H = new KeyCode(72)
staticget

A key code representing the 'H' key.

◆ Home

KeyCode Luciad.Input.KeyCode.Home = new KeyCode(200)
staticget

A key code representing the home key.

◆ I

KeyCode Luciad.Input.KeyCode.I = new KeyCode(73)
staticget

A key code representing the 'I' key.

◆ Index

uint Luciad.Input.KeyCode.Index
get

The index of the key code.

[get]

The index of the key code.

◆ Insert

KeyCode Luciad.Input.KeyCode.Insert = new KeyCode(155)
staticget

A key code representing the insert key.

Since
2025.0

◆ J

KeyCode Luciad.Input.KeyCode.J = new KeyCode(74)
staticget

A key code representing the 'J' key.

◆ K

KeyCode Luciad.Input.KeyCode.K = new KeyCode(75)
staticget

A key code representing the 'K' key.

◆ L

KeyCode Luciad.Input.KeyCode.L = new KeyCode(76)
staticget

A key code representing the 'L' key.

◆ Left

KeyCode Luciad.Input.KeyCode.Left = new KeyCode(202)
staticget

A key code representing the left key.

◆ M

KeyCode Luciad.Input.KeyCode.M = new KeyCode(77)
staticget

A key code representing the 'M' key.

◆ Minus

KeyCode Luciad.Input.KeyCode.Minus = new KeyCode(45)
staticget

A key code representing the '-' key.

◆ N

KeyCode Luciad.Input.KeyCode.N = new KeyCode(78)
staticget

A key code representing the 'N' key.

◆ Nine

KeyCode Luciad.Input.KeyCode.Nine = new KeyCode(57)
staticget

A key code representing the '9' key.

◆ O

KeyCode Luciad.Input.KeyCode.O = new KeyCode(79)
staticget

A key code representing the 'O' key.

◆ One

KeyCode Luciad.Input.KeyCode.One = new KeyCode(49)
staticget

A key code representing the '1' key.

◆ P

KeyCode Luciad.Input.KeyCode.P = new KeyCode(80)
staticget

A key code representing the 'P' key.

◆ PageDown

KeyCode Luciad.Input.KeyCode.PageDown = new KeyCode(207)
staticget

A key code representing the page down key.

◆ PageUp

KeyCode Luciad.Input.KeyCode.PageUp = new KeyCode(206)
staticget

A key code representing the pacge up key.

◆ Plus

KeyCode Luciad.Input.KeyCode.Plus = new KeyCode(43)
staticget

A key code representing the '+' key.

◆ Q

KeyCode Luciad.Input.KeyCode.Q = new KeyCode(81)
staticget

A key code representing the 'Q' key.

◆ R

KeyCode Luciad.Input.KeyCode.R = new KeyCode(82)
staticget

A key code representing the 'R' key.

◆ Right

KeyCode Luciad.Input.KeyCode.Right = new KeyCode(204)
staticget

A key code representing the right key.

◆ S

KeyCode Luciad.Input.KeyCode.S = new KeyCode(83)
staticget

A key code representing the 'S' key.

◆ Seven

KeyCode Luciad.Input.KeyCode.Seven = new KeyCode(55)
staticget

A key code representing the '7' key.

◆ Six

KeyCode Luciad.Input.KeyCode.Six = new KeyCode(54)
staticget

A key code representing the '6' key.

◆ Slash

KeyCode Luciad.Input.KeyCode.Slash = new KeyCode(47)
staticget

A key code representing the '/' key.

◆ Space

KeyCode Luciad.Input.KeyCode.Space = new KeyCode(32)
staticget

A key code representing the space key.

◆ T

KeyCode Luciad.Input.KeyCode.T = new KeyCode(84)
staticget

A key code representing the 'T' key.

◆ Tab

KeyCode Luciad.Input.KeyCode.Tab = new KeyCode(9)
staticget

A key code representing the tab key.

Since
2025.0

◆ Three

KeyCode Luciad.Input.KeyCode.Three = new KeyCode(51)
staticget

A key code representing the '3' key.

◆ Two

KeyCode Luciad.Input.KeyCode.Two = new KeyCode(50)
staticget

A key code representing the '2' key.

◆ U

KeyCode Luciad.Input.KeyCode.U = new KeyCode(85)
staticget

A key code representing the 'U' key.

◆ Unknown

KeyCode Luciad.Input.KeyCode.Unknown = new KeyCode(0)
staticget

A key code representing an unknown key.

◆ Up

KeyCode Luciad.Input.KeyCode.Up = new KeyCode(203)
staticget

A key code representing the up key.

◆ V

KeyCode Luciad.Input.KeyCode.V = new KeyCode(86)
staticget

A key code representing the 'V' key.

◆ W

KeyCode Luciad.Input.KeyCode.W = new KeyCode(87)
staticget

A key code representing the 'W' key.

◆ X

KeyCode Luciad.Input.KeyCode.X = new KeyCode(88)
staticget

A key code representing the 'X' key.

◆ Y

KeyCode Luciad.Input.KeyCode.Y = new KeyCode(89)
staticget

A key code representing the 'Y' key.

◆ Z

KeyCode Luciad.Input.KeyCode.Z = new KeyCode(90)
staticget

A key code representing the 'Z' key.

◆ Zero

KeyCode Luciad.Input.KeyCode.Zero = new KeyCode(48)
staticget

A key code representing the '0' key.