<?xml version="1.0" encoding="UTF-8"?> <!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" lang="en_US" xml:lang="en_US"> <head> <title>libkdegames: KGrid2D::Hexagonal< Type > Class Template Reference (libkdegames)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' /> <meta name="trademark" content="KDE e.V." /> <meta name="description" content="K Desktop Environment Homepage, KDE.org" /> <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="robots" content="all" /> <link rel="shortcut icon" href="../../favicon.ico" /> <link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" /> </head> <body> <div id="nav_header_top" align="right"> <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a> <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a> <span class="doNotDisplay">::</span> <div id="nav_header_title" align="left">KDE API Reference</div> </div> <div id="nav_header_bottom" align="right"> <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span> <div id="nav_header_bottom_right" style="text-align: left;"> / <a href="../..">API Reference</a> / <a href=".">libkdegames</a> </div> </div> <table id="main" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td valign="top" class="menuheader" height="0"></td> <td id="contentcolumn" valign="top" rowspan="2" > <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;"> <a name="content"></a> <!-- Generated by Doxygen 1.5.5 --> <div class="navpath"><b>KGrid2D</b>::<a class="el" href="classKGrid2D_1_1Hexagonal.html">Hexagonal</a> </div> <div class="contents"> <h1>KGrid2D::Hexagonal< Type > Class Template Reference</h1><!-- doxytag: class="KGrid2D::Hexagonal" --><!-- doxytag: inherits="KGrid2D::Generic,KGrid2D::HexagonalBase" --><code>#include <<a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for KGrid2D::Hexagonal< Type >:</div> <div class="dynsection"> <p><center><img src="classKGrid2D_1_1Hexagonal.png" usemap="#KGrid2D::Hexagonal< Type >_map" border="0" alt=""></center> <map name="KGrid2D::Hexagonal< Type >_map"> <area href="classKGrid2D_1_1Generic.html" alt="KGrid2D::Generic< Type >" shape="rect" coords="0,0,178,24"> <area href="classKGrid2D_1_1HexagonalBase.html" alt="KGrid2D::HexagonalBase" shape="rect" coords="188,0,366,24"> </map> </div> <p> <a href="classKGrid2D_1_1Hexagonal-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> <h3>template<class Type><br> class KGrid2D::Hexagonal< Type ></h3> This template implements a hexagonal grid where hexagons form horizontal lines:. <p> <pre> (0,0) (0,1) (0,2) (1,0) (1,1) (1,2) (2,0) (2,1) (2,2) </pre><p> @ since 3.2 <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00451">451</a> of file <a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGrid2D_1_1Hexagonal.html#a1924116eaf2b5cb9a45aefb64a042ab">Hexagonal</a> (uint width=0, uint height=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">CoordList </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGrid2D_1_1Hexagonal.html#d044accb113b4461cdc078609b2ab172">neighbours</a> (const Coord &c, bool insideOnly=true) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">CoordList </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGrid2D_1_1Hexagonal.html#0c3ff390240ddc844608b959581645c7">neighbours</a> (const Coord &c, uint distance, bool all, bool insideOnly=true) const </td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="a1924116eaf2b5cb9a45aefb64a042ab"></a><!-- doxytag: member="KGrid2D::Hexagonal::Hexagonal" ref="a1924116eaf2b5cb9a45aefb64a042ab" args="(uint width=0, uint height=0)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class Type> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKGrid2D_1_1Hexagonal.html">KGrid2D::Hexagonal</a>< Type >::<a class="el" href="classKGrid2D_1_1Hexagonal.html">Hexagonal</a> </td> <td>(</td> <td class="paramtype">uint </td> <td class="paramname"> <em>width</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint </td> <td class="paramname"> <em>height</em> = <code>0</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor. <p> <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00457">457</a> of file <a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="d044accb113b4461cdc078609b2ab172"></a><!-- doxytag: member="KGrid2D::Hexagonal::neighbours" ref="d044accb113b4461cdc078609b2ab172" args="(const Coord &c, bool insideOnly=true) const " --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class Type> </div> <table class="memname"> <tr> <td class="memname">CoordList <a class="el" href="classKGrid2D_1_1Hexagonal.html">KGrid2D::Hexagonal</a>< Type >::neighbours </td> <td>(</td> <td class="paramtype">const Coord & </td> <td class="paramname"> <em>c</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>insideOnly</em> = <code>true</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the neighbours of coordinate </dd></dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>to the given set of coordinates </td></tr> <tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the coordiante to use as the reference point </td></tr> <tr><td valign="top"></td><td valign="top"><em>insideOnly</em> </td><td>only add coordinates that are inside the grid. </td></tr> </table> </dl> <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00466">466</a> of file <a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a>.</p> </div> </div><p> <a class="anchor" name="0c3ff390240ddc844608b959581645c7"></a><!-- doxytag: member="KGrid2D::Hexagonal::neighbours" ref="0c3ff390240ddc844608b959581645c7" args="(const Coord &c, uint distance, bool all, bool insideOnly=true) const " --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class Type> </div> <table class="memname"> <tr> <td class="memname">CoordList <a class="el" href="classKGrid2D_1_1Hexagonal.html">KGrid2D::Hexagonal</a>< Type >::neighbours </td> <td>(</td> <td class="paramtype">const Coord & </td> <td class="paramname"> <em>c</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">uint </td> <td class="paramname"> <em>distance</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>all</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>insideOnly</em> = <code>true</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the neighbours at distance </dd></dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>distance</em> </td><td>of coordinate </td></tr> <tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the coordinate to use as the reference point </td></tr> <tr><td valign="top"></td><td valign="top"><em>distance</em> </td><td>distance to the neighbour (1 means at contact). </td></tr> <tr><td valign="top"></td><td valign="top"><em>insideOnly</em> </td><td>only add coordinates that are inside the grid. </td></tr> <tr><td valign="top"></td><td valign="top"><em>all</em> </td><td>returns all neighbours at distance equal and less than </td></tr> <tr><td valign="top"></td><td valign="top"><em>distance</em> </td><td>(the original coordinate is not included). </td></tr> </table> </dl> <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00485">485</a> of file <a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a></ul> </div> </div></div> </td> </tr> <tr> <td valign="top" id="leftmenu" width="25%"> <a name="navigation"></a> <div class="menu_box"><h2>libkdegames</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul> <!-- <h2>Class Picker</h2> <div style="text-align: center;"> <form name="guideform"> <select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value"> <option value="annotated.html">-- Choose --</option> <option value="classKCanvasRootPixmap.html">kcanvasrootpixmap</option>, <option value="classKCardDialog.html">kcarddialog</option>, <option value="classKChat.html">kchat</option>, <option value="classKChatBase.html">kchatbase</option>, <option value="classKChatBaseText.html">kchatbasetext</option>, <option value="classKExtHighscore_1_1Item.html">kexthighscore::item</option>, <option value="classKExtHighscore_1_1ItemArray.html">kexthighscore::itemarray</option>, <option value="classKExtHighscore_1_1Manager.html">kexthighscore::manager</option>, <option value="classKExtHighscore_1_1MultiplayerScores.html">kexthighscore::multiplayerscores</option>, <option value="classKExtHighscore_1_1Score.html">kexthighscore::score</option>, <option value="classKGame.html">kgame</option>, <option value="classKGameChat.html">kgamechat</option>, <option value="classKGameComputerIO.html">kgamecomputerio</option>, <option value="classKGameConnectDialog.html">kgameconnectdialog</option>, <option value="classKGameDialog.html">kgamedialog</option>, <option value="classKGameDialogChatConfig.html">kgamedialogchatconfig</option>, <option value="classKGameDialogConfig.html">kgamedialogconfig</option>, <option value="classKGameErrorDialog.html">kgameerrordialog</option>, <option value="classKGameErrorMessageDialog.html">kgameerrormessagedialog</option>, <option value="classKGameIO.html">kgameio</option>, <option value="classKGameKeyIO.html">kgamekeyio</option>, <option value="classKGameLCD.html">kgamelcd</option>, <option value="classKGameLCDClock.html">kgamelcdclock</option>, <option value="classKGameLCDList.html">kgamelcdlist</option>, <option value="classKGameMisc.html">kgamemisc</option>, <option value="classKGameMouseIO.html">kgamemouseio</option>, <option value="classKGameNetwork.html">kgamenetwork</option>, <option value="classKGameProcess.html">kgameprocess</option>, <option value="classKGameProcessIO.html">kgameprocessio</option>, <option value="classKGameProgress.html">kgameprogress</option>, <option value="classKGameProperty.html">kgameproperty</option>, <option value="classKGamePropertyBase.html">kgamepropertybase</option>, <option value="classKGamePropertyHandler.html">kgamepropertyhandler</option>, <option value="classKGameSequence.html">kgamesequence</option>, <option value="classKGrid2D_1_1Generic.html">kgrid2d::generic</option>, <option value="classKGrid2D_1_1Hexagonal.html">kgrid2d::hexagonal</option>, <option value="classKGrid2D_1_1HexagonalBase.html">kgrid2d::hexagonalbase</option>, <option value="classKGrid2D_1_1Square.html">kgrid2d::square</option>, <option value="classKGrid2D_1_1SquareBase.html">kgrid2d::squarebase</option>, <option value="classKHighscore.html">khighscore</option>, <option value="classKMessageClient.html">kmessageclient</option>, <option value="classKMessageDirect.html">kmessagedirect</option>, <option value="classKMessageIO.html">kmessageio</option>, <option value="classKMessageServer.html">kmessageserver</option>, <option value="classKMessageServerSocket.html">kmessageserversocket</option>, <option value="classKMessageSocket.html">kmessagesocket</option>, <option value="classKPlayer.html">kplayer</option>, <option value="classKScoreDialog.html">kscoredialog</option>, <option value="classKStdGameAction.html">kstdgameaction</option>, </select> </form> </div> --> </div></div> <div class="menu_box"><h2>API Dox</h2> <div class="nav_list"> <ul> <li><a href="../../libkdegames/html/index.html">libkdegames</a></li> </ul></div></div> </td> </tr> </table> <span class="doNotDisplay"> <a href="http://www.kde.org/" accesskey="8">KDE Home</a> | <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> | <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a> </span> <div style="height: 8px"></div> <div id="footer"> <div id="footer_left"> Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a> and <a href="mailto:winter@kde.org">Allen Winter</a>. <br/> KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div> <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div> </div> <!-- WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL BE BLOCKED INSTANTLY AND PERMANENTLY! <a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a> WARNING END --> </body> </html>