src/object/portable.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2005 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
  19 //  02111-1307, USA.
  20 #ifndef __PORTABLE_H__
  21 #define __PORTABLE_H__
  22
  23 #include "moving_object.hpp"
  24
  25 /**
  26  * An object that inherits from this object is considered "portable" and can
  27  * be carried around by the player.
  28  * The object has to additionally set the PORTABLE flag (this allows to
  29  * make the object only temporarily portable by resetting the flag)
  30  */
  31 class Portable
  32 {
  33 public:
  34   virtual ~Portable()
  35   { }
  36
  37   /**
  38    * called each frame when the object has been grabbed.
  39    */
  40   virtual void grab(MovingObject& object, const Vector& pos) = 0;
  41
  42   /** called when object isn't grabbed anymore */
  43   virtual void ungrab(MovingObject& object)
  44   {
  45     (void) object;
  46   }
  47 };
  48
  49 #endif