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 <cassert>
  26 #include <map>
  27
  28 #include "video/surface.h"
  29 #include "math/vector.h"
  30 #include "sprite_data.h"
  31
  32 namespace SuperTux
  33 {
  34   class Sprite
  35   {
  36   public:
  37     Sprite(SpriteData& data);
  38     Sprite(const Sprite& other);
  39     ~Sprite();
  40
  41     /** Draw sprite, automatically calculates next frame */
  42     void draw(DrawingContext& context, const Vector& pos, int layer,
  43         Uint32 drawing_effect = NONE_EFFECT);
  44
  45     void draw_part(DrawingContext& context, const Vector& source,
  46         const Vector& size, const Vector& pos, int layer,
  47         Uint32 drawing_effect = NONE_EFFECT);
  48
  49     /** Set action (or state) */
  50     void set_action(std::string act, int loops = -1);
  51
  52     /* Stop animation */
  53     void stop_animation()
  54     { animation_loops = 0; }
  55     /** Check if animation is stopped or not */
  56     bool check_animation();
  57
  58     float get_fps() const
  59     { return action->fps; }
  60     /** Get current action total frames */
  61     int get_frames() const
  62     { return action->surfaces.size(); }
  63     /** Get sprite's name */
  64     const std::string& get_name() const
  65     { return data.name; }
  66     /** Get current action name */
  67     const std::string& get_action_name() const
  68     { return action->name; }
  69
  70     int get_width() const;
  71     int get_height() const;
  72
  73     /** Get current frame */
  74     int get_frame() const
  75     { return (int)frame; }
  76     /** Set current frame */
  77     void set_frame(int frame_)
  78     { if(frame_ > get_frames()) frame = 0; else frame = frame_; }
  79     Surface* get_frame(unsigned int frame)
  80     {
  81       assert(frame < action->surfaces.size());
  82       return action->surfaces[frame];
  83     }
  84
  85   private:
  86     void update();
  87
  88     SpriteData& data;
  89
  90     float frame;
  91     int animation_loops;
  92     Uint32 last_ticks;
  93
  94     SpriteData::Action* action;
  95   };
  96 } //namespace SuperTux
  97
  98 #endif /*SUPERTUX_SPRITE_H*/
  99
 100 /* Local Variables: */
 101 /* mode:c++ */
 102 /* End: */