openvrml::child_node Class Reference

Abstract base class for child nodes. More...

#include <openvrml/node.h>

Inheritance diagram for openvrml::child_node:

Public Member Functions

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

 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 child_nodeto_child () throw ()
 Cast to a child_node.
virtual void do_relocate () throw ( std::bad_alloc )
 child_node subclass-specific relocation update.
virtual void do_render_child (viewer &v, rendering_context context)
 render_child implementation.

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

Abstract base class for child nodes.

Constructor & Destructor Documentation

openvrml::child_node::~child_node ( ) throw ()
pure virtual

Destructor.

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

Constructor.

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

Member Function Documentation

void openvrml::child_node::relocate ( ) throw ( std::bad_alloc )

Called when the node is relocated to a new position in the scene graph.

This function delegates to the virtual function do_relocate. relocate should be called by eventIn handlers that receive nodes.

Exceptions
std::bad_allocif memory allocation fails.
void openvrml::child_node::render_child ( viewer v,
rendering_context  context 
)

Render the node.

This function delegates to do_render_child.

Parameters
[in,out]vviewer implementation responsible for actually doing the drawing.
[in]contextgeneric context argument; holds things like the accumulated modelview transform.
openvrml::child_node * openvrml::child_node::to_child ( ) throw ()
privatevirtual

Cast to a child_node.

Returns
a pointer to this child_node.
void openvrml::child_node::do_relocate ( ) throw ( std::bad_alloc )
privatevirtual

child_node subclass-specific relocation update.

This method is called by relocate. Subclasses of child_node should override this function for any subclass-specific updates that need to be performed following relocation of a child_node to a new position in the scene graph (for example, updating a node_path).

The default implementation of this method does nothing.

void openvrml::child_node::do_render_child ( viewer v,
rendering_context  context 
)
privatevirtual

render_child implementation.

Rendered child_nodes should override this method.

Parameters
[in,out]vviewer implementation responsible for actually doing the drawing.
[in]contextgeneric context argument; holds things like the accumulated modelview transform.