Titania X3D Editor

Bring Colours to Your Life.

Titania v4.0.1

Bring Colours to Your Life.

X3D Reference

StringSensor

StringSensor

StringSensor generates events as the user presses keys on the keyboard.

The StringSensor node belongs to the KeyDeviceSensor component and its container field is children. It is available since X3D version 3.0 or later.

Hierarchy

Fields

SFNode [in, out] metadata NULL [X3DMetadataObject]

Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.

SFBool [in, out] enabled TRUE

Enables/disables node operation.

SFBool [in, out] deletionAllowed 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.

SFString [out] enteredText

Events generated as character-producing keys are pressed on keyboard.

SFString [out] finalText

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.

SFBool [out] isActive

Select geometry by activating the pointing device (e.g. clicking the mouse) to generate isActive events. Output event isActive=true is sent when geometry is selected (e.g. when primary mouse button is pressed), output event isActive=false is sent when geometry is deselected (e.g. when primary mouse button is released).

Browser Compatibility

Titania X_ITE
no no

External Links