SuperSpaceInvaderTurboApoca.../doc/SAE102-SpaceInvaders/html/d0/d8d/class_invaders_grid.html
2022-01-11 15:45:50 +01:00

216 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SUPER Space invader : Turbo edition DX - VS GOD: InvadersGrid Class Reference</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>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="../../LOGO.png"/></td>
<td id="projectalign">
<div id="projectname">SUPER Space invader : Turbo edition DX - VS GOD<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">A simple space invader ripoff</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('d0/d8d/class_invaders_grid.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d3/dc0/class_invaders_grid-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">InvadersGrid Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d6/def/invaders_grid_8h_source.html">invadersGrid.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for InvadersGrid:</div>
<div class="dyncontent">
<div class="center"><img src="../../d9/de6/class_invaders_grid__inherit__graph.png" border="0" usemap="#a_invaders_grid_inherit__map" alt="Inheritance graph"/></div>
<map name="a_invaders_grid_inherit__map" id="a_invaders_grid_inherit__map">
<area shape="rect" title=" " alt="" coords="45,80,141,107"/>
<area shape="rect" title=" " alt="" coords="5,5,180,32"/>
</map>
<center><span class="legend">[<a target="top" href="../../graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for InvadersGrid:</div>
<div class="dyncontent">
<div class="center"><img src="../../d3/dd8/class_invaders_grid__coll__graph.png" border="0" usemap="#a_invaders_grid_coll__map" alt="Collaboration graph"/></div>
<map name="a_invaders_grid_coll__map" id="a_invaders_grid_coll__map">
<area shape="rect" title=" " alt="" coords="45,80,141,107"/>
<area shape="rect" title=" " alt="" coords="5,5,180,32"/>
</map>
<center><span class="legend">[<a target="top" href="../../graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad327fc6f3a003e65ff3c131698ca6982"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d8d/class_invaders_grid.html#ad327fc6f3a003e65ff3c131698ca6982">validColsNumber</a> () const</td></tr>
<tr class="memdesc:ad327fc6f3a003e65ff3c131698ca6982"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function for <a class="el" href="../../d0/d8d/class_invaders_grid.html#ac184c30c8a60fdbe8abed9b9455d35d2" title="Returns a random valid column in the grid.">randomValidCol()</a> that returns the number of valid column (at least one invader in them) in the grid This is a separate function because we need to use it elsewhere. <a href="../../d0/d8d/class_invaders_grid.html#ad327fc6f3a003e65ff3c131698ca6982">More...</a><br /></td></tr>
<tr class="separator:ad327fc6f3a003e65ff3c131698ca6982"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac184c30c8a60fdbe8abed9b9455d35d2"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/d8d/class_invaders_grid.html#ac184c30c8a60fdbe8abed9b9455d35d2">randomValidCol</a> () const</td></tr>
<tr class="memdesc:ac184c30c8a60fdbe8abed9b9455d35d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a random valid column in the grid. <a href="../../d0/d8d/class_invaders_grid.html#ac184c30c8a60fdbe8abed9b9455d35d2">More...</a><br /></td></tr>
<tr class="separator:ac184c30c8a60fdbe8abed9b9455d35d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="../../d6/def/invaders_grid_8h_source.html#l00062">62</a> of file <a class="el" href="../../d6/def/invaders_grid_8h_source.html">invadersGrid.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac184c30c8a60fdbe8abed9b9455d35d2" name="ac184c30c8a60fdbe8abed9b9455d35d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac184c30c8a60fdbe8abed9b9455d35d2">&#9670;&nbsp;</a></span>randomValidCol()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned InvadersGrid::randomValidCol </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a random valid column in the grid. </p>
<dl class="section return"><dt>Returns</dt><dd>an index pointing to a column in the grid </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../da/de9/invader_grids_8cpp_source.html#l00058">58</a> of file <a class="el" href="../../da/de9/invader_grids_8cpp_source.html">invaderGrids.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d8d/class_invaders_grid_ac184c30c8a60fdbe8abed9b9455d35d2_cgraph.png" border="0" usemap="#ad0/d8d/class_invaders_grid_ac184c30c8a60fdbe8abed9b9455d35d2_cgraph" alt=""/></div>
<map name="ad0/d8d/class_invaders_grid_ac184c30c8a60fdbe8abed9b9455d35d2_cgraph" id="ad0/d8d/class_invaders_grid_ac184c30c8a60fdbe8abed9b9455d35d2_cgraph">
<area shape="rect" title="Returns a random valid column in the grid." alt="" coords="5,13,199,39"/>
<area shape="rect" href="../../d0/d8d/class_invaders_grid.html#ad327fc6f3a003e65ff3c131698ca6982" title="Helper function for randomValidCol() that returns the number of valid column (at least one invader in..." alt="" coords="247,13,448,39"/>
<area shape="rect" href="../../d1/dd8/class_invaders_column.html#ac21ea06c4b99ae790c5f69b0b70986be" title="tells if the column contains no non type NONE invader" alt="" coords="496,13,685,39"/>
<area shape="rect" href="../../d1/dd8/class_invaders_column.html#a712fad2377c0113268e94d4c90f688ec" title="gives the index of the last valid (type different than NONE) invader" alt="" coords="733,5,909,47"/>
</map>
</div>
</div>
</div>
<a id="ad327fc6f3a003e65ff3c131698ca6982" name="ad327fc6f3a003e65ff3c131698ca6982"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad327fc6f3a003e65ff3c131698ca6982">&#9670;&nbsp;</a></span>validColsNumber()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned InvadersGrid::validColsNumber </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper function for <a class="el" href="../../d0/d8d/class_invaders_grid.html#ac184c30c8a60fdbe8abed9b9455d35d2" title="Returns a random valid column in the grid.">randomValidCol()</a> that returns the number of valid column (at least one invader in them) in the grid This is a separate function because we need to use it elsewhere. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of valid columns in the grid </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../da/de9/invader_grids_8cpp_source.html#l00050">50</a> of file <a class="el" href="../../da/de9/invader_grids_8cpp_source.html">invaderGrids.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d8d/class_invaders_grid_ad327fc6f3a003e65ff3c131698ca6982_cgraph.png" border="0" usemap="#ad0/d8d/class_invaders_grid_ad327fc6f3a003e65ff3c131698ca6982_cgraph" alt=""/></div>
<map name="ad0/d8d/class_invaders_grid_ad327fc6f3a003e65ff3c131698ca6982_cgraph" id="ad0/d8d/class_invaders_grid_ad327fc6f3a003e65ff3c131698ca6982_cgraph">
<area shape="rect" title="Helper function for randomValidCol() that returns the number of valid column (at least one invader in..." alt="" coords="5,13,207,39"/>
<area shape="rect" href="../../d1/dd8/class_invaders_column.html#ac21ea06c4b99ae790c5f69b0b70986be" title="tells if the column contains no non type NONE invader" alt="" coords="255,13,444,39"/>
<area shape="rect" href="../../d1/dd8/class_invaders_column.html#a712fad2377c0113268e94d4c90f688ec" title="gives the index of the last valid (type different than NONE) invader" alt="" coords="492,5,668,47"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d0/d8d/class_invaders_grid_ad327fc6f3a003e65ff3c131698ca6982_icgraph.png" border="0" usemap="#ad0/d8d/class_invaders_grid_ad327fc6f3a003e65ff3c131698ca6982_icgraph" alt=""/></div>
<map name="ad0/d8d/class_invaders_grid_ad327fc6f3a003e65ff3c131698ca6982_icgraph" id="ad0/d8d/class_invaders_grid_ad327fc6f3a003e65ff3c131698ca6982_icgraph">
<area shape="rect" title="Helper function for randomValidCol() that returns the number of valid column (at least one invader in..." alt="" coords="247,5,448,32"/>
<area shape="rect" href="../../d0/d8d/class_invaders_grid.html#ac184c30c8a60fdbe8abed9b9455d35d2" title="Returns a random valid column in the grid." alt="" coords="5,5,199,32"/>
</map>
</div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>headers/<a class="el" href="../../d6/def/invaders_grid_8h_source.html">invadersGrid.h</a></li>
<li>src/<a class="el" href="../../da/de9/invader_grids_8cpp_source.html">invaderGrids.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d0/d8d/class_invaders_grid.html">InvadersGrid</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
</ul>
</div>
</body>
</html>