openvrml::geometry_node Class Reference

Abstract base class for geometry nodes. More...

#include <openvrml/node.h>

Inheritance diagram for openvrml::geometry_node:

Public Member Functions

virtual ~geometry_node ()=0 throw ()
 Destroy.
void render_geometry (viewer &v, rendering_context context)
 Insert geometry into a viewer.
bool emissive () const throw ()
 Indicates whether the geometry should be drawn with the emissive color.
const color_nodecolor () const throw ()
 Get the color node (if any) associated with this geometry.
- 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

 geometry_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
 Construct.
- 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_render_geometry (viewer &v, rendering_context context)
 render_geometry implementation.
virtual bool do_emissive () const throw ()
 emissive implementation.
virtual const color_nodedo_color () const throw ()
 Get the color node (if any) associated with this geometry.
virtual geometry_nodeto_geometry () throw ()
 Cast to a geometry_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.

Detailed Description

Abstract base class for geometry nodes.

Constructor & Destructor Documentation

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

Destroy.

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

Construct.

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

Member Function Documentation

void openvrml::geometry_node::render_geometry ( viewer v,
rendering_context  context 
)

Insert geometry into a viewer.

Parameters
[in,out]vviewer.
[in]contextrendering context.
bool openvrml::geometry_node::emissive ( ) const throw ()

Indicates whether the geometry should be drawn with the emissive color.

Returns
true if the geometry should be drawn with the emissive color; false otherwise (if the geometry should be drawn with the diffuse color).
const openvrml::color_node * openvrml::geometry_node::color ( ) const throw ()

Get the color node (if any) associated with this geometry.

Returns
the color_node associated associated with this geometry, or 0 if there is no such node.
void openvrml::geometry_node::do_render_geometry ( viewer v,
rendering_context  context 
)
privatevirtual

render_geometry implementation.

Parameters
[in,out]vviewer.
[in]contextrendering context.
bool openvrml::geometry_node::do_emissive ( ) const throw ()
privatevirtual

emissive implementation.

Returns
false.
const openvrml::color_node * openvrml::geometry_node::do_color ( ) const throw ()
privatevirtual

Get the color node (if any) associated with this geometry.

Returns
the color_node associated associated with this geometry, or 0 if there is no such node.
openvrml::geometry_node * openvrml::geometry_node::to_geometry ( ) throw ()
privatevirtual

Cast to a geometry_node.

Returns
a pointer to this geometry_node.