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