gem-graph-client/doc/docbook/d3/d0a/base_8h.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_base_8h" xml:lang="en-US">
<title>include/base.h File Reference</title>
<indexterm><primary>include/base.h</primary></indexterm>
<para>

<para>base header </para>
 
</para>
<programlisting linenumbering="unnumbered">#include &lt;assert.h&gt;<?linebreak?>#include &lt;errno.h&gt;<?linebreak?>#include &lt;fcntl.h&gt;<?linebreak?>#include &lt;math.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &lt;stddef.h&gt;<?linebreak?>#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;sys/types.h&gt;<?linebreak?>#include &lt;sys/stat.h&gt;<?linebreak?>#include &lt;unistd.h&gt;<?linebreak?>#include &lt;time.h&gt;<?linebreak?>#include &lt;string.h&gt;<?linebreak?>#include &lt;glib-2.0/glib.h&gt;<?linebreak?>#include &lt;gtk-4.0/gtk/gtk.h&gt;<?linebreak?></programlisting><simplesect>
    <title>Classes    </title>
        <itemizedlist>
            <listitem><para>struct <link linkend="_structarrow__t">arrow_t</link></para>

<para>defines an arrow address </para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Macros    </title>
        <itemizedlist>
            <listitem><para>#define <link linkend="_base_8h_1a072a1ef1143314441742097b799be322">EAST</link>&#160;&#160;&#160;0</para>

<para>If I&apos;m standing on Earth (or any spinning spheroid), looking towards its North pole. </para>
</listitem>
            <listitem><para>#define <link linkend="_base_8h_1a755da365a2f771fdb9e15af22fee7d74">WEST</link>&#160;&#160;&#160;1</para>
</listitem>
            <listitem><para>#define <link linkend="_base_8h_1a695b59c40e575e69cc7954a6045e01c7">ZENITH</link>&#160;&#160;&#160;2</para>
</listitem>
            <listitem><para>#define <link linkend="_base_8h_1a30dddfc4f2f483921921304d1d498674">NADIR</link>&#160;&#160;&#160;3</para>
</listitem>
            <listitem><para>#define <link linkend="_base_8h_1af3830320fe6287f717dca9669f417950">SOUTH</link>&#160;&#160;&#160;4</para>
</listitem>
            <listitem><para>#define <link linkend="_base_8h_1a1711232abf72723b5216c206e6bbb175">NORTH</link>&#160;&#160;&#160;5</para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Enumerations    </title>
        <itemizedlist>
            <listitem><para><anchor xml:id="_base_8h_1a06fc87d81c62e9abb8790b6e5713c55b"/>enum { <emphasis role="strong">X_AXIS</emphasis>
, <emphasis role="strong">Y_AXIS</emphasis>
, <emphasis role="strong">Z_AXIS</emphasis>
, <emphasis role="strong">N_AXIS</emphasis>
 }</para>

<para>used by <link linkend="_graphics_8h">graphics.h</link> </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>base header </para>

<para>This file is part of Gem-graph. </para>
</section>
<section>
<title>Macro Definition Documentation</title>
<anchor xml:id="_base_8h_1a072a1ef1143314441742097b799be322"/><section>
    <title>EAST</title>
<indexterm><primary>EAST</primary><secondary>base.h</secondary></indexterm>
<indexterm><primary>base.h</primary><secondary>EAST</secondary></indexterm>
<para><computeroutput>#define EAST&#160;&#160;&#160;0</computeroutput></para><para>

<para>If I&apos;m standing on Earth (or any spinning spheroid), looking towards its North pole. </para>
</para>

<para>Then :</para>

<para>X - X = EAST - WEST = red - cyan Y - Y = ZENITH - NADIR = green - magenta (fuschia) Z - Z = NORTH - SOUTH = blue - yellow<itemizedlist>
<listitem>
<para>x red </para>
</listitem></itemizedlist>
</para>
</section>
<anchor xml:id="_base_8h_1a30dddfc4f2f483921921304d1d498674"/><section>
    <title>NADIR</title>
<indexterm><primary>NADIR</primary><secondary>base.h</secondary></indexterm>
<indexterm><primary>base.h</primary><secondary>NADIR</secondary></indexterm>
<para><computeroutput>#define NADIR&#160;&#160;&#160;3</computeroutput></para>
<para><itemizedlist>
<listitem>
<para>y magenta </para>
</listitem></itemizedlist>
</para>
</section>
<anchor xml:id="_base_8h_1a1711232abf72723b5216c206e6bbb175"/><section>
    <title>NORTH</title>
<indexterm><primary>NORTH</primary><secondary>base.h</secondary></indexterm>
<indexterm><primary>base.h</primary><secondary>NORTH</secondary></indexterm>
<para><computeroutput>#define NORTH&#160;&#160;&#160;5</computeroutput></para>
<para><itemizedlist>
<listitem>
<para>z yellow </para>
</listitem></itemizedlist>
</para>
</section>
<anchor xml:id="_base_8h_1af3830320fe6287f717dca9669f417950"/><section>
    <title>SOUTH</title>
<indexterm><primary>SOUTH</primary><secondary>base.h</secondary></indexterm>
<indexterm><primary>base.h</primary><secondary>SOUTH</secondary></indexterm>
<para><computeroutput>#define SOUTH&#160;&#160;&#160;4</computeroutput></para>
<para><itemizedlist>
<listitem>
<para>z blue </para>
</listitem></itemizedlist>
</para>
</section>
<anchor xml:id="_base_8h_1a755da365a2f771fdb9e15af22fee7d74"/><section>
    <title>WEST</title>
<indexterm><primary>WEST</primary><secondary>base.h</secondary></indexterm>
<indexterm><primary>base.h</primary><secondary>WEST</secondary></indexterm>
<para><computeroutput>#define WEST&#160;&#160;&#160;1</computeroutput></para>
<para><itemizedlist>
<listitem>
<para>x cyan </para>
</listitem></itemizedlist>
</para>
</section>
<anchor xml:id="_base_8h_1a695b59c40e575e69cc7954a6045e01c7"/><section>
    <title>ZENITH</title>
<indexterm><primary>ZENITH</primary><secondary>base.h</secondary></indexterm>
<indexterm><primary>base.h</primary><secondary>ZENITH</secondary></indexterm>
<para><computeroutput>#define ZENITH&#160;&#160;&#160;2</computeroutput></para>
<para><itemizedlist>
<listitem>
<para>y green </para>
</listitem></itemizedlist>
</para>
</section>
</section>
</section>