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

The PointEmitter node is an emitter that generates particles from a specific point in space. More...

#include <H3D/PointEmitter.h>

Inheritance diagram for H3D::PointEmitter:
Inheritance graph

Public Member Functions

 PointEmitter (Inst< SFNode > _metadata=0, Inst< SFFloat > _speed=0, Inst< SFFloat > _variation=0, Inst< SFFloat > _mass=0, Inst< SFFloat > _surfaceArea=0, Inst< SFVec3f > _position=0, Inst< SFVec3f > _direction=0)
 Constructor.
 
- Public Member Functions inherited from H3D::X3DParticleEmitterNode
 X3DParticleEmitterNode (Inst< SFNode > _metadata=0, Inst< SFFloat > _speed=0, Inst< SFFloat > _variation=0, Inst< SFFloat > _mass=0, Inst< SFFloat > _surfaceArea=0, Inst< SFFloat > _angularSpeed=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 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 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< SFVec3fposition
 The position from which the particles are emitted. More...
 
H3DUniquePtr< SFVec3fdirection
 The direction along which the particles are emitted. More...
 
- Public Attributes inherited from H3D::X3DParticleEmitterNode
H3DUniquePtr< SFFloatspeed
 The speed field specifies an initial linear speed that will be imparted to all particles. More...
 
H3DUniquePtr< SFFloatvariation
 The variation field specifies a multiplier for the randomness that is used to control the range of possible output values. More...
 
H3DUniquePtr< SFFloatmass
 The mass field specifies the basic mass of each particle in kilograms. More...
 
H3DUniquePtr< SFFloatsurfaceArea
 The surfaceArea field specifies the surface area of the particle in metres-squared. More...
 
H3DUniquePtr< SFFloatangularSpeed
 The angularSpeed field specifies an initial rotational speed that will be imparted to all 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::X3DParticleEmitterNode
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 NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

The PointEmitter node is an emitter that generates particles from a specific point in space.

Particles are emitted from a single point in the specified direction and speed.

The direction field specifies a direction along which the particles are to be emitted. If the vector is zero length (a value of (0,0,0), particles are emitted in random directions from this point in space.

Examples:

Member Data Documentation

◆ direction

H3DUniquePtr< SFVec3f > H3D::PointEmitter::direction

The direction along which the particles are emitted.

If set to Vec3f( 0,0,0 ) particles are emitted in random directions.

Access type: inputOutput
Default value: 0 1 0

Referenced by PointEmitter().

◆ position

H3DUniquePtr< SFVec3f > H3D::PointEmitter::position

The position from which the particles are emitted.

Access type: inputOutput
Default value: 0 0 0

Referenced by PointEmitter().


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