The X3DParticleEmitterNode abstract type represents any node that is an emitter of particles. More...
#include <H3D/X3DParticleEmitterNode.h>
Public Member Functions | |
| 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. | |
| 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 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 Attributes | |
| H3DUniquePtr< SFFloat > | speed |
| The speed field specifies an initial linear speed that will be imparted to all particles. More... | |
| H3DUniquePtr< SFFloat > | variation |
| The variation field specifies a multiplier for the randomness that is used to control the range of possible output values. More... | |
| H3DUniquePtr< SFFloat > | mass |
| The mass field specifies the basic mass of each particle in kilograms. More... | |
| H3DUniquePtr< SFFloat > | surfaceArea |
| The surfaceArea field specifies the surface area of the particle in metres-squared. More... | |
| H3DUniquePtr< SFFloat > | angularSpeed |
| The angularSpeed field specifies an initial rotational speed that will be imparted to all particles. More... | |
| Public Attributes inherited from H3D::X3DNode | |
| H3DUniquePtr< SFNode > | metadata |
| Meta data about the node. 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 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
◆ defaultXMLContainerField()
|
inlinevirtual |
Returns the default xml containerField attribute value.
For this node it is "emitter".
Reimplemented from H3D::Node.
Member Data Documentation
◆ angularSpeed
| H3DUniquePtr< SFFloat > H3D::X3DParticleEmitterNode::angularSpeed |
The angularSpeed field specifies an initial rotational speed that will be imparted to all particles.
It does not signify the rotation axis of the particles. The directional component of the rotation depends on the particle's geometryType. The rotation is ignored for "POINT" and "LINE". For "TRIANGLE/QUAD", "GEOMETRY" the rotation axis is local z axis of the particle system, for "SPRITE" the rotation axis is the axis between the view point and the particle.
Access type: inputOutput
Default value: 0
Referenced by X3DParticleEmitterNode().
◆ mass
| H3DUniquePtr< SFFloat > H3D::X3DParticleEmitterNode::mass |
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().
◆ speed
| H3DUniquePtr< SFFloat > H3D::X3DParticleEmitterNode::speed |
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().
◆ surfaceArea
| H3DUniquePtr< SFFloat > H3D::X3DParticleEmitterNode::surfaceArea |
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().
◆ variation
| H3DUniquePtr< SFFloat > H3D::X3DParticleEmitterNode::variation |
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:
