Changeset 4478 in orxonox.OLD for orxonox/trunk/src/lib/particles/particle_system.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_system.cc (modified) (8 diffs)

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

@@ -35 +35 @@
 /**
    \brief standard constructor
-   \param count the Count of particles in the System
+   \param maxCount the Count of particles in the System
    \param type The Type of the ParticleSystem
-
-   \todo this constructor is not jet implemented - do it
 */
 ParticleSystem::ParticleSystem (unsigned int maxCount, PARTICLE_TYPE type) : PhysicsInterface(this)
@@ -54 +52 @@
   this->glID = NULL;
   this->setType(type, 1);
-  //  this->setColor(1.0,1.0,1.0,1.0, .5,.5,.5,.5, .0,.0,.0,.0);
   ParticleEngine::getInstance()->addSystem(this);
 }
@@ -88 +85 @@
 
 /**
+   \param particleType the type of particles in this System
+   \param count how many particles (in PARTICLE_MULTI-mode)
    \todo this will be different
 */
@@ -115 +114 @@
 
 // setting properties
+/**
+   \brief sets the material to an external material
+   \param material: the material to set this material to.
+
+   !! important if the extern material gets deleted it MUST be unregistered here or segfault !!
+*/
 void ParticleSystem::setMaterial(Material* material)
 {
@@ -124 +129 @@
    \param value a Value between zero and one
 
-   
    if you want to change the value of this variable during emission time (to make it more dynamic)
    you may want to use the animation class
@@ -189 +193 @@
 /**
    \brief sets a key in the color-animation on a per-particle basis
-   \param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]
-   \param red red
-   \param green green
-   \param blue blue
+   \param lifeCycleTime: the time (partilceLifeTime/particleAge) [0-1]
+   \param red: red
+   \param green: green
+   \param blue: blue
+   \param alpha: alpha
 */
 void ParticleSystem::setColor(float lifeCycleTime, GLfloat red, GLfloat green, GLfloat blue, GLfloat alpha)
@@ -270 +275 @@
     \brief applies some force to a Particle.
     \param field the Field to apply.
-    \param dt The time over which the field gets applied
  */
 void ParticleSystem::applyField(Field* field)
@@ -285 +289 @@
 /**
    \brief draws all the Particles of this System
-   \param the time passed in seconds (since the last draw)
 
    The Cases in this Function all do the same: