-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_grid_8h_source.html
82 lines (82 loc) · 20.7 KB
/
_grid_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): Grid.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Gamedev Framework (gf)
 <span id="projectnumber">0.14.0</span>
</div>
<div id="projectbrief">A C++14 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Grid.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Gamedev Framework (gf)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2016-2019 Julien Bernard</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This software is provided 'as-is', without any express or implied</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * freely, subject to the following restrictions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * 1. The origin of this software must not be misrepresented; you must not</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * claim that you wrote the original software. If you use this software</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * appreciated but is not required.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * misrepresented as being the original software.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef GF_GRID_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define GF_GRID_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "Portability.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "Transformable.h"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "Vector.h"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "VertexArray.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "VertexBuffer.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classgf_1_1_square_grid.html"> 39</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_square_grid.html">SquareGrid</a> : <span class="keyword">public</span> <a class="code" href="classgf_1_1_transformable.html">gf::Transformable</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classgf_1_1_square_grid.html">SquareGrid</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> gridSize, <a class="code" href="structgf_1_1_vector.html">Vector2f</a> cellSize, <span class="keyword">const</span> <a class="code" href="structgf_1_1_vector_3_01_t_00_014_01_4.html">Color4f</a>& color, <span class="keywordtype">float</span> lineWidth = 1.0f);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">void</span> setGridSize(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> gridSize);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classgf_1_1_square_grid.html#aa5dbac752ffa46950483e8df05e462c7"> 63</a></span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> <a class="code" href="classgf_1_1_square_grid.html#aa5dbac752ffa46950483e8df05e462c7">getGridSize</a>() const noexcept {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> m_gridSize;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> setCellSize(<a class="code" href="structgf_1_1_vector.html">Vector2f</a> cellSize);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classgf_1_1_square_grid.html#accd144ca36696d69a32559ca0742ed57"> 79</a></span>  <a class="code" href="structgf_1_1_vector.html">Vector2f</a> <a class="code" href="classgf_1_1_square_grid.html#accd144ca36696d69a32559ca0742ed57">getCellSize</a>() const noexcept {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">return</span> m_cellSize;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> setColor(<span class="keyword">const</span> <a class="code" href="structgf_1_1_vector_3_01_t_00_014_01_4.html">Color4f</a>& color);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classgf_1_1_square_grid.html#aaf5dc58d2c15e7663901b945aa1fa8e5"> 95</a></span>  <span class="keyword">const</span> <a class="code" href="structgf_1_1_vector_3_01_t_00_014_01_4.html">Color4f</a>& <a class="code" href="classgf_1_1_square_grid.html#aaf5dc58d2c15e7663901b945aa1fa8e5">getColor</a>() const noexcept {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> m_color;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classgf_1_1_square_grid.html#a9380e22ddf2164fc2cf726b4c355bc38"> 104</a></span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_grid.html#a9380e22ddf2164fc2cf726b4c355bc38">setLineWidth</a>(<span class="keywordtype">float</span> lineWidth) noexcept {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  m_lineWidth = lineWidth;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classgf_1_1_square_grid.html#ad018b0872d9cd345867e5078d9cfaae5"> 113</a></span>  <span class="keywordtype">float</span> <a class="code" href="classgf_1_1_square_grid.html#ad018b0872d9cd345867e5078d9cfaae5">getLineWidth</a>() const noexcept {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> m_lineWidth;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <a class="code" href="structgf_1_1_rect.html">RectF</a> getLocalBounds() <span class="keyword">const</span>;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">void</span> setAnchor(<a class="code" href="group__graphics.html#gadeb9cdf9d7e8eec2eb8cc638c54b5066">Anchor</a> anchor);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <a class="code" href="classgf_1_1_vertex_buffer.html">VertexBuffer</a> commitGeometry() <span class="keyword">const</span>;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> draw(<a class="code" href="classgf_1_1_render_target.html">RenderTarget</a>& target, <span class="keyword">const</span> <a class="code" href="structgf_1_1_render_states.html">RenderStates</a>& states) <span class="keyword">override</span>;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordtype">void</span> updateGeometry();</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> m_gridSize;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="structgf_1_1_vector.html">Vector2f</a> m_cellSize;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <a class="code" href="structgf_1_1_vector_3_01_t_00_014_01_4.html">Color4f</a> m_color;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">float</span> m_lineWidth;</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <a class="code" href="classgf_1_1_vertex_array.html">VertexArray</a> m_vertices;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  };</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> }</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> }</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor">#endif // GF_GRID_H</span></div><div class="ttc" id="classgf_1_1_transformable_html"><div class="ttname"><a href="classgf_1_1_transformable.html">gf::Transformable</a></div><div class="ttdoc">Decomposed transform defined by a position, a rotation and a scale. </div><div class="ttdef"><b>Definition:</b> Transformable.h:95</div></div>
<div class="ttc" id="classgf_1_1_square_grid_html_aa5dbac752ffa46950483e8df05e462c7"><div class="ttname"><a href="classgf_1_1_square_grid.html#aa5dbac752ffa46950483e8df05e462c7">gf::SquareGrid::getGridSize</a></div><div class="ttdeci">Vector2i getGridSize() const noexcept</div><div class="ttdoc">Get the grid size. </div><div class="ttdef"><b>Definition:</b> Grid.h:63</div></div>
<div class="ttc" id="classgf_1_1_vertex_array_html"><div class="ttname"><a href="classgf_1_1_vertex_array.html">gf::VertexArray</a></div><div class="ttdoc">A set of primitives. </div><div class="ttdef"><b>Definition:</b> VertexArray.h:65</div></div>
<div class="ttc" id="classgf_1_1_square_grid_html_accd144ca36696d69a32559ca0742ed57"><div class="ttname"><a href="classgf_1_1_square_grid.html#accd144ca36696d69a32559ca0742ed57">gf::SquareGrid::getCellSize</a></div><div class="ttdeci">Vector2f getCellSize() const noexcept</div><div class="ttdoc">Get the cell size. </div><div class="ttdef"><b>Definition:</b> Grid.h:79</div></div>
<div class="ttc" id="classgf_1_1_square_grid_html_ad018b0872d9cd345867e5078d9cfaae5"><div class="ttname"><a href="classgf_1_1_square_grid.html#ad018b0872d9cd345867e5078d9cfaae5">gf::SquareGrid::getLineWidth</a></div><div class="ttdeci">float getLineWidth() const noexcept</div><div class="ttdoc">Get the width of the grid frame. </div><div class="ttdef"><b>Definition:</b> Grid.h:113</div></div>
<div class="ttc" id="classgf_1_1_square_grid_html_a9380e22ddf2164fc2cf726b4c355bc38"><div class="ttname"><a href="classgf_1_1_square_grid.html#a9380e22ddf2164fc2cf726b4c355bc38">gf::SquareGrid::setLineWidth</a></div><div class="ttdeci">void setLineWidth(float lineWidth) noexcept</div><div class="ttdoc">Set the width of the grid frame. </div><div class="ttdef"><b>Definition:</b> Grid.h:104</div></div>
<div class="ttc" id="classgf_1_1_render_target_html"><div class="ttname"><a href="classgf_1_1_render_target.html">gf::RenderTarget</a></div><div class="ttdoc">Base class for all render targets (window, texture, ...) </div><div class="ttdef"><b>Definition:</b> RenderTarget.h:73</div></div>
<div class="ttc" id="structgf_1_1_render_states_html"><div class="ttname"><a href="structgf_1_1_render_states.html">gf::RenderStates</a></div><div class="ttdoc">Define the states used for drawing to a RenderTarget. </div><div class="ttdef"><b>Definition:</b> RenderStates.h:82</div></div>
<div class="ttc" id="classgf_1_1_vertex_buffer_html"><div class="ttname"><a href="classgf_1_1_vertex_buffer.html">gf::VertexBuffer</a></div><div class="ttdoc">Data in the graphics memory. </div><div class="ttdef"><b>Definition:</b> VertexBuffer.h:77</div></div>
<div class="ttc" id="structgf_1_1_rect_html"><div class="ttname"><a href="structgf_1_1_rect.html">gf::Rect< float ></a></div></div>
<div class="ttc" id="namespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes. </div><div class="ttdef"><b>Definition:</b> Action.h:35</div></div>
<div class="ttc" id="classgf_1_1_square_grid_html"><div class="ttname"><a href="classgf_1_1_square_grid.html">gf::SquareGrid</a></div><div class="ttdoc">A square grid. </div><div class="ttdef"><b>Definition:</b> Grid.h:39</div></div>
<div class="ttc" id="structgf_1_1_vector_3_01_t_00_014_01_4_html"><div class="ttname"><a href="structgf_1_1_vector_3_01_t_00_014_01_4.html">gf::Vector< T, 4 ></a></div><div class="ttdoc">A 4D vector. </div><div class="ttdef"><b>Definition:</b> Vector.h:838</div></div>
<div class="ttc" id="classgf_1_1_square_grid_html_aaf5dc58d2c15e7663901b945aa1fa8e5"><div class="ttname"><a href="classgf_1_1_square_grid.html#aaf5dc58d2c15e7663901b945aa1fa8e5">gf::SquareGrid::getColor</a></div><div class="ttdeci">const Color4f & getColor() const noexcept</div><div class="ttdoc">Get the color of the grid frame. </div><div class="ttdef"><b>Definition:</b> Grid.h:95</div></div>
<div class="ttc" id="group__graphics_html_gadeb9cdf9d7e8eec2eb8cc638c54b5066"><div class="ttname"><a href="group__graphics.html#gadeb9cdf9d7e8eec2eb8cc638c54b5066">gf::Anchor</a></div><div class="ttdeci">Anchor</div><div class="ttdoc">An anchor of a box. </div><div class="ttdef"><b>Definition:</b> Anchor.h:38</div></div>
<div class="ttc" id="structgf_1_1_vector_html"><div class="ttname"><a href="structgf_1_1_vector.html">gf::Vector< int, 2 ></a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>