openvrml::color_rgba_node Class Referenceabstract

Abstract base class for RGBA color nodes. More...

#include <openvrml/node.h>

Inheritance diagram for openvrml::color_rgba_node:

Public Member Functions

virtual ~color_rgba_node ()=0 throw ()
 Destroy. More...
 
const std::vector
< openvrml::color_rgba > & 
color_rgba () const throw ()
 Get the color_rgba array encapsulated by this node. More...
 
- Public Member Functions inherited from openvrml::node
virtual ~node ()=0 throw ()
 Destructor. More...
 
void add_ref () const throw ()
 Increment the reference count. More...
 
void remove_ref () const throw ()
 Decrement the reference count. More...
 
void release () const throw ()
 Decrement the reference count; destroy the instance if the count drops to zero. More...
 
size_t use_count () const throw ()
 The number of owning references to the instance. More...
 
const node_typetype () const throw ()
 The type information object for the node. More...
 
const std::string & id () const throw ()
 Retrieve the name of this node. More...
 
void id (const std::string &node_id) throw ( std::bad_alloc )
 Set the name of the node. More...
 
const openvrml::scopescope () const throw ()
 Get the scope to which the node belongs. More...
 
openvrml::scenescene () const throw ()
 Get the scene with which the node is associated. More...
 
const std::vector
< boost::intrusive_ptr< node > > & 
impl_nodes () const throw ()
 Get the implementation nodes of a PROTO instance. More...
 
std::ostream & print (std::ostream &out, size_t indent) const
 Pretty print. More...
 
void initialize (openvrml::scene &scene, double timestamp) throw ( std::bad_alloc )
 Initialize the node. More...
 
std::auto_ptr< field_valuefield (const std::string &id) const throw ( unsupported_interface , std::bad_alloc )
 Generalized field accessor. More...
 
openvrml::event_listenerevent_listener (const std::string &id) throw ( unsupported_interface )
 Get an event listener. More...
 
openvrml::event_emitterevent_emitter (const std::string &id) throw ( unsupported_interface )
 Get an event emitter. More...
 
void shutdown (double timestamp) throw ()
 Shut down the node. More...
 
bool modified () const throw ( boost::thread_resource_error )
 Determine whether the node has been modified. More...
 
void modified (bool value) throw ( boost::thread_resource_error )
 Set the modified flag. More...
 

Protected Member Functions

 color_rgba_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
 Construct. More...
 
- Protected Member Functions inherited from openvrml::node
 node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
 Construct. More...
 
boost::shared_mutex & scene_mutex ()
 The scene mutex. More...
 

Private Member Functions

virtual color_rgba_nodeto_color_rgba () throw ()
 Cast to a color_rgba_node. More...
 
virtual const std::vector
< openvrml::color_rgba > & 
do_color_rgba () const =0 throw ()
 Get the color_rgba array encapsulated by this node. More...
 

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

Detailed Description

Abstract base class for RGBA color nodes.

Constructor & Destructor Documentation

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

Destroy.

openvrml::color_rgba_node::color_rgba_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

const std::vector< openvrml::color_rgba > & openvrml::color_rgba_node::color_rgba ( ) const
throw (
)

Get the color_rgba array encapsulated by this node.

This function delegates to do_color_rgba.

Returns
the color_rgba array for this node.
openvrml::color_rgba_node * openvrml::color_rgba_node::to_color_rgba ( )
throw (
)
privatevirtual

Cast to a color_rgba_node.

Returns
a pointer to this color_rgba_node.

Reimplemented from openvrml::node.

const std::vector< openvrml::color_rgba > & openvrml::color_rgba_node::do_color_rgba ( ) const
throw (
)
privatepure virtual

Get the color_rgba array encapsulated by this node.

Returns
the color_rgba array for this node.