97274ce6d36ec4a0025b66764525135181949db2
[supertux.git] / src / trigger / trigger_base.hpp
1 //  $Id$
2 //
3 //  SuperTux
4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.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_TRIGGER_BASE_H
21 #define SUPERTUX_TRIGGER_BASE_H
22
23 #include <list>
24 #include "moving_object.hpp"
25 #include "object_remove_listener.hpp"
26
27 class Player;
28 class Sprite;
29
30 /** This class is the base class for all objects you can interact with in some
31  * way. There are several interaction types defined like touch and activate
32  */
33 class TriggerBase : public MovingObject, public ObjectRemoveListener
34 {
35 public:
36   enum EventType {
37     EVENT_TOUCH,     /**< Object came into contact */
38     EVENT_LOSETOUCH, /**< Lost contact with object */
39     EVENT_ACTIVATE   /**< Action button pressed    */
40   };
41
42   TriggerBase();
43   ~TriggerBase();
44
45   void update(float elapsed_time);
46   void draw(DrawingContext& context);
47   HitResponse collision(GameObject& other, const CollisionHit& hit);
48
49   /**
50    * Receive trigger events
51    */
52   virtual void event(Player& player, EventType type) = 0;
53   
54   /**
55    * Called by GameObject destructor of an object in losetouch_listeners
56    */
57   virtual void object_removed(GameObject* object);
58
59 private:
60   Sprite* sprite;
61   bool lasthit;
62   bool hit;
63
64   std::list<Player*> losetouch_listeners; /**< Players that will be informed when we lose touch with them */
65 };
66
67 #endif /*SUPERTUX_INTERACTIVE_OBJECT_H*/