Use field width of 9 on sscanf (fixes cppcheck portability issues)
[supertux.git] / src / sprite / sprite.hpp
index a43df0a..2c36b0d 100644 (file)
@@ -1,12 +1,10 @@
-//  $Id$
-//
 //  SuperTux
 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
 //
-//  This program is free software; you can redistribute it and/or
-//  modify it under the terms of the GNU General Public License
-//  as published by the Free Software Foundation; either version 2
-//  of the License, or (at your option) any later version.
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
 //
 //  This program is distributed in the hope that it will be useful,
 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
 //  GNU General Public License for more details.
 //
 //  You should have received a copy of the GNU General Public License
-//  along with this program; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-
-#ifndef SUPERTUX_SPRITE_H
-#define SUPERTUX_SPRITE_H
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-#include <string>
-#include <assert.h>
-#include <SDL.h>
+#ifndef HEADER_SUPERTUX_SPRITE_SPRITE_HPP
+#define HEADER_SUPERTUX_SPRITE_SPRITE_HPP
 
-#include "math/vector.hpp"
-#include "math/rect.hpp"
-#include "sprite_data.hpp"
-#include "video/color.hpp"
+#include "sprite/sprite_data.hpp"
+#include "sprite/sprite_ptr.hpp"
 #include "video/drawing_context.hpp"
 
 class Surface;
 class DrawingContext;
-class Color;
 class Blend;
 
 class Sprite
 {
 public:
   Sprite(SpriteData& data);
-  Sprite(const Sprite& other);
   ~Sprite();
 
+  SpritePtr clone() const;
+
   /** Draw sprite, automatically calculates next frame */
-  void draw(DrawingContext& context, const Vector& pos, int layer);
+  void draw(DrawingContext& context, const Vector& pos, int layer,
+      DrawingEffect effect = NO_EFFECT);
 
   void draw_part(DrawingContext& context, const Vector& source,
-      const Vector& size, const Vector& pos, int layer);
+                 const Vector& size, const Vector& pos, int layer);
 
   /** Set action (or state) */
-  void set_action(const std::string& act, int loops = -1);
+  void set_action(const std::string& name, int loops = -1);
+
+  /** Set action (or state), but keep current frame number, loop counter, etc. */
+  void set_action_continued(const std::string& name);
 
   /** Set number of animation cycles until animation stops */
   void set_animation_loops(int loops = -1)
   { animation_loops = loops; }
 
-  /** Set framerate */
-  void set_fps(float new_fps);
-
   /* Stop animation */
   void stop_animation()
   { animation_loops = 0; }
@@ -67,7 +59,7 @@ public:
   float get_fps() const
   { return action->fps; }
   /** Get current action total frames */
-  int get_frames() const
+  unsigned int get_frames() const
   { return action->surfaces.size(); }
   /** Get sprite's name */
   const std::string& get_name() const
@@ -88,7 +80,7 @@ public:
   /** return height of current action's hitbox */
   float get_current_hitbox_height() const;
   /** return current action's hitbox, relative to 0,0 */
-  Rect get_current_hitbox() const;
+  Rectf get_current_hitbox() const;
 
   /** Set the angle of the sprite rotation in degree */
   void set_angle(float angle);
@@ -105,33 +97,47 @@ public:
   Blend get_blend() const;
 
   /** Get current frame */
-  int get_frame() const
-  { return (int)frame; }
+  unsigned int get_frame() const
+  { return frameidx; }
   /** Set current frame */
-  void set_frame(int frame)
-  { 
-    this->frame = (frame % get_frames()); 
+  void set_frame(int frame_)
+  {
+    this->frame = 0;
+    this->frameidx = frame_ % get_frames();
   }
-  Surface* get_frame(unsigned int frame)
+  SurfacePtr get_frame(unsigned int frame_)
   {
-    assert(frame < action->surfaces.size());
-    return action->surfaces[frame];
-  }    
+    assert(frame_ < action->surfaces.size());
+    return action->surfaces[frame_];
+  }
+
+  bool has_action (const std::string& name)
+  {
+    return (data.get_action(name) != NULL);
+  }
 
 private:
   void update();
 
   SpriteData& data;
 
+  // between 0 and 1
   float frame;
+  // between 0 and get_frames()
+  unsigned int frameidx;
   int   animation_loops;
   float last_ticks;
   float angle;
   Color color;
   Blend blend;
 
-  SpriteData::Action* action;
+  const SpriteData::Action* action;
+
+private:
+  Sprite(const Sprite& other);
+  Sprite& operator=(const Sprite&);
 };
 
 #endif
 
+/* EOF */