<?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::SquareBase Class 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_1SquareBase.html">SquareBase</a> </div> <div class="contents"> <h1>KGrid2D::SquareBase Class Reference</h1><!-- doxytag: class="KGrid2D::SquareBase" --><code>#include <<a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for KGrid2D::SquareBase:</div> <div class="dynsection"> <p><center><img src="classKGrid2D_1_1SquareBase.png" usemap="#KGrid2D::SquareBase_map" border="0" alt=""></center> <map name="KGrid2D::SquareBase_map"> <area href="classKGrid2D_1_1Square.html" alt="KGrid2D::Square< T >" shape="rect" coords="0,56,137,80"> </map> </div> <p> <a href="classKGrid2D_1_1SquareBase-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> This class contains static methods to manipulate coordinates for a square bidimensionnal grid. <p> <dl class="since" compact><dt><b>Since:</b></dt><dd>3.2 </dd></dl> <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00234">234</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 Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> { <br> <b>Left</b> = 0, <b>Right</b>, <b>Up</b>, <b>Down</b>, <br> <b>LeftUp</b>, <b>LeftDown</b>, <b>RightUp</b>, <b>RightDown</b>, <br> <b>Nb_Neighbour</b> <br> }</td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGrid2D_1_1SquareBase.html#91f1d108210f6a81932fc51df97aa15f">angle</a> (<a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGrid2D_1_1SquareBase.html#3c50ad36944fa44133721bc3491d10ab">opposed</a> (<a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGrid2D_1_1SquareBase.html#2f8a1713de15d373015ba0789ca60ec9">isDirect</a> (<a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static Coord </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGrid2D_1_1SquareBase.html#7ec8248c41b2bf2bdb0770b4011e4c0e">neighbour</a> (const Coord &c, <a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> n)</td></tr> </table> <hr><h2>Member Enumeration Documentation</h2> <a class="anchor" name="40ab5d0c2ff1dd3389e228d870f305d5"></a><!-- doxytag: member="KGrid2D::SquareBase::Neighbour" ref="40ab5d0c2ff1dd3389e228d870f305d5" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">KGrid2D::SquareBase::Neighbour</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Identify the eight neighbours. <p> <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00240">240</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="91f1d108210f6a81932fc51df97aa15f"></a><!-- doxytag: member="KGrid2D::SquareBase::angle" ref="91f1d108210f6a81932fc51df97aa15f" args="(Neighbour n)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static double KGrid2D::SquareBase::angle </td> <td>(</td> <td class="paramtype"><a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> </td> <td class="paramname"> <em>n</em> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the trigonometric angle in radians for the given neighbour. </dd></dl> <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00246">246</a> of file <a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a>.</p> </div> </div><p> <a class="anchor" name="3c50ad36944fa44133721bc3491d10ab"></a><!-- doxytag: member="KGrid2D::SquareBase::opposed" ref="3c50ad36944fa44133721bc3491d10ab" args="(Neighbour n)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> KGrid2D::SquareBase::opposed </td> <td>(</td> <td class="paramtype"><a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> </td> <td class="paramname"> <em>n</em> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the opposed neighbour. </dd></dl> <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00264">264</a> of file <a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a>.</p> </div> </div><p> <a class="anchor" name="2f8a1713de15d373015ba0789ca60ec9"></a><!-- doxytag: member="KGrid2D::SquareBase::isDirect" ref="2f8a1713de15d373015ba0789ca60ec9" args="(Neighbour n)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool KGrid2D::SquareBase::isDirect </td> <td>(</td> <td class="paramtype"><a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> </td> <td class="paramname"> <em>n</em> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the neighbour is a direct one (ie is one of the four nearest). </dd></dl> <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00283">283</a> of file <a class="el" href="kgrid2d_8h-source.html">kgrid2d.h</a>.</p> </div> </div><p> <a class="anchor" name="7ec8248c41b2bf2bdb0770b4011e4c0e"></a><!-- doxytag: member="KGrid2D::SquareBase::neighbour" ref="7ec8248c41b2bf2bdb0770b4011e4c0e" args="(const Coord &c, Neighbour n)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static Coord KGrid2D::SquareBase::neighbour </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"><a class="el" href="classKGrid2D_1_1SquareBase.html#40ab5d0c2ff1dd3389e228d870f305d5">Neighbour</a> </td> <td class="paramname"> <em>n</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the neighbour for the given coordinate. </dd></dl> <p>Definition at line <a class="el" href="kgrid2d_8h-source.html#l00288">288</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>