H3D API  2.4.1
Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | List of all members
H3D::WindPhysicsModel Class Reference

The WindPhysicsModel node specifies a physics model that applies a wind effect to the particles. More...

#include <H3D/WindPhysicsModel.h>

Inheritance diagram for H3D::WindPhysicsModel:
Inheritance graph

Public Member Functions

 WindPhysicsModel (Inst< SFNode > _metadata=0, Inst< SFBool > _enabled=0, Inst< SFVec3f > _direction=0, Inst< SFFloat > _gustiness=0, Inst< SFFloat > _speed=0, Inst< SFFloat > _turbulence=0)
 Constructor.
 
virtual void traverseSG (TraverseInfo &ti)
 Traverse the scene graph. Updates the wind_speed member.
 
- Public Member Functions inherited from H3D::X3DParticlePhysicsModelNode
 X3DParticlePhysicsModelNode (Inst< SFNode > _metadata=0, Inst< SFBool > _enabled=0)
 Constructor.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
- Public Member Functions inherited from H3D::X3DNode
 X3DNode (Inst< SFNode > _metadata=0)
 Constructor.
 
X3DMetadataObjectgetMetadataByName (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 Nodeclone (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.
 
X3DPrototypeInstancegetProtoInstanceParent ()
 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 FieldgetField (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 Attributes

H3DUniquePtr< SFVec3fdirection
 The direction field specifies the direction in which the wind is travelling in the form of a normalized, unit vector. More...
 
H3DUniquePtr< SFFloatgustiness
 The gustiness specifies how much the wind speed varies from the average value defined by the speed field. More...
 
H3DUniquePtr< SFFloatspeed
 The speed field specifies the current wind speed in metres per second. More...
 
H3DUniquePtr< SFFloatturbulence
 The turbulence field specifies how much the wind acts directly in line with the direction, and how much variation is applied in directions other than the wind direction. More...
 
- Public Attributes inherited from H3D::X3DParticlePhysicsModelNode
H3DUniquePtr< SFBoolenabled
 The enabled field specifies whether this physics model is currently being applied to the particles. More...
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. More...
 

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 
- Static Public Attributes inherited from H3D::X3DParticlePhysicsModelNode
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 wind_speed
 The wind speed updated once per frame with gustiness taken into consideration.
 

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 NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

The WindPhysicsModel node specifies a physics model that applies a wind effect to the particles.

The wind has a random variation factor that allows for the gustiness of the wind to be modelled.

The direction field specifies the direction in which the wind is travelling in the form of a normalized, unit vector.

The speed field specifies the current wind speed in metres per second. From the wind speed, the force applied per unit-area on the particle is calculated using the following formula:

pressure = 10(2 × log(speed)) × 0.64615

The gustiness specifies how much the wind speed varies from the average value defined by the speed field. The wind speed variation is calculated once per frame and applied equally to all particles.

The turbulence field specifies how much the wind acts directly in line with the direction, and how much variation is applied in directions other than the wind direction. This is determined per-particle to model how the particle is effected by turbulence.

Examples:

Member Data Documentation

◆ direction

H3DUniquePtr< SFVec3f > H3D::WindPhysicsModel::direction

The direction field specifies the direction in which the wind is travelling in the form of a normalized, unit vector.

Access type: inputOutput
Default value: Vec3f( 0, 0, 0 )

Referenced by WindPhysicsModel().

◆ gustiness

H3DUniquePtr< SFFloat > H3D::WindPhysicsModel::gustiness

The gustiness specifies how much the wind speed varies from the average value defined by the speed field.

The wind speed variation is calculated once per frame and applied equally to all particles.

Access type: inputOutput
Default value: 0.1
Valid range: [0, inf)

Referenced by traverseSG(), and WindPhysicsModel().

◆ speed

H3DUniquePtr< SFFloat > H3D::WindPhysicsModel::speed

The speed field specifies the current wind speed in metres per second.

Access type: inputOutput
Default value: 0.1
Valid range: [0, inf)

Referenced by traverseSG(), and WindPhysicsModel().

◆ turbulence

H3DUniquePtr< SFFloat > H3D::WindPhysicsModel::turbulence

The turbulence field specifies how much the wind acts directly in line with the direction, and how much variation is applied in directions other than the wind direction.

This is determined per-particle to model how the particle is effected by turbulence.

Access type: inputOutput
Default value: 0
Valid range: [0,1]

Referenced by WindPhysicsModel().


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