* Add Airship (regular above-ground theme) and Battle (castle/boss theme) music court...

[supertux.git] / src / object / path_walker.hpp

diff --git a/src/object/path_walker.hpp b/src/object/path_walker.hpp
index 016de8a..cc15320 100644 (file)
--- a/src/object/path_walker.hpp
+++ b/src/object/path_walker.hpp
@@ -1,8 +1,7 @@
-//  $Id: path.hpp 3114 2006-03-23 23:47:04Z sommer $
-// 
-//  SuperTux Path
-//  Copyright (C) 2005 Philipp <balinor@pnxs.de>
-//  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
+//  $Id$
+//
+//  SuperTux
+//  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
 //
 //  This program is free software; you can redistribute it and/or
 //  modify it under the terms of the GNU General Public License
@@ -13,19 +12,15 @@
 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 //  GNU General Public License for more details.
-// 
+//
 //  You should have received a copy of the GNU General Public License
 //  along with this program; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-//  02111-1307, USA.
+//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
 #ifndef __PATH_WALKER_HPP__
 #define __PATH_WALKER_HPP__
 
 #include "path.hpp"
-#include "math/vector.hpp"
-#include "game_object.hpp"
-#include "lisp/lisp.hpp"
-#include "serializable.hpp"
 
 /**
  * A walker that travels along a path
@@ -33,28 +28,54 @@
 class PathWalker
 {
 public:
-  PathWalker(const Path* path);
+  PathWalker(const Path* path, bool running = true);
   virtual ~PathWalker();
 
   /**
-   * advanves the path walker on the path and returns the position delta
+   * advances the path walker on the path and returns the position delta
    * to the last position
    */
   virtual Vector advance(float elapsed_time);
 
+  /** advance until at given node, then stop */
+  void goto_node(int node_no);
+
+  /** start advancing automatically */
+  void start_moving();
+
+  /** stop advancing automatically */
+  void stop_moving();
+
+  /** returns true if PathWalker is currently moving */
+  bool is_moving() {
+    return running;
+  }
+  
+  const Path* path;
+
 private:
   void advance_node();
   void goback_node();
-  
-  const Path* path;
+
+  /**
+   * set to false to immediately stop advancing
+   */
+  bool running;
 
   size_t current_node_nr;
   size_t next_node_nr;
 
-  Vector last_pos;
+  /**
+   * stop advancing automatically when this node is reached
+   */
+  int stop_at_node_nr;
 
-  /** the time we already spend in the current node */
+  /**
+   * the position between the current node and the next node as fraction
+   * between 0 and 1
+   */
   float node_time;
+  float node_mult;
 
   float walking_speed;
 };