routepather.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 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_PATHFINDER_ROUTEPATHER
#define FIFE_PATHFINDER_ROUTEPATHER

// Standard C++ library includes
#include <map>
#include <vector>

// 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
#include "model/metamodel/ipather.h"
#include "model/structures/location.h"
#include "util/structures/priorityqueue.h"

namespace FIFE {

    class CellCache;
    class RoutePatherSearch;
    class Route;

    class RoutePather : public IPather {
    public:
        RoutePather() : m_nextFreeSessionId(0), m_maxTicks(1000) {
        }

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

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

        bool followRoute(const Location& current, Route* route, double speed, Location& nextLocation);
        
        void update();

        bool cancelSession(const int32_t sessionId);

        void setMaxTicks(int32_t ticks);

        int32_t getMaxTicks();

        std::string getName() const;

    private:
        typedef std::list<Location> Path;

        typedef PriorityQueue<RoutePatherSearch*, int32_t> SessionQueue;

        typedef std::list<int32_t> SessionList;

        void addSessionId(const int32_t sessionId);

        int32_t makeSessionId();

        bool locationsEqual(const Location& a, const Location& b);

        bool sessionIdValid(const int32_t sessionId);

        bool invalidateSessionId(const int32_t sessionId);

        SessionQueue m_sessions;

        SessionList m_registeredSessionIds;

        int32_t m_nextFreeSessionId;

        int32_t m_maxTicks;
    };
}
#endif