H3D::X3DKeyDeviceSensorNode Class Reference
[Abstract nodes.]

This abstract node type is the base type for all sensor node types which operate using key devices. More...

#include <H3D/X3DKeyDeviceSensorNode.h>

Inheritance diagram for H3D::X3DKeyDeviceSensorNode:

Inheritance graph

List of all members.

Public Member Functions

 X3DKeyDeviceSensorNode (Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isActive=0)
 Constructor.
 ~X3DKeyDeviceSensorNode ()
 Destructor.
virtual void keyboardDown (int key, bool special_key)=0
 Virtual function called when a key is pressed.
virtual void keyboardUp (int key, bool special_key)=0
 Virtual function called when a key is released.

Static Public Member Functions

static void keyboardDownCallback (unsigned char key)
 Call this function from a window whenever the window get a character event.
static void keyboardSpecialDownCallback (int key)
 Call this function from a window whenever the window get a key event.
static void keyboardUpCallback (unsigned char key)
 Call this function from a window whenever the window get a character event.
static void keyboardSpecialUpCallback (int key)
 Call this function from a window whenever the window get a key event.


Detailed Description

This abstract node type is the base type for all sensor node types which operate using key devices.

Member Function Documentation

virtual void H3D::X3DKeyDeviceSensorNode::keyboardDown ( int  key,
bool  special_key 
) [pure virtual]

Virtual function called when a key is pressed.

Parameters:
key The value of the key pressed, either ascii character or function key value depending on special_key argument.
special_key true if function key is pressed, false otherwise

Implemented in H3D::KeySensor, and H3D::StringSensor.

virtual void H3D::X3DKeyDeviceSensorNode::keyboardUp ( int  key,
bool  special_key 
) [pure virtual]

Virtual function called when a key is released.

Parameters:
key The value of the key pressed, either ascii character or function key value depending on special_key argument.
special_key true if function key is pressed, false otherwise

Implemented in H3D::KeySensor, and H3D::StringSensor.


The documentation for this class was generated from the following files:

Generated on Fri Nov 7 10:31:27 2008 for H3D API by  doxygen 1.5.7