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