H3D::X3DParticleEmitterNode Class Reference
[Abstract nodes.]

The X3DParticleEmitterNode abstract type represents any node that is an emitter of particles. More...

#include <H3D/X3DParticleEmitterNode.h>

Inheritance diagram for H3D::X3DParticleEmitterNode:

Inheritance graph

List of all members.

Public Member Functions

 X3DParticleEmitterNode (Inst< SFNode > _metadata=0, Inst< SFFloat > _speed=0, Inst< SFFloat > _variation=0, Inst< SFFloat > _mass=0, Inst< SFFloat > _surfaceArea=0)
 Constructor.
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value.

Public Attributes

auto_ptr< SFFloatspeed
 The speed field specifies an initial linear speed that will be imparted to all particles.
auto_ptr< SFFloatvariation
 The variation field specifies a multiplier for the randomness that is used to control the range of possible output values.
auto_ptr< SFFloatmass
 The mass field specifies the basic mass of each particle in kilograms.
auto_ptr< SFFloatsurfaceArea
 The surfaceArea field specifies the surface area of the particle in metres-squared.

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.


Detailed Description

The X3DParticleEmitterNode abstract type represents any node that is an emitter of particles.

The shape and distribution of particles is dependent on the type of the concrete node.

The speed field specifies an initial linear speed that will be imparted to all particles. It does not signify the direction of the particles. The directional component of the velocity is specified by the concrete node representation.

The variation field specifies a multiplier for the randomness that is used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of possible initial values possible. A variation of zero does not allow any randomness.

The mass field specifies the basic mass of each particle in kilograms. Mass is needed if gravity or other force-related calculations are to be performed per-particle.

The surfaceArea field specifies the surface area of the particle in metres-squared. Surface area is used for calculations such as wind effects per particle. The surfaceArea field value represents an average frontal area that would be presented to the wind, assuming a spherical model for each particle (i. e., the surface area is the same regardless of direction).


Member Function Documentation

virtual string H3D::X3DParticleEmitterNode::defaultXMLContainerField (  )  [inline, virtual]

Returns the default xml containerField attribute value.

For this node it is "emitter".

Reimplemented from H3D::Node.


Member Data Documentation

The mass field specifies the basic mass of each particle in kilograms.

Mass is needed if gravity or other force-related calculations are to be performed per-particle.

Access type: inputOutput
Default value: 0

Referenced by X3DParticleEmitterNode().

The speed field specifies an initial linear speed that will be imparted to all particles.

It does not signify the direction of the particles. The directional component of the velocity is specified by the concrete node representation.

Access type: inputOutput
Default value: 0

Referenced by X3DParticleEmitterNode().

The surfaceArea field specifies the surface area of the particle in metres-squared.

Surface area is used for calculations such as wind effects per particle. The surfaceArea field value represents an average frontal area that would be presented to the wind, assuming a spherical model for each particle (i.e., the surface area is the same regardless of direction).

Access type: inputOutput
Default value: 0

Referenced by X3DParticleEmitterNode().

The variation field specifies a multiplier for the randomness that is used to control the range of possible output values.

The bigger the value, the more random the output and the bigger the range of possible initial values possible. A variation of zero does not allow any randomness.

Access type: inputOutput
Default value: 0.25

Referenced by X3DParticleEmitterNode().


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

Generated on Fri Nov 7 10:31:29 2008 for H3D API by  doxygen 1.5.7