FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
hexgrid.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 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_GRIDS_HEXGRID_H
23 #define FIFE_MODEL_GRIDS_HEXGRID_H
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 "util/base/fife_stdint.h"
34 
35 #include "cellgrid.h"
36 
37 namespace FIFE {
38  class HexGrid: public CellGrid {
39  public:
40  HexGrid(bool axial = false);
41  virtual ~HexGrid();
42 
43  bool isAccessible(const ModelCoordinate& curpos, const ModelCoordinate& target);
44  const std::string& getType() const;
45  const std::string& getName() const;
46  double getAdjacentCost(const ModelCoordinate& curpos, const ModelCoordinate& target);
47  double getHeuristicCost(const ModelCoordinate& curpos, const ModelCoordinate& target);
48  uint32_t getCellSideCount() const { return 6; }
53  void getVertices(std::vector<ExactModelCoordinate>& vtx, const ModelCoordinate& cell);
54  std::vector<ModelCoordinate> toMultiCoordinates(const ModelCoordinate& position, const std::vector<ModelCoordinate>& orig, bool reverse);
55  std::vector<ModelCoordinate> getCoordinatesInLine(const ModelCoordinate& start, const ModelCoordinate& end);
56  CellGrid* clone();
57 
58  private:
59  double getXZigzagOffset(double y);
61 
62  bool m_axial;
63  };
64 }
65 
66 #endif
virtual ~HexGrid()
Definition: hexgrid.cpp:71
double getXZigzagOffset(double y)
Definition: hexgrid.cpp:124
double getAdjacentCost(const ModelCoordinate &curpos, const ModelCoordinate &target)
Returns distance const from curpos to target point only cells adjacent to curpos are considered in th...
Definition: hexgrid.cpp:93
ExactModelCoordinate toExactLayerCoordinates(const ExactModelCoordinate &map_coord)
Transforms given point from map coordinates to layer coordinates.
Definition: hexgrid.cpp:149
std::vector< ModelCoordinate > toMultiCoordinates(const ModelCoordinate &position, const std::vector< ModelCoordinate > &orig, bool reverse)
Returns point vector with coordinates for a multi object.
Definition: hexgrid.cpp:267
std::vector< ModelCoordinate > getCoordinatesInLine(const ModelCoordinate &start, const ModelCoordinate &end)
Returns point vector with coordinates for a line from start to end.
Definition: hexgrid.cpp:304
HexGrid(bool axial=false)
Definition: hexgrid.cpp:47
ExactModelCoordinate toMapCoordinates(const ExactModelCoordinate &layer_coords)
Transforms given point from layer coordinates to map coordinates.
Definition: hexgrid.cpp:140
bool m_axial
Definition: hexgrid.h:62
uint32_t getCellSideCount() const
Gets the count of sides for a single cell.
Definition: hexgrid.h:48
CellGrid * clone()
Returns clone of this cellgrid.
Definition: hexgrid.cpp:58
double getHeuristicCost(const ModelCoordinate &curpos, const ModelCoordinate &target)
Returns distance const from curpos to target point.
Definition: hexgrid.cpp:100
const std::string & getType() const
Type of cellgrid.
Definition: hexgrid.cpp:104
ModelCoordinate toLayerCoordinatesFromExactLayerCoordinates(const ExactModelCoordinate &exact_layer_coords)
Transforms given point from exact layer coordinates to cell precision layer coordinates.
Definition: hexgrid.cpp:164
const std::string & getName() const
Name of the cellgrid (DEPRECATED? -jwt)
Definition: hexgrid.cpp:114
void getVertices(std::vector< ExactModelCoordinate > &vtx, const ModelCoordinate &cell)
Fills given point vector with vertices from selected cell.
Definition: hexgrid.cpp:223
A 3D Point.
Definition: point.h:205
ModelCoordinate toLayerCoordinates(const ExactModelCoordinate &map_coord)
Transforms given point from map coordinates to layer coordinates.
Definition: hexgrid.cpp:157
bool isAccessible(const ModelCoordinate &curpos, const ModelCoordinate &target)
Tells if given target point is accessible from curpos only cells adjacent to curpos are considered in...
Definition: hexgrid.cpp:74
ModelCoordinate toLayerCoordinatesHelper(const ExactModelCoordinate &coords)
Definition: hexgrid.cpp:170
unsigned int uint32_t
Definition: core.h:40