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:

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

virtual void	keyboardUp (int key, bool special_key)=0
	Virtual function called when a key is released. More...

Public Member Functions inherited from H3D::X3DSensorNode
	X3DSensorNode (Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isActive=0)
	Constructor.

Public Member Functions inherited from H3D::X3DChildNode
	X3DChildNode (Inst< SFNode > _metadata=0)
	Constructor.

Public Member Functions inherited from H3D::X3DNode
	X3DNode (Inst< SFNode > _metadata=0)
	Constructor.

X3DMetadataObject *	getMetadataByName (const string &_name)
	Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More...

Public Member Functions inherited from H3D::Node
	Node ()
	Constructor.

virtual Node *	clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
	Returns a new instance of this node type with the same state as this one. More...

virtual	~Node ()
	Destructor.

X3DPrototypeInstance *	getProtoInstanceParent ()
	If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...

void	setProtoInstanceParent (X3DPrototypeInstance *p)
	Set the X3DPrototypeInstance this node is the the root node if applicaple.

virtual void	render ()
	the render() function is used for the depth-first rendering traversal of the scene-graph. More...

virtual void	traverseSG (TraverseInfo &ti)
	traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More...

virtual bool	lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
	Detect intersection between a line segment and the Node. More...

virtual void	closestPoint (const Vec3f &p, NodeIntersectResult &result)
	Find closest point on Node to p. More...

virtual bool	movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
	Detect collision between a moving sphere and the Node. More...

virtual string	defaultXMLContainerField ()
	Returns the default xml containerField attribute value. More...

virtual Field *	getField (const string &_name) const
	return a pointer to the field specified by name within this instance

int	addDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

int	removeDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

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.

Static Public Member Functions inherited from H3D::Node
static unsigned int	nrNodesAlive ()
	Returns the nr of nodes currently alive, i.e. nodes created but not destructed.

static int	nrNodesCreated ()
	Returns the number of nodes created in total since the start of the program.

Additional Inherited Members
Public Types inherited from H3D::Node
typedef std::map< Node , Node >	DeepCopyMap
	A map type used during a deep copy clone() to map from original nodes to cloned nodes.

Public Attributes inherited from H3D::X3DSensorNode
H3DUniquePtr< SFBool >	enabled
	If enabled is true the sensor node is enabled otherwise it is disabled and will not generate any output. More...

H3DUniquePtr< SFBool >	isActive
	A sensor is active when some special conditions are fulfilled and it will then generate extra output. More...

Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNode >	metadata
	Meta data about the node. More...

Static Public Attributes inherited from H3D::X3DSensorNode
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

Static Public Attributes inherited from H3D::X3DNode
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

Protected Member Functions inherited from H3D::Node
void	cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for the clone() method. More...

Static Protected Member Functions inherited from H3D::Node
static Node *	getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for nodes that implement clone() More...

Detailed Description

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

Member Function Documentation

◆ keyboardDown()

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::StringSensor, and H3D::KeySensor.

◆ keyboardUp()

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::StringSensor, and H3D::KeySensor.

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ keyboardDown()

◆ keyboardUp()