openvrml::node_impl_util::abstract_node< Derived > Class Template Reference

Abstract base class for node implementations. More...

#include <openvrml/node_impl_util.h>

Inheritance diagram for openvrml::node_impl_util::abstract_node< Derived >:

Classes

class  event_emitter
 Concrete event emitter class template. More...
class  exposedfield
 exposedField implementation. More...

Public Member Functions

virtual ~abstract_node ()=0 throw ()
 Destroy.
- 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 Types

typedef Derived self_t
 The derived type.
typedef
node_field_value_listener
< sfbool
sfbool_listener
 openvrml::sfbool listener. Provided for convenience.
typedef
node_field_value_listener
< sfcolor
sfcolor_listener
 openvrml::sfcolor listener. Provided for convenience.
typedef
node_field_value_listener
< sffloat
sffloat_listener
 openvrml::sffloat listener. Provided for convenience.
typedef
node_field_value_listener
< sfdouble
sfdouble_listener
 openvrml::sfdouble listener. Provided for convenience.
typedef
node_field_value_listener
< sfimage
sfimage_listener
 openvrml::sfimage listener. Provided for convenience.
typedef
node_field_value_listener
< sfint32
sfint32_listener
 openvrml::sfint32 listener. Provided for convenience.
typedef
node_field_value_listener
< sfnode
sfnode_listener
 openvrml::sfnode listener. Provided for convenience.
typedef
node_field_value_listener
< sfrotation
sfrotation_listener
 openvrml::sfrotation listener. Provided for convenience.
typedef
node_field_value_listener
< sfstring
sfstring_listener
 openvrml::sfstring listener. Provided for convenience.
typedef
node_field_value_listener
< sftime
sftime_listener
 openvrml::sftime listener. Provided for convenience.
typedef
node_field_value_listener
< sfvec2f
sfvec2f_listener
 openvrml::sfvec2f listener. Provided for convenience.
typedef
node_field_value_listener
< sfvec2d
sfvec2d_listener
 openvrml::sfvec2d listener. Provided for convenience.
typedef
node_field_value_listener
< sfvec3f
sfvec3f_listener
 openvrml::sfvec3f listener. Provided for convenience.
typedef
node_field_value_listener
< sfvec3d
sfvec3d_listener
 openvrml::sfvec3d listener. Provided for convenience.
typedef
node_field_value_listener
< mfbool
mfbool_listener
 openvrml::mfbool listener. Provided for convenience.
typedef
node_field_value_listener
< mfcolor
mfcolor_listener
 openvrml::mfcolor listener. Provided for convenience.
typedef
node_field_value_listener
< mffloat
mffloat_listener
 openvrml::mffloat listener. Provided for convenience.
typedef
node_field_value_listener
< mfdouble
mfdouble_listener
 openvrml::mfdouble listener. Provided for convenience.
typedef
node_field_value_listener
< mfint32
mfint32_listener
 openvrml::mfint32 listener. Provided for convenience.
typedef
node_field_value_listener
< mfnode
mfnode_listener
 openvrml::mfnode listener. Provided for convenience.
typedef
node_field_value_listener
< mfrotation
mfrotation_listener
 openvrml::mfrotation listener. Provided for convenience.
typedef
node_field_value_listener
< mfstring
mfstring_listener
 openvrml::mfstring listener. Provided for convenience.
typedef
node_field_value_listener
< mftime
mftime_listener
 openvrml::mftime listener. Provided for convenience.
typedef
node_field_value_listener
< mfvec2f
mfvec2f_listener
 openvrml::mfvec2f listener. Provided for convenience.
typedef
node_field_value_listener
< mfvec2d
mfvec2d_listener
 openvrml::mfvec2d listener. Provided for convenience.
typedef
node_field_value_listener
< mfvec3f
mfvec3f_listener
 openvrml::mfvec3f listener. Provided for convenience.
typedef
node_field_value_listener
< mfvec3d
mfvec3d_listener
 openvrml::mfvec3d listener. Provided for convenience.
typedef event_emitter< sfboolsfbool_emitter
 openvrml::sfbool event emitter.
typedef event_emitter< sfcolorsfcolor_emitter
 openvrml::sfcolor event emitter.
typedef event_emitter< sfdoublesfdouble_emitter
 openvrml::sfdouble event emitter.
typedef event_emitter< sffloatsffloat_emitter
 openvrml::sffloat event emitter.
typedef event_emitter< sfimagesfimage_emitter
 openvrml::sfimage event emitter.
typedef event_emitter< sfint32sfint32_emitter
 openvrml::sfint32 event emitter.
typedef event_emitter< sfnodesfnode_emitter
 openvrml::sfnode event emitter.
typedef event_emitter< sfrotationsfrotation_emitter
 openvrml::sfrotation event emitter.
typedef event_emitter< sfstringsfstring_emitter
 openvrml::sfstring event emitter.
typedef event_emitter< sftimesftime_emitter
 openvrml::sftime event emitter.
typedef event_emitter< sfvec2dsfvec2d_emitter
 openvrml::sfvec2d event emitter.
typedef event_emitter< sfvec2fsfvec2f_emitter
 openvrml::sfvec2f event emitter.
typedef event_emitter< sfvec3dsfvec3d_emitter
 openvrml::sfvec3d event emitter.
typedef event_emitter< sfvec3fsfvec3f_emitter
 openvrml::sfvec3f event emitter.
typedef event_emitter< mfcolormfcolor_emitter
 openvrml::mfcolor event emitter.
typedef event_emitter< mfdoublemfdouble_emitter
 openvrml::mfdouble event emitter.
typedef event_emitter< mffloatmffloat_emitter
 openvrml::mffloat event emitter.
typedef event_emitter< mfnodemfnode_emitter
 openvrml::mfnode event emitter.
typedef event_emitter< mfrotationmfrotation_emitter
 openvrml::mfrotation event emitter.
typedef event_emitter< mfstringmfstring_emitter
 openvrml::mfstring event emitter.
typedef event_emitter< mftimemftime_emitter
 openvrml::mftime event emitter.
typedef event_emitter< mfvec2dmfvec2d_emitter
 openvrml::mfvec2d event emitter.
typedef event_emitter< mfvec2fmfvec2f_emitter
 openvrml::mfvec2f event emitter.
typedef event_emitter< mfvec3dmfvec3d_emitter
 openvrml::mfvec3d event emitter.
typedef event_emitter< mfvec3fmfvec3f_emitter
 openvrml::mfvec3f event emitter.

Protected Member Functions

 abstract_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope)
 Construct.
- 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.

Protected Attributes

exposedfield< sfnodemetadata
 metadata exposedField.

Private Member Functions

virtual const field_valuedo_field (const std::string &id) const throw ( unsupported_interface )
 Get a field value for a node.
virtual openvrml::event_listenerdo_event_listener (const std::string &id) throw ( unsupported_interface )
 Get an event listener.
virtual openvrml::event_emitterdo_event_emitter (const std::string &id) throw ( unsupported_interface )
 Get an event emitter.

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

template<typename Derived>
class openvrml::node_impl_util::abstract_node< Derived >

Abstract base class for node implementations.

abstract_node encapsulates the mechanisms for field access and mutation, event dispatch, and eventOut access.

Template Parameters
Derivedthe type that inherits this class template.

Member Typedef Documentation

template<typename Derived >
Derived openvrml::node_impl_util::abstract_node< Derived >::self_t
protected

The derived type.

openvrml::sfbool listener. Provided for convenience.

openvrml::sfcolor listener. Provided for convenience.

openvrml::sffloat listener. Provided for convenience.

openvrml::sfdouble listener. Provided for convenience.

openvrml::sfimage listener. Provided for convenience.

openvrml::sfint32 listener. Provided for convenience.

openvrml::sfnode listener. Provided for convenience.

openvrml::sfrotation listener. Provided for convenience.

openvrml::sfstring listener. Provided for convenience.

openvrml::sftime listener. Provided for convenience.

openvrml::sfvec2f listener. Provided for convenience.

openvrml::sfvec2d listener. Provided for convenience.

openvrml::sfvec3f listener. Provided for convenience.

openvrml::sfvec3d listener. Provided for convenience.

openvrml::mfbool listener. Provided for convenience.

openvrml::mfcolor listener. Provided for convenience.

openvrml::mffloat listener. Provided for convenience.

openvrml::mfdouble listener. Provided for convenience.

openvrml::mfint32 listener. Provided for convenience.

openvrml::mfnode listener. Provided for convenience.

openvrml::mfrotation listener. Provided for convenience.

openvrml::mfstring listener. Provided for convenience.

openvrml::mftime listener. Provided for convenience.

openvrml::mfvec2f listener. Provided for convenience.

openvrml::mfvec2d listener. Provided for convenience.

openvrml::mfvec3f listener. Provided for convenience.

openvrml::mfvec3d listener. Provided for convenience.

Constructor & Destructor Documentation

template<typename Derived >
openvrml::node_impl_util::abstract_node< Derived >::~abstract_node ( ) throw ()
pure virtual

Destroy.

template<typename Derived >
openvrml::node_impl_util::abstract_node< Derived >::abstract_node ( const node_type type,
const boost::shared_ptr< openvrml::scope > &  scope 
)
protected

Construct.

Parameters
[in]typethe node_type associated with this node.
[in]scopethe scope to which the node belongs.

Member Function Documentation

template<typename Derived >
const field_value & openvrml::node_impl_util::abstract_node< Derived >::do_field ( const std::string &  id) const throw ( unsupported_interface )
privatevirtual

Get a field value for a node.

Parameters
[in]ida field name.
Exceptions
unsupported_interfaceif the node has no field id.
template<typename Derived >
event_listener & openvrml::node_impl_util::abstract_node< Derived >::do_event_listener ( const std::string &  id) throw ( unsupported_interface )
privatevirtual

Get an event listener.

This method is called by node::event_listener.

Parameters
[in]ideventIn identifier.
Returns
the event listener.
Exceptions
unsupported_interfaceif the node has no eventIn id.
template<typename Derived >
event_emitter & openvrml::node_impl_util::abstract_node< Derived >::do_event_emitter ( const std::string &  id) throw ( unsupported_interface )
privatevirtual

Get an event emitter.

This method is called by node::event_emitter.

Parameters
[in]ideventOut identifier.
Returns
the event emitter.
Exceptions
unsupported_interfaceif the node has no eventOut id.

Member Data Documentation

template<typename Derived >
openvrml::node_impl_util::abstract_node< Derived >::metadata
protected

metadata exposedField.