ipather.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2006-2011 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_MODEL_IPATHER_H
#define FIFE_MODEL_IPATHER_H

// Standard C++ library includes
#include <string>

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder

namespace FIFE {
    class Location;
    class Instance;
    class Route;
    
    typedef std::list<Location> Path;

    enum PriorityType {
        HIGH_PRIORITY,
        MEDIUM_PRIORITY,
        LOW_PRIORITY
    };

    class IPather {
    public:
        virtual ~IPather() {};

        virtual Route* createRoute(const Location& start, const Location& end, bool immediate = false, const std::string& cost_id = "") = 0;

        virtual bool solveRoute(Route* route, int32_t priority = MEDIUM_PRIORITY, bool immediate = false) = 0;

        virtual bool followRoute(const Location& current, Route* route, double speed, Location& nextLocation) = 0;

        virtual void update() = 0;

        virtual bool cancelSession(const int32_t sessionId) = 0;

        virtual void setMaxTicks(int32_t ticks) = 0;

        virtual int32_t getMaxTicks() = 0;

        virtual std::string getName() const = 0;
    };
}

#endif