Gamedev Framework (gf)  0.17.0
A C++14 framework for 2D games
Stagger.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2019 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_STAGGER_H
22 #define GF_STAGGER_H
23 
24 #include "MapCell.h"
25 #include "Vector.h"
26 
27 namespace gf {
28 #ifndef DOXYGEN_SHOULD_SKIP_THIS
29 inline namespace v1 {
30 #endif
31 
36  class StaggerHelper {
37  public:
39  : m_axis(axis)
40  , m_index(index)
41  {
42 
43  }
44 
52  Vector2f computeCenter(Vector2i coords, Vector2f size) const;
53 
54  private:
55  MapCellAxis m_axis;
56  MapCellIndex m_index;
57  };
58 
59 #ifndef DOXYGEN_SHOULD_SKIP_THIS
60 }
61 #endif
62 }
63 
64 #endif // GF_STAGGER_H
A helper for computing coordinates in a staggered map.
Definition: Stagger.h:36
StaggerHelper(MapCellAxis axis, MapCellIndex index)
Definition: Stagger.h:38
The namespace for gf classes.
Definition: Action.h:35
MapCellIndex
Map cell index in a map celled or hexagonal map.
Definition: MapCell.h:35
MapCellAxis
Map cell axis in a map celled.
Definition: MapCell.h:46