git.maemo.org Git - lordsawar/blob - src/RoadPathCalculator.h

   1 // Copyright (C) 2009 Ben Asselstine
   2 //
   3 //  This program is free software; you can redistribute it and/or modify
   4 //  it under the terms of the GNU General Public License as published by
   5 //  the Free Software Foundation; either version 3 of the License, or
   6 //  (at your option) any later version.
   7 //
   8 //  This program is distributed in the hope that it will be useful,
   9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 //  GNU Library General Public License for more details.
  12 //
  13 //  You should have received a copy of the GNU General Public License
  14 //  along with this program; if not, write to the Free Software
  15 //  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16 //  02110-1301, USA.
  17 #ifndef ROADPATH_CALCULATOR_H
  18 #define ROADPATH_CALCULATOR_H
  19
  20 #include <gtkmm.h>
  21 #include "vector.h"
  22
  23 class Path;
  24 class Stack;
  25 class PathCalculator;
  26
  27 //! An object that calculates shortest paths on a weighted grid.
  28 /**
  29  */
  30 class RoadPathCalculator
  31 {
  32  public:
  33
  34      //! Default constructor.
  35      RoadPathCalculator(Vector<int> starting_point);
  36
  37      //! Copy constructor.
  38      RoadPathCalculator(const RoadPathCalculator&);
  39
  40      //! Destructor.
  41      ~RoadPathCalculator();
  42
  43
  44      // Methods that operate on the class data and modify the class.
  45
  46      //! Return a calculated path from the starting point to the given position.
  47      Path* calculate(Vector<int> dest);
  48
  49  private:
  50
  51      // DATA
  52
  53      //! The stack with the movement characteristics to make the road with.
  54      Stack *stack;
  55
  56      //! The path calculator that does the hard work.
  57      PathCalculator *path_calculator;
  58
  59 };
  60
  61 #endif