argh, clean out copy
[supertux.git] / src / src / object / moving_sprite.hpp
1 //  $Id$
2 //
3 //  SuperTux - MovingSprite Base Class
4 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.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 __MOVING_SPRITE_H__
21 #define __MOVING_SPRITE_H__
22
23 #include <string>
24 #include "moving_object.hpp"
25 #include "sprite/sprite.hpp"
26 #include "video/drawing_context.hpp"
27 #include "object/anchor_point.hpp"
28
29 /**
30  * Abstract base class for MovingObjects that are represented by a Sprite
31  */
32 class MovingSprite : public MovingObject
33 {
34 public:
35   MovingSprite(const Vector& pos, const std::string& sprite_name, int layer = LAYER_OBJECTS, CollisionGroup collision_group = COLGROUP_MOVING);
36   MovingSprite(const lisp::Lisp& reader, const Vector& pos, int layer = LAYER_OBJECTS, CollisionGroup collision_group = COLGROUP_MOVING);
37   MovingSprite(const lisp::Lisp& reader, const std::string& sprite_name, int layer = LAYER_OBJECTS, CollisionGroup collision_group = COLGROUP_MOVING);
38   MovingSprite(const lisp::Lisp& reader, int layer = LAYER_OBJECTS, CollisionGroup collision_group = COLGROUP_MOVING);
39   MovingSprite(const MovingSprite& moving_sprite);
40   MovingSprite& operator=(const MovingSprite& moving_sprite);
41   ~MovingSprite();
42
43   virtual void draw(DrawingContext& context);
44   virtual void update(float elapsed_time);
45
46 protected:
47   std::string sprite_name;
48   Sprite* sprite;
49   int layer; /**< Sprite's z-position. Refer to video/drawing_context.hpp for sensible values. */
50
51   /**
52    * set new action for sprite and resize bounding box.
53    * use with care as you can easily get stuck when resizing the bounding box.
54    */
55   void set_action(const std::string& action, int loops);
56
57   /**
58    * set new action for sprite and re-center bounding box.
59    * use with care as you can easily get stuck when resizing the bounding box.
60    */
61   void set_action_centered(const std::string& action, int loops);
62
63   /**
64    * set new action for sprite and align bounding boxes at anchorPoint.
65    * use with care as you can easily get stuck when resizing the bounding box.
66    */
67   void set_action(const std::string& action, int loops, AnchorPoint anchorPoint);
68 };
69
70 #endif