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