openvrml::background_node Class Reference

Abstract base class for background nodes. More...

#include <openvrml/node.h>

Inheritance diagram for openvrml::background_node:

Public Member Functions

virtual ~background_node ()=0 throw ()
 Destroy.
const std::vector< float > & ground_angle () const throw ()
 Ground angles.
const std::vector< color > & ground_color () const throw ()
 Ground colors.
const std::vector< float > & sky_angle () const throw ()
 Sky angles.
const std::vector< color > & sky_color () const throw ()
 Sky colors.
texture_nodefront () const throw ()
 Front texture.
texture_nodeback () const throw ()
 Back texture.
texture_nodeleft () const throw ()
 Left texture.
texture_noderight () const throw ()
 Right texture.
texture_nodetop () const throw ()
 Top texture.
texture_nodebottom () const throw ()
 Bottom texture.
- 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

 background_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 background_nodeto_background () throw ()
 Cast to a background_node.
virtual const std::vector
< float > & 
do_ground_angle () const =0 throw ()
 Ground angles.
virtual const std::vector
< color > & 
do_ground_color () const =0 throw ()
 Ground colors.
virtual const std::vector
< float > & 
do_sky_angle () const =0 throw ()
 Sky angles.
virtual const std::vector
< color > & 
do_sky_color () const =0 throw ()
 Sky colors.
virtual texture_nodedo_front () const =0 throw ()
 Front texture.
virtual texture_nodedo_back () const =0 throw ()
 Back texture.
virtual texture_nodedo_left () const =0 throw ()
 Left texture.
virtual texture_nodedo_right () const =0 throw ()
 Right texture.
virtual texture_nodedo_top () const =0 throw ()
 Top texture.
virtual texture_nodedo_bottom () const =0 throw ()
 Bottom texture.

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 background nodes.

Constructor & Destructor Documentation

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

Destroy.

openvrml::background_node::background_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< float > & openvrml::background_node::ground_angle ( ) const throw ()

Ground angles.

This function delegates to do_ground_angle.

Returns
a vector of angles corresponding to ground colors.
const std::vector< openvrml::color > & openvrml::background_node::ground_color ( ) const throw ()

Ground colors.

This function delegates to do_ground_color.

Returns
a vector of ground colors.
const std::vector< float > & openvrml::background_node::sky_angle ( ) const throw ()

Sky angles.

This function delegates to do_sky_angle.

Returns
a vector of angles corresponding to sky colors.
const std::vector< openvrml::color > & openvrml::background_node::sky_color ( ) const throw ()

Sky colors.

This function delegates to do_sky_color.

Returns
a vector of sky colors.
openvrml::texture_node * openvrml::background_node::front ( ) const throw ()

Front texture.

This function delegates to do_front.

Returns
the front texture.
openvrml::texture_node * openvrml::background_node::back ( ) const throw ()

Back texture.

This function delegates to do_back.

Returns
the back texture.
openvrml::texture_node * openvrml::background_node::left ( ) const throw ()

Left texture.

This function delegates to do_left.

Returns
the left texture.
openvrml::texture_node * openvrml::background_node::right ( ) const throw ()

Right texture.

This function delegates to do_right.

Returns
the right texture.
openvrml::texture_node * openvrml::background_node::top ( ) const throw ()

Top texture.

This function delegates to do_top.

Returns
the top texture.
openvrml::texture_node * openvrml::background_node::bottom ( ) const throw ()

Bottom texture.

This function delegates to do_bottom.

Returns
the bottom texture.
openvrml::background_node * openvrml::background_node::to_background ( ) throw ()
privatevirtual

Cast to a background_node.

Returns
a pointer to this background_node.
const std::vector< float > & openvrml::background_node::do_ground_angle ( ) const throw ()
privatepure virtual

Ground angles.

Returns
a vector of angles corresponding to ground colors.
const std::vector< openvrml::color > & openvrml::background_node::do_ground_color ( ) const throw ()
privatepure virtual

Ground colors.

Returns
a vector of ground colors.
const std::vector< float > & openvrml::background_node::do_sky_angle ( ) const throw ()
privatepure virtual

Sky angles.

Returns
a vector of angles corresponding to sky colors.
const std::vector< openvrml::color > & openvrml::background_node::do_sky_color ( ) const throw ()
privatepure virtual

Sky colors.

Returns
a vector of sky colors.
openvrml::texture_node * openvrml::background_node::do_front ( ) const throw ()
privatepure virtual

Front texture.

Returns
the front texture.
openvrml::texture_node * openvrml::background_node::do_back ( ) const throw ()
privatepure virtual

Back texture.

Returns
the back texture.
openvrml::texture_node * openvrml::background_node::do_left ( ) const throw ()
privatepure virtual

Left texture.

Returns
the left texture.
openvrml::texture_node * openvrml::background_node::do_right ( ) const throw ()
privatepure virtual

Right texture.

Returns
the right texture.
openvrml::texture_node * openvrml::background_node::do_top ( ) const throw ()
privatepure virtual

Top texture.

Returns
the top texture.
openvrml::texture_node * openvrml::background_node::do_bottom ( ) const throw ()
privatepure virtual

Bottom texture.

Returns
the bottom texture.