StringSensor
StringSensor generates events as the user presses keys on the keyboard.
Inheritance
Code
XML encoding
<StringSensor deletionAllowed='TRUE' triggerName='Timer' keysToConsume='ALL' description='' enabled='TRUE' logFeature='' />
Classic encoding
StringSensor { deletionAllowed TRUE triggerName "Timer" keysToConsume ["ALL"] description "" enabled TRUE logFeature [""] }
Interface
Filter: X3D only | Avalon only | All
id | Name | DataType | PartType | Default | ValueType | Description |
---|---|---|---|---|---|---|
deletionAllowed | SFBool | inputOutput | TRUE | If deletionAllowed is true, then previously entered character in enteredText can be removed. If deletionAllowed is false, then characters may only be added to the string. Hint: deletion key is typically defined by local system. | ||
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. | ||
enteredText | SFString | outputOnly | Events generated as character-producing keys are pressed on keyboard. | |||
finalText | SFString | outputOnly | Events generated when sequence of keystrokes matches keys in terminationText string when this condition occurs, enteredText is moved to finalText and enteredText is set to empty string. Hint: termination key is typically defined by local system. | |||
isActive | SFBool | outputOnly | FALSE | isActive true/false events are sent when the sensor gets active | ||
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). | ||
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 | ||
metadata | SFNode | inputOutput | MetadataObject | container for payload metadata inside MetadataSet element | ||
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. | ||
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. |