routepathersearch.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_ROUTEPATHERSEARCH
#define FIFE_PATHFINDER_ROUTEPATHERSEARCH

// Standard C++ library includes

// 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 "util/structures/priorityqueue.h"

namespace FIFE {

    class CellCache;
    class Route;

    class RoutePatherSearch {
    public:
        RoutePatherSearch(Route* route, const int32_t sessionId);

        virtual ~RoutePatherSearch();

        enum SearchStatus {
            search_status_failed,
            search_status_complete,
            search_status_incomplete
        };

        virtual void updateSearch() = 0;

        virtual void calcPath() = 0;

        int32_t getSessionId() const;

        int32_t getSearchStatus() const;

        Route* getRoute();

    protected:
        void setSearchStatus(const SearchStatus status);

        Route* m_route;

        bool m_specialCost;

        bool m_multicell;

        bool m_ignoreDynamicBlockers;

        std::vector<Cell*> m_ignoredBlockers;

    private:
        int32_t m_sessionId;

        SearchStatus m_status;
    };
}
#endif