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

const std::vector< float > &	ground_angle () const throw ()
	Ground angles. More...

const std::vector< color > &	ground_color () const throw ()
	Ground colors. More...

const std::vector< float > &	sky_angle () const throw ()
	Sky angles. More...

const std::vector< color > &	sky_color () const throw ()
	Sky colors. More...

texture_node *	front () const throw ()
	Front texture. More...

texture_node *	back () const throw ()
	Back texture. More...

texture_node *	left () const throw ()
	Left texture. More...

texture_node *	right () const throw ()
	Right texture. More...

texture_node *	top () const throw ()
	Top texture. More...

texture_node *	bottom () const throw ()
	Bottom texture. More...

Public Member Functions inherited from openvrml::child_node
virtual	~child_node ()=0 throw ()
	Destructor. More...

void	relocate () throw ( std::bad_alloc )
	Called when the node is relocated to a new position in the scene graph. More...

void	render_child (viewer &v, rendering_context context)
	Render the node. More...

Public Member Functions inherited from openvrml::bounded_volume_node
virtual	~bounded_volume_node () throw ()
	Destroy. More...

const openvrml::bounding_volume &	bounding_volume () const
	Get this node's bounding volume. 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_type &	type () 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::scope &	scope () const throw ()
	Get the `scope` to which the `node` belongs. More...

openvrml::scene *	scene () 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_value >	field (const std::string &id) const throw ( unsupported_interface , std::bad_alloc )
	Generalized field accessor. More...

openvrml::event_listener &	event_listener (const std::string &id) throw ( unsupported_interface )
	Get an event listener. More...

openvrml::event_emitter &	event_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
	background_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
	Construct. More...

Protected Member Functions inherited from openvrml::child_node
	child_node (const node_type &type, const boost::shared_ptr< openvrml::scope > &scope) throw ()
	Constructor. More...

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

void	bounding_volume_dirty (bool value)
	Set whether the node's bounding volume needs to be recalculated. More...

bool	bounding_volume_dirty () const
	Whether the node's bounding volume needs to be recalculated. More...

virtual const openvrml::bounding_volume &	do_bounding_volume () const
	Called by `bounding_volume`. 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 background_node *	to_background () throw ()
	Cast to a `background_node`. More...

virtual const std::vector < float > &	do_ground_angle () const =0 throw ()
	Ground angles. More...

virtual const std::vector < color > &	do_ground_color () const =0 throw ()
	Ground colors. More...

virtual const std::vector < float > &	do_sky_angle () const =0 throw ()
	Sky angles. More...

virtual const std::vector < color > &	do_sky_color () const =0 throw ()
	Sky colors. More...

virtual texture_node *	do_front () const =0 throw ()
	Front texture. More...

virtual texture_node *	do_back () const =0 throw ()
	Back texture. More...

virtual texture_node *	do_left () const =0 throw ()
	Left texture. More...

virtual texture_node *	do_right () const =0 throw ()
	Right texture. More...

virtual texture_node *	do_top () const =0 throw ()
	Top texture. More...

virtual texture_node *	do_bottom () const =0 throw ()
	Bottom texture. 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...

Related Functions inherited from openvrml::node
To *	node_cast (node *n)
	Downcast a `node` to one of the abstract `node` types. More...

void	intrusive_ptr_add_ref (const node *n)
	Increment the reference count. More...

void	intrusive_ptr_release (const node *n)
	Decrement the reference count. More...

bool	is_proto_instance (const node &n)
	Check whether a `node` is a `PROTO` instance. More...

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]	type	the `node_type` associated with the node.
[in]	scope	the 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.

Reimplemented from openvrml::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.

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation