The Fog node provides a way to simulate atmospheric effects by blending objects with the colour specified by the color field based on the distances of the various objects from the viewer. More...

#include <H3D/Fog.h>

Inheritance diagram for H3D::Fog:

Public Member Functions
	Fog (Inst< SFSetBind > _set_bind=0, Inst< SFNode > _metadata=0, Inst< SFTime > _bindTime=0, Inst< SFBool > _isBound=0, Inst< SFColor > _color=0, Inst< SFString > _fogType=0, Inst< SFFloat > _visibilityRange=0)
	Construtor.

virtual void	renderFog ()
	Render the global fog with OpenGL.

virtual void	traverseSG (TraverseInfo &ti)
	Traverse the scenegraph. More...

Public Member Functions inherited from H3D::X3DBindableNode
	X3DBindableNode (const string &_bindable_stack_name, Inst< SFSetBind > _set_bind=0, Inst< SFNode > _metadata=0, Inst< SFTime > _bindTime=0, Inst< SFBool > _isBound=0)
	Constructor.

virtual	~X3DBindableNode ()
	Destructor.

virtual void	initialize ()
	Initialize this bindable stack, toStackTop is done.

virtual void	toStackTop ()
	Move this instance to the stack top.

virtual void	removeFromStack ()
	Remove the bindable node from the stack.

bool	isStackTop ()
	Is this node at the top of the stack.

Public Member Functions inherited from H3D::X3DChildNode
	X3DChildNode (Inst< SFNode > _metadata=0)
	Constructor.

Public Member Functions inherited from H3D::X3DNode
	X3DNode (Inst< SFNode > _metadata=0)
	Constructor.

X3DMetadataObject *	getMetadataByName (const string &_name)
	Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More...

Public Member Functions inherited from H3D::Node
	Node ()
	Constructor.

virtual Node *	clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
	Returns a new instance of this node type with the same state as this one. More...

virtual	~Node ()
	Destructor.

X3DPrototypeInstance *	getProtoInstanceParent ()
	If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...

void	setProtoInstanceParent (X3DPrototypeInstance *p)
	Set the X3DPrototypeInstance this node is the the root node if applicaple.

virtual void	render ()
	the render() function is used for the depth-first rendering traversal of the scene-graph. More...

virtual bool	lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
	Detect intersection between a line segment and the Node. More...

virtual void	closestPoint (const Vec3f &p, NodeIntersectResult &result)
	Find closest point on Node to p. More...

virtual bool	movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
	Detect collision between a moving sphere and the Node. More...

virtual string	defaultXMLContainerField ()
	Returns the default xml containerField attribute value. More...

virtual Field *	getField (const string &_name) const
	return a pointer to the field specified by name within this instance

int	addDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

int	removeDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

Public Member Functions inherited from H3D::X3DFogObject
	X3DFogObject (Inst< SFColor > _color=0, Inst< SFString > _fogType=0, Inst< SFFloat > _visibilityRange=0)
	Constructor.

Static Public Member Functions
static Fog *	getActive ()
	Convenience function to get the top of the Fog stack.

Static Public Member Functions inherited from H3D::X3DBindableNode
static X3DBindableNode *	getActive (const string &bindable_stack_name)
	Returns the active bindable instance, i.e. More...

static const StackType &	getStack (const string &bindable_stack_name)
	Get the stack for a given name.

static const StackMapType &	getStackMap ()
	Return the map of all bindable nodes available.

Static Public Member Functions inherited from H3D::Node
static unsigned int	nrNodesAlive ()
	Returns the nr of nodes currently alive, i.e. nodes created but not destructed.

static int	nrNodesCreated ()
	Returns the number of nodes created in total since the start of the program.

Static Public Attributes
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

Static Public Attributes inherited from H3D::X3DBindableNode
static H3DNodeDatabase	database
	The H3DNodedatabase for this node.

Static Public Attributes inherited from H3D::X3DNode
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

Protected Attributes
H3DFloat	scale_local_to_global
	The scaling factor from local to global space.

Additional Inherited Members
Public Types inherited from H3D::Node
typedef std::map< Node , Node >	DeepCopyMap
	A map type used during a deep copy clone() to map from original nodes to cloned nodes.

Public Attributes inherited from H3D::X3DBindableNode
H3DUniquePtr< SFSetBind >	set_bind
	Input field to bind or unbind the node. More...

H3DUniquePtr< SFTime >	bindTime
	The bindTime field is the time at which the Viewpoint node is bound or unbound. More...

H3DUniquePtr< SFBool >	isBound
	Output field telling if this node is bound or not. More...

Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNode >	metadata
	Meta data about the node. More...

Public Attributes inherited from H3D::X3DFogObject
H3DUniquePtr< SFColor >	color
	The color of the fog. More...

H3DUniquePtr< SFString >	fogType
	The fogType field controls how much of the fog colour is blended with the object as a function of distance. More...

H3DUniquePtr< SFFloat >	visibilityRange
	The visibilityRange specifies the distance in metres (in the local coordinate system) at which objects are totally obscured by the fog. More...

Protected Member Functions inherited from H3D::Node
void	cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for the clone() method. More...

Static Protected Member Functions inherited from H3D::Node
static Node *	getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for nodes that implement clone() More...

Static Protected Attributes inherited from H3D::X3DBindableNode
static StackMapType	stack
	The bindable stack.

Detailed Description

The Fog node provides a way to simulate atmospheric effects by blending objects with the colour specified by the color field based on the distances of the various objects from the viewer.

The distances are calculated in the coordinate space of the Fog node. The visibilityRange specifies the distance in metres (in the local coordinate system) at which objects are totally obscured by the fog. Objects located outside the visibilityRange from the viewer are drawn with a constant colour of color. Objects very close to the viewer are blended very little with the fog color. A visibilityRange of 0.0 disables the Fog node. The visibilityRange is affected by the scaling transformations of the Fog node's parents; translations and rotations have no affect on visibilityRange.

The fogType field controls how much of the fog colour is blended with the object as a function of distance. If fogType is "LINEAR", the amount of blending is a linear function of the distance, resulting in a depth cueing effect. If fogType is "EXPONENTIAL," an exponential increase in blending is used, resulting in a more natural fog appearance.

Examples:

Fog.x3d ( Source )

Member Function Documentation

◆ traverseSG()

virtual void H3D::Fog::traverseSG ( TraverseInfo & ti )

inlinevirtual

Traverse the scenegraph.

Set the scale_local_to_global variable.

Parameters

ti	The TraverseInfo object containing information about the traversal.

Reimplemented from H3D::Node.

References H3D::TraverseInfo::getAccForwardMatrix().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ traverseSG()