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         std::vector<Surface*> surfaces;
  49         };
  50
  51     public:
  52       /** cur has to be a pointer to data in the form of ((x-hotspot 5)
  53           (y-hotspot 10) ...) */
  54       Sprite(lisp_object_t* cur);
  55       ~Sprite();
  56
  57       /** Draw sprite, automatically calculates next frame */
  58       void draw(DrawingContext& context, const Vector& pos, int layer,
  59                 Uint32 drawing_effect = NONE_EFFECT);
  60
  61       /** Set action (or state) */
  62       void set_action(std::string act);
  63
  64       /* Start an animation
  65           -1 - for infinite
  66           0  - stopped
  67           1,2,3  - one, two, three times... */
  68       void start_animation(int loops);
  69       /** Check if animation is stopped or not */
  70       bool check_animation();
  71       /** Reverse the animation */
  72       void reverse_animation();
  73
  74       float get_fps()
  75         { return action->fps; }
  76       /** Get current action total frames */
  77       int get_frames()
  78         { return action->surfaces.size(); }
  79       /** Get sprite's name */
  80       std::string get_name() const
  81         { return name; }
  82       /** Get current action name */
  83       std::string get_action_name() const
  84         { return action->name; }
  85       int get_width();
  86       int get_height();
  87
  88       /** Get current frame */
  89       int get_frame()
  90         { return (int)frame; }
  91       /** Set current frame */
  92       void set_frame(int frame_)
  93         { if(frame_ > get_frames()) frame = 0; else frame = frame_; }
  94       Surface* get_frame(unsigned int frame)
  95       {
  96         if(frame < action->surfaces.size())
  97           return action->surfaces[frame];
  98         else
  99           return action->surfaces[0];
 100       }
 101     private:
 102       void init_defaults(Action* act);
 103       void parse_action(LispReader& lispreader);
 104
 105       void update();
 106       void reset();
 107
 108       std::string name;
 109
 110       float frame;
 111       int animation_loops;
 112       bool animation_reversed;
 113       float last_tick;
 114
 115       typedef std::map <std::string, Action*> Actions;
 116       Actions actions;
 117
 118       Action* action;
 119     };
 120
 121 } //namespace SuperTux
 122
 123 #endif /*SUPERTUX_SPRITE_H*/
 124
 125 /* Local Variables: */
 126 /* mode:c++ */
 127 /* End: */