KeySensor
KeySensor generates events as the user presses keys on the keyboard. Supports notion of 'keyboard focus'.
Inheritance
Code
XML encoding
<KeySensor triggerName='Timer' keysToConsume='ALL' description='' enabled='TRUE' logFeature='' />
Classic encoding
KeySensor { triggerName "Timer" keysToConsume ["ALL"] description "" enabled TRUE logFeature [""] }
Interface
Filter: X3D only | Avalon only | All
id | Name | DataType | PartType | Default | ValueType | Description |
---|---|---|---|---|---|---|
actionKeyPress | SFInt32 | outputOnly | action key press gives following values: HOME=13 END=14 PGUP=15 PGDN=16 UP=17 DOWN=18 LEFT=19 RIGHT=20 F1-F12=1-12. | |||
actionKeyRelease | SFInt32 | outputOnly | action key release gives following values: HOME=13 END=14 PGUP=15 PGDN=16 UP=17 DOWN=18 LEFT=19 RIGHT=20 F1-F12=1-12. | |||
altKey | SFBool | outputOnly | "altKey" generates true event when pressed, false event when released. | |||
controlKey | SFBool | outputOnly | "controlKey" generates true event when pressed, false event when released. | |||
shiftKey | SFBool | outputOnly | "shiftKey" generates true event when pressed, false event when released. | |||
keyPress | SFString | outputOnly | Events generated when user presses character-producing keys on keyboard produces integer UTF-8 character values. | |||
keyRelease | SFString | outputOnly | Events generated when user releases character-producing keys on keyboard produces integer UTF-8 character values. | |||
description | SFString | inputOutput | Text description to comment the sensor task. Can be used in run-time systems to give usefull feedback to the user and developer | |||
enabled | SFBool | inputOutput | TRUE | Enables/disables the sensor node. | ||
isActive | SFBool | outputOnly | FALSE | isActive true/false events are sent when the sensor gets active | ||
metadata | SFNode | inputOutput | MetadataObject | container for payload metadata inside MetadataSet element |