initial commit, lordsawar source, slightly modified

[lordsawar] / src / RoadPathCalculator.h

diff --git a/src/RoadPathCalculator.h b/src/RoadPathCalculator.h
new file mode 100644 (file)
index 0000000..0de4d06
--- /dev/null
+++ b/src/RoadPathCalculator.h
@@ -0,0 +1,61 @@
+// Copyright (C) 2009 Ben Asselstine
+//
+//  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 Library 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., 51 Franklin Street, Fifth Floor, Boston, MA 
+//  02110-1301, USA.
+#ifndef ROADPATH_CALCULATOR_H
+#define ROADPATH_CALCULATOR_H
+
+#include <gtkmm.h>
+#include "vector.h"
+
+class Path;
+class Stack;
+class PathCalculator;
+
+//! An object that calculates shortest paths on a weighted grid.
+/** 
+ */
+class RoadPathCalculator
+{
+ public:
+
+     //! Default constructor.
+     RoadPathCalculator(Vector<int> starting_point);
+
+     //! Copy constructor.
+     RoadPathCalculator(const RoadPathCalculator&);
+
+     //! Destructor.
+     ~RoadPathCalculator();
+
+
+     // Methods that operate on the class data and modify the class.
+ 
+     //! Return a calculated path from the starting point to the given position.
+     Path* calculate(Vector<int> dest);
+
+ private:
+
+     // DATA
+
+     //! The stack with the movement characteristics to make the road with.
+     Stack *stack;
+
+     //! The path calculator that does the hard work.
+     PathCalculator *path_calculator;
+
+};
+
+#endif