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