Sophie

Sophie

distrib > Fedora > 13 > i386 > by-pkgid > eebc325dc36bd6e3b09b9b45133e42f8 > files > 3211

HippoDraw-devel-docs-1.21.1-10.fc13.i686.rpm

<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>HippoDraw Class Library</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link rel="shortcut icon" href="hippoApp.ico">
</head><body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespacehippodraw.html">hippodraw</a>::<a class="el" href="classhippodraw_1_1Point.html">Point</a>
  </div>
</div>
<div class="contents">
<h1>Point Class Reference</h1><!-- doxytag: class="hippodraw::Point" -->
<p>Class representing a two or three dimension point.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="Point_8h_source.html">Point.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for Point:</div>
<div class="dynsection">
<div class="center"><img src="classhippodraw_1_1Point__coll__graph.gif" border="0" usemap="#Point_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classhippodraw_1_1Point-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#af71e522ec6aa935c2618819b54f20e02">getX</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The following function returns the X coordinate.  <a href="#af71e522ec6aa935c2618819b54f20e02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#acd84440598b1da2a23c326ce371db4e4">getY</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The following function returns the Y coordinate.  <a href="#acd84440598b1da2a23c326ce371db4e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#aa8d2d377de54332ea8f5c6191ddea692">getZ</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The following function returns the Z coordinate.  <a href="#aa8d2d377de54332ea8f5c6191ddea692"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#a0a54aee40f16bb73d33931f333f208be">moveBy</a> (double x, double y)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves the point by specified amount.  <a href="#a0a54aee40f16bb73d33931f333f208be"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#aecd2a13cc8c6397ccbe28953d4bc8111">Point</a> (double x=0.0, double y=0.0, double z=0.0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#a9807c9a18995b800d0edc865a399d741">setPoint</a> (double x, double y, double z)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#aae20a5a02597edd1813cf2d76b679926">setPoint</a> (double x, double y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#a5c7441d63ee9d9d76d552f188cc7a14c">setZ</a> (double)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the Z component of the Rectangle.  <a href="#a5c7441d63ee9d9d76d552f188cc7a14c"></a><br/></td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#a731554e49bda0967051ada79c3950f84">m_x</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#ade6c85874951f5bae1918341c786e240">m_y</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1Point.html#acaba22e6c9f9d0dd663899ed3588e843">m_z</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class representing a two or three dimension point. </p>
<dl class="attention"><dt><b>Attention:</b></dt><dd>The in line functions were measured to have high profile when plotting large images. </dd></dl>

<p>Definition at line <a class="el" href="Point_8h_source.html#l00025">25</a> of file <a class="el" href="Point_8h_source.html">Point.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aecd2a13cc8c6397ccbe28953d4bc8111"></a><!-- doxytag: member="hippodraw::Point::Point" ref="aecd2a13cc8c6397ccbe28953d4bc8111" args="(double x=0.0, double y=0.0, double z=0.0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhippodraw_1_1Point.html">Point</a> </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>x</em> = <code>0.0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em> = <code>0.0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>z</em> = <code>0.0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="Point_8cxx_source.html#l00014">14</a> of file <a class="el" href="Point_8cxx_source.html">Point.cxx</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af71e522ec6aa935c2618819b54f20e02"></a><!-- doxytag: member="hippodraw::Point::getX" ref="af71e522ec6aa935c2618819b54f20e02" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double getX </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The following function returns the X coordinate. </p>

<p>Definition at line <a class="el" href="Point_8h_source.html#l00059">59</a> of file <a class="el" href="Point_8h_source.html">Point.h</a>.</p>

<p>References <a class="el" href="Point_8h_source.html#l00028">Point::m_x</a>.</p>

<p>Referenced by <a class="el" href="LinePointRep_8cxx_source.html#l00271">LinePointRep::addEndPoints()</a>, <a class="el" href="LinePointRep_8cxx_source.html#l00308">LinePointRep::cornerCase()</a>, <a class="el" href="Rectangle_8h_source.html#l00154">Rect::getX()</a>, <a class="el" href="Rectangle_8cxx_source.html#l00185">Rect::makeInBounds()</a>, and <a class="el" href="LinePointRep_8cxx_source.html#l00265">LinePointRep::separation()</a>.</p>

</div>
</div>
<a class="anchor" id="acd84440598b1da2a23c326ce371db4e4"></a><!-- doxytag: member="hippodraw::Point::getY" ref="acd84440598b1da2a23c326ce371db4e4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double getY </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The following function returns the Y coordinate. </p>

<p>Definition at line <a class="el" href="Point_8h_source.html#l00067">67</a> of file <a class="el" href="Point_8h_source.html">Point.h</a>.</p>

<p>References <a class="el" href="Point_8h_source.html#l00029">Point::m_y</a>.</p>

<p>Referenced by <a class="el" href="LinePointRep_8cxx_source.html#l00271">LinePointRep::addEndPoints()</a>, <a class="el" href="LinePointRep_8cxx_source.html#l00308">LinePointRep::cornerCase()</a>, <a class="el" href="Rectangle_8h_source.html#l00162">Rect::getY()</a>, <a class="el" href="Rectangle_8cxx_source.html#l00185">Rect::makeInBounds()</a>, and <a class="el" href="LinePointRep_8cxx_source.html#l00265">LinePointRep::separation()</a>.</p>

</div>
</div>
<a class="anchor" id="aa8d2d377de54332ea8f5c6191ddea692"></a><!-- doxytag: member="hippodraw::Point::getZ" ref="aa8d2d377de54332ea8f5c6191ddea692" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double getZ </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The following function returns the Z coordinate. </p>

<p>Definition at line <a class="el" href="Point_8h_source.html#l00074">74</a> of file <a class="el" href="Point_8h_source.html">Point.h</a>.</p>

<p>References <a class="el" href="Point_8h_source.html#l00030">Point::m_z</a>.</p>

<p>Referenced by <a class="el" href="Rectangle_8cxx_source.html#l00098">Rect::getZ()</a>, <a class="el" href="Rectangle_8cxx_source.html#l00136">Rect::isInDepth()</a>, and <a class="el" href="Rectangle_8cxx_source.html#l00209">Rect::makeInBounds()</a>.</p>

</div>
</div>
<a class="anchor" id="a0a54aee40f16bb73d33931f333f208be"></a><!-- doxytag: member="hippodraw::Point::moveBy" ref="a0a54aee40f16bb73d33931f333f208be" args="(double x, double y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void moveBy </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Moves the point by specified amount. </p>

<p>Definition at line <a class="el" href="Point_8cxx_source.html#l00030">30</a> of file <a class="el" href="Point_8cxx_source.html">Point.cxx</a>.</p>

<p>References <a class="el" href="Point_8h_source.html#l00028">Point::m_x</a>, and <a class="el" href="Point_8h_source.html#l00029">Point::m_y</a>.</p>

<p>Referenced by <a class="el" href="Rectangle_8cxx_source.html#l00083">Rect::moveBy()</a>.</p>

</div>
</div>
<a class="anchor" id="a9807c9a18995b800d0edc865a399d741"></a><!-- doxytag: member="hippodraw::Point::setPoint" ref="a9807c9a18995b800d0edc865a399d741" args="(double x, double y, double z)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setPoint </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>z</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="Point_8cxx_source.html#l00024">24</a> of file <a class="el" href="Point_8cxx_source.html">Point.cxx</a>.</p>

<p>References <a class="el" href="Point_8h_source.html#l00028">Point::m_x</a>, <a class="el" href="Point_8h_source.html#l00029">Point::m_y</a>, and <a class="el" href="Point_8h_source.html#l00030">Point::m_z</a>.</p>

</div>
</div>
<a class="anchor" id="aae20a5a02597edd1813cf2d76b679926"></a><!-- doxytag: member="hippodraw::Point::setPoint" ref="aae20a5a02597edd1813cf2d76b679926" args="(double x, double y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setPoint </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="Point_8cxx_source.html#l00019">19</a> of file <a class="el" href="Point_8cxx_source.html">Point.cxx</a>.</p>

<p>References <a class="el" href="Point_8h_source.html#l00028">Point::m_x</a>, and <a class="el" href="Point_8h_source.html#l00029">Point::m_y</a>.</p>

<p>Referenced by <a class="el" href="LinePointRep_8cxx_source.html#l00286">LinePointRep::findEndPoints()</a>, <a class="el" href="Rectangle_8cxx_source.html#l00070">Rect::setRect()</a>, <a class="el" href="LinePointRep_8cxx_source.html#l00183">LinePointRep::straddles_x_boundary()</a>, and <a class="el" href="LinePointRep_8cxx_source.html#l00221">LinePointRep::straddles_y_boundary()</a>.</p>

</div>
</div>
<a class="anchor" id="a5c7441d63ee9d9d76d552f188cc7a14c"></a><!-- doxytag: member="hippodraw::Point::setZ" ref="a5c7441d63ee9d9d76d552f188cc7a14c" args="(double)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setZ </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>z</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the Z component of the Rectangle. </p>

<p>Definition at line <a class="el" href="Point_8cxx_source.html#l00036">36</a> of file <a class="el" href="Point_8cxx_source.html">Point.cxx</a>.</p>

<p>References <a class="el" href="Point_8h_source.html#l00030">Point::m_z</a>.</p>

<p>Referenced by <a class="el" href="Rectangle_8cxx_source.html#l00103">Rect::setZ()</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a731554e49bda0967051ada79c3950f84"></a><!-- doxytag: member="hippodraw::Point::m_x" ref="a731554e49bda0967051ada79c3950f84" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classhippodraw_1_1Point.html#a731554e49bda0967051ada79c3950f84">m_x</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="Point_8h_source.html#l00028">28</a> of file <a class="el" href="Point_8h_source.html">Point.h</a>.</p>

<p>Referenced by <a class="el" href="Point_8h_source.html#l00059">Point::getX()</a>, <a class="el" href="Point_8cxx_source.html#l00030">Point::moveBy()</a>, and <a class="el" href="Point_8cxx_source.html#l00019">Point::setPoint()</a>.</p>

</div>
</div>
<a class="anchor" id="ade6c85874951f5bae1918341c786e240"></a><!-- doxytag: member="hippodraw::Point::m_y" ref="ade6c85874951f5bae1918341c786e240" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classhippodraw_1_1Point.html#ade6c85874951f5bae1918341c786e240">m_y</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="Point_8h_source.html#l00029">29</a> of file <a class="el" href="Point_8h_source.html">Point.h</a>.</p>

<p>Referenced by <a class="el" href="Point_8h_source.html#l00067">Point::getY()</a>, <a class="el" href="Point_8cxx_source.html#l00030">Point::moveBy()</a>, and <a class="el" href="Point_8cxx_source.html#l00019">Point::setPoint()</a>.</p>

</div>
</div>
<a class="anchor" id="acaba22e6c9f9d0dd663899ed3588e843"></a><!-- doxytag: member="hippodraw::Point::m_z" ref="acaba22e6c9f9d0dd663899ed3588e843" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="classhippodraw_1_1Point.html#acaba22e6c9f9d0dd663899ed3588e843">m_z</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="Point_8h_source.html#l00030">30</a> of file <a class="el" href="Point_8h_source.html">Point.h</a>.</p>

<p>Referenced by <a class="el" href="Point_8h_source.html#l00074">Point::getZ()</a>, <a class="el" href="Point_8cxx_source.html#l00024">Point::setPoint()</a>, and <a class="el" href="Point_8cxx_source.html#l00036">Point::setZ()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Point_8h_source.html">Point.h</a></li>
<li><a class="el" href="Point_8cxx_source.html">Point.cxx</a></li>
</ul>
</div>
<hr size="1"><address style="align: right;"><small>
Generated for HippoDraw Class Library by <a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0>
</a> </small></address>
</body>
</html>