Massive copyright update. I'm sorry if I'm crediting Matze for something he didn...
[supertux.git] / src / object / particlesystem.hpp
1 //  $Id$
2 //
3 //  SuperTux
4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
5 //
6 //  This program is free software; you can redistribute it and/or
7 //  modify it under the terms of the GNU General Public License
8 //  as published by the Free Software Foundation; either version 2
9 //  of the License, or (at your option) any later version.
10 //
11 //  This program is distributed in the hope that it will be useful,
12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 //  GNU General Public License for more details.
15 //
16 //  You should have received a copy of the GNU General Public License
17 //  along with this program; if not, write to the Free Software
18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19
20 #ifndef SUPERTUX_PARTICLESYSTEM_H
21 #define SUPERTUX_PARTICLESYSTEM_H
22
23 #include <vector>
24
25 #include "video/surface.hpp"
26 #include "game_object.hpp"
27 #include "serializable.hpp"
28 #include "sector.hpp"
29 #include "math/vector.hpp"
30
31 namespace lisp {
32 class Lisp;
33 }
34
35 class DisplayManager;
36
37 /**
38  * This is the base class for particle systems. It is responsible for storing a
39  * set of particles with each having an x- and y-coordinate the number of the
40  * layer where it should be drawn and a texture.
41  * The coordinate system used here is a virtual one. It would be a bad idea to
42  * populate whole levels with particles. So we're using a virtual rectangle
43  * here that is tiled onto the level when drawing. This rect.has the size
44  * (virtual_width, virtual_height). We're using modulo on the particle
45  * coordinates, so when a particle leaves left, it'll reenter at the right
46  * side.
47  *
48  * Classes that implement a particle system should subclass from this class,
49  * initialize particles in the constructor and move them in the simulate
50  * function.
51  */
52 class ParticleSystem : public GameObject
53 {
54 public:
55     ParticleSystem();
56     virtual ~ParticleSystem();
57     
58     virtual void draw(DrawingContext& context);
59
60 protected:
61     int layer;
62
63     class Particle
64     {
65     public:
66         virtual ~Particle()
67         { }
68
69         Vector pos;
70         Surface* texture;
71     };
72     
73     std::vector<Particle*> particles;
74     float virtual_width, virtual_height;
75 };
76
77 class SnowParticleSystem : public ParticleSystem, public Serializable
78 {
79 public:
80     SnowParticleSystem();
81     virtual ~SnowParticleSystem();
82
83     void parse(const lisp::Lisp& lisp);
84     void write(lisp::Writer& writer);
85
86     virtual void update(float elapsed_time);
87
88     std::string type() const
89     { return "SnowParticleSystem"; }
90     
91 private:
92     class SnowParticle : public Particle
93     {
94     public:
95         float speed;
96     };
97     
98     Surface* snowimages[3];
99 };
100
101 class GhostParticleSystem : public ParticleSystem, public Serializable
102 {
103 public:
104     GhostParticleSystem();
105     virtual ~GhostParticleSystem();
106
107     void parse(const lisp::Lisp& lisp);
108     void write(lisp::Writer& writer);
109
110     virtual void update(float elapsed_time);
111
112     std::string type() const
113     { return "GhostParticleSystem"; }
114     
115 private:
116     class GhostParticle : public Particle
117     {
118     public:
119         float speed;
120     };
121     
122     Surface* ghosts[2];
123 };
124
125 class CloudParticleSystem : public ParticleSystem, public Serializable
126 {
127 public:
128     CloudParticleSystem();
129     virtual ~CloudParticleSystem();
130
131     void parse(const lisp::Lisp& lisp);
132     void write(lisp::Writer& writer);
133
134     virtual void update(float elapsed_time);
135
136     std::string type() const
137     { return "CloudParticleSystem"; }    
138     
139 private:
140     class CloudParticle : public Particle
141     {
142     public:
143         float speed;
144     };
145     
146     Surface* cloudimage;
147 };
148
149 #endif
150