Changeset 4394 in orxonox.OLD for orxonox/trunk/src/lib/graphics/particles/particle_engine.h

Timestamp:

May 30, 2005, 2:05:21 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: PhysicsEngine is now aware of the existing fields and interfaces

File:

• orxonox/trunk/src/lib/graphics/particles/particle_engine.h (modified) (2 diffs)

orxonox/trunk/src/lib/graphics/particles/particle_engine.h

@@ -20 +20 @@
 };
 
-//! A default singleton class.
+//! The physicsEngine handles and stores Systems and Emitters.
+/**
+   It is responsible for driving on the Particles (tick)
+   It draw particles (draw)
+   and it emitts particles into the system
+*/
 class ParticleEngine : public BaseObject {
 
@@ -48 +53 @@
  private:
   ParticleEngine(void);
-  static ParticleEngine* singletonRef;
+  static ParticleEngine* singletonRef;        //!< The reference to the engine.
 
-  tList<ParticleSystem>* systemList;
-  tList<ParticleEmitter>* emitterList;
+  tList<ParticleSystem>* systemList;          //!< A list of Systems handled by the ParticleEngine.
+  tList<ParticleEmitter>* emitterList;        //!< A list of Emitters handled by the ParticleEngine.
 
-  tList<ParticleConnection>* connectionList;
+  tList<ParticleConnection>* connectionList;  //!< A list of Connections between Systems and Emitters.
 };