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