gem-graph-client/doc/html/d3/d0a/base_8h.html

252 lines
12 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" lang="en-US">
<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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gem-graph: include/base.h File 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="../../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 icon mini.png"/></td>
<td id="projectalign">
<div id="projectname">Gem-graph<span id="projectnumber">&#160;0.1.0</span>
</div>
<div id="projectbrief">A modelling tool based on rewriting of geometric graphs.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../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>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle"><div class="title">base.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>base header
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;assert.h&gt;</code><br />
<code>#include &lt;errno.h&gt;</code><br />
<code>#include &lt;fcntl.h&gt;</code><br />
<code>#include &lt;math.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;stddef.h&gt;</code><br />
<code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &lt;sys/types.h&gt;</code><br />
<code>#include &lt;sys/stat.h&gt;</code><br />
<code>#include &lt;unistd.h&gt;</code><br />
<code>#include &lt;time.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;glib-2.0/glib.h&gt;</code><br />
<code>#include &lt;gtk-4.0/gtk/gtk.h&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d03/structarrow__t.html">arrow_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">defines an arrow address <a href="../../d3/d03/structarrow__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a072a1ef1143314441742097b799be322" id="r_a072a1ef1143314441742097b799be322"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/base_8h.html#a072a1ef1143314441742097b799be322">EAST</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:a072a1ef1143314441742097b799be322"><td class="mdescLeft">&#160;</td><td class="mdescRight">If I'm standing on Earth (or any spinning spheroid), looking towards its North pole. <br /></td></tr>
<tr class="separator:a072a1ef1143314441742097b799be322"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a755da365a2f771fdb9e15af22fee7d74" id="r_a755da365a2f771fdb9e15af22fee7d74"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/base_8h.html#a755da365a2f771fdb9e15af22fee7d74">WEST</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a755da365a2f771fdb9e15af22fee7d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a695b59c40e575e69cc7954a6045e01c7" id="r_a695b59c40e575e69cc7954a6045e01c7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/base_8h.html#a695b59c40e575e69cc7954a6045e01c7">ZENITH</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:a695b59c40e575e69cc7954a6045e01c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30dddfc4f2f483921921304d1d498674" id="r_a30dddfc4f2f483921921304d1d498674"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/base_8h.html#a30dddfc4f2f483921921304d1d498674">NADIR</a>&#160;&#160;&#160;3</td></tr>
<tr class="separator:a30dddfc4f2f483921921304d1d498674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3830320fe6287f717dca9669f417950" id="r_af3830320fe6287f717dca9669f417950"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/base_8h.html#af3830320fe6287f717dca9669f417950">SOUTH</a>&#160;&#160;&#160;4</td></tr>
<tr class="separator:af3830320fe6287f717dca9669f417950"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1711232abf72723b5216c206e6bbb175" id="r_a1711232abf72723b5216c206e6bbb175"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d0a/base_8h.html#a1711232abf72723b5216c206e6bbb175">NORTH</a>&#160;&#160;&#160;5</td></tr>
<tr class="separator:a1711232abf72723b5216c206e6bbb175"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a06fc87d81c62e9abb8790b6e5713c55b" id="r_a06fc87d81c62e9abb8790b6e5713c55b"><td class="memItemLeft" align="right" valign="top"><a id="a06fc87d81c62e9abb8790b6e5713c55b" name="a06fc87d81c62e9abb8790b6e5713c55b"></a>enum &#160;</td><td class="memItemRight" valign="bottom">{ <b>X_AXIS</b>
, <b>Y_AXIS</b>
, <b>Z_AXIS</b>
, <b>N_AXIS</b>
}</td></tr>
<tr class="memdesc:a06fc87d81c62e9abb8790b6e5713c55b"><td class="mdescLeft">&#160;</td><td class="mdescRight">used by <a class="el" href="d7/d04/graphics_8h.html" title="graphics header">graphics.h</a> <br /></td></tr>
<tr class="separator:a06fc87d81c62e9abb8790b6e5713c55b"><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>base header </p>
<p>This file is part of Gem-graph. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a072a1ef1143314441742097b799be322" name="a072a1ef1143314441742097b799be322"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a072a1ef1143314441742097b799be322">&#9670;&#160;</a></span>EAST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EAST&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>If I'm standing on Earth (or any spinning spheroid), looking towards its North pole. </p>
<p>Then :</p>
<p>X - X = EAST - WEST = red - cyan Y - Y = ZENITH - NADIR = green - magenta (fuschia) Z - Z = NORTH - SOUTH = blue - yellow</p><ul>
<li>x red </li>
</ul>
</div>
</div>
<a id="a30dddfc4f2f483921921304d1d498674" name="a30dddfc4f2f483921921304d1d498674"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30dddfc4f2f483921921304d1d498674">&#9670;&#160;</a></span>NADIR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NADIR&#160;&#160;&#160;3</td>
</tr>
</table>
</div><div class="memdoc">
<ul>
<li>y magenta </li>
</ul>
</div>
</div>
<a id="a1711232abf72723b5216c206e6bbb175" name="a1711232abf72723b5216c206e6bbb175"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1711232abf72723b5216c206e6bbb175">&#9670;&#160;</a></span>NORTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define NORTH&#160;&#160;&#160;5</td>
</tr>
</table>
</div><div class="memdoc">
<ul>
<li>z yellow </li>
</ul>
</div>
</div>
<a id="af3830320fe6287f717dca9669f417950" name="af3830320fe6287f717dca9669f417950"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3830320fe6287f717dca9669f417950">&#9670;&#160;</a></span>SOUTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SOUTH&#160;&#160;&#160;4</td>
</tr>
</table>
</div><div class="memdoc">
<ul>
<li>z blue </li>
</ul>
</div>
</div>
<a id="a755da365a2f771fdb9e15af22fee7d74" name="a755da365a2f771fdb9e15af22fee7d74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a755da365a2f771fdb9e15af22fee7d74">&#9670;&#160;</a></span>WEST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WEST&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<ul>
<li>x cyan </li>
</ul>
</div>
</div>
<a id="a695b59c40e575e69cc7954a6045e01c7" name="a695b59c40e575e69cc7954a6045e01c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a695b59c40e575e69cc7954a6045e01c7">&#9670;&#160;</a></span>ZENITH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ZENITH&#160;&#160;&#160;2</td>
</tr>
</table>
</div><div class="memdoc">
<ul>
<li>y green </li>
</ul>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>