Changeset 4478 in orxonox.OLD for orxonox/trunk/src/lib/particles/particle_emitter.cc

Timestamp:

Jun 2, 2005, 5:01:50 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: particles documented

File:

• orxonox/trunk/src/lib/particles/particle_emitter.cc (modified) (7 diffs)

orxonox/trunk/src/lib/particles/particle_emitter.cc

@@ -42 +42 @@
 }
 
+/**
+   \brief constructs and loads a ParticleEmitter from a XML-element
+   \param root the XML-element to load from
+*/
 ParticleEmitter::ParticleEmitter(const TiXmlElement* root)
 {
@@ -63 +67 @@
 }
 
+/**
+   \brief loads a ParticleEmitter from a XML-element
+   \param root the XML-element to load from
+*/
 void ParticleEmitter::loadParams(const TiXmlElement* root)
 {
@@ -109 +117 @@
 
 /**
-   \param the type of emitter
+   \brief sets the type of emitter
+   \param type the type as a const char*
+   dot: EMITTER_DOT, plane: EMITTER_PLANE, cube: EMITTER_CUBE, sphere, EMITTER_SPHERE;
 */
 void ParticleEmitter::setType(const char* type)
@@ -123 +133 @@
 }
 
-
+/**
+   \brief sets a new size to the emitter
+*/
 void ParticleEmitter::setSize(float emitterSize)
 {
@@ -134 +146 @@
 /**
    \brief set the emission rate
-   \param sets the number of particles emitted per second
+   \param emissionRate: sets the number of particles emitted per second
 
    if you want to change the value of this variable during emission time (to make it more dynamic)
@@ -164 +176 @@
    \brief sets the velocity of all particles emitted
    \param velocity The starting velocity of the emitted particles
-   \param random A random starting velocity, the +- randomness of this option
+   \param randomVelocity A random starting velocity, the +- randomness of this option
 
    if you want to change the value of this variable during emission time (to make it more dynamic)
@@ -177 +189 @@
 /**
    \brief this set the time to life of a particle, after which it will die
-   \param the time to live in seconds
+   \param dt: the time to live in seconds
+   \param system: the system into which to emitt
 
    if you want to change the value of this variable during emission time (to make it more dynamic)