Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/lib/particles/particle_system.h @ 9842

Last change on this file since 9842 was 9656, checked in by bensch, 18 years ago

orxonox/trunk: merged the proxy bache back with no conflicts

File size: 5.8 KB
Line 
1/*!
2 * @file particle_system.h
3
4*/
5
6#ifndef _PARTICLE_SYSTEM_H
7#define _PARTICLE_SYSTEM_H
8
9#include "world_entity.h"
10#include "physics_interface.h"
11
12#include "glincl.h"
13#include "vector.h"
14#include <list>
15#include "color.h"
16
17#include "quick_animation.h"
18
19// Forward Declaration
20class TiXmlElement;
21
22#define PARTICLE_DOT_MASK              0x000001     //!< A Mask if the Particles should be displayed as DOTs
23#define PARTICLE_SPARK_MASK            0x000010     //!< A Mask if the Particles should be displayed as SPARKs
24#define PARTICLE_SPRITE_MASK           0x000100     //!< A Mask if the Particles should be displayed as SPRITESs
25#define PARTICLE_MODEL_MASK            0x001000     //!< A Mask if the Particles should be displayed as MODELSs
26#define PARTICLE_WORDL_ENTITY_MASK     0x010000     //!< A Mask if the Particles should be displayed as WORLD_ENTITIEs
27#define PARTICLE_MULTI_MASK            0x100000     //!< A Mask if they are Multi-partilces
28
29#define PARTICLE_DEFAULT_MAX_COUNT    200               //!< A default count of particles in the system.
30
31// FORWARD DECLARATION
32class Material;
33class ParticleEmitter;
34class Field;
35
36//! A struct for one Particle
37typedef struct Particle
38{
39  float         lifeTime;            //!< The time this particle has to live.
40  float         lifeCycle;           //!< The fraction of time passed. (in percentage of its lifeTime)
41
42  Vector        position;            //!< The current position of this particle.
43  Vector        velocity;            //!< The current velocity of this Particle.
44  Vector        extForce;            //!< The external Force that influences this Particle.
45  Quaternion    orientation;         //!< The current orientation of this Particle.
46  Quaternion    momentum;            //!< The current angular momentum (spin) of this Particle.
47  float         mass;                //!< The mass of this Particle.
48  float         massRand;            //!< A random mass
49  float         radius;              //!< The current size of this Particle.
50  float         radiusRand;          //!< a random Radius
51  GLfloat       color [4];           //!< A Color for the particles.
52
53  Particle*     next;                //!< pointer to the next particle in the List. (NULL if no preceding one)
54};
55
56//! A class to handle ParticleSystems
57class ParticleSystem : public WorldEntity, public PhysicsInterface {
58
59 public:
60  ParticleSystem(unsigned int maxCount = PARTICLE_DEFAULT_MAX_COUNT);
61  virtual ~ParticleSystem();
62
63  virtual void loadParams(const TiXmlElement* root);
64  void loadEmitters(const TiXmlElement* root);
65
66  void setLifeSpan(float lifeSpan, float randomLifeSpan = 0.0);
67  void setConserve(float conserve);
68  void setMaxCount(unsigned int maxCount);
69
70  /* Per-Particle-Attributes */
71  void setRadius(float lifeCycleTime, float radius, float randRadius = 0.0);
72  void setMass(float lifeCycleTime, float mass, float randMass = 0.0);
73  void setColor(float lifeCycleTime, float red, float green, float blue, float alpha);
74  void setColor(float lifeCycleTime, const Color& color);
75
76  /** @returns the lifespan of the particles */
77  inline float getLifeSpan() const { return this->lifeSpan; };
78  /** @returns the starting-radius of the particles */
79  inline float getStartRadius() { return this->radiusAnim.getValue(0.0); };
80  /** @returns the end-radius of the particles */
81  inline float getEndRadius() { return this->radiusAnim.getValue(1.0); };
82  /** @returns the conserve-factor of the particles */
83  inline float getConserve() const { return this->conserve; };
84  /** @returns the initial mass of the particles */
85  inline float getMass() const { return this->initialMass; };
86
87  /** @returns the count of particles in this System */
88  inline unsigned int getCount() const { return this->count; };
89  /** @returns the maximum count of particles that can be contained by this System */
90  inline unsigned int getMaxCount() const { return this->maxCount; };
91
92  virtual unsigned int getFaceCount() const;
93
94  void addEmitter(ParticleEmitter* emitter);
95  void removeEmitter(ParticleEmitter* emitter);
96
97  virtual void applyField(const Field* field);
98  /** @brief this is an empty function, because the Physics are implemented in tick @param dt: useless here */
99  virtual void tickPhys(float dt) {};
100
101  void addParticle(const Vector& position, const Vector& velocity, const Quaternion& orientation, const Quaternion& momentum, unsigned int data = 0);
102
103  void precache(unsigned int seconds, unsigned int ticksPerSecond = 25);
104
105  virtual void tick(float dt);
106  virtual void draw() const = 0;
107
108  void debug() const;
109
110 protected:
111  float             conserve;            //!< How much energy gets conserved to the next Tick.
112  float             lifeSpan;            //!< Initial lifetime of a Particle.
113  float             randomLifeSpan;      //!< A random value for the Lifespan (around the initial lifetime)
114  float             initialMass;         //!< The initial Mass of the Particle
115  float             randomInitialMass;   //!< The random initial Mass of the Particle
116
117  unsigned int      maxCount;            //!< The maximum count of Particles.
118  unsigned int      count;               //!< The current count of Particles.
119  Particle*         particles;           //!< A list of particles of this System.
120  Particle*         deadList;            //!< A list of dead Particles in the System.
121
122  std::list<ParticleEmitter*> emitters;  //!< The Emitters that do emit into this System.
123
124  // per particle attributes
125  QuickAnimation    radiusAnim;          //!< Animation of the radius
126  QuickAnimation    randRadiusAnim;      //!< Animation of the random Value of the radius
127  QuickAnimation    massAnim;            //!< Animation of the mass
128  QuickAnimation    randMassAnim;        //!< Animation of the random Mass
129  QuickAnimation    colorAnim[4];        //!< Animation of the 4 colors (r,g,b,a)
130};
131
132#endif /* _PARTICLE_SYSTEM_H */
Note: See TracBrowser for help on using the repository browser.