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 its new position
  35    */
  36   virtual Vector advance(float elapsed_time);
  37
  38   /** current position of path walker */
  39   Vector get_pos();
  40
  41   /** advance until at given node, then stop */
  42   void goto_node(int node_no);
  43
  44   /** start advancing automatically */
  45   void start_moving();
  46
  47   /** stop advancing automatically */
  48   void stop_moving();
  49
  50   /** returns true if PathWalker is currently moving */
  51   bool is_moving() {
  52     return running;
  53   }
  54
  55   const Path* path;
  56
  57 private:
  58   void advance_node();
  59   void goback_node();
  60
  61   /**
  62    * set to false to immediately stop advancing
  63    */
  64   bool running;
  65
  66   size_t current_node_nr;
  67   size_t next_node_nr;
  68
  69   /**
  70    * stop advancing automatically when this node is reached
  71    */
  72   int stop_at_node_nr;
  73
  74   /**
  75    * the position between the current node and the next node as fraction
  76    * between 0 and 1
  77    */
  78   float node_time;
  79   float node_mult;
  80
  81   float walking_speed;
  82
  83 private:
  84   PathWalker(const PathWalker&);
  85   PathWalker& operator=(const PathWalker&);
  86 };
  87
  88 #endif
  89
  90 /* EOF */