This should definitively fix frames out of range.
[supertux.git] / lib / special / sprite.cpp
1 //  $Id$
2 //
3 //  SuperTux
4 //  Copyright (C) 2004 Ingo Ruhnke <grumbel@gmx.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 #include <iostream>
21 #include <cmath>
22
23 #include "../app/globals.h"
24 #include "../app/setup.h"
25 #include "../special/sprite.h"
26 #include "../video/drawing_context.h"
27
28 using namespace SuperTux;
29
30 Sprite::Sprite(lisp_object_t* cur)
31 {
32   for(; !lisp_nil_p(cur); cur = lisp_cdr(cur))
33     {
34     std::string token = lisp_symbol(lisp_car(lisp_car(cur)));
35     lisp_object_t* data = lisp_car(lisp_cdr(lisp_car(cur)));
36     LispReader reader(lisp_cdr(lisp_car(cur)));
37
38     if(token == "name")
39       name = lisp_string(data);
40     else if(token == "action")
41       parse_action(reader);
42     else
43       std::cerr << "Warning: Unknown sprite field: " << token << std::endl;
44     }
45
46   if(name.empty())
47     Termination::abort("Error: Sprite wihtout name.", "");
48   if(actions.empty())
49     Termination::abort("Error: Sprite wihtout actions.", "");
50 }
51
52 Sprite::~Sprite()
53 {
54   for(Actions::iterator i_act = actions.begin(); i_act != actions.end(); ++i_act)
55     {
56     for(std::vector<Surface*>::iterator i_sur = i_act->second->surfaces.begin();
57         i_sur != i_act->second->surfaces.end(); ++i_sur)
58       delete *i_sur;
59     delete i_act->second;
60     }
61 }
62
63 void
64 Sprite::parse_action(LispReader& lispreader)
65 {
66   action = new Action;
67
68   init_defaults(action);
69
70   if(!lispreader.read_string("name", action->name))
71     if(!actions.empty())
72       Termination::abort("Error: If there are more than one action, they need names!", "");
73   lispreader.read_int("x-offset", action->x_offset);
74   lispreader.read_int("y-offset", action->y_offset);
75   lispreader.read_int("z-order", action->z_order);
76   lispreader.read_float("fps",     action->fps);
77
78   std::vector<std::string> images;
79   if(!lispreader.read_string_vector("images", images))
80     Termination::abort("Sprite contains no images: ", action->name.c_str());
81
82   for(std::vector<std::string>::size_type i = 0; i < images.size(); i++)
83     {
84       action->surfaces.push_back(
85           new Surface(datadir + "/images/" + images[i], true));
86     }
87
88   // TODO: add a top filter entry
89   std::vector <int> mask_color;
90   lispreader.read_int_vector("apply-mask", mask_color);
91   if(mask_color.size() == 4)
92     {
93     for(std::vector<Surface*>::iterator i = action->surfaces.begin();
94         i < action->surfaces.end(); i++)
95       {
96         (*i)->apply_mask(Color(mask_color));
97       }
98     }
99
100   actions[action->name] = action;
101 }
102
103 /*void Sprite::parse_filter(LispReader& lispreader)
104 {
105
106 }*/
107
108 void
109 Sprite::init_defaults(Action* act)
110 {
111   act->x_offset = 0;
112   act->y_offset = 0;
113   act->z_order = 0;
114   act->fps = 10;
115
116   start_animation(-1);
117 }
118
119 void
120 Sprite::set_action(std::string act)
121 {
122 if(!next_action.empty() && animation_loops > 0)
123   {
124   next_action = act;
125   return;
126   }
127 Actions::iterator i = actions.find(act);
128 if(i == actions.end())
129   {
130   std::cerr << "Warning: Action '" << act << "' not found on Sprite '" << name << "'\n";
131   return;
132   }
133 action = i->second;
134 }
135
136 void
137 Sprite::start_animation(int loops)
138 {
139 reset();
140 animation_loops = loops;
141 }
142
143 void
144 Sprite::reset()
145 {
146 frame = 0;
147 last_tick = SDL_GetTicks();
148 animation_reversed = false;
149 next_action.clear();
150 }
151
152 bool
153 Sprite::check_animation()
154 {
155 return animation_loops;
156 }
157
158 void
159 Sprite::reverse_animation(bool reverse)
160 {
161 animation_reversed = reverse;
162
163 if(animation_reversed)
164   frame = get_frames()-1;
165 else
166   frame = 0;
167 }
168
169 void
170 Sprite::update()
171 {
172 if(animation_loops == 0)
173   {
174   if(frame >= get_frames() || frame < 0)
175     frame = 0;
176   return;
177   }
178
179 float frame_inc = (action->fps/1000.0) * (SDL_GetTicks() - last_tick);
180 last_tick = SDL_GetTicks();
181
182 if(animation_reversed)
183   frame -= frame_inc;
184 else
185   frame += frame_inc;
186
187 if(animation_reversed)
188   {
189   if(frame < 0 || frame >= (float)get_frames())
190     {  // last case can happen when not used reverse_animation()
191     float excedent = frame - 0;
192     frame = get_frames() - 1;
193     if(animation_loops > 0)
194       {
195       animation_loops--;
196       if(animation_loops == 0 && !next_action.empty())
197         {
198         set_action(next_action);
199         start_animation(-1);
200         }
201       }
202
203     if(fabsf(excedent) < get_frames())
204       frame += excedent;
205     }
206   }
207 else
208   {
209   if(frame >= (float)get_frames())
210     {
211     float excedent = frame - get_frames();
212     frame = 0;
213     if(animation_loops > 0)
214       {
215       animation_loops--;
216       if(animation_loops == 0 && !next_action.empty())
217         {
218         set_action(next_action);
219         start_animation(-1);
220         }
221       }
222
223     if(excedent < get_frames())
224       frame += excedent;
225     }
226   }
227 }
228
229 void
230 Sprite::draw(DrawingContext& context, const Vector& pos, int layer,
231     Uint32 drawing_effect)
232 {
233   update();
234
235   if((int)frame >= get_frames() || (int)frame < 0)
236     std::cerr << "Warning: frame out of range: " << (int)frame
237               << "/" << get_frames() << " at " << get_name()
238               << "/" << get_action_name() << std::endl;
239   else
240     context.draw_surface(action->surfaces[(int)frame],
241             pos - Vector(action->x_offset, action->y_offset), layer + action->z_order,
242             drawing_effect);
243 }
244
245 void
246 Sprite::draw_part(DrawingContext& context, const Vector& source, const Vector& size,
247                   const Vector& pos, int layer, Uint32 drawing_effect)
248 {
249   update();
250
251   if((int)frame >= get_frames() || (int)frame < 0)
252     std::cerr << "Warning: frame out of range: " << (int)frame
253               << "/" << get_frames() << " at sprite: " << get_name()
254               << "/" << get_action_name() << std::endl;
255   else
256     context.draw_surface_part(action->surfaces[(int)frame], source, size,
257             pos - Vector(action->x_offset, action->y_offset), layer + action->z_order,
258             drawing_effect);
259 }
260
261 int
262 Sprite::get_width()
263 {
264   return action->surfaces[get_frame()]->w;
265 }
266
267 int
268 Sprite::get_height()
269 {
270   return action->surfaces[get_frame()]->h;
271 }
272
273 /* EOF */