FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator
abstractpather.h
00001 /***************************************************************************
00002  *   Copyright (C) 2005-2008 by the FIFE team                              *
00003  *   http://www.fifengine.de                                               *
00004  *   This file is part of FIFE.                                            *
00005  *                                                                         *
00006  *   FIFE is free software; you can redistribute it and/or                 *
00007  *   modify it under the terms of the GNU Lesser General Public            *
00008  *   License as published by the Free Software Foundation; either          *
00009  *   version 2.1 of the License, or (at your option) any later version.    *
00010  *                                                                         *
00011  *   This library is distributed in the hope that it will be useful,       *
00012  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00013  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00014  *   Lesser General Public License for more details.                       *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU Lesser General Public      *
00017  *   License along with this library; if not, write to the                 *
00018  *   Free Software Foundation, Inc.,                                       *
00019  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
00020  ***************************************************************************/
00021 
00022 #ifndef FIFE_MODEL_ABSTRACTPATHER_H
00023 #define FIFE_MODEL_ABSTRACTPATHER_H
00024 
00025 // Standard C++ library includes
00026 #include <string>
00027 
00028 // 3rd party library includes
00029 
00030 // FIFE includes
00031 // These includes are split up in two parts, separated by one empty line
00032 // First block: files included from the FIFE root src directory
00033 // Second block: files included from the same folder
00034 
00035 namespace FIFE {
00036     class Map;
00037     class Location;
00038     class Instance;
00039 
00040     enum 
00041     {
00042         HIGH_PRIORITY,
00043         MEDIUM_PRIORITY,
00044         LOW_PRIORITY
00045     };
00046 
00047     class AbstractPather {
00048     public:
00049         virtual ~AbstractPather() {};
00050 
00067         virtual int getNextLocation(const Instance* instance, const Location& target, 
00068                                     double distance_to_travel, Location& nextLocation,
00069                                     Location& facingLocation, int session_id=-1, 
00070                                     int priority = MEDIUM_PRIORITY) = 0;
00071 
00079         virtual void update() = 0;
00080         
00090         virtual bool cancelSession(const int session_id) = 0;
00091 
00094         virtual std::string getName() const = 0;
00095     };
00096 }
00097 
00098 #endif