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 #include <map>
  26
  27 #include "../utils/lispreader.h"
  28 #include "../video/surface.h"
  29 #include "../math/vector.h"
  30
  31 namespace SuperTux
  32   {
  33
  34   class Sprite
  35     {
  36     private:
  37
  38       struct Action
  39         {
  40         std::string name;
  41
  42         int x_hotspot;
  43         int y_hotspot;
  44
  45         /** Frames per second */
  46         float fps;
  47
  48         /** Number of seconds that a frame is displayed until it is switched
  49             to the next frame */
  50         float frame_delay;
  51
  52         std::vector<Surface*> surfaces;
  53         };
  54
  55     public:
  56       /** cur has to be a pointer to data in the form of ((x-hotspot 5)
  57           (y-hotspot 10) ...) */
  58       Sprite(lisp_object_t* cur);
  59       ~Sprite();
  60
  61       void reset();
  62
  63       /** Update the sprite and process to the next frame */
  64       void update(float delta);
  65       void draw(DrawingContext& context, const Vector& pos, int layer,
  66                 Uint32 drawing_effect = NONE_EFFECT);
  67       int get_current_frame() const;
  68
  69       /** Set action (or state) */
  70       void set_action(std::string& act);
  71
  72       float get_fps()
  73       {
  74         return action->fps;
  75       } ;
  76       int get_frames()
  77       {
  78         return action->surfaces.size();
  79       } ;
  80
  81       std::string get_name() const
  82         {
  83           return name;
  84         }
  85       int get_width() const;
  86       int get_height() const;
  87
  88       Surface* get_frame(unsigned int frame)
  89       {
  90         if(frame < action->surfaces.size())
  91           return action->surfaces[frame];
  92         else
  93           return action->surfaces[0];
  94       }
  95     private:
  96       void init_defaults(Action* act);
  97       void parse_action(LispReader& lispreader);
  98
  99       std::string name;
 100
 101       float time;
 102
 103       typedef std::map <std::string, Action*> Actions;
 104       Actions actions;
 105
 106       Action* action;
 107     };
 108
 109 } //namespace SuperTux
 110
 111 #endif /*SUPERTUX_SPRITE_H*/
 112
 113 /* Local Variables: */
 114 /* mode:c++ */
 115 /* End: */