annotate engine/core/pathfinder/search.h @ 307:22253b2c9b14

- added LightEdit editor plugin (needs light branch to work; deactivated if lighting renderer is not available) - added animation viewer to ObjectEdit - several bugfixes for ObjectEdit plugin FEATURES: - ObjectEdit - viewing and rotating animated instances (rotations are hardcoded for now, FIFE needs to expose available angles to python in order to make animation rotation work for every client) - LightEdit - test global light values
author chewie@33b003aa-7bff-0310-803a-e67f0ece8222
date Tue, 11 Aug 2009 15:32:54 +0000 (2009-08-11)
parents 1465536aec94
children
rev   line source
300
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
1 /***************************************************************************
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
2 * Copyright (C) 2005-2008 by the FIFE team *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
3 * http://www.fifengine.de *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
4 * This file is part of FIFE. *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
5 * *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
6 * FIFE is free software; you can redistribute it and/or *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
7 * modify it under the terms of the GNU Lesser General Public *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
8 * License as published by the Free Software Foundation; either *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
9 * version 2.1 of the License, or (at your option) any later version. *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
10 * *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
11 * This library is distributed in the hope that it will be useful, *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
14 * Lesser General Public License for more details. *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
15 * *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
16 * You should have received a copy of the GNU Lesser General Public *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
17 * License along with this library; if not, write to the *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
18 * Free Software Foundation, Inc., *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
20 ***************************************************************************/
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
21
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
22 #ifndef FIFE_PATHFINDER_SEARCH
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
23 #define FIFE_PATHFINDER_SEARCH
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
24
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
25 // Standard C++ library includes
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
26 #include <vector>
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
27
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
28 // 3rd party library includes
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
29
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
30 // FIFE includes
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
31 // These includes are split up in two parts, separated by one empty line
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
32 // First block: files included from the FIFE root src directory
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
33 // Second block: files included from the same folder
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
34 #include "model/structures/location.h"
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
35
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
36 namespace FIFE {
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
37
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
38 class SearchSpace;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
39
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
40 /** A base class that all searches must derive from.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
41 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
42 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
43 class Search {
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
44 public:
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
45 typedef std::list<Location> Path;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
46 /** An enumeration of the different status the search can be in.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
47 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
48 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
49 enum SearchStatus {
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
50 search_status_failed,
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
51 search_status_complete,
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
52 search_status_incomplete
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
53 };
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
54 /** Constructor.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
55 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
56 * @param session_id The id in the pather that references this session.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
57 * @param from The location where the search should be started from.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
58 * @param to The location where the search should finish.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
59 * @param pather A pointer to the pather controlling this session.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
60 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
61 Search(const int session_id, const Location& from, const Location& to, SearchSpace* searchspace)
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
62 : m_to(to), m_from(from), m_sessionId(session_id), m_searchspace(searchspace),
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
63 m_status(search_status_incomplete) {
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
64 }
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
65
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
66 /** Destructor.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
67 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
68 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
69 virtual ~Search() {}
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
70
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
71 /** Retrieves the session id.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
72 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
73 * @return The searches session id in the pather.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
74 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
75 int getSessionId() const {
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
76 return m_sessionId;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
77 }
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
78
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
79 /** Retrieves the pather.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
80 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
81 * @return A pointer to the abstract pather which
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
82 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
83 SearchSpace* getSearchSpace() const {
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
84 return m_searchspace;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
85 }
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
86
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
87 /** A small function which returns the current status of the search.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
88 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
89 * @return An integer value representing the status, which is enumerated by this class.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
90 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
91 int getSearchStatus() const {
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
92 return m_status;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
93 }
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
94
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
95
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
96 /** Updates the search and returns the next part of the path or the entire path if the
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
97 * algorithm is offline.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
98 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
99 * @return A vector of Location objects representing the path.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
100 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
101 virtual void updateSearch() = 0;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
102
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
103 /** Calculates a path generated by a search.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
104 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
105 * Creates a path and returns it.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
106 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
107 virtual Path calcPath() = 0;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
108 protected:
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
109
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
110 /** Sets the current status of the search.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
111 *
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
112 * @param status The status to set.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
113 */
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
114 void setSearchStatus(const SearchStatus status) {
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
115 m_status = status;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
116 }
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
117
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
118 //A location object representing where the search started.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
119 Location m_to;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
120
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
121 //A location object representing where the search ended.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
122 Location m_from;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
123
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
124 //An integer containing the session id for this search.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
125 int m_sessionId;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
126
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
127 //A pointer to the pather that owns this search.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
128 SearchSpace* m_searchspace;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
129
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
130 //An enumeration of the searches current status.
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
131 SearchStatus m_status;
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
132 };
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
133
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
134 }
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
135
1465536aec94 * Reverting revisions 2937 - 2947; these have been pathfinding related changes that partially broke some FIFE-based 3rd party games
mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
136 #endif