openvrml::material_node Class Referenceabstract

Abstract base class for material nodes. More...

#include <openvrml/node.h>

Inheritance diagram for openvrml::material_node:

Public Member Functions

virtual ~material_node ()=0 throw ()
 Destroy. More...
 
float ambient_intensity () const throw ()
 Get the ambient intensity. More...
 
const colordiffuse_color () const throw ()
 Get the diffuse color. More...
 
const coloremissive_color () const throw ()
 Get the emissive color. More...
 
float shininess () const throw ()
 Get the shininess. More...
 
const colorspecular_color () const throw ()
 Get the specular color. More...
 
float transparency () const throw ()
 Get the transparency. 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

 material_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 material_nodeto_material () throw ()
 Cast to a material_node. More...
 
virtual float do_ambient_intensity () const =0 throw ()
 Get the ambient intensity. More...
 
virtual const colordo_diffuse_color () const =0 throw ()
 Get the diffuse color. More...
 
virtual const colordo_emissive_color () const =0 throw ()
 Get the emissive color. More...
 
virtual float do_shininess () const =0 throw ()
 Get the shininess. More...
 
virtual const colordo_specular_color () const =0 throw ()
 Get the specular color. More...
 
virtual float do_transparency () const =0 throw ()
 Get the transparency. 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 material nodes.

Constructor & Destructor Documentation

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

Destroy.

openvrml::material_node::material_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

float openvrml::material_node::ambient_intensity ( ) const
throw (
)

Get the ambient intensity.

This function delegates to do_ambient_intensity.

Returns
the ambient intensity.
const openvrml::color & openvrml::material_node::diffuse_color ( ) const
throw (
)

Get the diffuse color.

This function delegatest to do_diffuse_color.

Returns
the diffuse color.
const openvrml::color & openvrml::material_node::emissive_color ( ) const
throw (
)

Get the emissive color.

This function delegates to do_emissive_color.

Returns
the emissive color.
float openvrml::material_node::shininess ( ) const
throw (
)

Get the shininess.

This function delegates to do_shininess.

Returns
the shininess.
const openvrml::color & openvrml::material_node::specular_color ( ) const
throw (
)

Get the specular color.

This function delegates to do_specular_color.

Returns
the specular color.
float openvrml::material_node::transparency ( ) const
throw (
)

Get the transparency.

This function delegates to do_transparency.

Returns
the transparency.
openvrml::material_node * openvrml::material_node::to_material ( )
throw (
)
privatevirtual

Cast to a material_node.

Returns
a pointer to this material_node.

Reimplemented from openvrml::node.

float openvrml::material_node::do_ambient_intensity ( ) const
throw (
)
privatepure virtual

Get the ambient intensity.

Returns
the ambient intensity.
const openvrml::color & openvrml::material_node::do_diffuse_color ( ) const
throw (
)
privatepure virtual

Get the diffuse color.

Returns
the diffuse color.
const openvrml::color & openvrml::material_node::do_emissive_color ( ) const
throw (
)
privatepure virtual

Get the emissive color.

Returns
the emissive color.
float openvrml::material_node::do_shininess ( ) const
throw (
)
privatepure virtual

Get the shininess.

Returns
the shininess.
const openvrml::color & openvrml::material_node::do_specular_color ( ) const
throw (
)
privatepure virtual

Get the specular color.

Returns
the specular color.
float openvrml::material_node::do_transparency ( ) const
throw (
)
privatepure virtual

Get the transparency.

Returns
the transparency.