src/object/portable.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_OBJECT_PORTABLE_HPP
  18 #define HEADER_SUPERTUX_OBJECT_PORTABLE_HPP
  19
  20 #include "supertux/direction.hpp"
  21 #include "supertux/moving_object.hpp"
  22 #include "util/refcounter.hpp"
  23
  24 /**
  25  * An object that inherits from this object is considered "portable" and can
  26  * be carried around by the player.
  27  * The object has to additionally set the PORTABLE flag (this allows to
  28  * make the object only temporarily portable by resetting the flag)
  29  */
  30 class Portable
  31 {
  32 public:
  33   virtual ~Portable()
  34   { }
  35
  36   /**
  37    * called each frame when the object has been grabbed.
  38    */
  39   virtual void grab(MovingObject& object, const Vector& pos, Direction dir) = 0;
  40
  41   virtual void ungrab(MovingObject& , Direction )
  42   {}
  43
  44   virtual bool is_portable() const
  45   {
  46     return true;
  47   }
  48 };
  49
  50 #endif
  51
  52 /* EOF */