SoVRMLKeySensor Class Reference
[X3D Nodes]

Maps pointing device motion onto a plane.
Action not implemented for this node. More...

#include <Inventor/VRMLnodes/SoVRMLKeySensor.h>

Inheritance diagram for SoVRMLKeySensor:

Public Member Functions
virtual SoType	getTypeId () const
	SoVRMLKeySensor ()
virtual SbBool	affectsState () const
Static Public Member Functions
static SoType	getClassTypeId ()
static void	enableEvents (SbBool OnOffFlag)
static SbBool	isEventsEnabled ()
Public Attributes
SoSFBool	enabled
SoSFBool	isActive
SoSFInt32	actionKeyPress
SoSFInt32	actionKeyRelease
SoSFBool	altKey
SoSFBool	controlKey
SoSFString	keyPress
SoSFString	keyRelease
SoSFBool	shiftKey

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 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 .

The SoVRMLKeySensor node generates events when the user presses keys on the keyboard. A SoVRMLKeySensor node can be enabled or disabled by sending it an enabled event with TRUE or FALSE. If the SoVRMLKeySensor node is disabled, it does not track keyboard input or send events.

keyPress and keyRelease events are generated as keys which produce characters are pressed or released on the keyboard. The values of these events is a string of length 1 containing the single UTF-8 character associated with the key pressed.

actionKeyPress and actionKeyRelease events are generated as 'action' keys are pressed and released on the keyboard.

Action Key Values

HOME
PGDN
LEFT
END
UP
RIGHT
PGUP
DOWN
F1-F12

13
16
19
14
17
20
15
18
1-12

shiftKey_depressed, controlKey_depressed, and altKey_depressed events are generated as the shift, control, and alt keys on the keyboard are pressed and released. Their value is TRUE when the key is pressed and FALSE when the key is released.

When a key is pressed, the SoVRMLKeySensor sends an isActive event with the value TRUE. Once the key is released, the SoVRMLKeySensor sends an isActive event with the value FALSE.

The SoVRMLKeySensor is not affected by its position in the transformation hierarchy.

FILE FORMAT/DEFAULT

enabled	TRUE
metadata	NULL

EVENTS

eventIn

SoSFBool	set_enabled
SoSFNode	set_metadata

eventOut

SoSFBool	enabled_changed
SoSFInt32	actionKeyPress
SoSFInt32	actionKeyRelease
SoSFBool	altKey
SoSFBool	controlKey
SoSFBool	shiftKey
SoSFBool	isActive
SoSFString	keyPress
SoSFString	keyRelease
SoSFNode	metadata_changed

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.

Constructor & Destructor Documentation

SoVRMLKeySensor::SoVRMLKeySensor ( )

Constructor.

Member Function Documentation

virtual SbBool SoVRMLKeySensor::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 SoVRMLKeySensor::enableEvents ( SbBool OnOffFlag ) [static]

Enables/disables events for all SoVRMLKeySensor 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 SoVRMLKeySensor::getClassTypeId ( ) [static]

Returns the type identifier for this class.

Reimplemented from SoVRMLNode.

virtual SoType SoVRMLKeySensor::getTypeId ( ) const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoVRMLNode.

static SbBool SoVRMLKeySensor::isEventsEnabled ( ) [static]

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