SoVRMLStringSensor Class Reference
[X3D Nodes]
Maps pointing device motion onto a plane.
Action not implemented for this node.
More...
#include <Inventor/VRMLnodes/SoVRMLStringSensor.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoVRMLStringSensor () | |
| virtual SbBool | affectsState () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static void | enableEvents (SbBool OnOffFlag) |
| static SbBool | isEventsEnabled () |
Public Attributes | |
| SoSFBool | deletionAllowed |
| SoSFBool | enabled |
| SoSFBool | isActive |
| SoSFString | enteredText |
| SoSFString | finalText |
Detailed Description
Maps pointing device motion onto a plane. Action not implemented for this node.
See the X3D Specification, below.
NOTE: This class does not exist in Open Inventor 10.0 and later.VRML X3D SPECIFICATION
- This section describes the expected behavior of the node in a conforming X3D browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.
This section may reference portions of the X3D specification that are not present in this help file. The complete X3D spec is available at http://www.web3d.org .
A StringSensor node generates events as the user presses keys on the keyboard. A StringSensor node can be enabled or disabled by sending it an enabled event with a value of TRUE or FALSE. If the StringSensor node is disabled, it does not track keyboard input or send events.
enteredText events are generated as keys which produce characters are pressed on the keyboard. The value of this event is the UTF-8 string entered including the latest character struck. The set of UTF-8 characters that can be generated will vary between different keyboards and different implementations.
If a deletionAllowed has value TRUE, the previously entered character in the enteredText is removed when the browser-recognized value for deleting the preceding character of a string is entered. Typically, this value is defined by the local operating system. If deletionAllowed has value FALSE, characters may only be added to the string; deletion of characters will not be allowed. Should the browser-recognized value for deleting the preceding character is entered, it will be ignored.
The finalText event is generated whenever the browser-recognized value for terminating a string is entered. Typically, this value is defined by the local operating system. When this recognition occurs, the finalText field generates an event with value equal to that of enteredText. After the finalText field event has been generated, the enteredText field is set to the empty string but no event is generated.
When the user begins typing, the StringSensor sends an isActive event with value TRUE. When the string is terminated, the StringSensor sends an isActive event with value FALSE.
The StringSensor is not affected by its position in the transformation hierarchy.
See "Key device sensor component" for more details.
FILE FORMAT/DEFAULT
- VRMLStringSensor {
| deletionAllowed | TRUE |
| enabled | TRUE |
| metadata | NULL |
EVENTS
- Deprecated:
-
Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual. - Inventor/VRMLnodes/SoVRMLStringSensor.h
eventIn
| SoSFBool | set_deletionAllowed |
| SoSFBool | set_enabled |
| SoSFNode | set_metadata |
eventOut
| SoSFString | enteredText |
| SoSFString | finalText |
| SoSFBool | isActive |
| SoSFBool | deletionAllowed_changed |
| SoSFBool | enabled_changed |
| SoSFNode | metadata_changed |
Constructor & Destructor Documentation
| SoVRMLStringSensor::SoVRMLStringSensor | ( | ) |
Constructor.
Member Function Documentation
| virtual SbBool SoVRMLStringSensor::affectsState | ( | ) | const [virtual] |
Returns TRUE if a node has an effect on the state during traversal.
The default method returns TRUE. Node classes (such as SoSeparator) that isolate their effects from the rest of the graph override this method to return FALSE.
Reimplemented from SoNode.
| static void SoVRMLStringSensor::enableEvents | ( | SbBool | OnOffFlag | ) | [static] |
Enables/disables events for all SoVRMLStringSensor objects.
If you have created several objects of this class, you can disable/enable events for all of them with a single call to this method.
| static SoType SoVRMLStringSensor::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoVRMLNode.
| virtual SoType SoVRMLStringSensor::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoVRMLNode.
| static SbBool SoVRMLStringSensor::isEventsEnabled | ( | ) | [static] |
Queries if events are enabled for all objects of this class.
Member Data Documentation
Enables (TRUE) or disables (FALSE) the deletion of text in the enteredText eventOut.
Enables (TRUE) or disables (FALSE) the sensor.
Output event sent when text entered.
Output event sent when text finished.
Output event sent when cursor on shape.
The documentation for this class was generated from the following file: