SoKeyGrabber

InventorModule

genre	Interaction
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoUtils
definition	utils.def
see also	SoMouseGrabber, KeyCounter
keywords	iv, keyboard, event, interaction

Purpose

The module SoKeyGrabber listens to keyboard events in an Open Inventor scene and triggers fields depending on the keys pressed.

Windows

Default Panel

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

ALT pressed: Bool	Key1Pressed: Trigger	On: Bool
CTRL pressed: Bool	Key2: Enum	SHIFT pressed: Bool
Is Auto Repeat: Bool	Key2Pressed: Trigger
Key Pressed: Trigger	Key3: Enum
Key Released: Trigger	Key3Pressed: Trigger
Key0: Enum	Key4: Enum
Key0Pressed: Trigger	Key4Pressed: Trigger
Key1: Enum	Last Key: Enum

Visible Fields

On

name: on, type: Bool, default: TRUE

If checked, the module listens to keyboard events.

Key Pressed

name: keyPressed, type: Trigger, persistent: no

Is triggered when any key is pressed.

Key Released

name: keyReleased, type: Trigger, persistent: no

Is triggered when a pressed key is released.

SHIFT pressed

name: shiftPressed, type: Bool, persistent: no

Shows whether the SHIFT key is currently pressed.

CTRL pressed

name: ctrlPressed, type: Bool, persistent: no

Shows whether the CTRL key is currently pressed.

ALT pressed

name: altPressed, type: Bool, persistent: no

Shows whether the ALT key is currently pressed.

Is Auto Repeat

name: isAutoRepeat, type: Bool, persistent: no

This field is set to true during auto-repeat, i.e., for the intermediate release and press events auto-generated between the real first press and real last release.

Last Key

name: lastKey, type: Enum, persistent: no, deprecated name: pressedKey

Shows the last key pressed.

Values:

Title	Name
Any	ANY
Left Shift	LEFT_SHIFT
Right Shift	RIGHT_SHIFT
Left Control	LEFT_CONTROL
Right Control	RIGHT_CONTROL
Left Alt	LEFT_ALT
Right Alt	RIGHT_ALT
Number 0	NUMBER_0
Number 1	NUMBER_1
Number 2	NUMBER_2
Number 3	NUMBER_3
Number 4	NUMBER_4
Number 5	NUMBER_5
Number 6	NUMBER_6
Number 7	NUMBER_7
Number 8	NUMBER_8
Number 9	NUMBER_9
A	A
B	B
C	C
D	D
E	E
F	F
G	G
H	H
I	I
J	J
K	K
L	L
M	M
N	N
O	O
P	P
Q	Q
R	R
S	S
T	T
U	U
V	V
W	W
X	X
Y	Y
Z	Z
Home	HOME
Left Arrow	LEFT_ARROW
Up Arrow	UP_ARROW
Right Arrow	RIGHT_ARROW
Down Arrow	DOWN_ARROW
Page Up	PAGE_UP
Page Down	PAGE_DOWN
Prior	PRIOR
Next	NEXT
End	END
Pad Enter	PAD_ENTER
Pad F1	PAD_F1
Pad F2	PAD_F2
Pad F3	PAD_F3
Pad F4	PAD_F4
Pad 0	PAD_0
Pad 1	PAD_1
Pad 2	PAD_2
Pad 3	PAD_3
Pad 4	PAD_4
Pad 5	PAD_5
Pad 6	PAD_6
Pad 7	PAD_7
Pad 8	PAD_8
Pad 9	PAD_9
Pad Add	PAD_ADD
Pad Subtract	PAD_SUBTRACT
Pad Multiply	PAD_MULTIPLY
Pad Divide	PAD_DIVIDE
Pad Space	PAD_SPACE
Pad Tab	PAD_TAB
Pad Insert	PAD_INSERT
Pad Delete	PAD_DELETE
Pad Period	PAD_PERIOD
F1	F1
F2	F2
F3	F3
F4	F4
F5	F5
F6	F6
F7	F7
F8	F8
F9	F9
F10	F10
F11	F11
F12	F12
Backspace	BACKSPACE
Tab	TAB
Return	RETURN
Enter	ENTER
Pause	PAUSE
Scroll Lock	SCROLL_LOCK
Escape	ESCAPE
Key Delete	KEY_DELETE
Print	PRINT
Num Lock	NUM_LOCK
Caps Lock	CAPS_LOCK
Shift Lock	SHIFT_LOCK
Space	SPACE
Apostrophe	APOSTROPHE
Comma	COMMA
Minus	MINUS
Period	PERIOD
Slash	SLASH
Semicolon	SEMICOLON
Equal	EQUAL
Bracketleft	BRACKETLEFT
Backslash	BACKSLASH
Bracketright	BRACKETRIGHT
Grave	GRAVE
Insert	INSERT
Right Super	RIGHT_SUPER
Left Super	LEFT_SUPER
Exclam	EXCLAM
Quotedbl	QUOTEDBL
Numbersign	NUMBERSIGN
Dollar	DOLLAR
Percent	PERCENT
Ampersand	AMPERSAND
Parenleft	PARENLEFT
Parenright	PARENRIGHT
Asterisk	ASTERISK
Plus	PLUS
Colon	COLON
Less	LESS
Greater	GREATER
Question	QUESTION
At	AT
Asciicircum	ASCIICIRCUM
Underscore	UNDERSCORE
Braceleft	BRACELEFT
Bar	BAR
Braceright	BRACERIGHT
Asciitilde	ASCIITILDE

Key0

name: key0, type: Enum, default: ANY, deprecated name: key00

Defines a key that triggers Key0Pressed on pressing.

Values:

Title	Name
Any	ANY
Left Shift	LEFT_SHIFT
Right Shift	RIGHT_SHIFT
Left Control	LEFT_CONTROL
Right Control	RIGHT_CONTROL
Left Alt	LEFT_ALT
Right Alt	RIGHT_ALT
Number 0	NUMBER_0
Number 1	NUMBER_1
Number 2	NUMBER_2
Number 3	NUMBER_3
Number 4	NUMBER_4
Number 5	NUMBER_5
Number 6	NUMBER_6
Number 7	NUMBER_7
Number 8	NUMBER_8
Number 9	NUMBER_9
A	A
B	B
C	C
D	D
E	E
F	F
G	G
H	H
I	I
J	J
K	K
L	L
M	M
N	N
O	O
P	P
Q	Q
R	R
S	S
T	T
U	U
V	V
W	W
X	X
Y	Y
Z	Z
Home	HOME
Left Arrow	LEFT_ARROW
Up Arrow	UP_ARROW
Right Arrow	RIGHT_ARROW
Down Arrow	DOWN_ARROW
Page Up	PAGE_UP
Page Down	PAGE_DOWN
Prior	PRIOR
Next	NEXT
End	END
Pad Enter	PAD_ENTER
Pad F1	PAD_F1
Pad F2	PAD_F2
Pad F3	PAD_F3
Pad F4	PAD_F4
Pad 0	PAD_0
Pad 1	PAD_1
Pad 2	PAD_2
Pad 3	PAD_3
Pad 4	PAD_4
Pad 5	PAD_5
Pad 6	PAD_6
Pad 7	PAD_7
Pad 8	PAD_8
Pad 9	PAD_9
Pad Add	PAD_ADD
Pad Subtract	PAD_SUBTRACT
Pad Multiply	PAD_MULTIPLY
Pad Divide	PAD_DIVIDE
Pad Space	PAD_SPACE
Pad Tab	PAD_TAB
Pad Insert	PAD_INSERT
Pad Delete	PAD_DELETE
Pad Period	PAD_PERIOD
F1	F1
F2	F2
F3	F3
F4	F4
F5	F5
F6	F6
F7	F7
F8	F8
F9	F9
F10	F10
F11	F11
F12	F12
Backspace	BACKSPACE
Tab	TAB
Return	RETURN
Enter	ENTER
Pause	PAUSE
Scroll Lock	SCROLL_LOCK
Escape	ESCAPE
Key Delete	KEY_DELETE
Print	PRINT
Num Lock	NUM_LOCK
Caps Lock	CAPS_LOCK
Shift Lock	SHIFT_LOCK
Space	SPACE
Apostrophe	APOSTROPHE
Comma	COMMA
Minus	MINUS
Period	PERIOD
Slash	SLASH
Semicolon	SEMICOLON
Equal	EQUAL
Bracketleft	BRACKETLEFT
Backslash	BACKSLASH
Bracketright	BRACKETRIGHT
Grave	GRAVE
Insert	INSERT
Right Super	RIGHT_SUPER
Left Super	LEFT_SUPER
Exclam	EXCLAM
Quotedbl	QUOTEDBL
Numbersign	NUMBERSIGN
Dollar	DOLLAR
Percent	PERCENT
Ampersand	AMPERSAND
Parenleft	PARENLEFT
Parenright	PARENRIGHT
Asterisk	ASTERISK
Plus	PLUS
Colon	COLON
Less	LESS
Greater	GREATER
Question	QUESTION
At	AT
Asciicircum	ASCIICIRCUM
Underscore	UNDERSCORE
Braceleft	BRACELEFT
Bar	BAR
Braceright	BRACERIGHT
Asciitilde	ASCIITILDE

Key1

name: key1, type: Enum, default: ANY, deprecated name: key01

Defines a key that triggers Key1Pressed on pressing.

Values:

Title	Name
Any	ANY
Left Shift	LEFT_SHIFT
Right Shift	RIGHT_SHIFT
Left Control	LEFT_CONTROL
Right Control	RIGHT_CONTROL
Left Alt	LEFT_ALT
Right Alt	RIGHT_ALT
Number 0	NUMBER_0
Number 1	NUMBER_1
Number 2	NUMBER_2
Number 3	NUMBER_3
Number 4	NUMBER_4
Number 5	NUMBER_5
Number 6	NUMBER_6
Number 7	NUMBER_7
Number 8	NUMBER_8
Number 9	NUMBER_9
A	A
B	B
C	C
D	D
E	E
F	F
G	G
H	H
I	I
J	J
K	K
L	L
M	M
N	N
O	O
P	P
Q	Q
R	R
S	S
T	T
U	U
V	V
W	W
X	X
Y	Y
Z	Z
Home	HOME
Left Arrow	LEFT_ARROW
Up Arrow	UP_ARROW
Right Arrow	RIGHT_ARROW
Down Arrow	DOWN_ARROW
Page Up	PAGE_UP
Page Down	PAGE_DOWN
Prior	PRIOR
Next	NEXT
End	END
Pad Enter	PAD_ENTER
Pad F1	PAD_F1
Pad F2	PAD_F2
Pad F3	PAD_F3
Pad F4	PAD_F4
Pad 0	PAD_0
Pad 1	PAD_1
Pad 2	PAD_2
Pad 3	PAD_3
Pad 4	PAD_4
Pad 5	PAD_5
Pad 6	PAD_6
Pad 7	PAD_7
Pad 8	PAD_8
Pad 9	PAD_9
Pad Add	PAD_ADD
Pad Subtract	PAD_SUBTRACT
Pad Multiply	PAD_MULTIPLY
Pad Divide	PAD_DIVIDE
Pad Space	PAD_SPACE
Pad Tab	PAD_TAB
Pad Insert	PAD_INSERT
Pad Delete	PAD_DELETE
Pad Period	PAD_PERIOD
F1	F1
F2	F2
F3	F3
F4	F4
F5	F5
F6	F6
F7	F7
F8	F8
F9	F9
F10	F10
F11	F11
F12	F12
Backspace	BACKSPACE
Tab	TAB
Return	RETURN
Enter	ENTER
Pause	PAUSE
Scroll Lock	SCROLL_LOCK
Escape	ESCAPE
Key Delete	KEY_DELETE
Print	PRINT
Num Lock	NUM_LOCK
Caps Lock	CAPS_LOCK
Shift Lock	SHIFT_LOCK
Space	SPACE
Apostrophe	APOSTROPHE
Comma	COMMA
Minus	MINUS
Period	PERIOD
Slash	SLASH
Semicolon	SEMICOLON
Equal	EQUAL
Bracketleft	BRACKETLEFT
Backslash	BACKSLASH
Bracketright	BRACKETRIGHT
Grave	GRAVE
Insert	INSERT
Right Super	RIGHT_SUPER
Left Super	LEFT_SUPER
Exclam	EXCLAM
Quotedbl	QUOTEDBL
Numbersign	NUMBERSIGN
Dollar	DOLLAR
Percent	PERCENT
Ampersand	AMPERSAND
Parenleft	PARENLEFT
Parenright	PARENRIGHT
Asterisk	ASTERISK
Plus	PLUS
Colon	COLON
Less	LESS
Greater	GREATER
Question	QUESTION
At	AT
Asciicircum	ASCIICIRCUM
Underscore	UNDERSCORE
Braceleft	BRACELEFT
Bar	BAR
Braceright	BRACERIGHT
Asciitilde	ASCIITILDE

Key2

name: key2, type: Enum, default: ANY, deprecated name: key02

Defines a key that triggers Key2Pressed on pressing.

Values:

Title	Name
Any	ANY
Left Shift	LEFT_SHIFT
Right Shift	RIGHT_SHIFT
Left Control	LEFT_CONTROL
Right Control	RIGHT_CONTROL
Left Alt	LEFT_ALT
Right Alt	RIGHT_ALT
Number 0	NUMBER_0
Number 1	NUMBER_1
Number 2	NUMBER_2
Number 3	NUMBER_3
Number 4	NUMBER_4
Number 5	NUMBER_5
Number 6	NUMBER_6
Number 7	NUMBER_7
Number 8	NUMBER_8
Number 9	NUMBER_9
A	A
B	B
C	C
D	D
E	E
F	F
G	G
H	H
I	I
J	J
K	K
L	L
M	M
N	N
O	O
P	P
Q	Q
R	R
S	S
T	T
U	U
V	V
W	W
X	X
Y	Y
Z	Z
Home	HOME
Left Arrow	LEFT_ARROW
Up Arrow	UP_ARROW
Right Arrow	RIGHT_ARROW
Down Arrow	DOWN_ARROW
Page Up	PAGE_UP
Page Down	PAGE_DOWN
Prior	PRIOR
Next	NEXT
End	END
Pad Enter	PAD_ENTER
Pad F1	PAD_F1
Pad F2	PAD_F2
Pad F3	PAD_F3
Pad F4	PAD_F4
Pad 0	PAD_0
Pad 1	PAD_1
Pad 2	PAD_2
Pad 3	PAD_3
Pad 4	PAD_4
Pad 5	PAD_5
Pad 6	PAD_6
Pad 7	PAD_7
Pad 8	PAD_8
Pad 9	PAD_9
Pad Add	PAD_ADD
Pad Subtract	PAD_SUBTRACT
Pad Multiply	PAD_MULTIPLY
Pad Divide	PAD_DIVIDE
Pad Space	PAD_SPACE
Pad Tab	PAD_TAB
Pad Insert	PAD_INSERT
Pad Delete	PAD_DELETE
Pad Period	PAD_PERIOD
F1	F1
F2	F2
F3	F3
F4	F4
F5	F5
F6	F6
F7	F7
F8	F8
F9	F9
F10	F10
F11	F11
F12	F12
Backspace	BACKSPACE
Tab	TAB
Return	RETURN
Enter	ENTER
Pause	PAUSE
Scroll Lock	SCROLL_LOCK
Escape	ESCAPE
Key Delete	KEY_DELETE
Print	PRINT
Num Lock	NUM_LOCK
Caps Lock	CAPS_LOCK
Shift Lock	SHIFT_LOCK
Space	SPACE
Apostrophe	APOSTROPHE
Comma	COMMA
Minus	MINUS
Period	PERIOD
Slash	SLASH
Semicolon	SEMICOLON
Equal	EQUAL
Bracketleft	BRACKETLEFT
Backslash	BACKSLASH
Bracketright	BRACKETRIGHT
Grave	GRAVE
Insert	INSERT
Right Super	RIGHT_SUPER
Left Super	LEFT_SUPER
Exclam	EXCLAM
Quotedbl	QUOTEDBL
Numbersign	NUMBERSIGN
Dollar	DOLLAR
Percent	PERCENT
Ampersand	AMPERSAND
Parenleft	PARENLEFT
Parenright	PARENRIGHT
Asterisk	ASTERISK
Plus	PLUS
Colon	COLON
Less	LESS
Greater	GREATER
Question	QUESTION
At	AT
Asciicircum	ASCIICIRCUM
Underscore	UNDERSCORE
Braceleft	BRACELEFT
Bar	BAR
Braceright	BRACERIGHT
Asciitilde	ASCIITILDE

Key3

name: key3, type: Enum, default: ANY, deprecated name: key03

Defines a key that triggers Key3Pressed on pressing.

Values:

Title	Name
Any	ANY
Left Shift	LEFT_SHIFT
Right Shift	RIGHT_SHIFT
Left Control	LEFT_CONTROL
Right Control	RIGHT_CONTROL
Left Alt	LEFT_ALT
Right Alt	RIGHT_ALT
Number 0	NUMBER_0
Number 1	NUMBER_1
Number 2	NUMBER_2
Number 3	NUMBER_3
Number 4	NUMBER_4
Number 5	NUMBER_5
Number 6	NUMBER_6
Number 7	NUMBER_7
Number 8	NUMBER_8
Number 9	NUMBER_9
A	A
B	B
C	C
D	D
E	E
F	F
G	G
H	H
I	I
J	J
K	K
L	L
M	M
N	N
O	O
P	P
Q	Q
R	R
S	S
T	T
U	U
V	V
W	W
X	X
Y	Y
Z	Z
Home	HOME
Left Arrow	LEFT_ARROW
Up Arrow	UP_ARROW
Right Arrow	RIGHT_ARROW
Down Arrow	DOWN_ARROW
Page Up	PAGE_UP
Page Down	PAGE_DOWN
Prior	PRIOR
Next	NEXT
End	END
Pad Enter	PAD_ENTER
Pad F1	PAD_F1
Pad F2	PAD_F2
Pad F3	PAD_F3
Pad F4	PAD_F4
Pad 0	PAD_0
Pad 1	PAD_1
Pad 2	PAD_2
Pad 3	PAD_3
Pad 4	PAD_4
Pad 5	PAD_5
Pad 6	PAD_6
Pad 7	PAD_7
Pad 8	PAD_8
Pad 9	PAD_9
Pad Add	PAD_ADD
Pad Subtract	PAD_SUBTRACT
Pad Multiply	PAD_MULTIPLY
Pad Divide	PAD_DIVIDE
Pad Space	PAD_SPACE
Pad Tab	PAD_TAB
Pad Insert	PAD_INSERT
Pad Delete	PAD_DELETE
Pad Period	PAD_PERIOD
F1	F1
F2	F2
F3	F3
F4	F4
F5	F5
F6	F6
F7	F7
F8	F8
F9	F9
F10	F10
F11	F11
F12	F12
Backspace	BACKSPACE
Tab	TAB
Return	RETURN
Enter	ENTER
Pause	PAUSE
Scroll Lock	SCROLL_LOCK
Escape	ESCAPE
Key Delete	KEY_DELETE
Print	PRINT
Num Lock	NUM_LOCK
Caps Lock	CAPS_LOCK
Shift Lock	SHIFT_LOCK
Space	SPACE
Apostrophe	APOSTROPHE
Comma	COMMA
Minus	MINUS
Period	PERIOD
Slash	SLASH
Semicolon	SEMICOLON
Equal	EQUAL
Bracketleft	BRACKETLEFT
Backslash	BACKSLASH
Bracketright	BRACKETRIGHT
Grave	GRAVE
Insert	INSERT
Right Super	RIGHT_SUPER
Left Super	LEFT_SUPER
Exclam	EXCLAM
Quotedbl	QUOTEDBL
Numbersign	NUMBERSIGN
Dollar	DOLLAR
Percent	PERCENT
Ampersand	AMPERSAND
Parenleft	PARENLEFT
Parenright	PARENRIGHT
Asterisk	ASTERISK
Plus	PLUS
Colon	COLON
Less	LESS
Greater	GREATER
Question	QUESTION
At	AT
Asciicircum	ASCIICIRCUM
Underscore	UNDERSCORE
Braceleft	BRACELEFT
Bar	BAR
Braceright	BRACERIGHT
Asciitilde	ASCIITILDE

Key4

name: key4, type: Enum, default: ANY, deprecated name: key04

Defines a key that triggers Key4Pressed on pressing.

Values:

Title	Name
Any	ANY
Left Shift	LEFT_SHIFT
Right Shift	RIGHT_SHIFT
Left Control	LEFT_CONTROL
Right Control	RIGHT_CONTROL
Left Alt	LEFT_ALT
Right Alt	RIGHT_ALT
Number 0	NUMBER_0
Number 1	NUMBER_1
Number 2	NUMBER_2
Number 3	NUMBER_3
Number 4	NUMBER_4
Number 5	NUMBER_5
Number 6	NUMBER_6
Number 7	NUMBER_7
Number 8	NUMBER_8
Number 9	NUMBER_9
A	A
B	B
C	C
D	D
E	E
F	F
G	G
H	H
I	I
J	J
K	K
L	L
M	M
N	N
O	O
P	P
Q	Q
R	R
S	S
T	T
U	U
V	V
W	W
X	X
Y	Y
Z	Z
Home	HOME
Left Arrow	LEFT_ARROW
Up Arrow	UP_ARROW
Right Arrow	RIGHT_ARROW
Down Arrow	DOWN_ARROW
Page Up	PAGE_UP
Page Down	PAGE_DOWN
Prior	PRIOR
Next	NEXT
End	END
Pad Enter	PAD_ENTER
Pad F1	PAD_F1
Pad F2	PAD_F2
Pad F3	PAD_F3
Pad F4	PAD_F4
Pad 0	PAD_0
Pad 1	PAD_1
Pad 2	PAD_2
Pad 3	PAD_3
Pad 4	PAD_4
Pad 5	PAD_5
Pad 6	PAD_6
Pad 7	PAD_7
Pad 8	PAD_8
Pad 9	PAD_9
Pad Add	PAD_ADD
Pad Subtract	PAD_SUBTRACT
Pad Multiply	PAD_MULTIPLY
Pad Divide	PAD_DIVIDE
Pad Space	PAD_SPACE
Pad Tab	PAD_TAB
Pad Insert	PAD_INSERT
Pad Delete	PAD_DELETE
Pad Period	PAD_PERIOD
F1	F1
F2	F2
F3	F3
F4	F4
F5	F5
F6	F6
F7	F7
F8	F8
F9	F9
F10	F10
F11	F11
F12	F12
Backspace	BACKSPACE
Tab	TAB
Return	RETURN
Enter	ENTER
Pause	PAUSE
Scroll Lock	SCROLL_LOCK
Escape	ESCAPE
Key Delete	KEY_DELETE
Print	PRINT
Num Lock	NUM_LOCK
Caps Lock	CAPS_LOCK
Shift Lock	SHIFT_LOCK
Space	SPACE
Apostrophe	APOSTROPHE
Comma	COMMA
Minus	MINUS
Period	PERIOD
Slash	SLASH
Semicolon	SEMICOLON
Equal	EQUAL
Bracketleft	BRACKETLEFT
Backslash	BACKSLASH
Bracketright	BRACKETRIGHT
Grave	GRAVE
Insert	INSERT
Right Super	RIGHT_SUPER
Left Super	LEFT_SUPER
Exclam	EXCLAM
Quotedbl	QUOTEDBL
Numbersign	NUMBERSIGN
Dollar	DOLLAR
Percent	PERCENT
Ampersand	AMPERSAND
Parenleft	PARENLEFT
Parenright	PARENRIGHT
Asterisk	ASTERISK
Plus	PLUS
Colon	COLON
Less	LESS
Greater	GREATER
Question	QUESTION
At	AT
Asciicircum	ASCIICIRCUM
Underscore	UNDERSCORE
Braceleft	BRACELEFT
Bar	BAR
Braceright	BRACERIGHT
Asciitilde	ASCIITILDE

Key0Pressed

name: key0Pressed, type: Trigger, persistent: no, deprecated name: keyPressed00

Is triggered when the key defined in Key0 is pressed.

Key1Pressed

name: key1Pressed, type: Trigger, persistent: no, deprecated name: keyPressed01

Is triggered when the key defined in Key1 is pressed.

Key2Pressed

name: key2Pressed, type: Trigger, persistent: no, deprecated name: keyPressed02

Is triggered when the key defined in Key2 is pressed.

Key3Pressed

name: key3Pressed, type: Trigger, persistent: no, deprecated name: keyPressed03

Is triggered when the key defined in Key3 is pressed.

Key4Pressed

name: key4Pressed, type: Trigger, persistent: no, deprecated name: keyPressed04

Is triggered when the key defined in Key4 is pressed.