FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
searchspace.h
1 /***************************************************************************
2  * Copyright (C) 2005-2008 by the FIFE team *
3  * http://www.fifengine.de *
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_PATHFINDER_SEARCHSPACE
23 #define FIFE_PATHFINDER_SEARCHSPACE
24 
25 // Standard C++ library includes
26 
27 // 3rd party library includes
28 
29 // FIFE includes
30 // These includes are split up in two parts, separated by one empty line
31 // First block: files included from the FIFE root src directory
32 // Second block: files included from the same folder
33 #include "model/structures/location.h"
34 
35 namespace FIFE {
36 
37  class Layer;
38 
39  class SearchSpace {
40  public:
41  SearchSpace(Layer* layer);
42 
43  int getUpperX() const {
44  return m_upperX;
45  }
46 
47  int getUpperY() const {
48  return m_upperY;
49  }
50 
51  int getLowerX() const {
52  return m_lowerX;
53  }
54 
55  int getLowerY() const {
56  return m_lowerY;
57  }
58 
59  int getWidth() const {
60  //1 is added to make it inclusive of the first cell.
61  return (m_upperX - m_lowerX) + 1;
62  }
63 
64  int getHeight() const {
65  return (m_upperY - m_lowerY) + 1;
66  }
67 
68  Layer* getLayer() const {
69  return m_layer;
70  }
71 
80  bool isInSearchSpace(const Location& location) const;
81 
90  ModelCoordinate translateCoordsToSearchSpace(const ModelCoordinate& coords) const;
91 
99  int convertCoordToInt(const ModelCoordinate& coord) const;
100 
109  ModelCoordinate convertIntToCoord(const int cell) const;
110 
115  int getMaxIndex() const;
116  private:
117  //The boundries of the search space.
118  int m_upperX;
119  int m_upperY;
120  int m_lowerX;
121  int m_lowerY;
122 
123  //The layer of the search space.
124  Layer* m_layer;
125  };
126 
127 }
128 
129 
130 #endif