com.openinventor.inventor.vrmlnodes

Class SoVRMLStringSensor

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLStringSensor

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLStringSensor
extends SoVRMLNode

Maps pointing device motion onto a plane.
<font color="#FF0000">Action not implemented for this node. </font>

See the X3D Specification, below.

<font color="#0000FF">NOTE:</font> 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

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

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFBool	deletionAllowed Deprecated. Enables (true) or disables (false) the deletion of text in the enteredText eventOut.
SoSFBool	enabled Deprecated. Enables (true) or disables (false) the sensor.
SoSFString	enteredText Deprecated. Output event sent when text entered.
SoSFString	finalText Deprecated. Output event sent when text finished.
SoSFBool	isActive Deprecated. Output event sent when cursor on shape.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLNode

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLStringSensor() Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
static void	enableEvents(boolean OnOffFlag) Deprecated. Enables/disables events for all SoVRMLStringSensor objects.
static boolean	isEventsEnabled() Deprecated. Queries if events are enabled for all objects of this class.

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

deletionAllowed

public final SoSFBool deletionAllowed

Deprecated.

Enables (true) or disables (false) the deletion of text in the enteredText eventOut.

enabled

public final SoSFBool enabled

Deprecated.

Enables (true) or disables (false) the sensor.

isActive

public final SoSFBool isActive

Deprecated.

Output event sent when cursor on shape.

enteredText

public final SoSFString enteredText

Deprecated.

Output event sent when text entered.

finalText

public final SoSFString finalText

Deprecated.

Output event sent when text finished.

Constructor Detail

SoVRMLStringSensor

public SoVRMLStringSensor()

Deprecated.

Constructor.

Method Detail

isEventsEnabled

public static boolean isEventsEnabled()

Deprecated.

Queries if events are enabled for all objects of this class.

enableEvents

public static void enableEvents(boolean OnOffFlag)

Deprecated.

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.