src/object/path_walker.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 __PATH_WALKER_HPP__
  21 #define __PATH_WALKER_HPP__
  22
  23 #include "path.hpp"
  24 #include "math/vector.hpp"
  25 #include "game_object.hpp"
  26 #include "lisp/lisp.hpp"
  27 #include "serializable.hpp"
  28
  29 /**
  30  * A walker that travels along a path
  31  */
  32 class PathWalker
  33 {
  34 public:
  35   PathWalker(const Path* path, bool running = true);
  36   virtual ~PathWalker();
  37
  38   /**
  39    * advanves the path walker on the path and returns the position delta
  40    * to the last position
  41    */
  42   virtual Vector advance(float elapsed_time);
  43
  44   /** advance until at given node, then stop */
  45   void goto_node(int node_no);
  46
  47   /** start advancing automatically */
  48   void start_moving();
  49
  50   /** stop advancing automatically */
  51   void stop_moving();
  52
  53   /** returns true if PathWalker is currently moving */
  54   bool is_moving() {
  55     return running;
  56   }
  57
  58   const Path* path;
  59
  60 private:
  61   void advance_node();
  62   void goback_node();
  63
  64   /**
  65    * set to false to immediately stop advancing
  66    */
  67   bool running;
  68
  69   size_t current_node_nr;
  70   size_t next_node_nr;
  71
  72   /**
  73    * stop advancing automatically when this node is reached
  74    */
  75   int stop_at_node_nr;
  76
  77   /**
  78    * the position between the current node and the next node as fraction
  79    * between 0 and 1
  80    */
  81   float node_time;
  82   float node_mult;
  83
  84   float walking_speed;
  85 };
  86
  87 #endif