instantreality 1.0

Component:
KeyDeviceSensor
Status:
partly implemented
Structure type:
concrete
Standard:
X3D3.0

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
MFString keysToConsume MFString inputOutput ALL List of keys this sensor should consume, i.e. NOT pass on to the viewareas. The sensor will still react to ALL key presses. Keys can be specified as characters (e.g. 'a'), as key codes ('#123'), or as Navigator-ActionKey strings (e.g. 'ESC'). The special string 'ALL' means the sensor whould consume all events (default behavior).
MFString logFeature MFString inputOutput state, child, parent, route, eventIn, eventOut controls the logging of changes, state: log state changes (e.g. live), child: log child add/remove, parent: log parent add/remove, route: log route add/remove; eventIn: log receiving of events, eventOut: log sending of events: guiView, runtime system should create node-view, guiEdit: runtime system should create node-editeverything: log everything
SFBool altKey SFBool outputOnly "altKey" generates true event when pressed, false event when released.
SFBool controlKey SFBool outputOnly "controlKey" generates true event when pressed, false event when released.
SFBool enabled SFBool inputOutput TRUE Enables/disables the sensor node.
SFBool isActive SFBool outputOnly FALSE isActive true/false events are sent when the sensor gets active
SFBool shiftKey SFBool outputOnly "shiftKey" generates true event when pressed, false event when released.
SFInt32 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.
SFInt32 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.
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
SFString 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
SFString keyPress SFString outputOnly Events generated when user presses character-producing keys on keyboard produces integer UTF-8 character values.
SFString keyRelease SFString outputOnly Events generated when user releases character-producing keys on keyboard produces integer UTF-8 character values.
SFString triggerName SFString initializeOnly Timer Name of the dynamic context-slot which is used by the run-time environment (e.g. Jobs) to trigger the node. Life-Nodes will automatically connect the context-eventOutut to the triggerSlot-eventInput Slot.
SFTime triggerSlot SFTime inputOnly slot which is used internally to connect a dynamic context-slot which name is set by the triggerName value. Its used automatically to install run-time environment trigger.