FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
ipather.h
1 /***************************************************************************
2  * Copyright (C) 2006-2011 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef FIFE_MODEL_IPATHER_H
23 #define FIFE_MODEL_IPATHER_H
24 
25 // Standard C++ library includes
26 #include <string>
27 
28 // 3rd party library includes
29 
30 // FIFE includes
31 // These includes are split up in two parts, separated by one empty line
32 // First block: files included from the FIFE root src directory
33 // Second block: files included from the same folder
34 
35 namespace FIFE {
36  class Map;
37  class Location;
38  class Instance;
39 
40  enum
41  {
42  HIGH_PRIORITY,
43  MEDIUM_PRIORITY,
44  LOW_PRIORITY
45  };
46 
47  class IPather {
48  public:
49  virtual ~IPather() {};
50 
67  virtual int32_t getNextLocation(const Instance* instance, const Location& target,
68  double distance_to_travel, Location& nextLocation,
69  Location& facingLocation, int32_t session_id=-1,
70  int32_t priority = MEDIUM_PRIORITY) = 0;
71 
79  virtual void update() = 0;
80 
90  virtual bool cancelSession(const int32_t session_id) = 0;
91 
94  virtual std::string getName() const = 0;
95  };
96 }
97 
98 #endif