A sensor node for reading mouse values. More...

#include <H3D/MouseSensor.h>

Inheritance diagram for H3D::MouseSensor:

Public Member Functions
	MouseSensor (Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isActive=0, Inst< SFVec2f > _position=0, Inst< SFBool > _leftButton=0, Inst< SFBool > _middleButton=0, Inst< SFBool > _rightButton=0, Inst< SFVec2f > _motion=0, Inst< SFBool > _scrollUp=0, Inst< SFBool > _scrollDown=0)
	Constructor.

virtual	~MouseSensor ()
	Destructor.

virtual void	mouseMotionAction (int x, int y)
	Will be called when the mouse has moved. More...

virtual void	mouseButtonAction (int button, int state)
	Will be called when a mouse button event occurs. More...

virtual void	mouseWheelAction (int direction)
	Will be called when a mouse scroll wheel event occurs. 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	buttonCallback (int button, int state)
	Calls mouseButtonAction() on all MouseSensor instances.

static void	motionCallback (int x, int y)
	Calls mouseMotionAction() on all MouseSensor instances.

static void	wheelCallback (int direction)
	Calls mouseWheelAction() on all MouseSensor instances.

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.

Public Attributes
H3DUniquePtr< SFVec2f >	position
	The position of the mouse in window relative coordinates. More...

H3DUniquePtr< SFBool >	leftButton
	The status of the left button. More...

H3DUniquePtr< SFBool >	middleButton
	The status of the middle button. More...

H3DUniquePtr< SFBool >	rightButton
	The status of the right button. More...

H3DUniquePtr< SFVec2f >	motion
	The relative motion since in the last change of the position field. More...

H3DUniquePtr< SFBool >	scrollUp
	The scrollUp field generates a TRUE event when the mouse scroll wheel is moved up. More...

H3DUniquePtr< SFBool >	scrollDown
	The scrollDown field generates a TRUE event when the mouse scroll wheel is moved down. More...

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
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

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.

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.

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

A sensor node for reading mouse values.

Examples:

MouseSensor.x3d ( Source )

Member Function Documentation

◆ mouseButtonAction()

void MouseSensor::mouseButtonAction	(	int	button,
		int	state
	)

virtual

Will be called when a mouse button event occurs.

Parameters

button	is one of LEFT_BUTTON, MIDDLE_BUTTON, or RIGHT_BUTTON.
state	is either UP or DOWN indicating whether the callback was due to a release or press respectively.

References H3D::X3DSensorNode::enabled, leftButton, middleButton, and rightButton.

◆ mouseMotionAction()

void MouseSensor::mouseMotionAction	(	int	x,
		int	y
	)

virtual

Will be called when the mouse has moved.

The x and y parameters indicate the mouse location in window relative coordinates.

References H3D::X3DSensorNode::enabled, motion, position, Vec2f(), and x.

◆ mouseWheelAction()

void MouseSensor::mouseWheelAction ( int direction )

virtual

Will be called when a mouse scroll wheel event occurs.

direction is one of FROM or TOWARDS

References H3D::X3DSensorNode::enabled, scrollDown, and scrollUp.

Member Data Documentation

◆ leftButton

H3DUniquePtr< SFBool> H3D::MouseSensor::leftButton

The status of the left button.

TRUE indicates that it is pressed.

Access type: outputOnly

Referenced by mouseButtonAction(), and MouseSensor().

◆ middleButton

H3DUniquePtr< SFBool> H3D::MouseSensor::middleButton

The status of the middle button.

TRUE indicates that it is pressed.

Access type: outputOnly

Referenced by mouseButtonAction(), and MouseSensor().

◆ motion

H3DUniquePtr< SFVec2f> H3D::MouseSensor::motion

The relative motion since in the last change of the position field.

Access type: outputOnly

Referenced by mouseMotionAction().

◆ position

H3DUniquePtr< SFVec2f> H3D::MouseSensor::position

The position of the mouse in window relative coordinates.

Access type: outputOnly

Referenced by mouseMotionAction(), and MouseSensor().

◆ rightButton

H3DUniquePtr< SFBool> H3D::MouseSensor::rightButton

The status of the right button.

TRUE indicates that it is pressed.

Access type: outputOnly

Referenced by mouseButtonAction(), and MouseSensor().

◆ scrollDown

H3DUniquePtr< SFBool > H3D::MouseSensor::scrollDown

The scrollDown field generates a TRUE event when the mouse scroll wheel is moved down.

Access type: outputOnly

Referenced by MouseSensor(), and mouseWheelAction().

◆ scrollUp

H3DUniquePtr< SFBool > H3D::MouseSensor::scrollUp

The scrollUp field generates a TRUE event when the mouse scroll wheel is moved up.

Access type: outputOnly

Referenced by MouseSensor(), and mouseWheelAction().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ mouseButtonAction()

◆ mouseMotionAction()

◆ mouseWheelAction()

Member Data Documentation

◆ leftButton

◆ middleButton

◆ motion

◆ position

◆ rightButton

◆ scrollDown

◆ scrollUp