-// $Id$
-//
// SuperTux Path
// Copyright (C) 2005 Philipp <balinor@pnxs.de>
// Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
+// 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
-// as published by the Free Software Foundation; either version 2
-// of the License, or (at your option) any later version.
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// 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.
-#ifndef __PATH_HPP__
-#define __PATH_HPP__
-
-#include <string>
-#include <list>
-#include <map>
-
-#include "math/vector.hpp"
-#include "game_object.hpp"
-#include "lisp/lisp.hpp"
-#include "serializable.hpp"
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+#ifndef HEADER_SUPERTUX_OBJECT_PATH_HPP
+#define HEADER_SUPERTUX_OBJECT_PATH_HPP
-/**
- * Helper class that stores an individual node of a Path
- */
-class PathNode
-{
-public:
- Vector position; /**< position (in pixels) of this node */
- float time; /**< time (in seconds) to get to this node */
-};
+#include <vector>
+#include "math/vector.hpp"
+#include "util/reader_fwd.hpp"
+#include "util/writer_fwd.hpp"
-/**
- * Path an object can travel along. Made up of multiple nodes of type PathNode.
- */
-class Path : public GameObject, public Serializable
+class Path
{
public:
- Path(const lisp::Lisp& reader);
+ Path();
~Path();
- virtual void update(float elapsed_time);
- virtual void draw(DrawingContext& context);
-
- virtual void write(lisp::Writer& writer);
+ void read(const Reader& reader);
- const Vector& GetPosition();
- const Vector& GetLastMovement();
+ Vector get_base() const;
- const std::string GetName();
+ /**
+ * Helper class that stores an individual node of a Path
+ */
+ class Node
+ {
+ public:
+ Vector position; /**< the position of this node */
+ float time; /**< time (in seconds) to get from this node to next node */
- // WARNING: returns NULL if not found !
- static Path* GetByName(const std::string& name);
+ Node() :
+ position(),
+ time()
+ {}
+ };
-private:
- std::string name; /**< name this path can be referenced with, stored in PathRegistry */
- bool circular; /**< true: start with the first node once the last one has been reached. false: path will stop at last node */
- bool forward; /**< true: travel to nodes in the order they were defined. false: inverse order */
- std::vector<PathNode> pathNodes; /**< list of nodes that make up this path */
+ std::vector<Node> nodes;
- Vector position; /**< current position */
- Vector velocity; /**< current velocity */
- Vector last_movement; /**< amount of pixels we moved in the last call to update */
+ /**
+ * returns Node index nearest to reference_point or -1 if not applicable
+ */
+ int get_nearest_node_no(Vector reference_point) const;
- int destinationNode; /**< current destination Node */
- float timeToGo; /**< seconds until we arrive at the destination */
+ /**
+ * returns Node index farthest from reference_point or -1 if not applicable
+ */
+ int get_farthest_node_no(Vector reference_point) const;
- static std::map<std::string,Path*> registry;
+private:
+ friend class PathWalker;
+
+ enum WalkMode {
+ // moves from first to last path node and stops
+ ONE_SHOT,
+ // moves from first to last node then in reverse order back to first
+ PING_PONG,
+ // moves from last node back to the first node
+ CIRCULAR
+ };
+
+ WalkMode mode;
};
#endif
+
+/* EOF */