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

Protected Member Functions

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

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.

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

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]typethe node_type.
[in]scopethe 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]timestampthe current time.
[in]overwhether the pointing device is over the geometry affected by the pointing device sensor.
[in]activewhether the pointing device is “active”; e.g., whether a mouse button is currently depressed.
[in]pointthe 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]timestampthe current time.
[in]overwhether the pointing device is over the geometry affected by the pointing device sensor.
[in]activewhether the pointing device is “active”; e.g., whether a mouse button is currently depressed.
[in]pointthe position of the pointer on the affected geometry.