The LocalFog 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/LocalFog.h>
Public Member Functions | |
| LocalFog (Inst< SFNode > _metadata=0, Inst< SFColor > _color=0, Inst< SFString > _localFogType=0, Inst< SFFloat > _visibilityRange=0, Inst< SFBool > _enabled=0) | |
| Construtor. | |
| virtual void | enableGraphicsState () |
| Set up and enable the fog with OpenGL. | |
| virtual void | disableGraphicsState () |
| Restore the previous attribs. | |
 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 void | traverseSG (TraverseInfo &ti) |
| traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. 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. | |
| Public Member Functions inherited from H3D::H3DRenderStateObject | |
| virtual | ~H3DRenderStateObject () |
| Destructor. | |
| virtual void | enableHapticsState (TraverseInfo &) |
| Enable the states that you want to before all other nodes of a X3DGroupingNode's children field are traversed with traverseSG. | |
| virtual void | disableHapticsState (TraverseInfo &) |
| Reset the states that were changed in the enableHapticsState() function. | |
Public Attributes | |
| H3DUniquePtr< SFBool > | enabled |
| If enabled is true the LocalFog node is enabled otherwise it is disabled and will not affect the scene. 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... | |
Static Public Attributes | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
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. | |
| 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. | |
| 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... | |
Detailed Description
The LocalFog 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 LocalFog node. The visibilityRange field 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 LocalFog node. The visibilityRange is affected by the scaling transformations of the LocalFog 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:
- LocalFog.x3d ( Source )
Member Data Documentation
◆ enabled
| H3DUniquePtr< SFBool > H3D::LocalFog::enabled |
If enabled is true the LocalFog node is enabled otherwise it is disabled and will not affect the scene.
Access type: inputOutput Default value: TRUE
Referenced by enableGraphicsState(), and LocalFog().
The documentation for this class was generated from the following files:
