openvrml::sound_source_node Class Reference

Abstract base class for sound source nodes. More...

#include <openvrml/node.h>

Inheritance diagram for openvrml::sound_source_node:

Public Member Functions
virtual	~sound_source_node ()=0 throw ()
	Destructor.
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_type &	type () 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::scope &	scope () const throw ()
	Get the scope to which the node belongs.
openvrml::scene *	scene () 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_value >	field (const std::string &id) const throw ( unsupported_interface , std::bad_alloc )
	Generalized field accessor.
openvrml::event_listener &	event_listener (const std::string &id) throw ( unsupported_interface )
	Get an event listener.
openvrml::event_emitter &	event_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
	sound_source_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
	Constructor.
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 sound_source_node *	to_sound_source () throw ()
	Cast to a sound_source_node.

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.
Related Functions inherited from openvrml::node
To *	node_cast (node *n)
	Downcast a node to one of the abstract node types.
void	intrusive_ptr_add_ref (const node *n)
	Increment the reference count.
void	intrusive_ptr_release (const node *n)
	Decrement the reference count.
bool	is_proto_instance (const node &n)
	Check whether a node is a PROTO instance.

Detailed Description

Abstract base class for sound source nodes.

Constructor & Destructor Documentation

openvrml::sound_source_node::~sound_source_node ( ) throw ()

pure virtual

Destructor.

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

protected

Constructor.

Parameters

[in]	type	the node_type associated with the node.
[in]	scope	the scope the node belongs to.

Member Function Documentation

openvrml::sound_source_node * openvrml::sound_source_node::to_sound_source ( ) throw ()

privatevirtual

Cast to a sound_source_node.

Returns

a pointer to this sound_source_node.