added comments
[supertux.git] / lib / special / sprite.h
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 #ifndef SUPERTUX_SPRITE_H
21 #define SUPERTUX_SPRITE_H
22
23 #include <string>
24 #include <vector>
25
26 #include "utils/lispreader.h"
27 #include "video/surface.h"
28 #include "math/vector.h"
29
30 class Sprite
31 {
32  private:
33   std::string name;
34
35   int x_hotspot;
36   int y_hotspot;
37
38   /** Frames per second */
39   float fps;
40
41   /** Number of seconds that a frame is displayed until it is switched
42       to the next frame */
43   float frame_delay;
44
45   float time;
46
47   std::vector<Surface*> surfaces;
48
49   void init_defaults();
50  public:
51   /** cur has to be a pointer to data in the form of ((x-hotspot 5)
52       (y-hotspot 10) ...) */
53   Sprite(lisp_object_t* cur);
54   ~Sprite();
55   
56   void reset();
57
58   /** Update the sprite and process to the next frame */
59   void update(float delta);
60   void draw(DrawingContext& context, const Vector& pos, int layer,
61       Uint32 drawing_effect = NONE_EFFECT);
62   int get_current_frame() const;
63
64   float get_fps() { return fps; } ;
65   int get_frames() { return surfaces.size(); } ;
66
67   std::string get_name() const { return name; } 
68   int get_width() const;
69   int get_height() const;
70
71   Surface* get_frame(unsigned int frame)
72     {  if(frame < surfaces.size()) return surfaces[frame];
73        else return surfaces[0];  }
74 };
75
76 #endif /*SUPERTUX_SPRITE_H*/
77
78 /* Local Variables: */
79 /* mode:c++ */
80 /* End: */