openvrml::light_node Class Reference

Abstract base class for light nodes. More...

#include <openvrml/node.h>

Inheritance diagram for openvrml::light_node:

Public Member Functions

virtual ~light_node ()=0 throw ()
 Destroy.
float ambient_intensity () const throw ()
 Ambient intensity.
float intensity () const throw ()
 Intensity.
bool on () const throw ()
 “On” state.
const openvrml::colorcolor () const throw ()
 Color.
- Public Member Functions inherited from openvrml::child_node
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

 light_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
 Construct.
- Protected Member Functions inherited from openvrml::child_node
 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 light_nodeto_light () throw ()
 Cast to a light_node.
virtual float do_ambient_intensity () const =0 throw ()
 ambient_intensity implementation.
virtual float do_intensity () const =0 throw ()
 intensity implementation.
virtual bool do_on () const =0 throw ()
 on implementation.
virtual const openvrml::colordo_color () const =0 throw ()
 color 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 light nodes.

Constructor & Destructor Documentation

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

Destroy.

openvrml::light_node::light_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::light_node::ambient_intensity ( ) const throw ()

Ambient intensity.

Delegates to do_ambient_intensity.

Returns
the ambient intensity.
float openvrml::light_node::intensity ( ) const throw ()

Intensity.

Delegates to do_intensity.

Returns
the intensity.
bool openvrml::light_node::on ( ) const throw ()

“On” state.

Delegates to do_on.

Returns
true if the light is on; false otherwise.
const openvrml::color & openvrml::light_node::color ( ) const throw ()

Color.

Delegates to do_color.

Returns
the color.
openvrml::light_node * openvrml::light_node::to_light ( ) throw ()
privatevirtual

Cast to a light_node.

Returns
a pointer to this light_node.
float openvrml::light_node::do_ambient_intensity ( ) const throw ()
privatepure virtual

ambient_intensity implementation.

Returns
the ambient intensity.
float openvrml::light_node::do_intensity ( ) const throw ()
privatepure virtual

intensity implementation.

Returns
the intensity.
bool openvrml::light_node::do_on ( ) const throw ()
privatepure virtual

on implementation.

Returns
true if the light is on; false otherwise.
const openvrml::color & openvrml::light_node::do_color ( ) const throw ()
privatepure virtual

color implementation.

Returns
the color.