openvrml::pointing_device_sensor_node Class Reference

A node that can be affected by a pointing device. More...

#include <openvrml/node.h>

Inheritance diagram for openvrml::pointing_device_sensor_node:

Public Member Functions
virtual	~pointing_device_sensor_node ()=0 throw ()
	Destroy. More...
void	activate (double timestamp, bool over, bool active, const double(&point)[3])
	Convey a pointing device state change. More...
Public Member Functions inherited from openvrml::child_node
virtual	~child_node ()=0 throw ()
	Destructor. More...
void	relocate () throw ( std::bad_alloc )
	Called when the node is relocated to a new position in the scene graph. More...
void	render_child (viewer &v, rendering_context context)
	Render the node. More...
Public Member Functions inherited from openvrml::bounded_volume_node
virtual	~bounded_volume_node () throw ()
	Destroy. More...
const openvrml::bounding_volume &	bounding_volume () const
	Get this node's bounding volume. More...
Public Member Functions inherited from openvrml::node
virtual	~node ()=0 throw ()
	Destructor. More...
void	add_ref () const throw ()
	Increment the reference count. More...
void	remove_ref () const throw ()
	Decrement the reference count. More...
void	release () const throw ()
	Decrement the reference count; destroy the instance if the count drops to zero. More...
size_t	use_count () const throw ()
	The number of owning references to the instance. More...
const node_type &	type () const throw ()
	The type information object for the node. More...
const std::string &	id () const throw ()
	Retrieve the name of this node. More...
void	id (const std::string &node_id) throw ( std::bad_alloc )
	Set the name of the node. More...
const openvrml::scope &	scope () const throw ()
	Get the scope to which the node belongs. More...
openvrml::scene *	scene () const throw ()
	Get the scene with which the node is associated. More...
const std::vector < boost::intrusive_ptr< node > > &	impl_nodes () const throw ()
	Get the implementation nodes of a PROTO instance. More...
std::ostream &	print (std::ostream &out, size_t indent) const
	Pretty print. More...
void	initialize (openvrml::scene &scene, double timestamp) throw ( std::bad_alloc )
	Initialize the node. More...
std::auto_ptr< field_value >	field (const std::string &id) const throw ( unsupported_interface , std::bad_alloc )
	Generalized field accessor. More...
openvrml::event_listener &	event_listener (const std::string &id) throw ( unsupported_interface )
	Get an event listener. More...
openvrml::event_emitter &	event_emitter (const std::string &id) throw ( unsupported_interface )
	Get an event emitter. More...
void	shutdown (double timestamp) throw ()
	Shut down the node. More...
bool	modified () const throw ( boost::thread_resource_error )
	Determine whether the node has been modified. More...
void	modified (bool value) throw ( boost::thread_resource_error )
	Set the modified flag. More...

Protected Member Functions
	pointing_device_sensor_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope)
	Construct. More...
Protected Member Functions inherited from openvrml::child_node
	child_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
	Constructor. More...
Protected Member Functions inherited from openvrml::bounded_volume_node
	bounded_volume_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
	Construct. More...
void	bounding_volume_dirty (bool value)
	Set whether the node's bounding volume needs to be recalculated. More...
bool	bounding_volume_dirty () const
	Whether the node's bounding volume needs to be recalculated. More...
virtual const openvrml::bounding_volume &	do_bounding_volume () const
	Called by bounding_volume. More...
Protected Member Functions inherited from openvrml::node
	node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
	Construct. More...
boost::shared_mutex &	scene_mutex ()
	The scene mutex. More...

Private Member Functions
virtual void	do_activate (double timestamp, bool over, bool active, const double(&point)[3])=0
	Called to convey a pointing device state change. More...

Additional Inherited Members
Static Public Attributes inherited from openvrml::node
static const boost::intrusive_ptr< node >	self_tag
	Special value used when initializing a script_node. More...
Static Protected Member Functions inherited from openvrml::node
static void	emit_event (openvrml::event_emitter &emitter, double timestamp) throw ( std::bad_alloc )
	Emit an event. More...
Related Functions inherited from openvrml::node
To *	node_cast (node *n)
	Downcast a node to one of the abstract node types. More...
void	intrusive_ptr_add_ref (const node *n)
	Increment the reference count. More...
void	intrusive_ptr_release (const node *n)
	Decrement the reference count. More...
bool	is_proto_instance (const node &n)
	Check whether a node is a PROTO instance. More...

Detailed Description

A node that can be affected by a pointing device.

Constructor & Destructor Documentation

openvrml::pointing_device_sensor_node::~pointing_device_sensor_node ( ) throw ( )

pure virtual

Destroy.

openvrml::pointing_device_sensor_node::pointing_device_sensor_node ( const node_type &  type, const boost::shared_ptr< openvrml::scope > &  scope  )

protected

Construct.

Parameters

[in]	type	the node_type.
[in]	scope	the scope to which the node belongs.

Member Function Documentation

void openvrml::pointing_device_sensor_node::activate	(	double	timestamp,
		bool	over,
		bool	active,
		const double(&)	point[3]
	)

Convey a pointing device state change.

This function delegates to do_activate.

Parameters

[in]	timestamp	the current time.
[in]	over	whether the pointing device is over the geometry affected by the pointing device sensor.
[in]	active	whether the pointing device is “active”; e.g., whether a mouse button is currently depressed.
[in]	point	the position of the pointer on the affected geometry.

void openvrml::pointing_device_sensor_node::do_activate ( double  timestamp, bool  over, bool  active, const double(&)  point[3]  )

privatepure virtual

Called to convey a pointing device state change.

Parameters

[in]	timestamp	the current time.
[in]	over	whether the pointing device is over the geometry affected by the pointing device sensor.
[in]	active	whether the pointing device is “active”; e.g., whether a mouse button is currently depressed.
[in]	point	the position of the pointer on the affected geometry.